File content as of revision 0:3afcd581558d:

/***************************************************************************//**
 *   @file   ad713x.h
 *   @brief  Header file for the ad713x Driver.
 *   @author SPopa (stefan.popa@analog.com)
 *   @author Andrei Drimbarean (andrei.drimbarean@analog.com)
********************************************************************************
 * Copyright 2020(c) Analog Devices, Inc.
 *
 * All rights reserved.
 *
 * 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.
 *  - The use of this software may or may not infringe the patent rights
 *    of one or more patent holders.  This license does not release you
 *    from the requirement that you obtain separate licenses from these
 *    patent holders to use this software.
 *  - Use of the software either in source or binary form, must be run
 *    on or directly connected to an Analog Devices Inc. component.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.
*******************************************************************************/

#ifndef SRC_AD713X_H_
#define SRC_AD713X_H_

/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/

#include <stdbool.h>
#include <stdio.h>

#include "platform_drivers.h"

/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
/*
 * AD713X registers definition
 */
#define AD713X_REG_INTERFACE_CONFIG_A		0x00
#define AD713X_REG_INTERFACE_CONFIG_B		0x01
#define AD713X_REG_DEVICE_CONFIG		0x02
#define AD713X_REG_CHIP_TYPE			0x03
#define AD713X_REG_PRODUCT_ID_LSB		0x04
#define AD713X_REG_PRODUCT_ID_MSB		0x05
#define AD713X_REG_CHIP_GRADE			0x06
#define AD713X_REG_CHIP_INDEX			0x07
#define AD713X_REG_SCTATCH_PAD			0x0A
#define AD713X_REG_SPI_REVISION			0x0B
#define AD713X_REG_VENDOR_ID_LSB		0x0C
#define AD713X_REG_VENDOR_ID_MSB		0x0D
#define AD713X_REG_STREAM_MODE			0x0E
#define AD713X_REG_TRANSFER_REGISTER		0x0F
#define AD713X_REG_DEVICE_CONFIG1		0x10
#define AD713X_REG_DATA_PACKET_CONFIG		0x11
#define AD713X_REG_DIGITAL_INTERFACE_CONFIG	0x12
#define AD713X_REG_POWER_DOWN_CONTROL		0x13
#define AD713X_REG_AIN_RANGE_SELECT		0x14
#define AD713X_REG_DEVICE_STATUS		0x15
#define AD713X_REG_ODR_VAL_INT_LSB		0x16
#define AD713X_REG_ODR_VAL_INT_MID		0x17
#define AD713X_REG_ODR_VAL_INT_MSB		0x18
#define AD713X_REG_ODR_VAL_FLT_LSB		0x19
#define AD713X_REG_ODR_VAL_FLT_MID0		0x1A
#define AD713X_REG_ODR_VAL_FLT_MID1		0x1B
#define AD713X_REG_ODR_VAL_FLT_MSB		0x1C
#define AD713X_REG_CHANNEL_ODR_SELECT		0x1D
#define AD713X_REG_CHAN_DIG_FILTER_SEL		0x1E
#define AD713X_REG_FIR_BW_SEL			0x1F
#define AD713X_REG_GPIO_DIR_CTRL		0x20
#define AD713X_REG_GPIO_DATA			0x21
#define AD713X_REG_ERROR_PIN_SRC_CONTROL	0x22
#define AD713X_REG_ERROR_PIN_CONTROL		0x23
#define AD713X_REG_VCMBUF_CTRL			0x24
#define AD713X_REG_DIAGNOSTIC_CONTROL		0x25
#define AD713X_REG_MPC_CONFIG			0x26
#define AD713X_REG_CH0_GAIN_LSB			0x27
#define AD713X_REG_CH0_GAIN_MID			0x28
#define AD713X_REG_CH0_GAIN_MSB			0x29
#define AD713X_REG_CH0_OFFSET_LSB		0x2A
#define AD713X_REG_CH0_OFFSET_MID		0x2B
#define AD713X_REG_CH0_OFFSET_MSB		0x2C
#define AD713X_REG_CH1_GAIN_LSB			0x2D
#define AD713X_REG_CH1_GAIN_MID			0x2E
#define AD713X_REG_CH1_GAIN_MSB			0x2F
#define AD713X_REG_CH1_OFFSET_LSB		0x30
#define AD713X_REG_CH1_OFFSET_MID		0x31
#define AD713X_REG_CH1_OFFSET_MSB		0x32
#define AD713X_REG_CH2_GAIN_LSB			0x33
#define AD713X_REG_CH2_GAIN_MID			0x34
#define AD713X_REG_CH2_GAIN_MSB			0x35
#define AD713X_REG_CH2_OFFSET_LSB		0x36
#define AD713X_REG_CH2_OFFSET_MID		0x37
#define AD713X_REG_CH2_OFFSET_MSB		0x38
#define AD713X_REG_CH3_GAIN_LSB			0x39
#define AD713X_REG_CH3_GAIN_MID			0x3A
#define AD713X_REG_CH3_GAIN_MSB			0x3B
#define AD713X_REG_CH3_OFFSET_LSB		0x3C
#define AD713X_REG_CH3_OFFSET_MID		0x3D
#define AD713X_REG_CH3_OFFSET_MSB		0x3E
#define AD713X_REG_MCLK_COUNTER			0x3F
#define AD713X_REG_DIG_FILTER_OFUF		0x40
#define AD713X_REG_DIG_FILTER_SETTLED		0x41
#define AD713X_REG_INTERNAL_ERROR		0x42
#define AD713X_REG_POWER_OV_ERROR_1		0x43
#define AD713X_REG_POWER_UV_ERROR_1		0x44
#define AD713X_REG_POWER_OV_ERROR_2		0x45
#define AD713X_REG_POWER_UV_ERROR_2		0x46
#define AD713X_REG_SPI_ERROR			0x47
#define AD713X_REG_AIN_OR_ERROR			0x48
#define AD713X_REG_AVDD5_VALUE			0x49
#define AD713X_REG_DVDD5_VALUE			0x4A
#define AD713X_REG_VREF_VALUE			0x4B
#define AD713X_REG_LDOIN_VALUE			0x4C
#define AD713X_REG_AVDD1V8_VALUE		0x4D
#define AD713X_REG_DVDD1V8_VALUE		0x4E
#define AD713X_REG_CLKVDD_VALUE			0x4F
#define AD713X_REG_IOVDD_VALUE			0x50
#define AD713X_REG_TEMPERATURE_DATA		0x51

/*
 * AD713X_REG_INTERFACE_CONFIG_A
 */
#define AD713X_INT_CONFIG_A_SOFT_RESET_MSK		BIT(7)
#define AD713X_INT_CONFIG_A_ADDR_ASC_BIT_MSK		BIT(5)
#define AD713X_INT_CONFIG_A_SDO_ACTIVE_BIT_MSK		BIT(4)
#define AD713X_INT_CONFIG_A_SOFT_RESET_MIRR_MSK		BIT(0)
#define AD713X_INT_CONFIG_A_ADDR_ASC_MIRR_MSK		BIT(2)
#define AD713X_INT_CONFIG_A_SDO_ACTIVE_MIRR_MSK		BIT(3)

/*
 * AD713X_REG_INTERFACE_CONFIG_B
 */
#define AD713X_INT_CONFIG_B_SINGLE_INSTR_MSK		BIT(7)
#define AD713X_INT_CONFIG_B_M_S_RD_CTRL_MSK		BIT(5)
#define AD713X_INT_CONFIG_B_DIG_IF_RST_MSK		BIT(1)

/*
 * AD713X_REG_DEVICE_CONFIG
 */
#define AD713X_DEV_CONFIG_OP_IN_PROGRESS_MSK		BIT(5)
#define AD713X_DEV_CONFIG_NO_CHIP_ERR_MSK		BIT(4)
#define AD713X_DEV_CONFIG_PWR_MODE_MSK			BIT(0)

/*
 * AD713X_REG_CHIP_TYPE
 */
#define AD713X_CHIP_TYPE_BITS_MSK			GENMASK(7, 0)
#define AD713X_CHIP_TYPE_BITS_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_PRODUCT_ID_LSB
 */
#define AD713X_PRODUCT_ID_LSB_BITS_MSK			GENMASK(7, 0)
#define AD713X_PRODUCT_ID_LSB_BITS_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_PRODUCT_ID_MSB
 */
#define AD713X_PRODUCT_ID_MSB_BITS_MSK			GENMASK(7, 0)
#define AD713X_PRODUCT_ID_MSB_BITS_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CHIP_GRADE
 */
#define AD713X_CHIP_GRADE_PROD_GRADE_BITS_MSK		GENMASK(7, 4)
#define AD713X_CHIP_GRADE_PROD_GRADE_BITS_MODE(x) 	(((x) & 0x0F) << 4)
#define AD713X_CHIP_GRADE_DEV_VERSION_BITS_MSK		GENMASK(3, 0)
#define AD713X_CHIP_GRADE_DEV_VERSION_BITS_MODE(x) 	(((x) & 0x0F) << 0)

/*
 * AD713X_REG_CHIP_INDEX
 */
#define AD713X_SILICON_REV_ID_BITS_MSK			GENMASK(7, 0)
#define AD713X_SILICON_REV_ID_BITS_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_SCRATCH_PAD
 */
#define AD713X_SCRATCH_PAD_BITS_MSK			GENMASK(7, 0)
#define AD713X_SCRATCH_PAD_BITS_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_SPI_REVISION
 */
#define AD713X_SPI_REVISION_BITS_MSK			GENMASK(7, 0)
#define AD713X_SPI_REVISION_BITS_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_VENDOR_ID_LSB
 */
#define AD713X_VENDOR_ID_LSB_BITS_MSK			GENMASK(7, 0)
#define AD713X_VENDOR_ID_LSB_BITS_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_VENDOR_ID_MSB
 */
#define AD713X_VENDOR_ID_MSB_BITS_MSK			GENMASK(7, 0)
#define AD713X_VENDOR_ID_MSB_BITS_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_STREAM_MODE
 */
#define AD713X_STREAM_MODE_BITS_MSK			GENMASK(7, 0)
#define AD713X_STREAM_MODE_BITS_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_TRANSFER_REGISTER
 */
#define AD713X_TRANSFER_MASTER_SLAVE_TX_BIT_MSK		BIT(0)

/*
 * AD713X_REG_DEVICE_CONFIG1
 */
#define AD713X_DEV_CONFIG1_MPC_MAGPHA_EN_MSK		BIT(6)
#define AD713X_DEV_CONFIG1_MPC_MAG_EN_MSK		BIT(5)
#define AD713X_DEV_CONFIG1_AA_MODE_MSK			BIT(4)
#define AD713X_DEV_CONFIG1_SDO_PIN_SRC_SEL_MSK		BIT(2)
#define AD713X_DEV_CONFIG1_REF_GAIN_CORR_EN_MSK		BIT(1)
#define AD713X_DEV_CONFIG1_CLKOUT_EN_MSK		BIT(0)

/*
 * AD713X_REG_DATA_PACKET_CONFIG
 */
#define AD713X_DATA_PACKET_CONFIG_CRC_POLY_RST_MSK	BIT(7)
#define AD713X_DATA_PACKET_CONFIG_FRAME_MSK		GENMASK(6, 4)
#define AD713X_DATA_PACKET_CONFIG_FRAME_MODE(x)		(((x) & 0x7) << 4)
#define AD713X_DATA_PACKET_CONFIG_DCLK_FREQ_MSK		GENMASK(3, 0)
#define AD713X_DATA_PACKET_CONFIG_DCLK_FREQ_MODE(x)	(((x) & 0xF) << 0)

/*
 * AD713X_REG_DIGITAL_INTERFACE_CONFIG
 */
#define AD713X_DIG_INT_CONFIG_DAISY_CHAIN_NUM_MSK	GENMASK(7, 4)
#define AD713X_DIG_INT_CONFIG_DAISY_CHAIN_NUM_MODE(x)	(((x) & 0xF) << 4)
#define AD713X_DIG_INT_CONFIG_AVG_SEL_MSK		GENMASK(3, 2)
#define AD713X_DIG_INT_CONFIG_AVG_SEL_MODE(x)		(((x) & 0x3) << 2)
#define AD713X_DIG_INT_CONFIG_FORMAT_MSK		GENMASK(1, 0)
#define AD713X_DIG_INT_CONFIG_FORMAT_MODE(x)		(((x) & 0x3) << 0)

/*
 * AD713X_REG_POWER_DOWN_CONTROL
 */
#define AD713X_PWRDN_CTRL_PWRDN_CH_MSK(ch)		BIT(ch)
#define AD713X_PWRDN_CTRL_PWRDN_AUXADC_MSK		BIT(2)
#define AD713X_PWRDN_CTRL_PWRDN_LDO_MSK			BIT(1)
#define AD713X_PWRDN_CTRL_PWRDN_SLEEP_MODE_EN_MSK	BIT(0)

/*
 * AD713X_REG_AIN_RANGE_SELECT
 */
#define AD713X_AIN_RANGE_SEL_CH_MSK(ch)			BIT(ch)

/*
 * AD713X_REG_DEVICE_STATUS
 */
#define AD713X_DEV_STAT_DCLKMODE_MSK			BIT(5)
#define AD713X_DEV_STAT_DCLKIO_MSK			BIT(4)
#define AD713X_DEV_STAT_MODE_MSK			BIT(3)
#define AD713X_DEV_STAT_CLKSEL_MSK			BIT(2)
#define AD713X_DEV_STAT_FUSE_ECC_MSK			BIT(1)
#define AD713X_DEV_STAT_PLL_LOCK_MSK			BIT(0)

/*
 * AD713X_REG_ODR_VAL_INT_LSB
 */
#define AD713X_ODR_VAL_INT_LSB_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_INT_LSB_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ODR_VAL_INT_MID
 */
#define AD713X_ODR_VAL_INT_MID_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_INT_MID_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ODR_VAL_INT_MSB
 */
#define AD713X_ODR_VAL_INT_MSB_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_INT_MSB_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ODR_VAL_FLT_LSB
 */
#define AD713X_ODR_VAL_FLT_LSB_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_FLT_LSB_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ODR_VAL_FLT_MID0
 */
#define AD713X_ODR_VAL_FLT_MID0_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_FLT_MID0_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ODR_VAL_FLT_MID1
 */
#define AD713X_ODR_VAL_FLT_MID1_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_FLT_MID1_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ODR_VAL_FLT_MSB
 */
#define AD713X_ODR_VAL_FLT_MSB_MSK			GENMASK(7, 0)
#define AD713X_ODR_VAL_FLT_MSB_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CHANNEL_ODR_SELECT
 */
#define AD713X_ODR_RATE_SEL_CH_MSK(ch)			(GENMASK(1, 0) << (2 * ch))
#define AD713X_ODR_RATE_SEL_CH_MODE(x, ch)		(((x) & 0x3) << (2 * ch))

/*
 * AD713X_REG_CHAN_DIG_FILTER_SEL
 */
#define AD713X_DIGFILTER_SEL_CH_MSK(ch)			(GENMASK(1, 0) << (2 * ch))
#define AD713X_DIGFILTER_SEL_CH_MODE(x, ch)		(((x) & 0x3) << (2 * ch))

/*
 * AD713X_REG_FIR_BW_SEL
 */
#define AD713X_FIR_BW_SEL_CH_MSK(ch)			BIT(ch)

/*
 * AD713X_REG_GPIO_DIR_CTRL
 */
#define AD713X_GPIO_IO_CTRL_MSK				GENMASK(7, 0)
#define AD713X_GPIO_IO_CTRL_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_GPIO_DATA
 */
#define AD713X_GPIO_DATA_MSK				GENMASK(7, 0)
#define AD713X_GPIO_DATA_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_ERROR_PIN_SRC_CONTROL
 */
#define AD713X_ERR_PIN_EN_OR_AIN_MSK			BIT(5)
#define AD713X_ERR_PIN_EN_INTERNAL_MSK			BIT(4)
#define AD713X_ERR_PIN_EN_SPI_MSK			BIT(3)
#define AD713X_ERR_PIN_EN_LDO_XOSC_MSK			BIT(2)
#define AD713X_ERR_PIN_EN_TEMP_MSK			BIT(1)
#define AD713X_ERR_PIN_EN_PWR_MSK			BIT(0)

/*
 * AD713X_REG_ERROR_PIN_CONTROL
 */
#define AD713X_ERR_PIN_IN_STATUS_MSK			BIT(2)
#define AD713X_ERR_PIN_IN_EN_MSK			BIT(1)
#define AD713X_ERR_PIN_OUT_EN_MSK			BIT(0)

/*
 * AD713X_REG_VCMBUF_CTRL
 */
#define AD713X_VCMBUF_CTRL_PWRDN_MSK			BIT(6)
#define AD713X_VCMBUF_CTRL_REF_DIV_SEL_MSK		GENMASK(5, 1)
#define AD713X_VCMBUF_CTRL_REF_DIV_SEL_MODE(x)		(((x) & 0x1F) << 1)
#define AD713X_VCMBUF_CTRL_REF_SEL_MSK			BIT(0)

/*
 * AD713X_REG_DIAGNOSTIC_CONTROL
 */
#define AD713X_DIAGCTRL_ERR_OR_AIN_EN_MSK		BIT(5)
#define AD713X_DIAGCTRL_ERR_PWR_MON_EN_MSK		BIT(4)
#define AD713X_DIAGCTRL_MCLK_CNT_EN_MSK			BIT(3)
#define AD713X_DIAGCTRL_ERR_SPI_CRC_EN_MSK		BIT(2)
#define AD713X_DIAGCTRL_ERR_MM_CRC_EN_MSK		BIT(1)
#define AD713X_DIAGCTRL_FUSE_CRC_CHECK_MSK		BIT(0)

/*
 * AD713X_REG_MPC_CONFIG
 */
#define AD713X_MPC_CLKDEL_EN_CH_MSK(ch)			(GENMASK(1, 0) << (2 * ch))
#define AD713X_MPC_CLKDEL_EN_CH_MODE(x, ch)		(((x) & 0x3) << (2 * ch))

/*
 * AD713X_REG_CHx_GAIN_LSB
 */
#define AD713X_CH_GAIN_LSB_MSK				GENMASK(7, 0)
#define AD713X_CH_GAIN_LSB_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CHx_GAIN_MID
 */
#define AD713X_CH_GAIN_MID_MSK				GENMASK(7, 0)
#define AD713X_CH_GAIN_MID_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CHx_GAIN_MSB
 */
#define AD713X_CH_GAIN_CAL_SEL_MSK			BIT(4)
#define AD713X_CH_GAIN_MSB_MSK				GENMASK(3, 0)
#define AD713X_CH_GAIN_MSB_MODE(x)			(((x) & 0xF) << 0)

/*
 * AD713X_REG_CHx_OFFSET_LSB
 */
#define AD713X_CH_OFFSET_LSB_MSK			GENMASK(7, 0)
#define AD713X_CH_OFFSET_LSB_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CHx_OFFSET_MID
 */
#define AD713X_CH_OFFSET_MID_MSK			GENMASK(7, 0)
#define AD713X_CH_OFFSET_MID_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CHx_OFFSET_MSB
 */
#define AD713X_CH_OFFSET_CAL_EN_MSK			BIT(7)
#define AD713X_CH_OFFSET_MSB_MSK			GENMASK(6, 0)
#define AD713X_CH_OFFSET_MSB_MODE(x)			(((x) & 0x7F) << 0)

/*
 * AD713X_REG_MCLK_COUNTER
 */
#define AD713X_MCLK_COUNT_MSK				GENMASK(7, 0)
#define AD713X_MCLK_COUNT_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_DIG_FILTER_OFUF
 */
#define AD713X_DIGFILTER_ERR_OFUF_CH_MSK(ch)		BIT(ch)

/*
 * AD713X_REG_DIG_FILTER_SETTLED
 */
#define AD713X_DIGFILTER_CH_SETTLED_MSK(ch)		BIT(ch)

/*
 * AD713X_REG_INTERNAL_ERROR
 */
#define AD713X_INT_ERR_NO_CLOCK_MSK			BIT(5)
#define AD713X_INT_ERR_TEMP_MSK				BIT(4)
#define AD713X_INT_ERR_DCLK_MSK				BIT(3)
#define AD713X_INT_ERR_FUSE_CRC_MSK			BIT(2)
#define AD713X_INT_ERR_ASRC_MSK				BIT(1)
#define AD713X_INT_ERR_MM_CRC_MSK			BIT(0)

/*
 * AD713X_REG_POWER_OV_ERROR_1
 */
#define AD713X_POWER_ERR_OV_IOVDD_MSK			BIT(3)
#define AD713X_POWER_ERR_OV_CLKVDD_MSK			BIT(2)
#define AD713X_POWER_ERR_OV_DVDD1V8_MSK			BIT(1)
#define AD713X_POWER_ERR_OV_AVDD1V8_MSK			BIT(0)

/*
 * AD713X_REG_POWER_UV_ERROR_1
 */
#define AD713X_POWER_ERR_UV_IOVDD_MSK			BIT(3)
#define AD713X_POWER_ERR_UV_CLKVDD_MSK			BIT(2)
#define AD713X_POWER_ERR_UV_DVDD1V8_MSK			BIT(1)
#define AD713X_POWER_ERR_UV_AVDD1V8_MSK			BIT(0)

/*
 * AD713X_REG_POWER_OV_ERROR_2
 */
#define AD713X_POWER_ERR_OV_VREF_MSK			BIT(3)
#define AD713X_POWER_ERR_OV_LDOIN_MSK			BIT(2)
#define AD713X_POWER_ERR_OV_DVDD5_MSK			BIT(1)
#define AD713X_POWER_ERR_OV_AVDD5_MSK			BIT(0)

/*
 * AD713X_REG_POWER_UV_ERROR_2
 */
#define AD713X_POWER_ERR_UV_VREF_MSK			BIT(3)
#define AD713X_POWER_ERR_UV_LDOIN_MSK			BIT(2)
#define AD713X_POWER_ERR_UV_DVDD5_MSK			BIT(1)
#define AD713X_POWER_ERR_UV_AVDD5_MSK			BIT(0)

/*
 * AD713X_REG_SPI_ERROR
 */
#define AD713X_SPI_ERROR_CRC_MSK			BIT(3)
#define AD713X_SPI_ERROR_SCLK_CNT_MSK			BIT(2)
#define AD713X_SPI_ERROR_WRITE_MSK			BIT(1)
#define AD713X_SPI_ERROR_READ_MSK			BIT(0)

/*
 * AD713X_REG_AIN_OR_ERROR
 */
#define AD713X_ERR_OR_AIN_MSK(ch)			BIT(ch)

/*
 * AD713X_REG_AVDD5_VALUE
 */
#define AD713X_AVDD5_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_AVDD5_VALUE_PIN_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_DVDD5_VALUE
 */
#define AD713X_DVDD5_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_DVDD5_VALUE_PIN_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_VREF_VALUE
 */
#define AD713X_VREF_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_VREF_VALUE_PIN_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_LDOIN_VALUE
 */
#define AD713X_LDOIN_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_LDOIN_VALUE_PIN_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_AVDD1V8_VALUE
 */
#define AD713X_AVDD1V8_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_AVDD1V8_VALUE_PIN_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_DVDD1V8_VALUE
 */
#define AD713X_DVDD1V8_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_DVDD1V8_VALUE_PIN_MODE(x)		(((x) & 0xFF) << 0)

/*
 * AD713X_REG_CLKVDD_VALUE
 */
#define AD713X_CLKVDD_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_CLKVDD_VALUE_PIN_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_IOVDD_VALUE
 */
#define AD713X_IOVDD_VALUE_PIN_MSK			GENMASK(7, 0)
#define AD713X_IOVDD_VALUE_PIN_MODE(x)			(((x) & 0xFF) << 0)

/*
 * AD713X_REG_TEMPERATURE_DATA
 */
#define AD713X_TEMP_DATA_MSK				GENMASK(7, 0)
#define AD713X_TEMP_DATA_MODE(x)			(((x) & 0xFF) << 0)

#define AD713X_REG_READ(x)				((1 << 7) | (x & 0x7F))

/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/

/**
 * @enum ad713x_supported_dev_ids
 * @brief ID of devices supported by the driver
 */
enum ad713x_supported_dev_ids {
	ID_AD7132,
	ID_AD7134,
	ID_AD7136
};

/**
 * @enum ad713x_power_mode
 * @brief AD713x power modes
 */
enum ad713x_power_mode {
	/** Low power mode option */
	LOW_POWER,
	/** Full power mode option */
	HIGH_POWER
};

/**
 * @enum ad713x_adc_data_len
 * @brief AD713x possible number of bits per data sample
 */
enum ad713x_adc_data_len {
	/** 16 bit data sample */
	ADC_16_BIT_DATA,
	/** 24 bit data sample */
	ADC_24_BIT_DATA,
	/** 32 bit data sample */
	ADC_32_BIT_DATA,
	/** To know when to stop when cycling between them */
	INVALID
};

/**
 * @enum ad713x_crc_header
 * @brief AD713x possible data CRC header choices
 */
enum ad713x_crc_header {
	/** Data sample comes with no CRC attached */
	NO_CRC,
	/** Data sample comes with 6-bit CRC attached */
	CRC_6,
	/** Data sample comes with 8-bit CRC attached */
	CRC_8
};

/**
 * @enum ad713x_doutx_format
 * @brief AD713x list for possible output modes
 */
enum ad713x_doutx_format {
	/** Single channel Daisy-chain mode */
	SINGLE_CH_DC,
	/** Dual channel Daisy-chain mode */
	DUAL_CH_DC,
	/** Quad-channel parallel output mode */
	QUAD_CH_PO,
	/** Channel average mode */
	CH_AVG_MODE
};

/**
 * @enum ad713x_dig_filter_sel
 * @brief AD713x list of input filters.
 */
enum ad713x_dig_filter_sel {
	/** Wideband filter (Finite impulse response) */
	FIR,
	/** Sinc6 filter */
	SINC6,
	/** Sinc3 filter */
	SINC3,
	/** Sinc3 filter with 50Hz and 60Hz rejection */
	SINC3_50_60_REJ
};

/**
 * @enum ad713x_channels
 * @brief AD713x list of channels
 */
enum ad713x_channels {
	/** Channel 0 */
	CH0,
	/** Channel 1 */
	CH1,
	/** Channel 2 */
	CH2,
	/** Channel 3 */
	CH3
};

/**
 * @enum ad717x_mpc_clkdel
 * @brief AD713x list of clock delays
 */
enum ad717x_mpc_clkdel {
	/** No delay */
	DELAY_NONE,
	/** One clock cycle delay */
	DELAY_1_CLOCKS,
	/** Two clock cycles delay */
	DELAY_2_CLOCKS
};

/**
 * @struct ad713x_dev
 * @brief AD713x driver handler structure
 */
struct ad713x_dev {
	/** SPI layer handler. */
	struct spi_desc        	*spi_desc;
	/** MODE GPIO handler. */
	struct gpio_desc		*gpio_mode;
	/** DCLKMODE GPIO handler. */
	struct gpio_desc		*gpio_dclkmode;
	/** DCLKIO GPIO handler. */
	struct gpio_desc		*gpio_dclkio;
	/** RESET GPIO handler. */
	struct gpio_desc		*gpio_resetn;
	/** PDN GPIO handler. */
	struct gpio_desc		*gpio_pnd;
	/** ID of supported device. */
	enum ad713x_supported_dev_ids dev_id;
	/** Length of data in bits. */
	enum ad713x_adc_data_len	adc_data_len;
	/** CRC option. */
	enum ad713x_crc_header	crc_header;
};

/**
 * @struct ad713x_init_param
 * @brief AD713x driver initialization structure
 */
struct ad713x_init_param {
	/** SPI layer initialization structure. */
	struct spi_init_param spi_init_prm;
	/** MODE GPIO initialization structure. */
	struct gpio_init_param *gpio_mode;
	/** DCLKMODE GPIO initialization structure. */
	struct gpio_init_param *gpio_dclkmode;
	/** DCLKIO GPIO initialization structure. */
	struct gpio_init_param *gpio_dclkio;
	/** RESET GPIO initialization structure. */
	struct gpio_init_param *gpio_resetn;
	/** PDN GPIO initialization structure. */
	struct gpio_init_param *gpio_pnd;
	/** MODE GPIO starting value */
	bool mode_master_nslave;
	/** DCLKMODE GPIO starting value */
	bool dclkmode_free_ngated;
	/** DCLKIO GPIO starting value */
	bool dclkio_out_nin;
	/** PDN GPIO starting value */
	bool pnd;
	/** ID of supported device. */
	enum ad713x_supported_dev_ids dev_id;
	/** Length of data in bits. */
	enum ad713x_adc_data_len	adc_data_len;
	/** CRC option. */
	enum ad713x_crc_header	crc_header;
	enum ad713x_doutx_format	format;
	/** Clock delay state. */
	bool 			clk_delay_en;
	/** SPI layer handler if the SPI bus is shared with another device. In this
	 *  case the SPI should not be initialized again. */
	struct spi_desc *spi_common_dev;
};

/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/

/** Read from device. */
int32_t ad713x_spi_reg_read(struct ad713x_dev *dev, uint8_t reg_addr,
			    uint8_t *reg_data);

/** Write to device. */
int32_t ad713x_spi_reg_write(struct ad713x_dev *dev, uint8_t reg_addr,
			     uint8_t reg_data);

/** SPI write to device using a mask. */
int32_t ad713x_spi_write_mask(struct ad713x_dev *dev, uint8_t reg_addr,
			      uint32_t mask, uint8_t data);

/** Device power mode control. */
int32_t ad713x_set_power_mode(struct ad713x_dev *dev,
			      enum ad713x_power_mode mode);

/** ADC conversion data output frame control. */
int32_t ad713x_set_out_data_frame(struct ad713x_dev *dev,
				  enum ad713x_adc_data_len adc_data_len,
				  enum ad713x_crc_header crc_header);

/** DOUTx output format configuration. */
int32_t ad713x_dout_format_config(struct ad713x_dev *dev,
				  enum ad713x_doutx_format format);

/** Magnitude and phase matching calibration clock delay enable for all channels
 *  at 2 clock delay. */
int32_t ad713x_mag_phase_clk_delay(struct ad713x_dev *dev, bool clk_delay_en);

/** Digital filter type selection for each channel. */
int32_t ad713x_dig_filter_sel_ch(struct ad713x_dev *dev,
				 enum ad713x_dig_filter_sel filter, enum ad713x_channels ch);

/** Enable/Disable CLKOUT output. */
int32_t ad713x_clkout_output_en(struct ad713x_dev *dev, bool enable);

/** Enable/Disable reference gain correction. */
int32_t ad713x_ref_gain_correction_en(struct ad713x_dev *dev, bool enable);

/** Select the wideband filter bandwidth for a channel. */
int32_t ad713x_wideband_bw_sel(struct ad713x_dev *dev,
			       enum ad713x_channels ch, uint8_t wb_opt);

/** Initialize the device. */
int32_t ad713x_init(struct ad713x_dev **device,
		    struct ad713x_init_param *init_param);

/** Free the resources allocated by ad713x_init(). */
int32_t ad713x_remove(struct ad713x_dev *dev);

#endif /* SRC_AD713X_H_ */