ad5242.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 dependency graph for ad5242.h:

Classes
struct	ad5242_dpot_init_param
struct	ad5242_dpot_dev

Macros
#define	AD5242_READ_ENABLE   0x01
#define	AD5242_SHUT_DOWN_ENABLE   0x20
#define	AD5242_SHUT_DOWN_DISABLE   0x00
#define	AD5242_CTL_FOR_MID_SCALE_POSITION   0x40

Functions
int	ad5242_dpot_init (struct dpot_init_param *init_params, 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_read (struct dpot_dev *desc, enum dpot_chn_type chn, uint8_t *data)
	Read the ad5242 digital potentiometer channel.
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_send_cmd (struct dpot_dev *desc, struct dpot_command *cmd)
int	ad5242_dpot_shutdown (struct dpot_dev *desc, enum dpot_chn_type chn, bool shutdown_enable)
	Shutdown the AD5144 digital potentiometer channel.

Macro Definition Documentation

AD5242_CTL_FOR_MID_SCALE_POSITION

#define AD5242_CTL_FOR_MID_SCALE_POSITION   0x40

AD5242_READ_ENABLE

#define AD5242_READ_ENABLE   0x01

 @file   ad5242.h
 @brief  Header file for the ad5242 digital potentiometer drivers

Copyright 2025(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

AD5242_SHUT_DOWN_DISABLE

#define AD5242_SHUT_DOWN_DISABLE   0x00

AD5242_SHUT_DOWN_ENABLE

#define AD5242_SHUT_DOWN_ENABLE   0x20

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()

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

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.