mehmet gok / max32630hsp

max32630 icarus board support library

MAX20303.h@2:5da03fb73b5b, 2018-12-17 (annotated)

Committer:
gmehmet
Date:
Mon Dec 17 10:40:37 2018 +0000
Revision:
2:5da03fb73b5b
Parent:
1:ad243e13fa3d 
lib removed

Who changed what in which revision?

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