Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_wrist

Example Host software for integration of MAX3266x chips (, MAX32664GWEB) equipped with Heart Rate from Wrist Algorithm. This is “stand-alone” software that runs on the MAX32630 low-power microcontroller to display heart rate on the display of the MAXREFDES101 reference design. It is intended provide a simple example of how to initialize and communicate with the sensor hub. Windows and Android communications are not supported.

Dependencies:   Maxim_Sensor_Hub_Communications BMI160 whrmDemoUI max32630hsp3

Fork of Host_Software_MAX32664GWEB_HR_wrist by mehmet gok

max32630hsp/MAX20303.h@0:ddc2fef69ef9, 2018-12-17 (annotated)

Committer:
gmehmet
Date:
Mon Dec 17 10:34:32 2018 +0300
Revision:
0:ddc2fef69ef9
First Commit New Repo name

Who changed what in which revision?

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