ad5242.c File Reference

#include "ad5242.h"
#include "no_os_delay.h"

Include dependency graph for ad5242.c:

Functions
int	ad5242_dpot_send_cmd_write (struct dpot_dev *desc, struct dpot_command *cmd)
	Send command word to the ad5242 digital potentiometer.
int	ad5242_dpot_init (struct dpot_init_param *param, struct dpot_dev **desc)
	Initialize the ad5242 digital potentiometer.
int	ad5242_dpot_remove (struct dpot_dev *desc)
	Free the memory allocated by ad5242_dpot_init().
int	ad5242_dpot_chn_write (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t data)
	Write to the digital potentiometer channel.
int	ad5242_dpot_chn_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the ad5242 digital potentiometer channel.
int	ad5242_dpot_shutdown (struct dpot_dev *desc, enum dpot_chn_type chn, bool shutdown_enable)
	Shutdown the AD5144 digital potentiometer channel.
int	ad5242_dpot_set_mid_scale (struct dpot_dev *desc, enum dpot_chn_type chn, bool bMidScaleEnable)
	Shutdown the AD5144 digital potentiometer channel.

Variables
const struct dpot_ops	ad5242_dpot_ops

Function Documentation

ad5242_dpot_chn_read()

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

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

ad5242_dpot_chn_write()

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

ad5242_dpot_init()

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

Initialize the ad5242 digital potentiometer.

Parameters

param	- digipot init parameters.
desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

ad5242_dpot_remove()

int ad5242_dpot_remove

(

struct dpot_dev *

desc

)

Free the memory allocated by ad5242_dpot_init().

Parameters

desc	- digipot descriptor.

Returns

0 in case of success, negative error code otherwise.

ad5242_dpot_send_cmd_write()

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

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

ad5242_dpot_set_mid_scale()

int ad5242_dpot_set_mid_scale	(	struct dpot_dev *	desc,
		enum dpot_chn_type	chn,
		bool	bMidScaleEnable )

Shutdown the AD5144 digital potentiometer channel.

Parameters

desc	- digipot descriptor.
chn	- digipot channel.
bMidScaleEnable	- boolean variable to indiate .

Returns

0 in case of success, negative error code otherwise.

ad5242_dpot_shutdown()

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

Shutdown the AD5144 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.

Variable Documentation

ad5242_dpot_ops

const struct dpot_ops ad5242_dpot_ops

Initial value:

= {
    .dpot_init = &ad5242_dpot_init,
    .dpot_reset = NULL,
    .dpot_shutdown = &ad5242_dpot_shutdown,
    .dpot_set_operating_mode = NULL,
    .dpot_input_reg_read = NULL,
    .dpot_input_reg_write = NULL,
    .dpot_sw_lrdac_update = NULL,
    .dpot_chn_read = &ad5242_dpot_chn_read,
    .dpot_chn_write = &ad5242_dpot_chn_write,
    .dpot_nvm_read = NULL,
    .dpot_nvm_write = NULL,
    .dpot_copy_rdac_to_nvm = NULL,
    .dpot_copy_nvm_to_rdac = NULL,
    .dpot_rdac_linear_update = NULL,
    .dpot_rdac_6db_update = NULL,
    
    .dpot_remove = &ad5242_dpot_remove,
    .dpot_enable_top_bottom_scale = NULL,
    .dpot_tolerance_read = NULL,
    .dpot_set_mid_scale = &ad5242_dpot_set_mid_scale
}