Seyhmus Cacina / max20303

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of max20303 by Maxim Integrated

MAX20303.h@1:d85b06dc60a3, 2018-01-25 (annotated)

Committer:
seyhmuscacina
Date:
Thu Jan 25 15:31:43 2018 +0300
Revision:
1:d85b06dc60a3
Parent:
0:ff4818eff240
Child:
2:39e05cf7ef7d
updates max20303 library:



- added support for hard, soft reset

- removed external dependencies

- Application processor read and write functions added

Who changed what in which revision?

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