File content as of revision 5:a18a189588dc:

/******************************************************************//**
* @file max17055.cpp
*
* @author Felipe Neira - Maxim Integrated - TTS
*
* @version 1.0
*
* Started: 11SEP17
*
* Updated:
*
* @brief Source file for MAX31855 class
*
********************************************************************************
* Copyright (C) 2017 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 "mbed.h"
#include "max17055.h"

#define DRV_NAME "max17055"

/* CONFIG register bits */
#define MAX17055_CONFIG_ALRT_EN         (1 << 2)
#define MAX17055_CONFIG2_LDMDL          (1 << 5)

/* STATUS register bits */
#define MAX17055_STATUS_BST             (1 << 3)
#define MAX17055_STATUS_POR             (1 << 1)

/* MODELCFG register bits */
#define MAX17055_MODELCFG_REFRESH       (1 << 15)

/* TALRTTH register bits */
#define MIN_TEMP_ALERT                  0
#define MAX_TEMP_ALERT                  8

/* FSTAT register bits */
#define MAX17055_FSTAT_DNR              (1)

/* STATUS interrupt status bits */
#define MAX17055_STATUS_ALRT_CLR_MASK   (0x88BB)
#define MAX17055_STATUS_SOC_MAX_ALRT    (1 << 14)
#define MAX17055_STATUS_TEMP_MAX_ALRT   (1 << 13)
#define MAX17055_STATUS_VOLT_MAX_ALRT   (1 << 12)
#define MAX17055_STATUS_SOC_MIN_ALRT    (1 << 10)
#define MAX17055_STATUS_TEMP_MIN_ALRT   (1 << 9)
#define MAX17055_STATUS_VOLT_MIN_ALRT   (1 << 8)
#define MAX17055_STATUS_CURR_MAX_ALRT   (1 << 6)
#define MAX17055_STATUS_CURR_MIN_ALRT   (1 << 2)

#define MAX17055_VMAX_TOLERANCE     50 /* 50 mV */


//struct battery_priv {
//        struct power_supply battery;
//    };


MAX17055::MAX17055(I2C &i2c):
    m_i2cBus(i2c)
{
    //empty block
}

MAX17055::~MAX17055()
{
    //empty block
}









///////////////////////////////////////////////////////////////////////////////

/**
* \brief        Write a value to a MAX17055 register
* \par          Details
*               This function writes a value to a MAX17055 register
*
* \param[in]    reg_addr - register address
* \param[in]    reg_data - register data
*
* \retval       1 on success
*/

int MAX17055::writeReg(Registers_e reg_addr, uint16_t reg_data)
{


    uint8_t dataLSB;
    uint8_t dataMSB;

    dataLSB = reg_data & 0x00FF;
    dataMSB = (reg_data >> 8) & 0x00FF;

    char add_plus_data[3] = {reg_addr, dataLSB, dataMSB};

    if ( m_i2cBus.write(I2C_W_ADRS, add_plus_data, 3, false) == 0)
        return 1;
    else
        return 0;

}
///////////////////////////////////////////////////////////////////////////////
/**
* \brief        Read a MAX17055 register
* \par          Details
*               This function reads a MAX17055 register
*
* \param[in]    reg_addr   - register address
* \param[out]   &value   - pointer that stores the register data
*
* \retval       1 on success
*/


int32_t MAX17055::readReg(Registers_e reg_addr, uint16_t &value)
{
    int32_t result;
    //int16_t value2;
    //int16_t twoBytes;
    char local_data[1];
    local_data[0] = reg_addr;
    char read_data[2];

    result = m_i2cBus.write(I2C_W_ADRS, local_data, 1);
    if(result == 0) {
        result = m_i2cBus.read(I2C_R_ADRS, read_data , 2, false);
        if (result == 0) {
            value = ( ((read_data[1] & 0x00FF) << 8) + (read_data[0]));
            result = 1;
        }
    }

    return result;

}

///////////////////////////////////////////////////////////////////////////////
/**
* \brief        Write and Verify a MAX17055 register
* \par          Details
*               This function wites and verifies if the writing process was successful
*
* \param[in]    reg_addr     - register address
* \param[out]   reg_data     - the variable that contains the data to write
*                                to the register address
*
* \retval       1 on success
*/


int MAX17055::write_and_verify_reg(Registers_e reg_addr, uint16_t reg_data)
{
    int retries = 8;
    int ret;
    int statusRead;
    int statusWrite;
    uint16_t read_data;

    do {
        statusWrite = writeReg(reg_addr, reg_data);
        if (statusWrite != 1)
            ret = -1;
        wait_ms(3);
        statusRead = readReg(reg_addr, read_data);
        if  (statusRead != 1)
            ret = -2;
        if (read_data != reg_data) {
            ret = -3;
            retries--;
        }
    } while (retries && read_data != reg_data);

    if (ret<0) {
        return ret;
    } else {
        return 1;
    }
}

////////////////////////////////////////////////////////////////////////////////

/**
* \brief        Initialise Function for MAX17055
* \par          Details
*               This function intitializes the MAX17055
*
* \retval       1 on success
*               0 if device is not present
*              -1 if errors exist
*/


int MAX17055::init(struct max17055_platform_data *pri)
{
    //*batt_con = batt_info;
    int status, ret;
    uint16_t read_data, hibcfg_value,dpacc, reg;


    status = readReg(MAX17055_VERSION_REG, read_data);
    if (status == 0)
        return status;  //Device is not present in the i2c Bus

    /* Step 0: Check for POR */
    /* Skip load model if POR bit is cleared */

    readReg(MAX17055_STATUS_REG, read_data);

    if (!(read_data & MAX17055_STATUS_POR ) )
        return -1;  //POR is not set. Skip Initialization.

    /* Step 1: Check if FStat.DNR == 0 */
    // Do not continue until FSTAT.DNR == 0

    while(readReg(MAX17055_FSTAT_REG, read_data)&1) {
        wait_ms(10);//10 ms wait empty loop
    }

    /* Force exit from hibernate */
    hibcfg_value = forcedExitHyberMode();


    /* Step 2: Initialize configuration */
    switch (1) {
        case MODEL_LOADING_OPTION1:
            /* Step 2.1: Option 1 EZ Config */
            writeReg(MAX17055_DESIGNCAP_REG, designcap);
            writeReg(MAX17055_DQACC_REG, pri.designcap >> 5);
            writeReg(MAX17055_ICHGTERM_REG, pri.ichgterm);
            writeReg(MAX17055_VEMPTY_REG, pri.vempty);

            if (pri.vcharge > 4275) { //Need to know what this 4275 is
                dpacc = (pri.designcap >> 5) * 0xC800 / pri.designcap;
                writeReg(MAX17055_DPACC_REG, dpacc);
                writeReg(MAX17055_MODELCFG_REG, 0x8400); //Why 0x8400
            } else {
                dpacc = (pri.designcap >> 5) * 0xAC6A / pri.designcap;
                writeReg(MAX17055_DPACC_REG, dpacc);
                writeReg(MAX17055_MODELCFG_REG, 0x8000);
            }

            /* Poll ModelCFG.ModelRefresh bit for clear */
            ret = max17055_poll_flag_clear(MAX17055_MODELCFG_REG, MAX17055_MODELCFG_REFRESH, 500);
            if(ret < 0) {
                //dev_err(priv->dev, "Option1 model refresh not completed!\n");
                return ret;
            }
            break;
    }
    /* Restore original HibCfg */
    writeReg(MAX17055_HIBCFG_REG, hibcfg_value);

    /* Optional step - alert threshold initialization */
    //max17055_set_alert_thresholds(priv);

    /* Clear Status.POR */
    readReg(MAX17055_STATUS_REG, reg);
    write_and_verify_reg(MAX17055_STATUS_REG, (reg & ~MAX17055_STATUS_POR));

    return 1;
}


///////////////////////////////////////////////////////////////////////////////

/**
* \brief        Poll Flag clear
* \par          Details
*               This function clears status flags for the MAX17055
*
* \param[in]    reg_addr - register address
* \param[in]    mask - register address
* \param[in]    timeout - register data
*
* \retval       1 on success
*              -1 on Failure
*/

int max17055_poll_flag_clear(Registers_e reg_addr, int mask, int timeout)
{
    uint16_t data;
    int ret;

    do {
        wait(50);
        ret = readReg(red_addr, data);
        if(ret < 0)
            return ret;

        if(!(data & mask))
            return 1;

        timeout -= 50;
    } while(timeout > 0);

    return -1;
}



////////////////////////////////////////////////////////////////////////////////

/**
* \brief        Get Internal Temperature Function for MAX17055
* \par          Details
*               This function sends a request to access the internal
*               of the MAX17055
*
* \param[in]    reg_addr     - register address
* \param[out]   reg_data     - the variable that contains the data to write
*                                to the register address
* \retval       1 on success
*
*              -1 if errors exist
*/


int MAX17055::get_temperature(int *temp)
{

    int ret;
    uint16_t data;

    ret = readReg(MAX17055_TEMP_REG, data);
    if (ret < 0)
        return ret;

    *temp = data;
    /* The value is signed. */
    if (*temp & 0x8000)
        *temp |= 0xFFFF0000;

    /* The value is converted into centigrade scale */
    /* Units of LSB = 1 / 256 degree Celsius */
    *temp >>= 8;

    return 1;
}


////////////////////////////////////////////////////////////////////////////////

/**
* \brief        Forced Exit Hibernate Mode Function for MAX17055
* \par          Details
*               This function executes a force exit from hibernate mode.
*
* \retval       returns HibCFG original value before forced Exit Hybernate mode
*
*/


uint16_t MAX17055::forcedExitHyberMode()
{
    uint16_t hibcfg;

    /* Force exit from hibernate */

    //STEP 0: Store original HibCFG value
    readReg(MAX17055_HIBCFG_REG, hibcfg);

    //STEP 1: Write to Soft-Wakeup Commannd Register
    writeReg(MAX17055_VFSOC0_QH0_LOCK_REG, 0x90); //Soft-Wakeup from hybernate

    //STEP 2: Write to Hibernate Configuration register
    writeReg(MAX17055_HIBCFG_REG, 0x0); //disable hibernate mode

    //STEP 3:Write to Soft-Wakeup Commannd Register
    writeReg(MAX17055_VFSOC0_QH0_LOCK_REG, 0x0); //Clear All commnads

    return hibcfg;
}