ad5141.c File Reference

#include "ad5141.h"
#include "no_os_delay.h"

Include dependency graph for ad5141.c:

Macros
#define	AD5141_NVM_WRITE_DELAY   18

Functions
int	ad5141_dpot_init (struct dpot_init_param *param, struct dpot_dev **desc)
	Initialize the AD5141 digital potentiometer.
int	ad5141_dpot_remove (struct dpot_dev *desc)
	Free the memory allocated by ad5141_dpot_init().
int	ad5141_dpot_reset (struct dpot_dev *desc)
	Reset the AD5141 digital potentiometer.
int	ad5141_dpot_shutdown (struct dpot_dev *desc, enum dpot_chn_type chn, bool shutdown_enable)
	Shutdown the AD5141 digital potentiometer channel.
int	ad5141_dpot_set_operating_mode (struct dpot_dev *desc, enum dpot_operating_mode operating_mode)
	Set the AD5141 digital potentiometer operating mode.
int	ad5141_dpot_input_reg_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the AD5141 digital potentiometer input register.
int	ad5141_dpot_input_reg_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write to the digital potentiometer input register.
int	ad5141_dpot_sw_lrdac_update (struct dpot_dev *desc, enum dpot_chn_type chn)
	Copy input register to RDAC (software LRDAC).
int	ad5141_dpot_chn_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the AD5141 digital potentiometer channel.
int	ad5141_dpot_chn_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write to the digital potentiometer channel.
int	ad5141_dpot_nvm_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the NVM (non-volatile) memory data.
int	ad5141_dpot_nvm_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write data to NVM (non-volatile) memory.
int	ad5141_dpot_copy_rdac_to_nvm (struct dpot_dev *desc, enum dpot_chn_type chn)
	Copy RDAC register to NVM/EEPROM.
int	ad5141_dpot_copy_nvm_to_rdac (struct dpot_dev *desc, enum dpot_chn_type chn)
	Copy NVM/EEPROM data to RDAC.
int	ad5141_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	ad5141_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	ad5141_dpot_send_cmd (struct dpot_dev *desc, struct dpot_command *cmd)
	Send command word to the AD5141 digital potentiometer.

Variables
uint8_t	ad5141_dpot_cmd_addr []
uint8_t	ad5141_dpot_cmd_nvm_addr []
const struct dpot_ops	ad5141_dpot_ops

Macro Definition Documentation

AD5141_NVM_WRITE_DELAY

#define AD5141_NVM_WRITE_DELAY   18

Function Documentation

ad5141_dpot_chn_read()

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

Read the AD5141 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.

ad5141_dpot_chn_write()

int ad5141_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.

ad5141_dpot_copy_nvm_to_rdac()

int ad5141_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.

ad5141_dpot_copy_rdac_to_nvm()

int ad5141_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.

ad5141_dpot_init()

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

Initialize the AD5141 digital potentiometer.

Parameters

param	- digipot init parameters.
desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

ad5141_dpot_input_reg_read()

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

Read the AD5141 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.

ad5141_dpot_input_reg_write()

int ad5141_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.

ad5141_dpot_nvm_read()

int ad5141_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.

ad5141_dpot_nvm_write()

int ad5141_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.

ad5141_dpot_rdac_6db_update()

int ad5141_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.

ad5141_dpot_rdac_linear_update()

int ad5141_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.

ad5141_dpot_remove()

int ad5141_dpot_remove

(

struct dpot_dev *

desc

)

Free the memory allocated by ad5141_dpot_init().

Parameters

desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

ad5141_dpot_reset()

int ad5141_dpot_reset

(

struct dpot_dev *

desc

)

Reset the AD5141 digital potentiometer.

Parameters

desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

ad5141_dpot_send_cmd()

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

Send command word to the AD5141 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:

ad5141_dpot_set_operating_mode()

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

Set the AD5141 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:

ad5141_dpot_shutdown()

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

Shutdown the AD5141 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:

ad5141_dpot_sw_lrdac_update()

int ad5141_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

ad5141_dpot_cmd_addr

uint8_t ad5141_dpot_cmd_addr[]

Initial value:

= {
    [DPOT_CHN_RDAC1] = 0x0,
    [DPOT_CHN_R_AW1] = 0x4,
    [DPOT_CHN_R_WB1] = 0x0,
}

ad5141_dpot_cmd_nvm_addr

uint8_t ad5141_dpot_cmd_nvm_addr[]

Initial value:

= {
    [DPOT_CHN_RDAC1] = 0x0,
    [DPOT_CHN_R_AW1] = 0x1,
    [DPOT_CHN_R_WB1] = 0x0,
}

ad5141_dpot_ops

const struct dpot_ops ad5141_dpot_ops

Initial value:

= {
    .dpot_init = &ad5141_dpot_init,
    .dpot_reset = &ad5141_dpot_reset,
    .dpot_shutdown = &ad5141_dpot_shutdown,
    .dpot_set_operating_mode = &ad5141_dpot_set_operating_mode,
    .dpot_input_reg_read = &ad5141_dpot_input_reg_read,
    .dpot_input_reg_write = &ad5141_dpot_input_reg_write,
    .dpot_sw_lrdac_update = &ad5141_dpot_sw_lrdac_update,
    .dpot_chn_read = &ad5141_dpot_chn_read,
    .dpot_chn_write = &ad5141_dpot_chn_write,
    .dpot_nvm_read = &ad5141_dpot_nvm_read,
    .dpot_nvm_write = &ad5141_dpot_nvm_write,
    .dpot_copy_rdac_to_nvm = &ad5141_dpot_copy_rdac_to_nvm,
    .dpot_copy_nvm_to_rdac = &ad5141_dpot_copy_nvm_to_rdac,
    .dpot_rdac_linear_update = &ad5141_dpot_rdac_linear_update,
    .dpot_rdac_6db_update = &ad5141_dpot_rdac_6db_update,
 
    .dpot_remove = &ad5141_dpot_remove,
}