Analog Devices / AD717x-AD411x

Library files for AD717x and AD411x family of products.

Dependents:  

ad717x.h@2:0780c234e572, 2020-08-03 (annotated)

Committer:
mahphalke
Date:
Mon Aug 03 09:18:41 2020 +0000
Revision:
2:0780c234e572
Parent:
1:1d54b9448386 
Added no-os driver support for AD4114/15 devices

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mahphalke 1:1d54b9448386 1 /**************************************************************************//**
mahphalke 1:1d54b9448386 2 * @file AD717X.h
mahphalke 1:1d54b9448386 3 * @brief AD717X header file.
mahphalke 1:1d54b9448386 4 * Devices: AD7172-2, AD7172-4, AD7173-8, AD7175-2, AD7175-8, AD7176-2,
mahphalke 2:0780c234e572 5 * AD7177-2, AD4111, AD4112, AD4114, AD4115
mahphalke 1:1d54b9448386 6 * @author acozma (andrei.cozma@analog.com)
mahphalke 1:1d54b9448386 7 * dnechita (dan.nechita@analog.com)
mahphalke 1:1d54b9448386 8 *******************************************************************************
mahphalke 1:1d54b9448386 9 * Copyright 2015, 2020(c) Analog Devices, Inc.
mahphalke 1:1d54b9448386 10 *
mahphalke 1:1d54b9448386 11 * All rights reserved.
mahphalke 1:1d54b9448386 12 *
mahphalke 1:1d54b9448386 13 * Redistribution and use in source and binary forms, with or without modification,
mahphalke 1:1d54b9448386 14 * are permitted provided that the following conditions are met:
mahphalke 1:1d54b9448386 15 * - Redistributions of source code must retain the above copyright
mahphalke 1:1d54b9448386 16 * notice, this list of conditions and the following disclaimer.
mahphalke 1:1d54b9448386 17 * - Redistributions in binary form must reproduce the above copyright
mahphalke 1:1d54b9448386 18 * notice, this list of conditions and the following disclaimer in
mahphalke 1:1d54b9448386 19 * the documentation and/or other materials provided with the
mahphalke 1:1d54b9448386 20 * distribution.
mahphalke 1:1d54b9448386 21 * - Neither the name of Analog Devices, Inc. nor the names of its
mahphalke 1:1d54b9448386 22 * contributors may be used to endorse or promote products derived
mahphalke 1:1d54b9448386 23 * from this software without specific prior written permission.
mahphalke 1:1d54b9448386 24 * - The use of this software may or may not infringe the patent rights
mahphalke 1:1d54b9448386 25 * of one or more patent holders. This license does not release you
mahphalke 1:1d54b9448386 26 * from the requirement that you obtain separate licenses from these
mahphalke 1:1d54b9448386 27 * patent holders to use this software.
mahphalke 1:1d54b9448386 28 * - Use of the software either in source or binary form, must be run
mahphalke 1:1d54b9448386 29 * on or directly connected to an Analog Devices Inc. component.
mahphalke 1:1d54b9448386 30 *
mahphalke 1:1d54b9448386 31 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED
mahphalke 1:1d54b9448386 32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY
mahphalke 1:1d54b9448386 33 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
mahphalke 1:1d54b9448386 34 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
mahphalke 1:1d54b9448386 35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
mahphalke 1:1d54b9448386 36 * INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
mahphalke 1:1d54b9448386 37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
mahphalke 1:1d54b9448386 38 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
mahphalke 1:1d54b9448386 39 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
mahphalke 1:1d54b9448386 40 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mahphalke 1:1d54b9448386 41 ******************************************************************************/
mahphalke 1:1d54b9448386 42
mahphalke 1:1d54b9448386 43 #ifndef __AD717X_H__
mahphalke 1:1d54b9448386 44 #define __AD717X_H__
mahphalke 1:1d54b9448386 45
mahphalke 1:1d54b9448386 46 /******************************************************************************/
mahphalke 1:1d54b9448386 47 /***************************** Include Files **********************************/
mahphalke 1:1d54b9448386 48 /******************************************************************************/
mahphalke 1:1d54b9448386 49 #include <stdint.h>
mahphalke 1:1d54b9448386 50 #include "platform_drivers.h"
mahphalke 1:1d54b9448386 51
mahphalke 1:1d54b9448386 52 /******************************************************************************/
mahphalke 1:1d54b9448386 53 /*************************** Types Declarations *******************************/
mahphalke 1:1d54b9448386 54 /******************************************************************************/
mahphalke 1:1d54b9448386 55
mahphalke 1:1d54b9448386 56 typedef enum {
mahphalke 1:1d54b9448386 57 AD717X_DISABLE,
mahphalke 1:1d54b9448386 58 AD717X_USE_CRC,
mahphalke 1:1d54b9448386 59 AD717X_USE_XOR,
mahphalke 1:1d54b9448386 60 } ad717x_crc_mode;
mahphalke 1:1d54b9448386 61
mahphalke 1:1d54b9448386 62 /*! AD717X register info */
mahphalke 1:1d54b9448386 63 typedef struct {
mahphalke 1:1d54b9448386 64 int32_t addr;
mahphalke 1:1d54b9448386 65 int32_t value;
mahphalke 1:1d54b9448386 66 int32_t size;
mahphalke 1:1d54b9448386 67 } ad717x_st_reg;
mahphalke 1:1d54b9448386 68
mahphalke 1:1d54b9448386 69 /*
mahphalke 1:1d54b9448386 70 * The structure describes the device and is used with the ad717x driver.
mahphalke 1:1d54b9448386 71 * @slave_select_id: The ID of the Slave Select to be passed to the SPI calls.
mahphalke 1:1d54b9448386 72 * @regs: A reference to the register list of the device that the user must
mahphalke 1:1d54b9448386 73 * provide when calling the Setup() function.
mahphalke 1:1d54b9448386 74 * @num_regs: The length of the register list.
mahphalke 1:1d54b9448386 75 * @userCRC: Error check type to use on SPI transfers.
mahphalke 1:1d54b9448386 76 */
mahphalke 1:1d54b9448386 77 typedef struct {
mahphalke 1:1d54b9448386 78 /* SPI */
mahphalke 1:1d54b9448386 79 spi_desc *spi_desc;
mahphalke 1:1d54b9448386 80 /* Device Settings */
mahphalke 1:1d54b9448386 81 ad717x_st_reg *regs;
mahphalke 1:1d54b9448386 82 uint8_t num_regs;
mahphalke 1:1d54b9448386 83 ad717x_crc_mode useCRC;
mahphalke 1:1d54b9448386 84 } ad717x_dev;
mahphalke 1:1d54b9448386 85
mahphalke 1:1d54b9448386 86 typedef struct {
mahphalke 1:1d54b9448386 87 /* SPI */
mahphalke 1:1d54b9448386 88 spi_init_param spi_init;
mahphalke 1:1d54b9448386 89 /* Device Settings */
mahphalke 1:1d54b9448386 90 ad717x_st_reg *regs;
mahphalke 1:1d54b9448386 91 uint8_t num_regs;
mahphalke 1:1d54b9448386 92 } ad717x_init_param;
mahphalke 1:1d54b9448386 93
mahphalke 1:1d54b9448386 94 /*****************************************************************************/
mahphalke 1:1d54b9448386 95 /***************** AD717X Register Definitions *******************************/
mahphalke 1:1d54b9448386 96 /*****************************************************************************/
mahphalke 1:1d54b9448386 97
mahphalke 1:1d54b9448386 98 /* AD717X Register Map */
mahphalke 1:1d54b9448386 99 #define AD717X_COMM_REG 0x00
mahphalke 1:1d54b9448386 100 #define AD717X_STATUS_REG 0x00
mahphalke 1:1d54b9448386 101 #define AD717X_ADCMODE_REG 0x01
mahphalke 1:1d54b9448386 102 #define AD717X_IFMODE_REG 0x02
mahphalke 1:1d54b9448386 103 #define AD717X_REGCHECK_REG 0x03
mahphalke 1:1d54b9448386 104 #define AD717X_DATA_REG 0x04
mahphalke 1:1d54b9448386 105 #define AD717X_GPIOCON_REG 0x06
mahphalke 1:1d54b9448386 106 #define AD717X_ID_REG 0x07
mahphalke 1:1d54b9448386 107 #define AD717X_CHMAP0_REG 0x10
mahphalke 1:1d54b9448386 108 #define AD717X_CHMAP1_REG 0x11
mahphalke 1:1d54b9448386 109 #define AD717X_CHMAP2_REG 0x12
mahphalke 1:1d54b9448386 110 #define AD717X_CHMAP3_REG 0x13
mahphalke 1:1d54b9448386 111 #define AD717X_CHMAP4_REG 0x14
mahphalke 1:1d54b9448386 112 #define AD717X_CHMAP5_REG 0x15
mahphalke 1:1d54b9448386 113 #define AD717X_CHMAP6_REG 0x16
mahphalke 1:1d54b9448386 114 #define AD717X_CHMAP7_REG 0x17
mahphalke 1:1d54b9448386 115 #define AD717X_CHMAP8_REG 0x18
mahphalke 1:1d54b9448386 116 #define AD717X_CHMAP9_REG 0x19
mahphalke 1:1d54b9448386 117 #define AD717X_CHMAP10_REG 0x1A
mahphalke 1:1d54b9448386 118 #define AD717X_CHMAP11_REG 0x1B
mahphalke 1:1d54b9448386 119 #define AD717X_CHMAP12_REG 0x1C
mahphalke 1:1d54b9448386 120 #define AD717X_CHMAP13_REG 0x1D
mahphalke 1:1d54b9448386 121 #define AD717X_CHMAP14_REG 0x1E
mahphalke 1:1d54b9448386 122 #define AD717X_CHMAP15_REG 0x1F
mahphalke 1:1d54b9448386 123 #define AD717X_SETUPCON0_REG 0x20
mahphalke 1:1d54b9448386 124 #define AD717X_SETUPCON1_REG 0x21
mahphalke 1:1d54b9448386 125 #define AD717X_SETUPCON2_REG 0x22
mahphalke 1:1d54b9448386 126 #define AD717X_SETUPCON3_REG 0x23
mahphalke 1:1d54b9448386 127 #define AD717X_SETUPCON4_REG 0x24
mahphalke 1:1d54b9448386 128 #define AD717X_SETUPCON5_REG 0x25
mahphalke 1:1d54b9448386 129 #define AD717X_SETUPCON6_REG 0x26
mahphalke 1:1d54b9448386 130 #define AD717X_SETUPCON7_REG 0x27
mahphalke 1:1d54b9448386 131 #define AD717X_FILTCON0_REG 0x28
mahphalke 1:1d54b9448386 132 #define AD717X_FILTCON1_REG 0x29
mahphalke 1:1d54b9448386 133 #define AD717X_FILTCON2_REG 0x2A
mahphalke 1:1d54b9448386 134 #define AD717X_FILTCON3_REG 0x2B
mahphalke 1:1d54b9448386 135 #define AD717X_FILTCON4_REG 0x2C
mahphalke 1:1d54b9448386 136 #define AD717X_FILTCON5_REG 0x2D
mahphalke 1:1d54b9448386 137 #define AD717X_FILTCON6_REG 0x2E
mahphalke 1:1d54b9448386 138 #define AD717X_FILTCON7_REG 0x2F
mahphalke 1:1d54b9448386 139 #define AD717X_OFFSET0_REG 0x30
mahphalke 1:1d54b9448386 140 #define AD717X_OFFSET1_REG 0x31
mahphalke 1:1d54b9448386 141 #define AD717X_OFFSET2_REG 0x32
mahphalke 1:1d54b9448386 142 #define AD717X_OFFSET3_REG 0x33
mahphalke 1:1d54b9448386 143 #define AD717X_OFFSET4_REG 0x34
mahphalke 1:1d54b9448386 144 #define AD717X_OFFSET5_REG 0x35
mahphalke 1:1d54b9448386 145 #define AD717X_OFFSET6_REG 0x36
mahphalke 1:1d54b9448386 146 #define AD717X_OFFSET7_REG 0x37
mahphalke 1:1d54b9448386 147 #define AD717X_GAIN0_REG 0x38
mahphalke 1:1d54b9448386 148 #define AD717X_GAIN1_REG 0x39
mahphalke 1:1d54b9448386 149 #define AD717X_GAIN2_REG 0x3A
mahphalke 1:1d54b9448386 150 #define AD717X_GAIN3_REG 0x3B
mahphalke 1:1d54b9448386 151 #define AD717X_GAIN4_REG 0x3C
mahphalke 1:1d54b9448386 152 #define AD717X_GAIN5_REG 0x3D
mahphalke 1:1d54b9448386 153 #define AD717X_GAIN6_REG 0x3E
mahphalke 1:1d54b9448386 154 #define AD717X_GAIN7_REG 0x3F
mahphalke 1:1d54b9448386 155
mahphalke 1:1d54b9448386 156 /* Communication Register bits */
mahphalke 1:1d54b9448386 157 #define AD717X_COMM_REG_WEN (0 << 7)
mahphalke 1:1d54b9448386 158 #define AD717X_COMM_REG_WR (0 << 6)
mahphalke 1:1d54b9448386 159 #define AD717X_COMM_REG_RD (1 << 6)
mahphalke 1:1d54b9448386 160 #define AD717X_COMM_REG_RA(x) ((x) & 0x3F)
mahphalke 1:1d54b9448386 161
mahphalke 1:1d54b9448386 162 /* Status Register bits */
mahphalke 1:1d54b9448386 163 #define AD717X_STATUS_REG_RDY (1 << 7)
mahphalke 1:1d54b9448386 164 #define AD717X_STATUS_REG_ADC_ERR (1 << 6)
mahphalke 1:1d54b9448386 165 #define AD717X_STATUS_REG_CRC_ERR (1 << 5)
mahphalke 1:1d54b9448386 166 #define AD717X_STATUS_REG_REG_ERR (1 << 4)
mahphalke 1:1d54b9448386 167 #define AD717X_STATUS_REG_CH(x) ((x) & 0x0F)
mahphalke 1:1d54b9448386 168
mahphalke 1:1d54b9448386 169 /* ADC Mode Register bits */
mahphalke 1:1d54b9448386 170 #define AD717X_ADCMODE_REG_REF_EN (1 << 15)
mahphalke 1:1d54b9448386 171 #define AD717X_ADCMODE_SING_CYC (1 << 13)
mahphalke 1:1d54b9448386 172 #define AD717X_ADCMODE_REG_DELAY(x) (((x) & 0x7) << 8)
mahphalke 1:1d54b9448386 173 #define AD717X_ADCMODE_REG_MODE(x) (((x) & 0x7) << 4)
mahphalke 1:1d54b9448386 174 #define AD717X_ADCMODE_REG_CLKSEL(x) (((x) & 0x3) << 2)
mahphalke 1:1d54b9448386 175
mahphalke 1:1d54b9448386 176 /* ADC Mode Register additional bits for AD7172-2, AD7172-4, AD4111 and AD4112 */
mahphalke 1:1d54b9448386 177 #define AD717X_ADCMODE_REG_HIDE_DELAY (1 << 14)
mahphalke 1:1d54b9448386 178
mahphalke 1:1d54b9448386 179 /* Interface Mode Register bits */
mahphalke 1:1d54b9448386 180 #define AD717X_IFMODE_REG_ALT_SYNC (1 << 12)
mahphalke 1:1d54b9448386 181 #define AD717X_IFMODE_REG_IOSTRENGTH (1 << 11)
mahphalke 1:1d54b9448386 182 #define AD717X_IFMODE_REG_HIDE_DELAY (1 << 10)
mahphalke 1:1d54b9448386 183 #define AD717X_IFMODE_REG_DOUT_RESET (1 << 8)
mahphalke 1:1d54b9448386 184 #define AD717X_IFMODE_REG_CONT_READ (1 << 7)
mahphalke 1:1d54b9448386 185 #define AD717X_IFMODE_REG_DATA_STAT (1 << 6)
mahphalke 1:1d54b9448386 186 #define AD717X_IFMODE_REG_REG_CHECK (1 << 5)
mahphalke 1:1d54b9448386 187 #define AD717X_IFMODE_REG_XOR_EN (0x01 << 2)
mahphalke 1:1d54b9448386 188 #define AD717X_IFMODE_REG_CRC_EN (0x02 << 2)
mahphalke 1:1d54b9448386 189 #define AD717X_IFMODE_REG_XOR_STAT(x) (((x) & AD717X_IFMODE_REG_XOR_EN) == AD717X_IFMODE_REG_XOR_EN)
mahphalke 1:1d54b9448386 190 #define AD717X_IFMODE_REG_CRC_STAT(x) (((x) & AD717X_IFMODE_REG_CRC_EN) == AD717X_IFMODE_REG_CRC_EN)
mahphalke 1:1d54b9448386 191 #define AD717X_IFMODE_REG_DATA_WL16 (1 << 0)
mahphalke 1:1d54b9448386 192
mahphalke 1:1d54b9448386 193 /* GPIO Configuration Register bits */
mahphalke 1:1d54b9448386 194 #define AD717X_GPIOCON_REG_MUX_IO (1 << 12)
mahphalke 1:1d54b9448386 195 #define AD717X_GPIOCON_REG_SYNC_EN (1 << 11)
mahphalke 1:1d54b9448386 196 #define AD717X_GPIOCON_REG_ERR_EN(x) (((x) & 0x3) << 9)
mahphalke 1:1d54b9448386 197 #define AD717X_GPIOCON_REG_ERR_DAT (1 << 8)
mahphalke 1:1d54b9448386 198 #define AD717X_GPIOCON_REG_IP_EN1 (1 << 5)
mahphalke 1:1d54b9448386 199 #define AD717X_GPIOCON_REG_IP_EN0 (1 << 4)
mahphalke 1:1d54b9448386 200 #define AD717X_GPIOCON_REG_OP_EN1 (1 << 3)
mahphalke 1:1d54b9448386 201 #define AD717X_GPIOCON_REG_OP_EN0 (1 << 2)
mahphalke 1:1d54b9448386 202 #define AD717X_GPIOCON_REG_DATA1 (1 << 1)
mahphalke 1:1d54b9448386 203 #define AD717X_GPIOCON_REG_DATA0 (1 << 0)
mahphalke 1:1d54b9448386 204
mahphalke 1:1d54b9448386 205 /* GPIO Configuration Register additional bits for AD7172-4, AD7173-8 */
mahphalke 1:1d54b9448386 206 #define AD717X_GPIOCON_REG_GP_DATA3 (1 << 7)
mahphalke 1:1d54b9448386 207 #define AD717X_GPIOCON_REG_GP_DATA2 (1 << 6)
mahphalke 1:1d54b9448386 208 #define AD717X_GPIOCON_REG_GP_DATA1 (1 << 1)
mahphalke 1:1d54b9448386 209 #define AD717X_GPIOCON_REG_GP_DATA0 (1 << 0)
mahphalke 1:1d54b9448386 210
mahphalke 1:1d54b9448386 211 /* GPIO Configuration Register additional bits for AD7173-8 */
mahphalke 1:1d54b9448386 212 #define AD717X_GPIOCON_REG_PDSW (1 << 14)
mahphalke 1:1d54b9448386 213 #define AD717X_GPIOCON_REG_OP_EN2_3 (1 << 13)
mahphalke 1:1d54b9448386 214
mahphalke 2:0780c234e572 215 /* GPIO Configuration Register additional bits for AD4111, AD4112, AD4114, AD4115 */
mahphalke 1:1d54b9448386 216 #define AD4111_GPIOCON_REG_OP_EN0_1 (1 << 13)
mahphalke 1:1d54b9448386 217 #define AD4111_GPIOCON_REG_DATA1 (1 << 7)
mahphalke 1:1d54b9448386 218 #define AD4111_GPIOCON_REG_DATA0 (1 << 6)
mahphalke 1:1d54b9448386 219
mahphalke 1:1d54b9448386 220 /* GPIO Configuration Register additional bits for AD4111 */
mahphalke 1:1d54b9448386 221 #define AD4111_GPIOCON_REG_OW_EN (1 << 12)
mahphalke 1:1d54b9448386 222
mahphalke 1:1d54b9448386 223 /* Channel Map Register 0-3 bits */
mahphalke 1:1d54b9448386 224 #define AD717X_CHMAP_REG_CH_EN (1 << 15)
mahphalke 1:1d54b9448386 225 #define AD717X_CHMAP_REG_SETUP_SEL(x) (((x) & 0x7) << 12)
mahphalke 1:1d54b9448386 226 #define AD717X_CHMAP_REG_AINPOS(x) (((x) & 0x1F) << 5)
mahphalke 1:1d54b9448386 227 #define AD717X_CHMAP_REG_AINNEG(x) (((x) & 0x1F) << 0)
mahphalke 1:1d54b9448386 228
mahphalke 1:1d54b9448386 229 /* Channel Map Register additional bits for AD4111, AD4112 */
mahphalke 1:1d54b9448386 230 #define AD4111_CHMAP_REG_INPUT(x) (((x) & 0x3FF) << 0)
mahphalke 1:1d54b9448386 231
mahphalke 1:1d54b9448386 232 /* Setup Configuration Register 0-3 bits */
mahphalke 1:1d54b9448386 233 #define AD717X_SETUP_CONF_REG_BI_UNIPOLAR (1 << 12)
mahphalke 1:1d54b9448386 234 #define AD717X_SETUP_CONF_REG_REF_SEL(x) (((x) & 0x3) << 4)
mahphalke 1:1d54b9448386 235
mahphalke 1:1d54b9448386 236 /* Setup Configuration Register additional bits for AD7173-8 */
mahphalke 1:1d54b9448386 237 #define AD717X_SETUP_CONF_REG_REF_BUF(x) (((x) & 0x3) << 10)
mahphalke 1:1d54b9448386 238 #define AD717X_SETUP_CONF_REG_AIN_BUF(x) (((x) & 0x3) << 8)
mahphalke 1:1d54b9448386 239 #define AD717X_SETUP_CONF_REG_BURNOUT_EN (1 << 7)
mahphalke 1:1d54b9448386 240 #define AD717X_SETUP_CONF_REG_BUFCHOPMAX (1 << 6)
mahphalke 1:1d54b9448386 241
mahphalke 1:1d54b9448386 242 /* Setup Configuration Register additional bits for AD7172-2, AD7172-4, AD7175-2 */
mahphalke 1:1d54b9448386 243 #define AD717X_SETUP_CONF_REG_REFBUF_P (1 << 11)
mahphalke 1:1d54b9448386 244 #define AD717X_SETUP_CONF_REG_REFBUF_N (1 << 10)
mahphalke 1:1d54b9448386 245 #define AD717X_SETUP_CONF_REG_AINBUF_P (1 << 9)
mahphalke 1:1d54b9448386 246 #define AD717X_SETUP_CONF_REG_AINBUF_N (1 << 8)
mahphalke 1:1d54b9448386 247
mahphalke 1:1d54b9448386 248 /* Setup Configuration Register additional bits for AD4111, AD4112 */
mahphalke 1:1d54b9448386 249 #define AD4111_SETUP_CONF_REG_REFPOS_BUF (1 << 11)
mahphalke 1:1d54b9448386 250 #define AD4111_SETUP_CONF_REG_REFNEG_BUF (1 << 10)
mahphalke 1:1d54b9448386 251 #define AD4111_SETUP_CONF_REG_AIN_BUF(x) (((x) & 0x3) << 8)
mahphalke 1:1d54b9448386 252 #define AD4111_SETUP_CONF_REG_BUFCHOPMAX (1 << 6)
mahphalke 1:1d54b9448386 253
mahphalke 1:1d54b9448386 254 /* Filter Configuration Register 0-3 bits */
mahphalke 1:1d54b9448386 255 #define AD717X_FILT_CONF_REG_SINC3_MAP (1 << 15)
mahphalke 1:1d54b9448386 256 #define AD717X_FILT_CONF_REG_ENHFILTEN (1 << 11)
mahphalke 1:1d54b9448386 257 #define AD717X_FILT_CONF_REG_ENHFILT(x) (((x) & 0x7) << 8)
mahphalke 1:1d54b9448386 258 #define AD717X_FILT_CONF_REG_ORDER(x) (((x) & 0x3) << 5)
mahphalke 1:1d54b9448386 259 #define AD717X_FILT_CONF_REG_ODR(x) (((x) & 0x1F) << 0)
mahphalke 1:1d54b9448386 260
mahphalke 1:1d54b9448386 261 /* ID register mask for relevant bits */
mahphalke 1:1d54b9448386 262 #define AD717X_ID_REG_MASK 0xFFF0
mahphalke 1:1d54b9448386 263 /* AD7172-2 ID */
mahphalke 1:1d54b9448386 264 #define AD7172_2_ID_REG_VALUE 0x00D0
mahphalke 1:1d54b9448386 265 /* AD7172-4 ID */
mahphalke 1:1d54b9448386 266 #define AD7172_4_ID_REG_VALUE 0x2050
mahphalke 1:1d54b9448386 267 /* AD7173-8 ID */
mahphalke 1:1d54b9448386 268 #define AD7173_8_ID_REG_VALUE 0x30D0
mahphalke 1:1d54b9448386 269 /* AD7175-2 ID */
mahphalke 1:1d54b9448386 270 #define AD7175_2_ID_REG_VALUE 0x0CD0
mahphalke 1:1d54b9448386 271 /* AD7175-8 ID */
mahphalke 1:1d54b9448386 272 #define AD7175_8_ID_REG_VALUE 0x3CD0
mahphalke 1:1d54b9448386 273 /* AD7176-2 ID */
mahphalke 1:1d54b9448386 274 #define AD7176_2_ID_REG_VALUE 0x0C90
mahphalke 1:1d54b9448386 275 /* AD7177-2 ID */
mahphalke 1:1d54b9448386 276 #define AD7177_2_ID_REG_VALUE 0x4FD0
mahphalke 1:1d54b9448386 277 /* AD411x ID */
mahphalke 1:1d54b9448386 278 #define AD411X_ID_REG_VALUE 0x30D0
mahphalke 1:1d54b9448386 279
mahphalke 1:1d54b9448386 280 /*****************************************************************************/
mahphalke 1:1d54b9448386 281 /******************* AD717X Constants ****************************************/
mahphalke 1:1d54b9448386 282 /*****************************************************************************/
mahphalke 1:1d54b9448386 283 #define AD717X_CRC8_POLYNOMIAL_REPRESENTATION 0x07 /* x8 + x2 + x + 1 */
mahphalke 1:1d54b9448386 284
mahphalke 1:1d54b9448386 285 /*****************************************************************************/
mahphalke 1:1d54b9448386 286 /************************ Functions Declarations *****************************/
mahphalke 1:1d54b9448386 287 /*****************************************************************************/
mahphalke 1:1d54b9448386 288
mahphalke 1:1d54b9448386 289 /*! Retrieves a pointer to the register that matches the given address */
mahphalke 1:1d54b9448386 290 ad717x_st_reg *AD717X_GetReg(ad717x_dev *device,
mahphalke 1:1d54b9448386 291 uint8_t reg_address);
mahphalke 1:1d54b9448386 292
mahphalke 1:1d54b9448386 293 /*! Reads the value of the specified register. */
mahphalke 1:1d54b9448386 294 int32_t AD717X_ReadRegister(ad717x_dev *device,
mahphalke 1:1d54b9448386 295 uint8_t addr);
mahphalke 1:1d54b9448386 296
mahphalke 1:1d54b9448386 297 /*! Writes the value of the specified register. */
mahphalke 1:1d54b9448386 298 int32_t AD717X_WriteRegister(ad717x_dev *device,
mahphalke 1:1d54b9448386 299 uint8_t);
mahphalke 1:1d54b9448386 300
mahphalke 1:1d54b9448386 301 /*! Resets the device. */
mahphalke 1:1d54b9448386 302 int32_t AD717X_Reset(ad717x_dev *device);
mahphalke 1:1d54b9448386 303
mahphalke 1:1d54b9448386 304 /*! Waits until a new conversion result is available. */
mahphalke 1:1d54b9448386 305 int32_t AD717X_WaitForReady(ad717x_dev *device,
mahphalke 1:1d54b9448386 306 uint32_t timeout);
mahphalke 1:1d54b9448386 307
mahphalke 1:1d54b9448386 308 /*! Reads the conversion result from the device. */
mahphalke 1:1d54b9448386 309 int32_t AD717X_ReadData(ad717x_dev *device,
mahphalke 1:1d54b9448386 310 int32_t* pData);
mahphalke 1:1d54b9448386 311
mahphalke 1:1d54b9448386 312 /*! Computes data register read size to account for bit number and status
mahphalke 1:1d54b9448386 313 * read. */
mahphalke 1:1d54b9448386 314 int32_t AD717X_ComputeDataregSize(ad717x_dev *device);
mahphalke 1:1d54b9448386 315
mahphalke 1:1d54b9448386 316 /*! Computes the CRC checksum for a data buffer. */
mahphalke 1:1d54b9448386 317 uint8_t AD717X_ComputeCRC8(uint8_t* pBuf,
mahphalke 1:1d54b9448386 318 uint8_t bufSize);
mahphalke 1:1d54b9448386 319
mahphalke 1:1d54b9448386 320 /*! Computes the XOR checksum for a data buffer. */
mahphalke 1:1d54b9448386 321 uint8_t AD717X_ComputeXOR8(uint8_t * pBuf,
mahphalke 1:1d54b9448386 322 uint8_t bufSize);
mahphalke 1:1d54b9448386 323
mahphalke 1:1d54b9448386 324 /*! Updates the CRC settings. */
mahphalke 1:1d54b9448386 325 int32_t AD717X_UpdateCRCSetting(ad717x_dev *device);
mahphalke 1:1d54b9448386 326
mahphalke 1:1d54b9448386 327 /*! Initializes the AD717X. */
mahphalke 1:1d54b9448386 328 int32_t AD717X_Init(ad717x_dev **device,
mahphalke 1:1d54b9448386 329 ad717x_init_param init_param);
mahphalke 1:1d54b9448386 330
mahphalke 1:1d54b9448386 331 /*! Free the resources allocated by AD717X_Init(). */
mahphalke 1:1d54b9448386 332 int32_t AD717X_remove(ad717x_dev *dev);
mahphalke 1:1d54b9448386 333
mahphalke 1:1d54b9448386 334 #endif /* __AD717X_H__ */