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