MAX30102.cpp

00001 /** \file max30102.cpp ******************************************************
00002 *
00003 * Project: MAXREFDES117#
00004 * Filename: max30102.cpp
00005 * Description: This module is an embedded controller driver for the MAX30102
00006 *
00007 *
00008 * --------------------------------------------------------------------
00009 *
00010 * This code follows the following naming conventions:
00011 *
00012 * char              ch_pmod_value
00013 * char (array)      s_pmod_s_string[16]
00014 * float             f_pmod_value
00015 * int32_t           n_pmod_value
00016 * int32_t (array)   an_pmod_value[16]
00017 * int16_t           w_pmod_value
00018 * int16_t (array)   aw_pmod_value[16]
00019 * uint16_t          uw_pmod_value
00020 * uint16_t (array)  auw_pmod_value[16]
00021 * uint8_t           uch_pmod_value
00022 * uint8_t (array)   auch_pmod_buffer[16]
00023 * uint32_t          un_pmod_value
00024 * int32_t *         pn_pmod_value
00025 *
00026 * ------------------------------------------------------------------------- */
00027 /*******************************************************************************
00028 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00029 *
00030 * Permission is hereby granted, free of charge, to any person obtaining a
00031 * copy of this software and associated documentation files (the "Software"),
00032 * to deal in the Software without restriction, including without limitation
00033 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00034 * and/or sell copies of the Software, and to permit persons to whom the
00035 * Software is furnished to do so, subject to the following conditions:
00036 *
00037 * The above copyright notice and this permission notice shall be included
00038 * in all copies or substantial portions of the Software.
00039 *
00040 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00041 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00042 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00043 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00044 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00045 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00046 * OTHER DEALINGS IN THE SOFTWARE.
00047 *
00048 * Except as contained in this notice, the name of Maxim Integrated
00049 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00050 * Products, Inc. Branding Policy.
00051 *
00052 * The mere transfer of this software does not imply any licenses
00053 * of trade secrets, proprietary technology, copyrights, patents,
00054 * trademarks, maskwork rights, or any other form of intellectual
00055 * property whatsoever. Maxim Integrated Products, Inc. retains all
00056 * ownership rights.
00057 *******************************************************************************
00058 */
00059 #include "mbed.h"
00060 #include "MAX30102.h"
00061 
00062 I2C i2c(p9,p10);//p9-sda,p10-scl
00063 
00064 bool maxim_max30102_write_reg(uint8_t uch_addr, uint8_t uch_data)
00065 /**
00066 * \brief        Write a value to a MAX30102 register
00067 * \par          Details
00068 *               This function writes a value to a MAX30102 register
00069 *
00070 * \param[in]    uch_addr    - register address
00071 * \param[in]    uch_data    - register data
00072 *
00073 * \retval       true on success
00074 */
00075 {
00076   char ach_i2c_data[2];
00077   ach_i2c_data[0]=uch_addr;
00078   ach_i2c_data[1]=uch_data;
00079   
00080   if(i2c.write(I2C_WRITE_ADDR, ach_i2c_data, 2, false)==0)
00081     return true;
00082   else
00083     return false;
00084 }
00085 
00086 bool maxim_max30102_read_reg(uint8_t uch_addr, uint8_t *puch_data)
00087 /**
00088 * \brief        Read a MAX30102 register
00089 * \par          Details
00090 *               This function reads a MAX30102 register
00091 *
00092 * \param[in]    uch_addr    - register address
00093 * \param[out]   puch_data    - pointer that stores the register data
00094 *
00095 * \retval       true on success
00096 */
00097 {
00098   char ch_i2c_data;
00099   ch_i2c_data=uch_addr;
00100   if(i2c.write(I2C_WRITE_ADDR, &ch_i2c_data, 1, true)!=0)
00101     return false;
00102   if(i2c.read(I2C_READ_ADDR, &ch_i2c_data, 1, false)==0)
00103   {
00104     *puch_data=(uint8_t) ch_i2c_data;
00105     return true;
00106   }
00107   else
00108     return false;
00109 }
00110 
00111 bool maxim_max30102_init()
00112 /**
00113 * \brief        Initialize the MAX30102
00114 * \par          Details
00115 *               This function initializes the MAX30102
00116 *
00117 * \param        None
00118 *
00119 * \retval       true on success
00120 */
00121 {
00122   if(!maxim_max30102_write_reg(REG_INTR_ENABLE_1,0xc0)) // INTR setting
00123     return false;
00124   if(!maxim_max30102_write_reg(REG_INTR_ENABLE_2,0x00))
00125     return false;
00126   if(!maxim_max30102_write_reg(REG_FIFO_WR_PTR,0x00))  //FIFO_WR_PTR[4:0]
00127     return false;
00128   if(!maxim_max30102_write_reg(REG_OVF_COUNTER,0x00))  //OVF_COUNTER[4:0]
00129     return false;
00130   if(!maxim_max30102_write_reg(REG_FIFO_RD_PTR,0x00))  //FIFO_RD_PTR[4:0]
00131     return false;
00132   if(!maxim_max30102_write_reg(REG_FIFO_CONFIG,0x0f))  //sample avg = 1, fifo rollover=false, fifo almost full = 17
00133     return false;
00134   if(!maxim_max30102_write_reg(REG_MODE_CONFIG,0x03))   //0x02 for Red only, 0x03 for SpO2 mode 0x07 multimode LED
00135     return false;
00136   if(!maxim_max30102_write_reg(REG_SPO2_CONFIG,0x27))  // SPO2_ADC range = 4096nA, SPO2 sample rate (100 Hz), LED pulseWidth (400uS)
00137     return false;
00138   
00139   if(!maxim_max30102_write_reg(REG_LED1_PA,0x24))   //Choose value for ~ 7mA for LED1
00140     return false;
00141   if(!maxim_max30102_write_reg(REG_LED2_PA,0x24))   // Choose value for ~ 7mA for LED2
00142     return false;
00143   if(!maxim_max30102_write_reg(REG_PILOT_PA,0x7f))   // Choose value for ~ 25mA for Pilot LED
00144     return false;
00145   return true;  
00146 }
00147 
00148 bool maxim_max30102_read_fifo(uint32_t *pun_red_led, uint32_t *pun_ir_led)
00149 /**
00150 * \brief        Read a set of samples from the MAX30102 FIFO register
00151 * \par          Details
00152 *               This function reads a set of samples from the MAX30102 FIFO register
00153 *
00154 * \param[out]   *pun_red_led   - pointer that stores the red LED reading data
00155 * \param[out]   *pun_ir_led    - pointer that stores the IR LED reading data
00156 *
00157 * \retval       true on success
00158 */
00159 {
00160   uint32_t un_temp;
00161   unsigned char uch_temp;
00162   *pun_red_led=0;
00163   *pun_ir_led=0;
00164   char ach_i2c_data[6];
00165   
00166   //read and clear status register
00167   maxim_max30102_read_reg(REG_INTR_STATUS_1, &uch_temp);
00168   maxim_max30102_read_reg(REG_INTR_STATUS_2, &uch_temp);
00169   
00170   ach_i2c_data[0]=REG_FIFO_DATA;
00171   if(i2c.write(I2C_WRITE_ADDR, ach_i2c_data, 1, true)!=0)
00172     return false;
00173   if(i2c.read(I2C_READ_ADDR, ach_i2c_data, 6, false)!=0)
00174   {
00175     return false;
00176   }
00177   un_temp=(unsigned char) ach_i2c_data[0];
00178   un_temp<<=16;
00179   *pun_red_led+=un_temp;
00180   un_temp=(unsigned char) ach_i2c_data[1];
00181   un_temp<<=8;
00182   *pun_red_led+=un_temp;
00183   un_temp=(unsigned char) ach_i2c_data[2];
00184   *pun_red_led+=un_temp;
00185   
00186   un_temp=(unsigned char) ach_i2c_data[3];
00187   un_temp<<=16;
00188   *pun_ir_led+=un_temp;
00189   un_temp=(unsigned char) ach_i2c_data[4];
00190   un_temp<<=8;
00191   *pun_ir_led+=un_temp;
00192   un_temp=(unsigned char) ach_i2c_data[5];
00193   *pun_ir_led+=un_temp;
00194   *pun_red_led&=0x03FFFF;  //Mask MSB [23:18]
00195   *pun_ir_led&=0x03FFFF;  //Mask MSB [23:18]
00196   
00197   
00198   return true;
00199 }
00200 
00201 bool maxim_max30102_reset()
00202 /**
00203 * \brief        Reset the MAX30102
00204 * \par          Details
00205 *               This function resets the MAX30102
00206 *
00207 * \param        None
00208 *
00209 * \retval       true on success
00210 */
00211 {
00212     if(!maxim_max30102_write_reg(REG_MODE_CONFIG,0x40))
00213         return false;
00214     else
00215         return true;    
00216 }