adf4371.h File Reference

Header file of ADF4371 Driver. More...

#include <stdint.h>
#include "no_os_spi.h"

Include dependency graph for adf4371.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	adf4371_channel_config
struct	adf4371_cp_settings
struct	adf4371_chan_spec
struct	adf4371_dev
struct	adf4371_init_param

Functions
int32_t	adf4371_init (struct adf4371_dev **device, const struct adf4371_init_param *init_param)
int32_t	adf4371_remove (struct adf4371_dev *device)
int32_t	adf4371_clk_recalc_rate (struct adf4371_dev *dev, uint32_t chan, uint64_t *rate)
int32_t	adf4371_clk_round_rate (struct adf4371_dev *dev, uint64_t rate, uint64_t *rounded_rate)
int32_t	adf4371_clk_set_rate (struct adf4371_dev *dev, uint32_t chan, uint64_t rate)

Detailed Description

Header file of ADF4371 Driver.

Author

DBogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2020(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

adf4371_clk_recalc_rate()

int32_t adf4371_clk_recalc_rate	(	struct adf4371_dev *	dev,
		uint32_t	chan,
		uint64_t *	rate
	)

Recalculate rate corresponding to a channel.

Parameters

dev	- The device structure.
chan	- Channel number.
rate	- Channel rate.

Returns

0 in case of success, negative error code otherwise.

adf4371_clk_round_rate()

int32_t adf4371_clk_round_rate	(	struct adf4371_dev *	dev,
		uint64_t	rate,
		uint64_t *	rounded_rate
	)

Calculate closest possible rate

Parameters

dev	- The device structure
rate	- The desired rate.
rounded_rate	- The closest possible rate of desired rate.

Returns

0 in case of success, negative error code otherwise.

adf4371_clk_set_rate()

int32_t adf4371_clk_set_rate	(	struct adf4371_dev *	dev,
		uint32_t	chan,
		uint64_t	rate
	)

Set channel rate.

Parameters

dev	- The device structure.
chan	- Channel number.
rate	- Channel rate.

Returns

0 in case of success, negative error code otherwise.

adf4371_init()

int32_t adf4371_init	(	struct adf4371_dev **	device,
		const struct adf4371_init_param *	init_param
	)

Initialize the device.

Parameters

device	- The device structure.
init_param	- The structure that contains the device initial parameters.

Returns

0 in case of success, negative error code otherwise.

adf4371_remove()

int32_t adf4371_remove

(

struct adf4371_dev *

device

)

Remove the device - release resources.

Parameters

device

- The device structure.

Returns

0 in case of success, negative error code otherwise.