Header file of ADGS1408 Driver. More...

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

Include dependency graph for adgs1408.h:

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

Classes
struct	adgs1408_rrobin_config

struct	adgs1408_dev

struct	adgs1408_init_param

Macros
#define	ADGS1408_REG_SW_DATA 0x01

#define	ADGS1408_REG_ERR_CONFIG 0x02

#define	ADGS1408_REG_ERR_FLAGS 0x03

#define	ADGS1408_REG_BURST_EN 0x05

#define	ADGS1408_REG_ROUND_ROBIN_EN 0x06

#define	ADGS1408_REG_RROBIN_CHANNEL_CONFIG 0x07

#define	ADGS1408_REG_CNV_EDGE_SEL 0x09

#define	ADGS1408_REG_SOFT_RESETB 0x0B

#define	ADGS1408_SW1_EN 0x01

#define	ADGS1408_SW2_EN 0x03

#define	ADGS1408_SW3_EN 0x05

#define	ADGS1408_SW4_EN 0x07

#define	ADGS1408_SW5_EN 0x09

#define	ADGS1408_SW6_EN 0x0B

#define	ADGS1408_SW7_EN 0x0D

#define	ADGS1408_SW8_EN 0x0F

#define	ADGS1409_SW1_EN 0x01

#define	ADGS1409_SW2_EN 0x03

#define	ADGS1409_SW3_EN 0x05

#define	ADGS1409_SW4_EN 0x07

#define	ADGS1408_RW_ERR_EN (1 << 2)

#define	ADGS1408_SCLK_ERR_EN (1 << 1)

#define	ADGS1408_CRC_ERR_EN (1 << 0)

#define	ADGS1408_RW_ERR_FLAG (1 << 2)

#define	ADGS1408_SCLK_ERR_FLAG (1 << 1)

#define	ADGS1408_CRC_ERR_FLAG (1 << 0)

#define	ADGS1408_CLR_1 0x6C

#define	ADGS1408_CLR_2 0xA9

#define	ADGS1408_BURST_MODE_EN (1 << 0)

#define	ADGS1408_ROUND_ROBIN_EN (1 << 0)

#define	ADGS1408_RROBIN_SW1(x) (((x) & 0x1) << 0)

#define	ADGS1408_RROBIN_SW2(x) (((x) & 0x1) << 1)

#define	ADGS1408_RROBIN_SW3(x) (((x) & 0x1) << 2)

#define	ADGS1408_RROBIN_SW4(x) (((x) & 0x1) << 3)

#define	ADGS1408_RROBIN_SW5(x) (((x) & 0x1) << 4)

#define	ADGS1408_RROBIN_SW6(x) (((x) & 0x1) << 5)

#define	ADGS1408_RROBIN_SW7(x) (((x) & 0x1) << 6)

#define	ADGS1408_RROBIN_SW8(x) (((x) & 0x1) << 7)

#define	ADGS1408_RROBIN_SW1(x) (((x) & 0x1) << 0)

#define	ADGS1408_RROBIN_SW2(x) (((x) & 0x1) << 1)

#define	ADGS1408_RROBIN_SW3(x) (((x) & 0x1) << 2)

#define	ADGS1408_RROBIN_SW4(x) (((x) & 0x1) << 3)

#define	ADGS1408_CNV_EDGE_RISING (1 << 0)

#define	ADGS1408_SOFT_RESETB(x) (((x) & 0xFF) << 0)

#define	ADGS1408_RESET_1 0xA3

#define	ADGS1408_RESET_2 0x05

#define	ADGS1408_DAISY_CHAIN_1 0x25

#define	ADGS1408_DAISY_CHAIN_2 0x00

#define	ADGS1408_RROBIN_EXIT_1 0xA3

#define	ADGS1408_RROBIN_EXIT_2 0x18

#define	ADGS1408_RROBIN_EXIT_3 0xE3

#define	ADGS1408_RROBIN_EXIT_4 0xB4

#define	ADGS1408_ALIGNMENT 0x25

#define	ADGS1408_CRC8_POLY 0x07

Enumerations
enum	adgs1408_type { ID_ADGS1408, ID_ADGS1409 }

enum	adgs1408_state { ADGS1408_ENABLE, ADGS1408_DISABLE }

Functions
uint8_t	adgs1408_compute_crc8 (uint8_t *data, uint8_t data_size)

int32_t	adgs1408_spi_reg_read (struct adgs1408_dev dev, uint8_t reg_addr, uint8_t reg_data)

int32_t	adgs1408_spi_reg_write (struct adgs1408_dev *dev, uint8_t reg_addr, uint8_t reg_data)

int32_t	adgs1408_spi_reg_read_mask (struct adgs1408_dev dev, uint8_t reg_addr, uint8_t mask, uint8_t data)

int32_t	adgs1408_spi_reg_write_mask (struct adgs1408_dev *dev, uint8_t reg_addr, uint8_t mask, uint8_t data)

int32_t	adgs1408_do_soft_reset (struct adgs1408_dev *dev)

int32_t	adgs1408_clear_err_flags (struct adgs1408_dev *dev)

int32_t	adgs1408_enter_daisy_chain (struct adgs1408_dev *dev)

int32_t	adgs1408_send_daisy_chain_cmds (struct adgs1408_dev dev, uint8_t cmds, uint8_t cmds_size)

int32_t	adgs1408_enter_round_robin (struct adgs1408_dev *dev)

int32_t	adgs1408_configure_round_robin (struct adgs1408_dev *dev, uint8_t cnv_polarity)

int32_t	adgs1408_exit_round_robin (struct adgs1408_dev *dev)

int32_t	adgs1408_init (struct adgs1408_dev **device, struct adgs1408_init_param init_param)

int32_t	adgs1408_remove (struct adgs1408_dev *dev)
	Free the resources allocated by adgs1408_init(). More...

Detailed Description

Header file of ADGS1408 Driver.

Author: Mircea Caprioru (mirce.nosp@m.a.ca.nosp@m.prior.nosp@m.u@an.nosp@m.alog..nosp@m.com)

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.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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.

Macro Definition Documentation

◆ ADGS1408_ALIGNMENT

#define ADGS1408_ALIGNMENT 0x25

◆ ADGS1408_BURST_MODE_EN

#define ADGS1408_BURST_MODE_EN (1 << 0)

◆ ADGS1408_CLR_1

#define ADGS1408_CLR_1 0x6C

◆ ADGS1408_CLR_2

#define ADGS1408_CLR_2 0xA9

◆ ADGS1408_CNV_EDGE_RISING

#define ADGS1408_CNV_EDGE_RISING (1 << 0)

◆ ADGS1408_CRC8_POLY

#define ADGS1408_CRC8_POLY 0x07

◆ ADGS1408_CRC_ERR_EN

#define ADGS1408_CRC_ERR_EN (1 << 0)

◆ ADGS1408_CRC_ERR_FLAG

#define ADGS1408_CRC_ERR_FLAG (1 << 0)

◆ ADGS1408_DAISY_CHAIN_1

#define ADGS1408_DAISY_CHAIN_1 0x25

◆ ADGS1408_DAISY_CHAIN_2

#define ADGS1408_DAISY_CHAIN_2 0x00

◆ ADGS1408_REG_BURST_EN

#define ADGS1408_REG_BURST_EN 0x05

◆ ADGS1408_REG_CNV_EDGE_SEL

#define ADGS1408_REG_CNV_EDGE_SEL 0x09

◆ ADGS1408_REG_ERR_CONFIG

#define ADGS1408_REG_ERR_CONFIG 0x02

◆ ADGS1408_REG_ERR_FLAGS

#define ADGS1408_REG_ERR_FLAGS 0x03

◆ ADGS1408_REG_ROUND_ROBIN_EN

#define ADGS1408_REG_ROUND_ROBIN_EN 0x06

◆ ADGS1408_REG_RROBIN_CHANNEL_CONFIG

#define ADGS1408_REG_RROBIN_CHANNEL_CONFIG 0x07

◆ ADGS1408_REG_SOFT_RESETB

#define ADGS1408_REG_SOFT_RESETB 0x0B

◆ ADGS1408_REG_SW_DATA

#define ADGS1408_REG_SW_DATA 0x01

◆ ADGS1408_RESET_1

#define ADGS1408_RESET_1 0xA3

◆ ADGS1408_RESET_2

#define ADGS1408_RESET_2 0x05

◆ ADGS1408_ROUND_ROBIN_EN

#define ADGS1408_ROUND_ROBIN_EN (1 << 0)

◆ ADGS1408_RROBIN_EXIT_1

#define ADGS1408_RROBIN_EXIT_1 0xA3

◆ ADGS1408_RROBIN_EXIT_2

#define ADGS1408_RROBIN_EXIT_2 0x18

◆ ADGS1408_RROBIN_EXIT_3

#define ADGS1408_RROBIN_EXIT_3 0xE3

◆ ADGS1408_RROBIN_EXIT_4

#define ADGS1408_RROBIN_EXIT_4 0xB4

◆ ADGS1408_RROBIN_SW1 [1/2]

#define ADGS1408_RROBIN_SW1 ( x ) (((x) & 0x1) << 0)

◆ ADGS1408_RROBIN_SW1 [2/2]

#define ADGS1408_RROBIN_SW1 ( x ) (((x) & 0x1) << 0)

◆ ADGS1408_RROBIN_SW2 [1/2]

#define ADGS1408_RROBIN_SW2 ( x ) (((x) & 0x1) << 1)

◆ ADGS1408_RROBIN_SW2 [2/2]

#define ADGS1408_RROBIN_SW2 ( x ) (((x) & 0x1) << 1)

◆ ADGS1408_RROBIN_SW3 [1/2]

#define ADGS1408_RROBIN_SW3 ( x ) (((x) & 0x1) << 2)

◆ ADGS1408_RROBIN_SW3 [2/2]

#define ADGS1408_RROBIN_SW3 ( x ) (((x) & 0x1) << 2)

◆ ADGS1408_RROBIN_SW4 [1/2]

#define ADGS1408_RROBIN_SW4 ( x ) (((x) & 0x1) << 3)

◆ ADGS1408_RROBIN_SW4 [2/2]

#define ADGS1408_RROBIN_SW4 ( x ) (((x) & 0x1) << 3)

◆ ADGS1408_RROBIN_SW5

#define ADGS1408_RROBIN_SW5 ( x ) (((x) & 0x1) << 4)

◆ ADGS1408_RROBIN_SW6

#define ADGS1408_RROBIN_SW6 ( x ) (((x) & 0x1) << 5)

◆ ADGS1408_RROBIN_SW7

#define ADGS1408_RROBIN_SW7 ( x ) (((x) & 0x1) << 6)

◆ ADGS1408_RROBIN_SW8

#define ADGS1408_RROBIN_SW8 ( x ) (((x) & 0x1) << 7)

◆ ADGS1408_RW_ERR_EN

#define ADGS1408_RW_ERR_EN (1 << 2)

◆ ADGS1408_RW_ERR_FLAG

#define ADGS1408_RW_ERR_FLAG (1 << 2)

◆ ADGS1408_SCLK_ERR_EN

#define ADGS1408_SCLK_ERR_EN (1 << 1)

◆ ADGS1408_SCLK_ERR_FLAG

#define ADGS1408_SCLK_ERR_FLAG (1 << 1)

◆ ADGS1408_SOFT_RESETB

#define ADGS1408_SOFT_RESETB ( x ) (((x) & 0xFF) << 0)

◆ ADGS1408_SW1_EN

#define ADGS1408_SW1_EN 0x01

◆ ADGS1408_SW2_EN

#define ADGS1408_SW2_EN 0x03

◆ ADGS1408_SW3_EN

#define ADGS1408_SW3_EN 0x05

◆ ADGS1408_SW4_EN

#define ADGS1408_SW4_EN 0x07

◆ ADGS1408_SW5_EN

#define ADGS1408_SW5_EN 0x09

◆ ADGS1408_SW6_EN

#define ADGS1408_SW6_EN 0x0B

◆ ADGS1408_SW7_EN

#define ADGS1408_SW7_EN 0x0D

◆ ADGS1408_SW8_EN

#define ADGS1408_SW8_EN 0x0F

◆ ADGS1409_SW1_EN

#define ADGS1409_SW1_EN 0x01

◆ ADGS1409_SW2_EN

#define ADGS1409_SW2_EN 0x03

◆ ADGS1409_SW3_EN

#define ADGS1409_SW3_EN 0x05

◆ ADGS1409_SW4_EN

#define ADGS1409_SW4_EN 0x07

Enumeration Type Documentation

◆ adgs1408_state

enum adgs1408_state

Enumerator
ADGS1408_ENABLE
ADGS1408_DISABLE

◆ adgs1408_type

enum adgs1408_type

Enumerator
ID_ADGS1408
ID_ADGS1409

Function Documentation

◆ adgs1408_clear_err_flags()

int32_t adgs1408_clear_err_flags ( struct adgs1408_dev * dev )

Clear the Error Flags Register.

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

◆ adgs1408_compute_crc8()

uint8_t adgs1408_compute_crc8	(	uint8_t *	data,
		uint8_t	data_size
	)

Compute CRC8 checksum.

Parameters

data	- The data buffer.
data_size	- The size of the data buffer.

Returns: CRC8 checksum.

Here is the caller graph for this function:

◆ adgs1408_configure_round_robin()

int32_t adgs1408_configure_round_robin	(	struct adgs1408_dev *	dev,
		uint8_t	cnv_polarity
	)

Configure Round Robin Mode.

Parameters

dev	- The device structure.
cnv_polarity	- The CNV pin polarity.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

◆ adgs1408_do_soft_reset()

int32_t adgs1408_do_soft_reset ( struct adgs1408_dev * dev )

Do a software reset.

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

◆ adgs1408_enter_daisy_chain()

int32_t adgs1408_enter_daisy_chain ( struct adgs1408_dev * dev )

Enter Daisy-Chain Mode.

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

◆ adgs1408_enter_round_robin()

int32_t adgs1408_enter_round_robin ( struct adgs1408_dev * dev )

Enter Round Robin Mode.

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

◆ adgs1408_exit_round_robin()

int32_t adgs1408_exit_round_robin ( struct adgs1408_dev * dev )

Exit Round Robin Mode.

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

◆ adgs1408_init()

int32_t adgs1408_init	(	struct adgs1408_dev **	device,
		struct adgs1408_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.

◆ adgs1408_remove()

int32_t adgs1408_remove ( struct adgs1408_dev * dev )

Free the resources allocated by adgs1408_init().

Parameters

dev	- The device structure.

Returns: 0 in case of success, negative error code otherwise.

◆ adgs1408_send_daisy_chain_cmds()

int32_t adgs1408_send_daisy_chain_cmds	(	struct adgs1408_dev *	dev,
		uint8_t *	cmds,
		uint8_t	cmds_size
	)

Send Daisy-Chain commands.

Parameters

dev	- The device structure.
cmds	- The commands to be sent.
cmds_size	- The number of commands.

Returns: 0 in case of success, negative error code otherwise.

◆ adgs1408_spi_reg_read()

int32_t adgs1408_spi_reg_read	(	struct adgs1408_dev *	dev,
		uint8_t	reg_addr,
		uint8_t *	reg_data
	)

SPI register read from device.

Parameters

dev	- The device structure.
reg_addr	- The register address.
reg_data	- The register data.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

◆ adgs1408_spi_reg_read_mask()

int32_t adgs1408_spi_reg_read_mask	(	struct adgs1408_dev *	dev,
		uint8_t	reg_addr,
		uint8_t	mask,
		uint8_t *	data
	)

◆ adgs1408_spi_reg_write()

int32_t adgs1408_spi_reg_write	(	struct adgs1408_dev *	dev,
		uint8_t	reg_addr,
		uint8_t	reg_data
	)

SPI register write to device.

Parameters

dev	- The device structure.
reg_addr	- The register address.
reg_data	- The register data.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

◆ adgs1408_spi_reg_write_mask()

int32_t adgs1408_spi_reg_write_mask	(	struct adgs1408_dev *	dev,
		uint8_t	reg_addr,
		uint8_t	mask,
		uint8_t	data
	)

SPI internal register write to device using a mask.

Parameters

dev	- The device structure.
reg_addr	- The register address.
mask	- The mask.
data	- The register data.

Returns: 0 in case of success, negative error code otherwise.

Here is the caller graph for this function:

Classes

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ ADGS1408_ALIGNMENT

◆ ADGS1408_BURST_MODE_EN

◆ ADGS1408_CLR_1

◆ ADGS1408_CLR_2

◆ ADGS1408_CNV_EDGE_RISING

◆ ADGS1408_CRC8_POLY

◆ ADGS1408_CRC_ERR_EN

◆ ADGS1408_CRC_ERR_FLAG

◆ ADGS1408_DAISY_CHAIN_1

◆ ADGS1408_DAISY_CHAIN_2

◆ ADGS1408_REG_BURST_EN

◆ ADGS1408_REG_CNV_EDGE_SEL

◆ ADGS1408_REG_ERR_CONFIG

◆ ADGS1408_REG_ERR_FLAGS

◆ ADGS1408_REG_ROUND_ROBIN_EN

◆ ADGS1408_REG_RROBIN_CHANNEL_CONFIG

◆ ADGS1408_REG_SOFT_RESETB

◆ ADGS1408_REG_SW_DATA

◆ ADGS1408_RESET_1

◆ ADGS1408_RESET_2

◆ ADGS1408_ROUND_ROBIN_EN

◆ ADGS1408_RROBIN_EXIT_1

◆ ADGS1408_RROBIN_EXIT_2

◆ ADGS1408_RROBIN_EXIT_3

◆ ADGS1408_RROBIN_EXIT_4

◆ ADGS1408_RROBIN_SW1 [1/2]

◆ ADGS1408_RROBIN_SW1 [2/2]

◆ ADGS1408_RROBIN_SW2 [1/2]

◆ ADGS1408_RROBIN_SW2 [2/2]

◆ ADGS1408_RROBIN_SW3 [1/2]

◆ ADGS1408_RROBIN_SW3 [2/2]

◆ ADGS1408_RROBIN_SW4 [1/2]

◆ ADGS1408_RROBIN_SW4 [2/2]

◆ ADGS1408_RROBIN_SW5

◆ ADGS1408_RROBIN_SW6

◆ ADGS1408_RROBIN_SW7

◆ ADGS1408_RROBIN_SW8

◆ ADGS1408_RW_ERR_EN

◆ ADGS1408_RW_ERR_FLAG

◆ ADGS1408_SCLK_ERR_EN

◆ ADGS1408_SCLK_ERR_FLAG

◆ ADGS1408_SOFT_RESETB

◆ ADGS1408_SW1_EN

◆ ADGS1408_SW2_EN

◆ ADGS1408_SW3_EN

◆ ADGS1408_SW4_EN

◆ ADGS1408_SW5_EN

◆ ADGS1408_SW6_EN

◆ ADGS1408_SW7_EN

◆ ADGS1408_SW8_EN

◆ ADGS1409_SW1_EN

◆ ADGS1409_SW2_EN

◆ ADGS1409_SW3_EN

◆ ADGS1409_SW4_EN

Enumeration Type Documentation

◆ adgs1408_state

◆ adgs1408_type

Function Documentation

◆ adgs1408_clear_err_flags()

◆ adgs1408_compute_crc8()

◆ adgs1408_configure_round_robin()

◆ adgs1408_do_soft_reset()

◆ adgs1408_enter_daisy_chain()

◆ adgs1408_enter_round_robin()

◆ adgs1408_exit_round_robin()

◆ adgs1408_init()

◆ adgs1408_remove()

◆ adgs1408_send_daisy_chain_cmds()

◆ adgs1408_spi_reg_read()

◆ adgs1408_spi_reg_read_mask()

◆ adgs1408_spi_reg_write()

◆ adgs1408_spi_reg_write_mask()