Maxim Integrated / max20303

The MAX20303 is a highly integrated and programmable power management solution designed for ultra-low-power wearable applications.

Dependents:   MAX20303_Wearable_PMIC_Activity_Tracker MAX20303_Wearable_PMIC_Activity_Tracker

MAX20303 Wearable PMIC

MAX20303 Product Page

MAX20303.cpp@0:ff4818eff240, 2018-01-19 (annotated)

Committer:
Ismail Kose
Date:
Fri Jan 19 15:47:44 2018 -0800
Revision:
0:ff4818eff240
Child:
1:0333f77c665f
Add initial max20303 pmic library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Ismail Kose 0:ff4818eff240 1 /*******************************************************************************
Ismail Kose 0:ff4818eff240 2 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
Ismail Kose 0:ff4818eff240 3 *
Ismail Kose 0:ff4818eff240 4 * Permission is hereby granted, free of charge, to any person obtaining a
Ismail Kose 0:ff4818eff240 5 * copy of this software and associated documentation files (the "Software"),
Ismail Kose 0:ff4818eff240 6 * to deal in the Software without restriction, including without limitation
Ismail Kose 0:ff4818eff240 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Ismail Kose 0:ff4818eff240 8 * and/or sell copies of the Software, and to permit persons to whom the
Ismail Kose 0:ff4818eff240 9 * Software is furnished to do so, subject to the following conditions:
Ismail Kose 0:ff4818eff240 10 *
Ismail Kose 0:ff4818eff240 11 * The above copyright notice and this permission notice shall be included
Ismail Kose 0:ff4818eff240 12 * in all copies or substantial portions of the Software.
Ismail Kose 0:ff4818eff240 13 *
Ismail Kose 0:ff4818eff240 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Ismail Kose 0:ff4818eff240 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Ismail Kose 0:ff4818eff240 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Ismail Kose 0:ff4818eff240 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Ismail Kose 0:ff4818eff240 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Ismail Kose 0:ff4818eff240 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Ismail Kose 0:ff4818eff240 20 * OTHER DEALINGS IN THE SOFTWARE.
Ismail Kose 0:ff4818eff240 21 *
Ismail Kose 0:ff4818eff240 22 * Except as contained in this notice, the name of Maxim Integrated
Ismail Kose 0:ff4818eff240 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Ismail Kose 0:ff4818eff240 24 * Products, Inc. Branding Policy.
Ismail Kose 0:ff4818eff240 25 *
Ismail Kose 0:ff4818eff240 26 * The mere transfer of this software does not imply any licenses
Ismail Kose 0:ff4818eff240 27 * of trade secrets, proprietary technology, copyrights, patents,
Ismail Kose 0:ff4818eff240 28 * trademarks, maskwork rights, or any other form of intellectual
Ismail Kose 0:ff4818eff240 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
Ismail Kose 0:ff4818eff240 30 * ownership rights.
Ismail Kose 0:ff4818eff240 31 *******************************************************************************
Ismail Kose 0:ff4818eff240 32 */
Ismail Kose 0:ff4818eff240 33
Ismail Kose 0:ff4818eff240 34
Ismail Kose 0:ff4818eff240 35 #include "MAX20303.h"
Ismail Kose 0:ff4818eff240 36 #include "Peripherals.h"
Ismail Kose 0:ff4818eff240 37
Ismail Kose 0:ff4818eff240 38
Ismail Kose 0:ff4818eff240 39 //******************************************************************************
Ismail Kose 0:ff4818eff240 40 MAX20303::MAX20303(I2C *i2c):
Ismail Kose 0:ff4818eff240 41 m_i2c(i2c), m_writeAddress(MAX20303_SLAVE_WR_ADDR),
Ismail Kose 0:ff4818eff240 42 m_readAddress(MAX20303_SLAVE_RD_ADDR)
Ismail Kose 0:ff4818eff240 43 {
Ismail Kose 0:ff4818eff240 44 }
Ismail Kose 0:ff4818eff240 45
Ismail Kose 0:ff4818eff240 46
Ismail Kose 0:ff4818eff240 47 //******************************************************************************
Ismail Kose 0:ff4818eff240 48 MAX20303::~MAX20303(void)
Ismail Kose 0:ff4818eff240 49 {
Ismail Kose 0:ff4818eff240 50 //empty block
Ismail Kose 0:ff4818eff240 51 }
Ismail Kose 0:ff4818eff240 52
Ismail Kose 0:ff4818eff240 53
Ismail Kose 0:ff4818eff240 54 //******************************************************************************
Ismail Kose 0:ff4818eff240 55 int MAX20303::LDO1Config()
Ismail Kose 0:ff4818eff240 56 {
Ismail Kose 0:ff4818eff240 57 int32_t ret = 0;
Ismail Kose 0:ff4818eff240 58 uint8_t val;
Ismail Kose 0:ff4818eff240 59 ret |= writeReg(MAX20303::REG_AP_CMDOUT, 0x40);
Ismail Kose 0:ff4818eff240 60 ret |= writeReg(MAX20303::REG_AP_DATOUT0, 0x05);
Ismail Kose 0:ff4818eff240 61 ret |= writeReg(MAX20303::REG_AP_DATOUT1, 0x34);
Ismail Kose 0:ff4818eff240 62
Ismail Kose 0:ff4818eff240 63 readReg(MAX20303::REG_AP_CMDOUT, val);
Ismail Kose 0:ff4818eff240 64 readReg(MAX20303::REG_AP_DATOUT0, val);
Ismail Kose 0:ff4818eff240 65 readReg(MAX20303::REG_AP_DATOUT1, val);
Ismail Kose 0:ff4818eff240 66
Ismail Kose 0:ff4818eff240 67 return ret;
Ismail Kose 0:ff4818eff240 68 }
Ismail Kose 0:ff4818eff240 69
Ismail Kose 0:ff4818eff240 70 //******************************************************************************
Ismail Kose 0:ff4818eff240 71 int MAX20303::writeReg(registers_t reg, uint8_t value)
Ismail Kose 0:ff4818eff240 72 {
Ismail Kose 0:ff4818eff240 73 int32_t ret;
Ismail Kose 0:ff4818eff240 74
Ismail Kose 0:ff4818eff240 75 char cmdData[2] = {reg, value};
Ismail Kose 0:ff4818eff240 76
Ismail Kose 0:ff4818eff240 77 ret = m_i2c->write(m_writeAddress, cmdData, sizeof(cmdData));
Ismail Kose 0:ff4818eff240 78 //printf("MAX20303 write reg[0x%X]=0x%X, ret=%d\r\n", (uint32_t)reg, value, ret)
Ismail Kose 0:ff4818eff240 79
Ismail Kose 0:ff4818eff240 80 if (ret != 0)
Ismail Kose 0:ff4818eff240 81 return MAX20303_ERROR;
Ismail Kose 0:ff4818eff240 82
Ismail Kose 0:ff4818eff240 83 return MAX20303_NO_ERROR;
Ismail Kose 0:ff4818eff240 84 }
Ismail Kose 0:ff4818eff240 85
Ismail Kose 0:ff4818eff240 86
Ismail Kose 0:ff4818eff240 87 //******************************************************************************
Ismail Kose 0:ff4818eff240 88 int MAX20303::readReg(registers_t reg, uint8_t &value)
Ismail Kose 0:ff4818eff240 89 {
Ismail Kose 0:ff4818eff240 90 int32_t ret;
Ismail Kose 0:ff4818eff240 91
Ismail Kose 0:ff4818eff240 92 char data = reg;
Ismail Kose 0:ff4818eff240 93
Ismail Kose 0:ff4818eff240 94 ret = m_i2c->write(m_writeAddress, &data, sizeof(data));
Ismail Kose 0:ff4818eff240 95 if (ret != 0) {
Ismail Kose 0:ff4818eff240 96 printf("%s - failed - ret: %d\n", __func__);
Ismail Kose 0:ff4818eff240 97 return MAX20303_ERROR;
Ismail Kose 0:ff4818eff240 98 }
Ismail Kose 0:ff4818eff240 99
Ismail Kose 0:ff4818eff240 100 ret = m_i2c->read(m_readAddress, &data, sizeof(data));
Ismail Kose 0:ff4818eff240 101 if (ret != 0) {
Ismail Kose 0:ff4818eff240 102 printf("%s - failed - ret: %d\n", __func__);
Ismail Kose 0:ff4818eff240 103 return MAX20303_ERROR;
Ismail Kose 0:ff4818eff240 104 }
Ismail Kose 0:ff4818eff240 105
Ismail Kose 0:ff4818eff240 106 value = data;
Ismail Kose 0:ff4818eff240 107 printf("MAX20303 read reg[0x%X]=0x%X, ret=%d\r\n", (uint32_t)reg, value, ret);
Ismail Kose 0:ff4818eff240 108 return MAX20303_NO_ERROR;
Ismail Kose 0:ff4818eff240 109 }
Ismail Kose 0:ff4818eff240 110
Ismail Kose 0:ff4818eff240 111
Ismail Kose 0:ff4818eff240 112 //******************************************************************************
Ismail Kose 0:ff4818eff240 113 int MAX20303::mv2bits(int mV)
Ismail Kose 0:ff4818eff240 114 {
Ismail Kose 0:ff4818eff240 115 int regBits;
Ismail Kose 0:ff4818eff240 116
Ismail Kose 0:ff4818eff240 117 if (( MAX20303_LDO_MIN_MV <= mV) && (mV <= MAX20303_LDO_MAX_MV)) {
Ismail Kose 0:ff4818eff240 118 regBits = (mV - MAX20303_LDO_MIN_MV) / MAX20303_LDO_STEP_MV;
Ismail Kose 0:ff4818eff240 119 } else {
Ismail Kose 0:ff4818eff240 120 return -1;
Ismail Kose 0:ff4818eff240 121 }
Ismail Kose 0:ff4818eff240 122
Ismail Kose 0:ff4818eff240 123 return regBits;
Ismail Kose 0:ff4818eff240 124 }
Ismail Kose 0:ff4818eff240 125
Ismail Kose 0:ff4818eff240 126 int MAX20303::led0on(void) {
Ismail Kose 0:ff4818eff240 127
Ismail Kose 0:ff4818eff240 128 writeReg(REG_LED0_DIRECT, 0x21);
Ismail Kose 0:ff4818eff240 129
Ismail Kose 0:ff4818eff240 130 return MAX20303_NO_ERROR;
Ismail Kose 0:ff4818eff240 131 }
Ismail Kose 0:ff4818eff240 132
Ismail Kose 0:ff4818eff240 133 int MAX20303::BoostEnable(void) {
Ismail Kose 0:ff4818eff240 134
Ismail Kose 0:ff4818eff240 135 writeReg(REG_AP_CMDOUT, 0x30);
Ismail Kose 0:ff4818eff240 136 writeReg(REG_AP_DATOUT3, 0x00); // 00 : 5V
Ismail Kose 0:ff4818eff240 137 writeReg(REG_AP_DATOUT0, 0x01); // Boost Enabled
Ismail Kose 0:ff4818eff240 138
Ismail Kose 0:ff4818eff240 139 return MAX20303_NO_ERROR;
Ismail Kose 0:ff4818eff240 140 }
Ismail Kose 0:ff4818eff240 141
Ismail Kose 0:ff4818eff240 142 int MAX20303::BuckBoostEnable(void)
Ismail Kose 0:ff4818eff240 143 {
Ismail Kose 0:ff4818eff240 144 int ret = 0;
Ismail Kose 0:ff4818eff240 145
Ismail Kose 0:ff4818eff240 146 ret |= writeReg( REG_AP_DATOUT0, 0x00); // Reserved = 0x00
Ismail Kose 0:ff4818eff240 147 ret |= writeReg( REG_AP_DATOUT1, 0x04); // BBstlSet = 0b'100 Buck Boost Peak current Limit = 200mA
Ismail Kose 0:ff4818eff240 148 ret |= writeReg( REG_AP_DATOUT2, 0x19); // BBstVSet = 0b'11001 Buck Boost Output Voltage = 5V
Ismail Kose 0:ff4818eff240 149 ret |= writeReg( REG_AP_DATOUT3, 0x01); // BBstRipRed = 1 Ripple Reduction
Ismail Kose 0:ff4818eff240 150 // BBstAct = 1 Actively discharged in Hard-Reset or Enable Low
Ismail Kose 0:ff4818eff240 151 // BBstPas = 1 Passively discharged in Hard-Reset or Enable Low
Ismail Kose 0:ff4818eff240 152 // BBstMd = 1 Damping Enabled
Ismail Kose 0:ff4818eff240 153 // BBstInd = 0 Inductance is 4.7uH
Ismail Kose 0:ff4818eff240 154 // BBstEn = 0b'01 Enabled
Ismail Kose 0:ff4818eff240 155 ret |= writeReg( REG_AP_CMDOUT, 0x70);
Ismail Kose 0:ff4818eff240 156 if (ret != 0)
Ismail Kose 0:ff4818eff240 157 return MAX20303_ERROR;
Ismail Kose 0:ff4818eff240 158
Ismail Kose 0:ff4818eff240 159 return MAX20303_NO_ERROR;
Ismail Kose 0:ff4818eff240 160 }