mehmet gok / HSPdemoUtils

Utility library for HSP SPo2 HR demo including user interface, board support adn accelerometer.

demoPlatform/MAX20303.h@0:a12d6976d64c, 2018-12-17 (annotated)

Committer:
gmehmet
Date:
Mon Dec 17 13:58:56 2018 +0300
Revision:
0:a12d6976d64c
create and put source to HSP demo utility repo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gmehmet 0:a12d6976d64c 1 /*******************************************************************************
gmehmet 0:a12d6976d64c 2 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
gmehmet 0:a12d6976d64c 3 *
gmehmet 0:a12d6976d64c 4 * Permission is hereby granted, free of charge, to any person obtaining a
gmehmet 0:a12d6976d64c 5 * copy of this software and associated documentation files (the "Software"),
gmehmet 0:a12d6976d64c 6 * to deal in the Software without restriction, including without limitation
gmehmet 0:a12d6976d64c 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
gmehmet 0:a12d6976d64c 8 * and/or sell copies of the Software, and to permit persons to whom the
gmehmet 0:a12d6976d64c 9 * Software is furnished to do so, subject to the following conditions:
gmehmet 0:a12d6976d64c 10 *
gmehmet 0:a12d6976d64c 11 * The above copyright notice and this permission notice shall be included
gmehmet 0:a12d6976d64c 12 * in all copies or substantial portions of the Software.
gmehmet 0:a12d6976d64c 13 *
gmehmet 0:a12d6976d64c 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
gmehmet 0:a12d6976d64c 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
gmehmet 0:a12d6976d64c 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
gmehmet 0:a12d6976d64c 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
gmehmet 0:a12d6976d64c 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
gmehmet 0:a12d6976d64c 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
gmehmet 0:a12d6976d64c 20 * OTHER DEALINGS IN THE SOFTWARE.
gmehmet 0:a12d6976d64c 21 *
gmehmet 0:a12d6976d64c 22 * Except as contained in this notice, the name of Maxim Integrated
gmehmet 0:a12d6976d64c 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
gmehmet 0:a12d6976d64c 24 * Products, Inc. Branding Policy.
gmehmet 0:a12d6976d64c 25 *
gmehmet 0:a12d6976d64c 26 * The mere transfer of this software does not imply any licenses
gmehmet 0:a12d6976d64c 27 * of trade secrets, proprietary technology, copyrights, patents,
gmehmet 0:a12d6976d64c 28 * trademarks, maskwork rights, or any other form of intellectual
gmehmet 0:a12d6976d64c 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
gmehmet 0:a12d6976d64c 30 * ownership rights.
gmehmet 0:a12d6976d64c 31 *******************************************************************************
gmehmet 0:a12d6976d64c 32 */
gmehmet 0:a12d6976d64c 33 #ifndef __MAX20303_H_
gmehmet 0:a12d6976d64c 34 #define __MAX20303_H_
gmehmet 0:a12d6976d64c 35
gmehmet 0:a12d6976d64c 36 #include "mbed.h"
gmehmet 0:a12d6976d64c 37
gmehmet 0:a12d6976d64c 38 #define MAX20303_SLAVE_ADDR (0x50 >> 1)
gmehmet 0:a12d6976d64c 39 #define MAX20303_SLAVE_WR_ADDR ((MAX20303_SLAVE_ADDR << 1))
gmehmet 0:a12d6976d64c 40 #define MAX20303_SLAVE_RD_ADDR ((MAX20303_SLAVE_ADDR << 1) | 1)
gmehmet 0:a12d6976d64c 41
gmehmet 0:a12d6976d64c 42
gmehmet 0:a12d6976d64c 43 #define MAX20303_NO_ERROR 0
gmehmet 0:a12d6976d64c 44 #define MAX20303_ERROR -1
gmehmet 0:a12d6976d64c 45
gmehmet 0:a12d6976d64c 46 #define MAX20303_I2C_ADDR_FUEL_GAUGE 0x6c
gmehmet 0:a12d6976d64c 47 #define MAX20303_I2C_ADDR_FUEL_GAUGE 0x6C
gmehmet 0:a12d6976d64c 48
gmehmet 0:a12d6976d64c 49 #define MAX20303_LDO_MIN_MV 800
gmehmet 0:a12d6976d64c 50 #define MAX20303_LDO_MAX_MV 3600
gmehmet 0:a12d6976d64c 51 #define MAX20303_LDO_STEP_MV 100
gmehmet 0:a12d6976d64c 52
gmehmet 0:a12d6976d64c 53 #define MAX20303_OFF_COMMAND 0xB2
gmehmet 0:a12d6976d64c 54
gmehmet 0:a12d6976d64c 55 class MAX20303
gmehmet 0:a12d6976d64c 56 {
gmehmet 0:a12d6976d64c 57
gmehmet 0:a12d6976d64c 58 public:
gmehmet 0:a12d6976d64c 59 /**
gmehmet 0:a12d6976d64c 60 * @brief Register Addresses
gmehmet 0:a12d6976d64c 61 * @details Enumerated MAX20303 register addresses
gmehmet 0:a12d6976d64c 62 */
gmehmet 0:a12d6976d64c 63 enum registers_t {
gmehmet 0:a12d6976d64c 64 REG_HARDWARE_ID = 0x00, ///< HardwareID Register
gmehmet 0:a12d6976d64c 65 REG_FIRMWARE_REV = 0x01, ///< FirmwareID Register
gmehmet 0:a12d6976d64c 66 // = 0x02, ///<
gmehmet 0:a12d6976d64c 67 REG_INT0 = 0x03, ///< Int0 Register
gmehmet 0:a12d6976d64c 68 REG_INT1 = 0x04, ///< Int1 Register
gmehmet 0:a12d6976d64c 69 REG_INT2 = 0x05, ///< Int2 Register
gmehmet 0:a12d6976d64c 70 REG_STATUS0 = 0x06, ///< Status Register 0
gmehmet 0:a12d6976d64c 71 REG_STATUS1 = 0x07, ///< Status Register 1
gmehmet 0:a12d6976d64c 72 REG_STATUS2 = 0x08, ///< Status Register 2
gmehmet 0:a12d6976d64c 73 REG_STATUS3 = 0x09, ///< Status Register 2
gmehmet 0:a12d6976d64c 74 // = 0x0A, ///<
gmehmet 0:a12d6976d64c 75 REG_SYSTEM_ERROR = 0x0B, ///< SystemError Register
gmehmet 0:a12d6976d64c 76 REG_INT_MASK0 = 0x0C, ///< IntMask0 Register
gmehmet 0:a12d6976d64c 77 REG_INT_MASK1 = 0x0D, ///< IntMask1 Register
gmehmet 0:a12d6976d64c 78 REG_INT_MASK2 = 0x0E, ///< IntMask1 Register
gmehmet 0:a12d6976d64c 79 REG_AP_DATOUT0 = 0x0F, ///< APDataOut0 Register
gmehmet 0:a12d6976d64c 80 REG_AP_DATOUT1 = 0x10, ///< APDataOut1 Register
gmehmet 0:a12d6976d64c 81 REG_AP_DATOUT2 = 0x11, ///< APDataOut2 Register
gmehmet 0:a12d6976d64c 82 REG_AP_DATOUT3 = 0x12, ///< APDataOut3 Register
gmehmet 0:a12d6976d64c 83 REG_AP_DATOUT4 = 0x13, ///< APDataOut4 Register
gmehmet 0:a12d6976d64c 84 REG_AP_DATOUT5 = 0x14, ///< APDataOut5 Register
gmehmet 0:a12d6976d64c 85 REG_AP_DATOUT6 = 0x15, ///< APDataOut6 Register
gmehmet 0:a12d6976d64c 86 REG_AP_CMDOUT = 0x17, ///< APCmdOut Register
gmehmet 0:a12d6976d64c 87 REG_AP_RESPONSE = 0x18, ///< APResponse Register
gmehmet 0:a12d6976d64c 88 REG_AP_DATAIN0 = 0x19,
gmehmet 0:a12d6976d64c 89 REG_AP_DATAIN1 = 0x1A,
gmehmet 0:a12d6976d64c 90 REG_AP_DATAIN2 = 0x1B,
gmehmet 0:a12d6976d64c 91 REG_AP_DATAIN3 = 0x1C,
gmehmet 0:a12d6976d64c 92 REG_AP_DATAIN4 = 0x1D,
gmehmet 0:a12d6976d64c 93 REG_AP_DATAIN5 = 0x1E,
gmehmet 0:a12d6976d64c 94 // = 0x1F, ///<
gmehmet 0:a12d6976d64c 95 REG_LDO_DIRECT = 0x20,
gmehmet 0:a12d6976d64c 96 REG_MPC_DIRECTWRITE = 0x21,
gmehmet 0:a12d6976d64c 97 REG_MPC_DIRECTRED = 0x22,
gmehmet 0:a12d6976d64c 98
gmehmet 0:a12d6976d64c 99 REG_LED_STEP_DIRECT = 0x2C,
gmehmet 0:a12d6976d64c 100 REG_LED0_DIRECT = 0x2D,
gmehmet 0:a12d6976d64c 101 REG_LED1_DIRECT = 0x2E,
gmehmet 0:a12d6976d64c 102 REG_LED2_DIRECT = 0x2F,
gmehmet 0:a12d6976d64c 103
gmehmet 0:a12d6976d64c 104
gmehmet 0:a12d6976d64c 105 REG_LDO1_CONFIG_WRITE = 0x40,
gmehmet 0:a12d6976d64c 106 REG_LDO1_CONFIG_READ = 0x41,
gmehmet 0:a12d6976d64c 107 REG_LDO2_CONFIG_WRITE = 0x42,
gmehmet 0:a12d6976d64c 108 REG_LDO2_CONFIG_READ = 0x43
gmehmet 0:a12d6976d64c 109
gmehmet 0:a12d6976d64c 110 /*
gmehmet 0:a12d6976d64c 111 REG_CHG_TMR = 0x0C, ///< Charger Timers
gmehmet 0:a12d6976d64c 112 REG_BUCK1_CFG = 0x0D, ///< Buck 1 Configuration
gmehmet 0:a12d6976d64c 113 REG_BUCK1_VSET = 0x0E, ///< Buck 1 Voltage Setting
gmehmet 0:a12d6976d64c 114 REG_BUCK2_CFG = 0x0F, ///< Buck 2 Configuration
gmehmet 0:a12d6976d64c 115 REG_BUCK2_VSET = 0x10, ///< Buck 2 Voltage Setting
gmehmet 0:a12d6976d64c 116 REG_RSVD_11 = 0x11, ///< Reserved 0x11
gmehmet 0:a12d6976d64c 117 REG_LDO1_CFG = 0x12, ///< LDO 1 Configuration
gmehmet 0:a12d6976d64c 118 REG_LDO1_VSET = 0x13, ///< LDO 1 Voltage Setting
gmehmet 0:a12d6976d64c 119 REG_LDO2_CFG = 0x14, ///< LDO 2 Configuration
gmehmet 0:a12d6976d64c 120 REG_LDO2_VSET = 0x15, ///< LDO 2 Voltage Setting
gmehmet 0:a12d6976d64c 121 REG_LDO3_CFG = 0x16, ///< LDO 3 Configuration
gmehmet 0:a12d6976d64c 122 REG_LDO3_VSET = 0x17, ///< LDO 3 Voltage Setting
gmehmet 0:a12d6976d64c 123 REG_THRM_CFG = 0x18, ///< Thermistor Configuration
gmehmet 0:a12d6976d64c 124 REG_MON_CFG = 0x19, ///< Monitor Multiplexer Configuration
gmehmet 0:a12d6976d64c 125 REG_BOOT_CFG = 0x1A, ///< Boot Configuration
gmehmet 0:a12d6976d64c 126 REG_PIN_STATUS = 0x1B, ///< Pin Status
gmehmet 0:a12d6976d64c 127 REG_BUCK_EXTRA = 0x1C, ///< Additional Buck Settings
gmehmet 0:a12d6976d64c 128 REG_PWR_CFG = 0x1D, ///< Power Configuration
gmehmet 0:a12d6976d64c 129 REG_NULL = 0x1E, ///< Reserved 0x1E
gmehmet 0:a12d6976d64c 130 REG_PWR_OFF = 0x1F, ///< Power Off Register
gmehmet 0:a12d6976d64c 131 */
gmehmet 0:a12d6976d64c 132 };
gmehmet 0:a12d6976d64c 133
gmehmet 0:a12d6976d64c 134 /**
gmehmet 0:a12d6976d64c 135 * @brief Constructor using reference to I2C object
gmehmet 0:a12d6976d64c 136 * @param i2c - Reference to I2C object
gmehmet 0:a12d6976d64c 137 * @param slaveAddress - 7-bit I2C address
gmehmet 0:a12d6976d64c 138 */
gmehmet 0:a12d6976d64c 139 MAX20303(I2C *i2c);
gmehmet 0:a12d6976d64c 140
gmehmet 0:a12d6976d64c 141 /** @brief Destructor */
gmehmet 0:a12d6976d64c 142 ~MAX20303(void);
gmehmet 0:a12d6976d64c 143
gmehmet 0:a12d6976d64c 144 int led0on(char enable);
gmehmet 0:a12d6976d64c 145 int led1on(char enable);
gmehmet 0:a12d6976d64c 146 int led2on(char enable);
gmehmet 0:a12d6976d64c 147 int BoostEnable(void);
gmehmet 0:a12d6976d64c 148 int BuckBoostEnable(void);
gmehmet 0:a12d6976d64c 149
gmehmet 0:a12d6976d64c 150 /// @brief Enable the 1.8V output rail **/
gmehmet 0:a12d6976d64c 151 int LDO1Config(void);
gmehmet 0:a12d6976d64c 152
gmehmet 0:a12d6976d64c 153 /// @brief Enable the 3V output rail **/
gmehmet 0:a12d6976d64c 154 int LDO2Config(void);
gmehmet 0:a12d6976d64c 155
gmehmet 0:a12d6976d64c 156
gmehmet 0:a12d6976d64c 157 int mv2bits(int mV);
gmehmet 0:a12d6976d64c 158
gmehmet 0:a12d6976d64c 159 /** @brief Power Off the board
gmehmet 0:a12d6976d64c 160 */
gmehmet 0:a12d6976d64c 161 int PowerOffthePMIC();
gmehmet 0:a12d6976d64c 162
gmehmet 0:a12d6976d64c 163 /** @brief Power Off the board with 30ms delay
gmehmet 0:a12d6976d64c 164 */
gmehmet 0:a12d6976d64c 165 int PowerOffDelaythePMIC();
gmehmet 0:a12d6976d64c 166
gmehmet 0:a12d6976d64c 167 /** @brief Soft reset the PMIC
gmehmet 0:a12d6976d64c 168 */
gmehmet 0:a12d6976d64c 169 int SoftResetthePMIC();
gmehmet 0:a12d6976d64c 170
gmehmet 0:a12d6976d64c 171 /** @brief Hard reset the PMIC
gmehmet 0:a12d6976d64c 172 */
gmehmet 0:a12d6976d64c 173 int HardResetthePMIC();
gmehmet 0:a12d6976d64c 174
gmehmet 0:a12d6976d64c 175 /** @brief check if can communicate with max20303
gmehmet 0:a12d6976d64c 176 */
gmehmet 0:a12d6976d64c 177 char CheckPMICHWID();
gmehmet 0:a12d6976d64c 178
gmehmet 0:a12d6976d64c 179 /** @brief CheckPMICStatusRegisters
gmehmet 0:a12d6976d64c 180 */
gmehmet 0:a12d6976d64c 181 int CheckPMICStatusRegisters(unsigned char buf_results[5]);
gmehmet 0:a12d6976d64c 182
gmehmet 0:a12d6976d64c 183 int Max20303_BatteryGauge(unsigned char *batterylevel);
gmehmet 0:a12d6976d64c 184
gmehmet 0:a12d6976d64c 185 private:
gmehmet 0:a12d6976d64c 186
gmehmet 0:a12d6976d64c 187 int writeReg(registers_t reg, uint8_t value);
gmehmet 0:a12d6976d64c 188 int readReg(registers_t reg, uint8_t &value);
gmehmet 0:a12d6976d64c 189
gmehmet 0:a12d6976d64c 190 int writeRegMulti(registers_t reg, uint8_t *value, uint8_t len);
gmehmet 0:a12d6976d64c 191 int readRegMulti(registers_t reg, uint8_t *value, uint8_t len);
gmehmet 0:a12d6976d64c 192
gmehmet 0:a12d6976d64c 193 /// I2C object
gmehmet 0:a12d6976d64c 194 I2C *m_i2c;
gmehmet 0:a12d6976d64c 195
gmehmet 0:a12d6976d64c 196 /// Device slave addresses
gmehmet 0:a12d6976d64c 197 uint8_t m_writeAddress, m_readAddress;
gmehmet 0:a12d6976d64c 198
gmehmet 0:a12d6976d64c 199 // Application Processor Interface Related Variables
gmehmet 0:a12d6976d64c 200 uint8_t i2cbuffer_[16];
gmehmet 0:a12d6976d64c 201 uint8_t appdatainoutbuffer_[8];
gmehmet 0:a12d6976d64c 202 uint8_t appcmdoutvalue_;
gmehmet 0:a12d6976d64c 203
gmehmet 0:a12d6976d64c 204
gmehmet 0:a12d6976d64c 205 /** @brief API Related Functions ***/
gmehmet 0:a12d6976d64c 206
gmehmet 0:a12d6976d64c 207 /***
gmehmet 0:a12d6976d64c 208 * @brief starts writing from ApResponse register 0x0F
gmehmet 0:a12d6976d64c 209 * check the datasheet to determine the value of dataoutlen
gmehmet 0:a12d6976d64c 210 */
gmehmet 0:a12d6976d64c 211 int AppWrite(uint8_t dataoutlen);
gmehmet 0:a12d6976d64c 212
gmehmet 0:a12d6976d64c 213 /** @brief starts reading from ApResponse register 0x18
gmehmet 0:a12d6976d64c 214 * check the datasheet to determine the value of datainlen
gmehmet 0:a12d6976d64c 215 * the result values are written into i2cbuffer
gmehmet 0:a12d6976d64c 216 *
gmehmet 0:a12d6976d64c 217 */
gmehmet 0:a12d6976d64c 218 int AppRead(uint8_t datainlen);
gmehmet 0:a12d6976d64c 219 };
gmehmet 0:a12d6976d64c 220
gmehmet 0:a12d6976d64c 221 #endif /* __MAX20303_H_ */