Pratyush Mallick / Mbed OS testing

this is testing

app/noos_mbed/drivers/temperature/adt7420/adt7420.h@0:3afcd581558d, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 18:54:16 2021 +0530
Revision:
0:3afcd581558d
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:3afcd581558d 1 /***************************************************************************//**
pmallick 0:3afcd581558d 2 * @file adt7420.h
pmallick 0:3afcd581558d 3 * @brief Header file of ADT7420 Driver.
pmallick 0:3afcd581558d 4 * @author DBogdan (dragos.bogdan@analog.com)
pmallick 0:3afcd581558d 5 ********************************************************************************
pmallick 0:3afcd581558d 6 * Copyright 2012(c) Analog Devices, Inc.
pmallick 0:3afcd581558d 7 *
pmallick 0:3afcd581558d 8 * All rights reserved.
pmallick 0:3afcd581558d 9 *
pmallick 0:3afcd581558d 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:3afcd581558d 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:3afcd581558d 12 * - Redistributions of source code must retain the above copyright
pmallick 0:3afcd581558d 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:3afcd581558d 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:3afcd581558d 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:3afcd581558d 16 * the documentation and/or other materials provided with the
pmallick 0:3afcd581558d 17 * distribution.
pmallick 0:3afcd581558d 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:3afcd581558d 19 * contributors may be used to endorse or promote products derived
pmallick 0:3afcd581558d 20 * from this software without specific prior written permission.
pmallick 0:3afcd581558d 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:3afcd581558d 22 * of one or more patent holders. This license does not release you
pmallick 0:3afcd581558d 23 * from the requirement that you obtain separate licenses from these
pmallick 0:3afcd581558d 24 * patent holders to use this software.
pmallick 0:3afcd581558d 25 * - Use of the software either in source or binary form, must be run
pmallick 0:3afcd581558d 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:3afcd581558d 27 *
pmallick 0:3afcd581558d 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
pmallick 0:3afcd581558d 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
pmallick 0:3afcd581558d 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:3afcd581558d 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:3afcd581558d 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:3afcd581558d 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:3afcd581558d 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:3afcd581558d 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:3afcd581558d 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:3afcd581558d 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:3afcd581558d 38 *******************************************************************************/
pmallick 0:3afcd581558d 39 #ifndef __ADT7420_H__
pmallick 0:3afcd581558d 40 #define __ADT7420_H__
pmallick 0:3afcd581558d 41
pmallick 0:3afcd581558d 42 /******************************************************************************/
pmallick 0:3afcd581558d 43 /***************************** Include Files **********************************/
pmallick 0:3afcd581558d 44 /******************************************************************************/
pmallick 0:3afcd581558d 45 #include <stdint.h>
pmallick 0:3afcd581558d 46 #include "platform_drivers.h"
pmallick 0:3afcd581558d 47
pmallick 0:3afcd581558d 48 /******************************************************************************/
pmallick 0:3afcd581558d 49 /************************** ADT7420 Definitions *******************************/
pmallick 0:3afcd581558d 50 /******************************************************************************/
pmallick 0:3afcd581558d 51
pmallick 0:3afcd581558d 52 /* ADT7420 address */
pmallick 0:3afcd581558d 53 #define ADT7420_A0_PIN(x) (((x) & 0x1) << 0) // I2C Serial Bus Address Selection Pin
pmallick 0:3afcd581558d 54 #define ADT7420_A1_PIN(x) (((x) & 0x1) << 1) // I2C Serial Bus Address Selection Pin
pmallick 0:3afcd581558d 55 #define ADT7420_ADDRESS(x,y) (0x48 + ADT7420_A1_PIN(x) + ADT7420_A0_PIN(y))
pmallick 0:3afcd581558d 56
pmallick 0:3afcd581558d 57 /* ADT7420 registers */
pmallick 0:3afcd581558d 58 #define ADT7420_REG_TEMP_MSB 0x00 // Temperature value MSB
pmallick 0:3afcd581558d 59 #define ADT7420_REG_TEMP_LSB 0x01 // Temperature value LSB
pmallick 0:3afcd581558d 60 #define ADT7420_REG_STATUS 0x02 // Status
pmallick 0:3afcd581558d 61 #define ADT7420_REG_CONFIG 0x03 // Configuration
pmallick 0:3afcd581558d 62 #define ADT7420_REG_T_HIGH_MSB 0x04 // Temperature HIGH setpoint MSB
pmallick 0:3afcd581558d 63 #define ADT7420_REG_T_HIGH_LSB 0x05 // Temperature HIGH setpoint LSB
pmallick 0:3afcd581558d 64 #define ADT7420_REG_T_LOW_MSB 0x06 // Temperature LOW setpoint MSB
pmallick 0:3afcd581558d 65 #define ADT7420_REG_T_LOW_LSB 0x07 // Temperature LOW setpoint LSB
pmallick 0:3afcd581558d 66 #define ADT7420_REG_T_CRIT_MSB 0x08 // Temperature CRIT setpoint MSB
pmallick 0:3afcd581558d 67 #define ADT7420_REG_T_CRIT_LSB 0x09 // Temperature CRIT setpoint LSB
pmallick 0:3afcd581558d 68 #define ADT7420_REG_HIST 0x0A // Temperature HYST setpoint
pmallick 0:3afcd581558d 69 #define ADT7420_REG_ID 0x0B // ID
pmallick 0:3afcd581558d 70 #define ADT7420_REG_RESET 0x2F // Software reset
pmallick 0:3afcd581558d 71
pmallick 0:3afcd581558d 72 /* ADT7420_REG_STATUS definition */
pmallick 0:3afcd581558d 73 #define ADT7420_STATUS_T_LOW (1 << 4)
pmallick 0:3afcd581558d 74 #define ADT7420_STATUS_T_HIGH (1 << 5)
pmallick 0:3afcd581558d 75 #define ADT7420_STATUS_T_CRIT (1 << 6)
pmallick 0:3afcd581558d 76 #define ADT7420_STATUS_RDY (1 << 7)
pmallick 0:3afcd581558d 77
pmallick 0:3afcd581558d 78 /* ADT7420_REG_CONFIG definition */
pmallick 0:3afcd581558d 79 #define ADT7420_CONFIG_FAULT_QUEUE(x) (x & 0x3)
pmallick 0:3afcd581558d 80 #define ADT7420_CONFIG_CT_POL (1 << 2)
pmallick 0:3afcd581558d 81 #define ADT7420_CONFIG_INT_POL (1 << 3)
pmallick 0:3afcd581558d 82 #define ADT7420_CONFIG_INT_CT_MODE (1 << 4)
pmallick 0:3afcd581558d 83 #define ADT7420_CONFIG_OP_MODE(x) ((x & 0x3) << 5)
pmallick 0:3afcd581558d 84 #define ADT7420_CONFIG_RESOLUTION (1 << 7)
pmallick 0:3afcd581558d 85
pmallick 0:3afcd581558d 86 /* ADT7420_CONFIG_FAULT_QUEUE(x) options */
pmallick 0:3afcd581558d 87 #define ADT7420_FAULT_QUEUE_1_FAULT 0
pmallick 0:3afcd581558d 88 #define ADT7420_FAULT_QUEUE_2_FAULTS 1
pmallick 0:3afcd581558d 89 #define ADT7420_FAULT_QUEUE_3_FAULTS 2
pmallick 0:3afcd581558d 90 #define ADT7420_FAULT_QUEUE_4_FAULTS 3
pmallick 0:3afcd581558d 91
pmallick 0:3afcd581558d 92 /* ADT7420_CONFIG_OP_MODE(x) options */
pmallick 0:3afcd581558d 93 #define ADT7420_OP_MODE_CONT_CONV 0
pmallick 0:3afcd581558d 94 #define ADT7420_OP_MODE_ONE_SHOT 1
pmallick 0:3afcd581558d 95 #define ADT7420_OP_MODE_1_SPS 2
pmallick 0:3afcd581558d 96 #define ADT7420_OP_MODE_SHUTDOWN 3
pmallick 0:3afcd581558d 97
pmallick 0:3afcd581558d 98 /* ADT7420 default ID */
pmallick 0:3afcd581558d 99 #define ADT7420_DEFAULT_ID 0xCB
pmallick 0:3afcd581558d 100
pmallick 0:3afcd581558d 101 /******************************************************************************/
pmallick 0:3afcd581558d 102 /*************************** Types Declarations *******************************/
pmallick 0:3afcd581558d 103 /******************************************************************************/
pmallick 0:3afcd581558d 104
pmallick 0:3afcd581558d 105 struct adt7420_dev {
pmallick 0:3afcd581558d 106 /* I2C */
pmallick 0:3afcd581558d 107 i2c_desc *i2c_desc;
pmallick 0:3afcd581558d 108 /* Device Settings */
pmallick 0:3afcd581558d 109 uint8_t resolution_setting;
pmallick 0:3afcd581558d 110 };
pmallick 0:3afcd581558d 111
pmallick 0:3afcd581558d 112 struct adt7420_init_param {
pmallick 0:3afcd581558d 113 /* I2C */
pmallick 0:3afcd581558d 114 i2c_init_param i2c_init;
pmallick 0:3afcd581558d 115 /* Device Settings */
pmallick 0:3afcd581558d 116 uint8_t resolution_setting;
pmallick 0:3afcd581558d 117 };
pmallick 0:3afcd581558d 118
pmallick 0:3afcd581558d 119 /******************************************************************************/
pmallick 0:3afcd581558d 120 /************************ Functions Declarations ******************************/
pmallick 0:3afcd581558d 121 /******************************************************************************/
pmallick 0:3afcd581558d 122
pmallick 0:3afcd581558d 123 /*! Reads the value of a register. */
pmallick 0:3afcd581558d 124 uint8_t adt7420_get_register_value(struct adt7420_dev *dev,
pmallick 0:3afcd581558d 125 uint8_t register_address);
pmallick 0:3afcd581558d 126
pmallick 0:3afcd581558d 127 /*! Sets the value of a register. */
pmallick 0:3afcd581558d 128 void adt7420_set_register_value(struct adt7420_dev *dev,
pmallick 0:3afcd581558d 129 uint8_t register_address,
pmallick 0:3afcd581558d 130 uint8_t register_value);
pmallick 0:3afcd581558d 131
pmallick 0:3afcd581558d 132 /*! Initializes the comm. peripheral and checks if the device is present. */
pmallick 0:3afcd581558d 133 int32_t adt7420_init(struct adt7420_dev **device,
pmallick 0:3afcd581558d 134 struct adt7420_init_param init_param);
pmallick 0:3afcd581558d 135
pmallick 0:3afcd581558d 136 /* Free the resources allocated by adt7420_init(). */
pmallick 0:3afcd581558d 137 int32_t adt7420_remove(struct adt7420_dev *dev);
pmallick 0:3afcd581558d 138
pmallick 0:3afcd581558d 139 /*! Resets the ADT7420. */
pmallick 0:3afcd581558d 140 void adt7420_reset(struct adt7420_dev *dev);
pmallick 0:3afcd581558d 141
pmallick 0:3afcd581558d 142 /*! Sets the operational mode for ADT7420. */
pmallick 0:3afcd581558d 143 void adt7420_set_operation_mode(struct adt7420_dev *dev,
pmallick 0:3afcd581558d 144 uint8_t mode);
pmallick 0:3afcd581558d 145
pmallick 0:3afcd581558d 146 /*! Sets the resolution for ADT7420. */
pmallick 0:3afcd581558d 147 void adt7420_set_resolution(struct adt7420_dev *dev,
pmallick 0:3afcd581558d 148 uint8_t resolution);
pmallick 0:3afcd581558d 149
pmallick 0:3afcd581558d 150 /*! Reads the temperature data and converts it to Celsius degrees. */
pmallick 0:3afcd581558d 151 float adt7420_get_temperature(struct adt7420_dev *dev);
pmallick 0:3afcd581558d 152
pmallick 0:3afcd581558d 153 #endif /* __ADT7420_H__ */