ad5142.h File Reference

#include "../common/dpot.h"
#include "no_os_spi.h"
#include "no_os_i2c.h"
#include "no_os_gpio.h"
#include "no_os_util.h"
#include "ad51xx_cmd.h"

Include dependency graph for ad5142.h:

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

Go to the source code of this file.

Classes
struct	ad5142_dpot_init_param
	AD5142 digital potentiometer init parameters. More...
struct	ad5142_dpot_dev
	AD5142 digital potentiometer device descriptor parameters. More...

Macros
#define	AD5142_NUM_POTENTIOMETER_CH   2
#define	AD5142_NUM_LINEAR_GAIN_CH   4

Functions
int	ad5142_dpot_init (struct dpot_init_param *init_params, struct dpot_dev **desc)
	Initialize the AD5142 digital potentiometer.
int	ad5142_dpot_remove (struct dpot_dev *desc)
	Free the memory allocated by ad5142_dpot_init().
int	ad5142_dpot_reset (struct dpot_dev *desc)
	Reset the AD5142 digital potentiometer.
int	ad5142_dpot_shutdown (struct dpot_dev *desc, enum dpot_chn_type chn, bool shutdown_enable)
	Shutdown the AD5142 digital potentiometer channel.
int	ad5142_dpot_set_operating_mode (struct dpot_dev *desc, enum dpot_operating_mode operating_mode)
	Set the AD5142 digital potentiometer operating mode.
int	ad5142_dpot_input_reg_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the AD5142 digital potentiometer input register.
int	ad5142_dpot_input_reg_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write to the digital potentiometer input register.
int	ad5142_dpot_sw_lrdac_update (struct dpot_dev *desc, enum dpot_chn_type chn)
	Copy input register to RDAC (software LRDAC).
int	ad5142_dpot_chn_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the AD5142 digital potentiometer channel.
int	ad5142_dpot_chn_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write to the digital potentiometer channel.
int	ad5142_dpot_nvm_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the NVM (non-volatile) memory data.
int	ad5142_dpot_nvm_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write data to NVM (non-volatile) memory.
int	ad5142_dpot_copy_rdac_to_nvm (struct dpot_dev *desc, enum dpot_chn_type chn)
	Copy RDAC register to NVM/EEPROM.
int	ad5142_dpot_copy_nvm_to_rdac (struct dpot_dev *desc, enum dpot_chn_type chn)
	Copy NVM/EEPROM data to RDAC.
int	ad5142_dpot_rdac_linear_update (struct dpot_dev *desc, enum dpot_chn_type chn, enum dpot_rdac_linear_status status)
	Perform RDAC linear increment/decrement.
int	ad5142_dpot_rdac_6db_update (struct dpot_dev *desc, enum dpot_chn_type chn, enum dpot_rdac_6db_status status)
	Perform RDAC 6dB increment/decrement.
int	ad5142_dpot_send_cmd (struct dpot_dev *desc, struct dpot_command *cmd)
	Send command word to the AD5142 digital potentiometer.

Variables
const struct dpot_ops	ad5142_dpot_ops

Macro Definition Documentation

AD5142_NUM_LINEAR_GAIN_CH

#define AD5142_NUM_LINEAR_GAIN_CH   4

AD5142_NUM_POTENTIOMETER_CH

#define AD5142_NUM_POTENTIOMETER_CH   2

Function Documentation

ad5142_dpot_chn_read()

int ad5142_dpot_chn_read	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		uint8_t *	data )

Read the AD5142 digital potentiometer channel.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
data	- Channel data to be read.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_chn_write()

int ad5142_dpot_chn_write	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		uint8_t	data )

Write to the digital potentiometer channel.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
data	- Channel data to be written.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_copy_nvm_to_rdac()

int ad5142_dpot_copy_nvm_to_rdac	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn )

Copy NVM/EEPROM data to RDAC.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_copy_rdac_to_nvm()

int ad5142_dpot_copy_rdac_to_nvm	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn )

Copy RDAC register to NVM/EEPROM.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_init()

int ad5142_dpot_init	(	struct dpot_init_param *	param,
		struct dpot_dev **	desc )

Initialize the AD5142 digital potentiometer.

Parameters

param	- digipot init parameters.
desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_input_reg_read()

int ad5142_dpot_input_reg_read	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		uint8_t *	data )

Read the AD5142 digital potentiometer input register.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
data	- input register data to be read.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_input_reg_write()

int ad5142_dpot_input_reg_write	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		uint8_t	data )

Write to the digital potentiometer input register.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
data	- input register data to be written.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_nvm_read()

int ad5142_dpot_nvm_read	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		uint8_t *	data )

Read the NVM (non-volatile) memory data.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
data	- NVM data to be read.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_nvm_write()

int ad5142_dpot_nvm_write	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		uint8_t	data )

Write data to NVM (non-volatile) memory.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
data	- NVM data to be written.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_rdac_6db_update()

int ad5142_dpot_rdac_6db_update	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		enum dpot_rdac_6db_status	status )

Perform RDAC 6dB increment/decrement.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
status	- 6dB increment/decrement status.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_rdac_linear_update()

int ad5142_dpot_rdac_linear_update	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		enum dpot_rdac_linear_status	status )

Perform RDAC linear increment/decrement.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
status	- linear increment/decrement status.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_remove()

int ad5142_dpot_remove

(

struct dpot_dev *

desc

)

Free the memory allocated by ad5142_dpot_init().

Parameters

desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

ad5142_dpot_reset()

int ad5142_dpot_reset

(

struct dpot_dev *

desc

)

Reset the AD5142 digital potentiometer.

Parameters

desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

ad5142_dpot_send_cmd()

int ad5142_dpot_send_cmd	(	struct dpot_dev *	desc,
		struct dpot_command *	cmd )

Send command word to the AD5142 digital potentiometer.

Parameters

desc	- digipot descriptor.
cmd	- digipot command word

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

ad5142_dpot_set_operating_mode()

int ad5142_dpot_set_operating_mode	(	struct dpot_dev *	desc,
		enum dpot_operating_mode	operating_mode )

Set the AD5142 digital potentiometer operating mode.

Parameters

desc	- digipot descriptor.
operating_mode	- digipot operating mode.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

ad5142_dpot_shutdown()

int ad5142_dpot_shutdown	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		bool	shutdown_enable )

Shutdown the AD5142 digital potentiometer channel.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
shutdown_enable	- Shutdown enable status flag.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

ad5142_dpot_sw_lrdac_update()

int ad5142_dpot_sw_lrdac_update	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn )

Copy input register to RDAC (software LRDAC).

Parameters

desc	- digipot descriptor.
chn	- digipot channel.

Returns

0 in case of success, negative error code otherwise.

Variable Documentation

ad5142_dpot_ops

const struct dpot_ops ad5142_dpot_ops

extern