Team Walter
MAX20303
Revision 1:0333f77c665f, committed 2018-04-25
- Comitter:
- Emre.Eken
- Date:
- Wed Apr 25 09:52:48 2018 +0300
- Parent:
- 0:ff4818eff240
- Commit message:
- The contents of the .cpp and .h files were changed
Changed in this revision
| MAX20303.cpp | Show annotated file Show diff for this revision Revisions of this file |
| MAX20303.h | Show annotated file Show diff for this revision Revisions of this file |
diff -r ff4818eff240 -r 0333f77c665f MAX20303.cpp
--- a/MAX20303.cpp Fri Jan 19 15:47:44 2018 -0800
+++ b/MAX20303.cpp Wed Apr 25 09:52:48 2018 +0300
@@ -1,160 +1,287 @@
-/*******************************************************************************
- * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included
- * in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
- * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
- * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- * OTHER DEALINGS IN THE SOFTWARE.
- *
- * Except as contained in this notice, the name of Maxim Integrated
- * Products, Inc. shall not be used except as stated in the Maxim Integrated
- * Products, Inc. Branding Policy.
- *
- * The mere transfer of this software does not imply any licenses
- * of trade secrets, proprietary technology, copyrights, patents,
- * trademarks, maskwork rights, or any other form of intellectual
- * property whatsoever. Maxim Integrated Products, Inc. retains all
- * ownership rights.
- *******************************************************************************
- */
-
-
-#include "MAX20303.h"
-#include "Peripherals.h"
-
-
-//******************************************************************************
-MAX20303::MAX20303(I2C *i2c):
- m_i2c(i2c), m_writeAddress(MAX20303_SLAVE_WR_ADDR),
- m_readAddress(MAX20303_SLAVE_RD_ADDR)
-{
-}
-
-
-//******************************************************************************
-MAX20303::~MAX20303(void)
-{
- //empty block
-}
-
-
-//******************************************************************************
-int MAX20303::LDO1Config()
-{
- int32_t ret = 0;
- uint8_t val;
- ret |= writeReg(MAX20303::REG_AP_CMDOUT, 0x40);
- ret |= writeReg(MAX20303::REG_AP_DATOUT0, 0x05);
- ret |= writeReg(MAX20303::REG_AP_DATOUT1, 0x34);
-
- readReg(MAX20303::REG_AP_CMDOUT, val);
- readReg(MAX20303::REG_AP_DATOUT0, val);
- readReg(MAX20303::REG_AP_DATOUT1, val);
-
- return ret;
-}
-
-//******************************************************************************
-int MAX20303::writeReg(registers_t reg, uint8_t value)
-{
- int32_t ret;
-
- char cmdData[2] = {reg, value};
-
- ret = m_i2c->write(m_writeAddress, cmdData, sizeof(cmdData));
- //printf("MAX20303 write reg[0x%X]=0x%X, ret=%d\r\n", (uint32_t)reg, value, ret)
-
- if (ret != 0)
- return MAX20303_ERROR;
-
- return MAX20303_NO_ERROR;
-}
-
-
-//******************************************************************************
-int MAX20303::readReg(registers_t reg, uint8_t &value)
-{
- int32_t ret;
-
- char data = reg;
-
- ret = m_i2c->write(m_writeAddress, &data, sizeof(data));
- if (ret != 0) {
- printf("%s - failed - ret: %d\n", __func__);
- return MAX20303_ERROR;
- }
-
- ret = m_i2c->read(m_readAddress, &data, sizeof(data));
- if (ret != 0) {
- printf("%s - failed - ret: %d\n", __func__);
- return MAX20303_ERROR;
- }
-
- value = data;
- printf("MAX20303 read reg[0x%X]=0x%X, ret=%d\r\n", (uint32_t)reg, value, ret);
- return MAX20303_NO_ERROR;
-}
-
-
-//******************************************************************************
-int MAX20303::mv2bits(int mV)
-{
- int regBits;
-
- if (( MAX20303_LDO_MIN_MV <= mV) && (mV <= MAX20303_LDO_MAX_MV)) {
- regBits = (mV - MAX20303_LDO_MIN_MV) / MAX20303_LDO_STEP_MV;
- } else {
- return -1;
- }
-
- return regBits;
-}
-
-int MAX20303::led0on(void) {
-
- writeReg(REG_LED0_DIRECT, 0x21);
-
- return MAX20303_NO_ERROR;
-}
-
-int MAX20303::BoostEnable(void) {
-
- writeReg(REG_AP_CMDOUT, 0x30);
- writeReg(REG_AP_DATOUT3, 0x00); // 00 : 5V
- writeReg(REG_AP_DATOUT0, 0x01); // Boost Enabled
-
- return MAX20303_NO_ERROR;
-}
-
-int MAX20303::BuckBoostEnable(void)
-{
- int ret = 0;
-
- ret |= writeReg( REG_AP_DATOUT0, 0x00); // Reserved = 0x00
- ret |= writeReg( REG_AP_DATOUT1, 0x04); // BBstlSet = 0b'100 Buck Boost Peak current Limit = 200mA
- ret |= writeReg( REG_AP_DATOUT2, 0x19); // BBstVSet = 0b'11001 Buck Boost Output Voltage = 5V
- ret |= writeReg( REG_AP_DATOUT3, 0x01); // BBstRipRed = 1 Ripple Reduction
- // BBstAct = 1 Actively discharged in Hard-Reset or Enable Low
- // BBstPas = 1 Passively discharged in Hard-Reset or Enable Low
- // BBstMd = 1 Damping Enabled
- // BBstInd = 0 Inductance is 4.7uH
- // BBstEn = 0b'01 Enabled
- ret |= writeReg( REG_AP_CMDOUT, 0x70);
- if (ret != 0)
- return MAX20303_ERROR;
-
- return MAX20303_NO_ERROR;
-}
+/*******************************************************************************
+ * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+ * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Except as contained in this notice, the name of Maxim Integrated
+ * Products, Inc. shall not be used except as stated in the Maxim Integrated
+ * Products, Inc. Branding Policy.
+ *
+ * The mere transfer of this software does not imply any licenses
+ * of trade secrets, proprietary technology, copyrights, patents,
+ * trademarks, maskwork rights, or any other form of intellectual
+ * property whatsoever. Maxim Integrated Products, Inc. retains all
+ * ownership rights.
+ *******************************************************************************
+ */
+
+
+#include "MAX20303.h"
+
+
+//******************************************************************************
+MAX20303::MAX20303(I2C *i2c):
+ m_i2c(i2c), m_writeAddress(MAX20303_SLAVE_WR_ADDR),
+ m_readAddress(MAX20303_SLAVE_RD_ADDR)
+{
+}
+
+
+//******************************************************************************
+MAX20303::~MAX20303(void)
+{
+ //empty block
+}
+
+
+//******************************************************************************
+int MAX20303::LDO1Config()
+{
+ int32_t ret = 0;
+ uint8_t val;
+ appcmdoutvalue_ = 0x40;
+ appdatainoutbuffer_[0] = 0x05;
+ appdatainoutbuffer_[1] = 0x34;
+ AppWrite(2);
+
+ return ret;
+}
+
+//******************************************************************************
+int MAX20303::writeReg(registers_t reg, uint8_t value)
+{
+ int32_t ret;
+
+ char cmdData[2] = {reg, value};
+
+ ret = m_i2c->write(m_writeAddress, cmdData, sizeof(cmdData));
+
+ if (ret != 0)
+ return MAX20303_ERROR;
+
+ return MAX20303_NO_ERROR;
+}
+
+
+//******************************************************************************
+int MAX20303::readReg(registers_t reg, uint8_t &value)
+{
+ int32_t ret;
+
+ char data = reg;
+
+ ret = m_i2c->write(m_writeAddress, &data, sizeof(data));
+ if (ret != 0) {
+ printf("%s - failed - ret: %d\n", __func__);
+ return MAX20303_ERROR;
+ }
+
+ ret = m_i2c->read(m_readAddress, &data, sizeof(data));
+ if (ret != 0) {
+ printf("%s - failed - ret: %d\n", __func__);
+ return MAX20303_ERROR;
+ }
+
+ value = data;
+ printf("MAX20303 read reg[0x%X]=0x%X, ret=%d\r\n", (uint32_t)reg, value, ret);
+ return MAX20303_NO_ERROR;
+}
+
+//******************************************************************************
+int MAX20303::readRegMulti(registers_t reg, uint8_t *value, uint8_t len){
+ int32_t ret;
+ char data = reg;
+
+ ret = m_i2c->write(m_writeAddress, &data, sizeof(data));
+ if (ret != 0) {
+ printf("%s - failed - ret: %d\n", __func__);
+ return MAX20303_ERROR;
+ }
+
+ ret = m_i2c->read(m_readAddress, (char *)value, len);
+ if (ret != 0) {
+ printf("%s - failed - ret: %d\n", __func__);
+ return MAX20303_ERROR;
+ }
+
+ printf("MAX20303 read reg[0x%X]=0x%X, ret=%d\r\n", (uint32_t)reg, value, ret);
+ return MAX20303_NO_ERROR;
+}
+
+//******************************************************************************
+int MAX20303::writeRegMulti(registers_t reg, uint8_t *value, uint8_t len){
+ int32_t ret;
+ i2cbuffer_[0] = reg;
+ memcpy(&i2cbuffer_[1], value, len);
+
+ ret = m_i2c->write(m_writeAddress, (char *)i2cbuffer_, (len+1));
+
+ if (ret != 0)
+ return MAX20303_ERROR;
+
+ return MAX20303_NO_ERROR;
+}
+//******************************************************************************
+int MAX20303::mv2bits(int mV)
+{
+ int regBits;
+
+ if (( MAX20303_LDO_MIN_MV <= mV) && (mV <= MAX20303_LDO_MAX_MV)) {
+ regBits = (mV - MAX20303_LDO_MIN_MV) / MAX20303_LDO_STEP_MV;
+ } else {
+ return -1;
+ }
+
+ return regBits;
+}
+//******************************************************************************
+int MAX20303::PowerOffthePMIC(){
+ int ret;
+ appdatainoutbuffer_[0] = 0xB2;
+ appcmdoutvalue_ = 0x80;
+ ret = AppWrite(1);
+
+ if(appcmdoutvalue_ != 0x80){
+ ret |= MAX20303_ERROR;
+ }
+
+ return ret;
+}
+//******************************************************************************
+int MAX20303::SoftResetthePMIC(){
+ int ret;
+ appdatainoutbuffer_[0] = 0xB3;
+ appcmdoutvalue_ = 0x81;
+ ret = AppWrite(1);
+
+ if(appcmdoutvalue_ != 0x81){
+ ret |= MAX20303_ERROR;
+ }
+
+ return ret;
+}
+//******************************************************************************
+int MAX20303::HardResetthePMIC(){
+ int ret;
+ appdatainoutbuffer_[0] = 0xB4;
+ appcmdoutvalue_ = 0x82;
+ ret = AppWrite(1);
+
+ if(appcmdoutvalue_ != 0x82){
+ ret |= MAX20303_ERROR;
+ }
+
+ return ret;
+}
+
+//******************************************************************************
+int MAX20303::AppWrite(uint8_t dataoutlen){
+ int ret;
+
+ ret = writeRegMulti(MAX20303::REG_AP_DATOUT0, appdatainoutbuffer_, dataoutlen);
+ ret |= writeReg(MAX20303::REG_AP_CMDOUT, appcmdoutvalue_);
+ wait_ms(10);
+ ret |= readReg(MAX20303::REG_AP_RESPONSE, appcmdoutvalue_);
+
+ if(ret != 0)
+ return MAX20303_ERROR;
+
+ return MAX20303_NO_ERROR;
+}
+
+
+//******************************************************************************
+int MAX20303::AppRead(uint8_t datainlen){
+ int ret;
+
+ ret = writeReg(MAX20303::REG_AP_CMDOUT, appcmdoutvalue_);
+ wait_ms(10);
+ ret |= readRegMulti(MAX20303::REG_AP_RESPONSE, i2cbuffer_, datainlen);
+ if(ret != 0)
+ return MAX20303_ERROR;
+
+ return MAX20303_NO_ERROR;
+}
+
+//******************************************************************************
+char MAX20303::CheckPMICHWID(){
+ int ret;
+ uint8_t value = 0x00;
+
+ ret = readReg(MAX20303::REG_HARDWARE_ID, value);
+ if(ret != MAX20303_NO_ERROR)
+ return false;
+
+ if(value == 0x02)
+ return true;
+ else
+ return false;
+}
+
+//******************************************************************************
+int MAX20303::led0on(char enable) {
+
+ if(enable)
+ return writeReg(REG_LED0_DIRECT, 0x21);
+ else
+ return writeReg(REG_LED0_DIRECT, 0x01);
+}
+
+//******************************************************************************
+int MAX20303::led1on(char enable) {
+ if(enable)
+ return writeReg(REG_LED1_DIRECT, 0x21);
+ else
+ return writeReg(REG_LED1_DIRECT, 0x01);
+}
+
+//******************************************************************************
+int MAX20303::led2on(char enable) {
+ if(enable)
+ return writeReg(REG_LED2_DIRECT, 0x21);
+ else
+ return writeReg(REG_LED2_DIRECT, 0x01);
+}
+
+
+//******************************************************************************
+int MAX20303::BoostEnable(void) {
+
+ writeReg(REG_AP_CMDOUT, 0x30);
+ writeReg(REG_AP_DATOUT3, 0x00); // 00 : 5V
+ writeReg(REG_AP_DATOUT0, 0x01); // Boost Enabled
+
+ return MAX20303_NO_ERROR;
+}
+
+//******************************************************************************
+int MAX20303::BuckBoostEnable(void)
+{
+ int ret = 0;
+
+ ret |= writeReg( REG_AP_DATOUT0, 0x00); // Reserved = 0x00
+ ret |= writeReg( REG_AP_DATOUT1, 0x04); // BBstlSet = 0b'100 Buck Boost Peak current Limit = 200mA
+ ret |= writeReg( REG_AP_DATOUT2, 0x19); // BBstVSet = 0b'11001 Buck Boost Output Voltage = 5V
+ ret |= writeReg( REG_AP_DATOUT3, 0x01); // BBstRipRed = 1 Ripple Reduction
+ ret |= writeReg( REG_AP_CMDOUT, 0x70);
+ if (ret != 0)
+ return MAX20303_ERROR;
+
+ return MAX20303_NO_ERROR;
+}
diff -r ff4818eff240 -r 0333f77c665f MAX20303.h
--- a/MAX20303.h Fri Jan 19 15:47:44 2018 -0800
+++ b/MAX20303.h Wed Apr 25 09:52:48 2018 +0300
@@ -1,163 +1,182 @@
-/*******************************************************************************
- * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included
- * in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
- * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
- * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- * OTHER DEALINGS IN THE SOFTWARE.
- *
- * Except as contained in this notice, the name of Maxim Integrated
- * Products, Inc. shall not be used except as stated in the Maxim Integrated
- * Products, Inc. Branding Policy.
- *
- * The mere transfer of this software does not imply any licenses
- * of trade secrets, proprietary technology, copyrights, patents,
- * trademarks, maskwork rights, or any other form of intellectual
- * property whatsoever. Maxim Integrated Products, Inc. retains all
- * ownership rights.
- *******************************************************************************
- */
-#ifndef __MAX20303_H_
-#define __MAX20303_H_
-
-#include "mbed.h"
-
-#define MAX20303_SLAVE_ADDR (0x50 >> 1)
-#define MAX20303_SLAVE_WR_ADDR ((MAX20303_SLAVE_ADDR << 1))
-#define MAX20303_SLAVE_RD_ADDR ((MAX20303_SLAVE_ADDR << 1) | 1)
-
-
-#define MAX20303_NO_ERROR 0
-#define MAX20303_ERROR -1
-
-#define MAX20303_I2C_ADDR_FUEL_GAUGE 0x6c
-
-#define MAX20303_LDO_MIN_MV 800
-#define MAX20303_LDO_MAX_MV 3600
-#define MAX20303_LDO_STEP_MV 100
-
-#define MAX20303_OFF_COMMAND 0xB2
-
-class MAX20303
-{
-
-public:
- /**
- * @brief Constructor using reference to I2C object
- * @param i2c - Reference to I2C object
- * @param slaveAddress - 7-bit I2C address
- */
- MAX20303(I2C *i2c);
-
- /** @brief Destructor */
- ~MAX20303(void);
-
- int led0on(void);
- int BoostEnable(void);
- int BuckBoostEnable(void);
-
- /** @brief Enable the 1.8V output rail **/
- int LDO1Config(void);
- int mv2bits(int mV);
-
-private:
- /**
- * @brief Register Addresses
- * @details Enumerated MAX20303 register addresses
- */
- enum registers_t {
- REG_HARDWARE_ID = 0x00, ///< HardwareID Register
- REG_FIRMWARE_REV = 0x01, ///< FirmwareID Register
- // = 0x02, ///<
- REG_INT0 = 0x03, ///< Int0 Register
- REG_INT1 = 0x04, ///< Int1 Register
- REG_INT2 = 0x05, ///< Int2 Register
- REG_STATUS0 = 0x06, ///< Status Register 0
- REG_STATUS1 = 0x07, ///< Status Register 1
- REG_STATUS2 = 0x08, ///< Status Register 2
- REG_STATUS3 = 0x09, ///< Status Register 2
- // = 0x0A, ///<
- REG_SYSTEM_ERROR = 0x0B, ///< SystemError Register
- REG_INT_MASK0 = 0x0C, ///< IntMask0 Register
- REG_INT_MASK1 = 0x0D, ///< IntMask1 Register
- REG_INT_MASK2 = 0x0E, ///< IntMask1 Register
- REG_AP_DATOUT0 = 0x0F, ///< APDataOut0 Register
- REG_AP_DATOUT1 = 0x10, ///< APDataOut1 Register
- REG_AP_DATOUT2 = 0x11, ///< APDataOut2 Register
- REG_AP_DATOUT3 = 0x12, ///< APDataOut3 Register
- REG_AP_DATOUT4 = 0x13, ///< APDataOut4 Register
- REG_AP_DATOUT5 = 0x14, ///< APDataOut5 Register
- REG_AP_DATOUT6 = 0x15, ///< APDataOut6 Register
- REG_AP_CMDOUT = 0x17, ///< APCmdOut Register
- REG_AP_RESPONSE = 0x18, ///< APResponse Register
- REG_AP_DATAIN0 = 0x19,
- REG_AP_DATAIN1 = 0x1A,
- REG_AP_DATAIN2 = 0x1B,
- REG_AP_DATAIN3 = 0x1C,
- REG_AP_DATAIN4 = 0x1D,
- REG_AP_DATAIN5 = 0x1E,
- // = 0x1F, ///<
- REG_LDO_DIRECT = 0x20,
- REG_MPC_DIRECTWRITE = 0x21,
- REG_MPC_DIRECTRED = 0x22,
-
- REG_LED_STEP_DIRECT = 0x2C,
- REG_LED0_DIRECT = 0x2D,
- REG_LED1_DIRECT = 0x2E,
- REG_LED2_DIRECT = 0x2F,
-
-
- REG_LDO1_CONFIG_WRITE = 0x40,
- REG_LDO1_CONFIG_READ = 0x41,
- REG_LDO2_CONFIG_WRITE = 0x42,
- REG_LDO2_CONFIG_READ = 0x43
-
- /*
- REG_CHG_TMR = 0x0C, ///< Charger Timers
- REG_BUCK1_CFG = 0x0D, ///< Buck 1 Configuration
- REG_BUCK1_VSET = 0x0E, ///< Buck 1 Voltage Setting
- REG_BUCK2_CFG = 0x0F, ///< Buck 2 Configuration
- REG_BUCK2_VSET = 0x10, ///< Buck 2 Voltage Setting
- REG_RSVD_11 = 0x11, ///< Reserved 0x11
- REG_LDO1_CFG = 0x12, ///< LDO 1 Configuration
- REG_LDO1_VSET = 0x13, ///< LDO 1 Voltage Setting
- REG_LDO2_CFG = 0x14, ///< LDO 2 Configuration
- REG_LDO2_VSET = 0x15, ///< LDO 2 Voltage Setting
- REG_LDO3_CFG = 0x16, ///< LDO 3 Configuration
- REG_LDO3_VSET = 0x17, ///< LDO 3 Voltage Setting
- REG_THRM_CFG = 0x18, ///< Thermistor Configuration
- REG_MON_CFG = 0x19, ///< Monitor Multiplexer Configuration
- REG_BOOT_CFG = 0x1A, ///< Boot Configuration
- REG_PIN_STATUS = 0x1B, ///< Pin Status
- REG_BUCK_EXTRA = 0x1C, ///< Additional Buck Settings
- REG_PWR_CFG = 0x1D, ///< Power Configuration
- REG_NULL = 0x1E, ///< Reserved 0x1E
- REG_PWR_OFF = 0x1F, ///< Power Off Register
- */
- };
-
-
- int writeReg(registers_t reg, uint8_t value);
- int readReg(registers_t reg, uint8_t &value);
-
- /// I2C object
- I2C *m_i2c;
-
- /// Device slave addresses
- uint8_t m_writeAddress, m_readAddress;
-};
-
-#endif /* __MAX20303_H_ */
+/*******************************************************************************
+ * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+ * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Except as contained in this notice, the name of Maxim Integrated
+ * Products, Inc. shall not be used except as stated in the Maxim Integrated
+ * Products, Inc. Branding Policy.
+ *
+ * The mere transfer of this software does not imply any licenses
+ * of trade secrets, proprietary technology, copyrights, patents,
+ * trademarks, maskwork rights, or any other form of intellectual
+ * property whatsoever. Maxim Integrated Products, Inc. retains all
+ * ownership rights.
+ *******************************************************************************
+ */
+#ifndef __MAX20303_H_
+#define __MAX20303_H_
+
+#include "mbed.h"
+
+#define MAX20303_SLAVE_ADDR (0x50 >> 1)
+#define MAX20303_SLAVE_WR_ADDR ((MAX20303_SLAVE_ADDR << 1))
+#define MAX20303_SLAVE_RD_ADDR ((MAX20303_SLAVE_ADDR << 1) | 1)
+
+
+#define MAX20303_NO_ERROR 0
+#define MAX20303_ERROR -1
+
+#define MAX20303_I2C_ADDR_FUEL_GAUGE 0x6c
+
+#define MAX20303_LDO_MIN_MV 800
+#define MAX20303_LDO_MAX_MV 3600
+#define MAX20303_LDO_STEP_MV 100
+
+#define MAX20303_OFF_COMMAND 0xB2
+
+class MAX20303
+{
+
+public:
+ /**
+ * @brief Register Addresses
+ * @details Enumerated MAX20303 register addresses
+ */
+ enum registers_t {
+ REG_HARDWARE_ID = 0x00, ///< HardwareID Register
+ REG_FIRMWARE_REV = 0x01, ///< FirmwareID Register
+ // = 0x02, ///<
+ REG_INT0 = 0x03, ///< Int0 Register
+ REG_INT1 = 0x04, ///< Int1 Register
+ REG_INT2 = 0x05, ///< Int2 Register
+ REG_STATUS0 = 0x06, ///< Status Register 0
+ REG_STATUS1 = 0x07, ///< Status Register 1
+ REG_STATUS2 = 0x08, ///< Status Register 2
+ REG_STATUS3 = 0x09, ///< Status Register 2
+ // = 0x0A, ///<
+ REG_SYSTEM_ERROR = 0x0B, ///< SystemError Register
+ REG_INT_MASK0 = 0x0C, ///< IntMask0 Register
+ REG_INT_MASK1 = 0x0D, ///< IntMask1 Register
+ REG_INT_MASK2 = 0x0E, ///< IntMask1 Register
+ REG_AP_DATOUT0 = 0x0F, ///< APDataOut0 Register
+ REG_AP_DATOUT1 = 0x10, ///< APDataOut1 Register
+ REG_AP_DATOUT2 = 0x11, ///< APDataOut2 Register
+ REG_AP_DATOUT3 = 0x12, ///< APDataOut3 Register
+ REG_AP_DATOUT4 = 0x13, ///< APDataOut4 Register
+ REG_AP_DATOUT5 = 0x14, ///< APDataOut5 Register
+ REG_AP_DATOUT6 = 0x15, ///< APDataOut6 Register
+ REG_AP_CMDOUT = 0x17, ///< APCmdOut Register
+ REG_AP_RESPONSE = 0x18, ///< APResponse Register
+ REG_AP_DATAIN0 = 0x19,
+ REG_AP_DATAIN1 = 0x1A,
+ REG_AP_DATAIN2 = 0x1B,
+ REG_AP_DATAIN3 = 0x1C,
+ REG_AP_DATAIN4 = 0x1D,
+ REG_AP_DATAIN5 = 0x1E,
+ // = 0x1F, ///<
+ REG_LDO_DIRECT = 0x20,
+ REG_MPC_DIRECTWRITE = 0x21,
+ REG_MPC_DIRECTRED = 0x22,
+
+ REG_LED_STEP_DIRECT = 0x2C,
+ REG_LED0_DIRECT = 0x2D,
+ REG_LED1_DIRECT = 0x2E,
+ REG_LED2_DIRECT = 0x2F,
+
+
+ REG_LDO1_CONFIG_WRITE = 0x40,
+ REG_LDO1_CONFIG_READ = 0x41,
+ REG_LDO2_CONFIG_WRITE = 0x42,
+ REG_LDO2_CONFIG_READ = 0x43
+ };
+
+ /**
+ * @brief Constructor using reference to I2C object
+ * @param i2c - Reference to I2C object
+ * @param slaveAddress - 7-bit I2C address
+ */
+ MAX20303(I2C *i2c);
+
+ /** @brief Destructor */
+ ~MAX20303(void);
+
+ int led0on(char enable);
+ int led1on(char enable);
+ int led2on(char enable);
+ int BoostEnable(void);
+ int BuckBoostEnable(void);
+
+ /// @brief Enable the 1.8V output rail **/
+ int LDO1Config(void);
+ int mv2bits(int mV);
+
+ /** @brief Power Off the board
+ */
+ int PowerOffthePMIC();
+
+ /** @brief Soft reset the PMIC
+ */
+ int SoftResetthePMIC();
+
+ /** @brief Hard reset the PMIC
+ */
+ int HardResetthePMIC();
+
+ /** @brief check if can communicate with max20303
+ */
+ char CheckPMICHWID();
+
+private:
+
+ int writeReg(registers_t reg, uint8_t value);
+ int readReg(registers_t reg, uint8_t &value);
+
+ int writeRegMulti(registers_t reg, uint8_t *value, uint8_t len);
+ int readRegMulti(registers_t reg, uint8_t *value, uint8_t len);
+
+ /// I2C object
+ I2C *m_i2c;
+
+ /// Device slave addresses
+ uint8_t m_writeAddress, m_readAddress;
+
+ // Application Processor Interface Related Variables
+ uint8_t i2cbuffer_[16];
+ uint8_t appdatainoutbuffer_[8];
+ uint8_t appcmdoutvalue_;
+
+
+ /** @brief API Related Functions ***/
+
+ /***
+ * @brief starts writing from ApResponse register 0x0F
+ * check the datasheet to determine the value of dataoutlen
+ */
+ int AppWrite(uint8_t dataoutlen);
+
+ /** @brief starts reading from ApResponse register 0x18
+ * check the datasheet to determine the value of datainlen
+ * the result values are written into i2cbuffer
+ *
+ */
+ int AppRead(uint8_t datainlen);
+};
+
+#endif /* __MAX20303_H_ */