Maxim Integrated / MAX77654
Embed: (wiki syntax)

« Back to documentation index

MAX77654 Class Reference

MAX77654 Class Reference

MAX77654 Ultra-Low Power PMIC Featuring Single-Inductor, 3-Output Buck-Boost, 2-LDOs, Power Path Charger for Small Li+, and Ship Mode. More...

#include <MAX77654.h>

Public Types

enum  int_glbl_t
 

Register Configuration All Interrupt Flags combined from INT_GLBL0, INT_GLBL1 and INT_CHG.

More...
enum  ercflag_t
 

Register Configuration.

More...
enum  didm_t
 

Register Configuration.

More...
enum  bok_t
 

Register Configuration.

More...
enum  dod0_s_t
 

Register Configuration.

More...
enum  dod1_s_t
 

Register Configuration.

More...
enum  tjal2_s_t
 

Register Configuration.

More...
enum  tjal1_s_t
 

Register Configuration.

More...
enum  stat_en_t
 

Register Configuration.

More...
enum  stat_irq_t
 

Register Configuration.

More...
enum  intm_t
 

Register Configuration.

More...
enum  pu_dis_t
 

Register Configuration.

More...
enum  t_mrst_t
 

Register Configuration.

More...
enum  sbia_lpm_t
 

Register Configuration.

More...
enum  sbia_en_t
 

Register Configuration.

More...
enum  nen_mode_t
 

Register Configuration.

More...
enum  dben_nen_t
 

Register Configuration.

More...
enum  sft_ctrl_t
 

Register Configuration.

More...
enum  alt_gpio_t
 

Register Configuration.

More...
enum  dben_gpi_t
 

Register Configuration.

More...
enum  gpo_do_t
 

Register Configuration.

More...
enum  gpo_drv_t
 

Register Configuration.

More...
enum  gpo_di_t
 

Register Configuration.

More...
enum  gpo_dir_t
 

Register Configuration.

More...
enum  wdt_per_t
 

Register Configuration.

More...
enum  wdt_mode_t
 

Register Configuration.

More...
enum  wdt_clr_t
 

Register Configuration.

More...
enum  wdt_en_t
 

Register Configuration.

More...
enum  wdt_lock_t
 

Register Configuration.

More...
enum  stat_t
 

Register Configuration.

More...
enum  thm_dtls_t
 

Register Configuration.

More...
enum  chg_dtls_t
 

Register Configuration.

More...
enum  chgin_dtls_t
 

Register Configuration.

More...
enum  chg_t
 

Register Configuration.

More...
enum  time_sus_t
 

Register Configuration.

More...
enum  thm_hot_t
 

Register Configuration.

More...
enum  thm_warm_t
 

Register Configuration.

More...
enum  thm_cool_t
 

Register Configuration.

More...
enum  thm_cold_t
 

Register Configuration.

More...
enum  vchgin_min_t
 

Register Configuration.

More...
enum  ichgin_lim_t
 

Register Configuration.

More...
enum  i_pq_t
 

Register Configuration.

More...
enum  chg_en_t
 

Register Configuration.

More...
enum  chg_pq_t
 

Register Configuration.

More...
enum  i_term_t
 

Register Configuration.

More...
enum  t_topoff_t
 

Register Configuration.

More...
enum  tj_reg_t
 

Register Configuration.

More...
enum  vsys_reg_t
 

Register Configuration.

More...
enum  chg_cc_t
 

Register Configuration.

More...
enum  t_fast_chg_t
 

Register Configuration.

More...
enum  thm_en_t
 

Register Configuration.

More...
enum  chg_cv_t
 

Register Configuration.

More...
enum  usbs_t
 

Register Configuration.

More...
enum  imon_dischg_scale_t
 

Register Configuration.

More...
enum  mux_sel_t
 

Register Configuration.

More...
enum  tv_sbb_t
 

Register Configuration.

More...
enum  op_mode_t
 

Register Configuration.

More...
enum  ip_sbb_t
 

Register Configuration.

More...
enum  ade_sbb_t
 

Register Configuration.

More...
enum  en_sbb_t
 

Register Configuration.

More...
enum  ichgin_lim_def_t
 

Register Configuration.

More...
enum  drv_sbb_t
 

Register Configuration.

More...
enum  tv_ldo_t
 

Register Configuration.

More...
enum  ldo_md_t
 

Register Configuration.

More...
enum  ade_ldo_t
 

Register Configuration.

More...
enum  en_ldo_t
 

Register Configuration.

More...
typedef void(* interrupt_handler_function )(void *)
 Function pointer type to interrupt handler function.

Public Member Functions

 MAX77654 (I2C *i2c, PinName IRQPin=NC)
 MAX77654 constructor.
 ~MAX77654 ()
 MAX77654 destructor.
int read_register (uint8_t reg, uint8_t *value)
 Read from a register.
int write_register (uint8_t reg, const uint8_t *value)
 Write to a register.
int GetThermalOverload (ercflag_t *ercflag)
 Get Thermal Overload Flag.
int GetSysOvervoltageLockout (ercflag_t *ercflag)
 Get Sys Domain Overvoltage Lockout Flag.
int GetSysUndervoltageLockout (ercflag_t *ercflag)
 Get Sys Domain Undervoltage Lockout Flag.
int GetManualResetTimer (ercflag_t *ercflag)
 Get Manual Reset Timer Flag.
int GetSoftwareOffFlag (ercflag_t *ercflag)
 Get Software Off Flag.
int GetSoftwareColdResetFlag (ercflag_t *ercflag)
 Get Software Cold Reset.
int GetWatchdogTimerOffFlag (ercflag_t *ercflag)
 Get Watchdog Timer Off Flag.
int GetWatchdogTimerResetFlag (ercflag_t *ercflag)
 Get Watchdog Timer Reset Flag.
int GetDeviceIdentification (didm_t *didm)
 Get Device Identification Bits for Metal Options.
int GetBOKInterruptStatus (bok_t *bok)
 Get BOK Interrupt Status.
int GetLDO0DropoutRisingStatus (dod0_s_t *dod0_s)
 Get LDO0 Dropout Detector Rising Status.
int GetLDO1DropoutRisingStatus (dod1_s_t *dod1_s)
 Get LDO1 Dropout Detector Rising Status.
int GetThermalAlarm2Status (tjal2_s_t *tjal2_s)
 Get Thermal Alarm 2 Status.
int GetThermalAlarm1Status (tjal1_s_t *tjal1_s)
 Get Thermal Alarm 1 Status.
int GetnENDebouncedStatus (stat_en_t *stat_en)
 Get Debounced Status for the nEN input.
int GetSoftwareVersionGateDrive (stat_irq_t *stat_irq)
 Get Software Version of the nIRQ MOSFET gate drive.
int SetLDO1FaultInterruptMask (intm_t intm)
 Set LDO1 Fault Interrupt Mask.
int GetLDO1FaultInterruptMask (intm_t *intm)
 Get LDO1 Fault Interrupt Mask.
int SetLDO0FaultInterruptMask (intm_t intm)
 Set LDO0 Fault Interrupt Mask.
int GetLDO0FaultInterruptMask (intm_t *intm)
 Get LDO1 Fault Interrupt Mask.
int SetSBBTimeoutMask (intm_t intm)
 Set SBB Timeout Mask.
int GetSBBTimeoutMask (intm_t *intm)
 Get SBB Timeout Mask.
int SetGPI2RisingInterruptMask (intm_t intm)
 Set GPI2 Rising Interrupt Mask.
int GetGPI2RisingInterruptMask (intm_t *intm)
 Get GPI2 Rising Mask.
int SetGPI2FallingInterruptMask (intm_t intm)
 Set GPI2 Falling Interrupt Mask.
int GetGPI2FallingInterruptMask (intm_t *intm)
 Get GPI2 Falling Mask.
int SetGPI1RisingInterruptMask (intm_t intm)
 Set GPI1 Rising Interrupt Mask.
int GetGPI1RisingInterruptMask (intm_t *intm)
 Get GPI1 Rising Mask.
int SetGPI1FallingInterruptMask (intm_t intm)
 Set GPI1 Falling Interrupt Mask.
int GetGPI1FallingInterruptMask (intm_t *intm)
 Get GPI1 Falling Mask.
int SetDropout0RisingInterruptMask (intm_t intm)
 Set LDO Dropout0 Detector Rising Interrupt Mask.
int GetDropout0RisingInterruptMask (intm_t *intm)
 Get LDO Dropout0 Detector Rising Interrupt Mask.
int SetDropout1RisingInterruptMask (intm_t intm)
 Set LDO Dropout1 Detector Rising Interrupt Mask.
int GetDropout1RisingInterruptMask (intm_t *intm)
 Get LDO Dropout1 Detector Rising Interrupt Mask.
int SetThermalAlarm2RisingInterruptMask (intm_t intm)
 Set Thermal Alarm 2 Rising Interrupt Mask.
int GetThermalAlarm2RisingInterruptMask (intm_t *intm)
 Get Thermal Alarm 2 Rising Interrupt Mask.
int SetThermalAlarm1RisingInterruptMask (intm_t intm)
 Set Thermal Alarm 1 Rising Interrupt Mask.
int GetThermalAlarm1RisingInterruptMask (intm_t *intm)
 Get Thermal Alarm 1 Rising Interrupt Mask.
int SetnENRisingInterruptMask (intm_t intm)
 Set nEN Rising Interrupt Mask.
int GetnENRisingInterruptMask (intm_t *intm)
 Get nEN Rising Interrupt Mask.
int SetnENFallingInterruptMask (intm_t intm)
 Set nEN Falling Interrupt Mask.
int GetnENFallingInterruptMask (intm_t *intm)
 Get nEN Falling Interrupt Mask.
int SetGPI0RisingInterruptMask (intm_t intm)
 Set GPI0 Rising Interrupt Mask.
int GetGPI0RisingInterruptMask (intm_t *intm)
 Get GPI0 Rising Interrupt Mask.
int SetGPI0FallingInterruptMask (intm_t intm)
 Set GPI0 Falling Interrupt Mask.
int GetGPI0FallingInterruptMask (intm_t *intm)
 Get GPI0 Falling Interrupt Mask.
int SetnENInternalPullupResistor (pu_dis_t pu_dis)
 Set nEN Internal Pullup Resistor.
int GetnENInternalPullupResistor (pu_dis_t *pu_dis)
 Get nEN Internal Pullup Resistor.
int SetManualResetTime (t_mrst_t t_mrst)
 Set the Manual Reset Time (tMRST).
int GetManualResetTime (t_mrst_t *t_mrst)
 Get the Manual Reset Time (tMRST).
int SetMainBiasLowerPowerModeReq (sbia_lpm_t sbia_lpm)
 Set Main Bias Low-Power Mode Software Request.
int GetMainBiasLowerPowerModeReq (sbia_lpm_t *sbia_lpm)
 Get Main Bias Low-Power Mode Software Request.
int SetMainBiasEnableReq (sbia_en_t sbia_en)
 Set Main Bias Enable Software Request.
int GetMainBiasEnableReq (sbia_en_t *sbia_en)
 Get Main Bias Enable Software Request.
int SetnEnInputMode (nen_mode_t nen_mode)
 Set nEN Input (ON-KEY) Default Configuration Mode.
int GetnEnInputMode (nen_mode_t *nen_mode)
 Get nEN Input (ON-KEY) Default Configuration Mode.
int SetDebounceTimerEnable (dben_nen_t dben_nen)
 Set Debounce Timer Enable for the nEN Pin.
int GetDebounceTimerEnable (dben_nen_t *dben_nen)
 Get Debounce Timer Enable for the nEN Pin.
int SetSoftwareResetFunctions (sft_ctrl_t sft_ctrl)
 Set Software Reset Functions.
int GetSoftwareResetFunctions (sft_ctrl_t *sft_ctrl)
 Get Software Reset Functions.
int SetAlternateModeEnable (uint8_t channel, alt_gpio_t alt_gpio)
 Set Alternate Mode Enable for GPIO.
int GetAlternateModeEnable (uint8_t channel, alt_gpio_t *alt_gpio)
 Get Alternate Mode Enable for GPIO.
int SetGPIDebounceTimerEnable (uint8_t channel, dben_gpi_t dben_gpi)
 Set General Purpose Input Debounce Timer Enable.
int GetGPIDebounceTimerEnable (uint8_t channel, dben_gpi_t *dben_gpi)
 Get General Purpose Input Debounce Timer Enable.
int SetGPODataOutput (uint8_t channel, gpo_do_t gpo_do)
 Set General Purpose Output Data Output.
int GetGPODataOutput (uint8_t channel, gpo_do_t *gpo_do)
 Get General Purpose Output Data Output.
int SetGPODriveType (uint8_t channel, gpo_drv_t gpo_drv)
 Set General Purpose Output Driver Type.
int GetGPODriveType (uint8_t channel, gpo_drv_t *gpo_drv)
 Get General Purpose Output Driver Type.
int SetGPIOInputValue (uint8_t channel, gpo_di_t gpo_di)
 Set GPIO Digital Input Value.
int GetGPIOInputValue (uint8_t channel, gpo_di_t *gpo_di)
 Get GPIO Digital Input Value.
int SetGPIODirection (uint8_t channel, gpo_dir_t gpo_dir)
 Set GPIO Direction.
int GetGPIODirection (uint8_t channel, gpo_dir_t *gpo_dir)
 Get GPIO Direction.
int GetCID (void)
 Read the CID.
int SetWatchdogTimerPeriod (wdt_per_t wdt_per)
 Set Watchdog Timer Period.
int GetWatchdogTimerPeriod (wdt_per_t *wdt_per)
 Get Watchdog Timer Period.
int SetWatchdogTimerExpiredAction (wdt_mode_t wdt_mode)
 Set Watchdog Timer Expired Action.
int GetWatchdogTimerExpiredAction (wdt_mode_t *wdt_mode)
 Get Watchdog Timer Expired Action.
int SetWatchdogTimerClearControl (wdt_clr_t wdt_clr)
 Set Watchdog Timer Clear Control.
int GetWatchdogTimerClearControl (wdt_clr_t *wdt_clr)
 Get Watchdog Timer Clear Control.
int SetWatchdogTimerEnable (wdt_en_t wdt_en)
 Set Watchdog Timer Enable.
int GetWatchdogTimerEnable (wdt_en_t *wdt_en)
 Get Watchdog Timer Enable.
int SetFactorySetSafetyBit (wdt_lock_t wdt_lock)
 Set Factory-Set Safety Bit for the Watchdog Timer.
int GetFactorySetSafetyBit (wdt_lock_t *wdt_lock)
 Get Factory-Set Safety Bit for the Watchdog Timer.
int GetMinimumVCHGINVoltageLoopStatus (stat_t *stat)
 Get Minimum Input Voltage Regulation Loop Status.
int GetCHGINCurrentLimitLoopStatus (stat_t *stat)
 Get Input Current Limit Loop Status.
int GetMinimumSYSVoltageLoopStatus (stat_t *stat)
 Get Minimum System Voltage Regulation Loop Status.
int GetMaximumJunctionTempLoopStatus (stat_t *stat)
 Get Maximum Junction Temperature Regulation Loop Status.
int GetBatteryTemperatureDetails (thm_dtls_t *thm_dtls)
 Get Battery Temperature Details.
int GetChargerDetails (chg_dtls_t *chg_dtls)
 Get Charger Details.
int GetCHGINStatusDetails (chgin_dtls_t *chgin_dtls)
 Get CHGIN Status Detail.
int GetQuickChargerStatus (chg_t *chg)
 Get Quick Charger Status.
int GetTimeSuspendedIndicator (time_sus_t *time_sus)
 Get Time Suspend Indicator.
int SetSYSCONFIGMBit (intm_t intm)
 Set SYS_CNFG_I.
int GetSYSCONFIGMBit (intm_t *intm)
 Get SYS_CNFG_I.
int SetSYSCTRLMBit (intm_t intm)
 Set SYS_CTRL_I.
int GetSYSCTRLMBit (intm_t *intm)
 Get SYS_CTRL_I.
int SetCHGINCTRLMBit (intm_t intm)
 Set CHGIN_CTRL_I.
int GetCHGINCTRLMBit (intm_t *intm)
 Get CHGIN_CTRL_I.
int SetTJREGMBit (intm_t intm)
 Set TJREG_I.
int GetTJREGMBit (intm_t *intm)
 Get TJREG_I.
int SetCHGINMBit (intm_t intm)
 Set CHGIN_I.
int GetCHGINMBit (intm_t *intm)
 Get CHGIN_I.
int SetCHGMBit (intm_t intm)
 Set CHG_I.
int GetCHGMBit (intm_t *intm)
 Get CHG_I.
int SetTHMMBit (intm_t intm)
 Set THM_I.
int GetTHMMBit (intm_t *intm)
 Get THM_I.
int SetHOTJEITATemperature (thm_hot_t thm_hot)
 Set the VHOT JEITA Temperature Threshold.
int GetHOTJEITATemperature (thm_hot_t *thm_hot)
 Get the VHOT JEITA Temperature Threshold.
int SetWARMJEITATemperature (thm_warm_t thm_warm)
 Set the VWARM JEITA Temperature Threshold.
int GetWARMJEITATemperature (thm_warm_t *thm_warm)
 Get the VWARM JEITA Temperature Threshold.
int SetCOOLJEITATemperature (thm_cool_t thm_cool)
 Set the VCOOL JEITA Temperature Threshold.
int GetCOOLJEITATemperature (thm_cool_t *thm_cool)
 Get the VCOOL JEITA Temperature Threshold.
int SetCOLDJEITATemperature (thm_cold_t thm_cold)
 Set the VCOLD JEITA Temperature Threshold.
int GetCOLDJEITATemperature (thm_cold_t *thm_cold)
 Get the VCOLD JEITA Temperature Threshold.
int SetMinimumCHGINVoltage (vchgin_min_t vchgin_min)
 Set Minimum CHGIN Regulation Voltage.
int GetMinimumCHGINVoltage (vchgin_min_t *vchgin_min)
 Get Minimum CHGIN Regulation Voltage.
int SetCHGINInputCurrentLimit (ichgin_lim_t ichgin_lim)
 Set CHGIN Input Current Limit.
int GetCHGINInputCurrentLimit (ichgin_lim_t *ichgin_lim)
 Get CHGIN Input Current Limit.
int SetPrequalificationChargeCurrent (i_pq_t i_pq)
 Set the Prequalification Charge Current as a percentage of IFAST-CHG.
int GetPrequalificationChargeCurrent (i_pq_t *i_pq)
 Get the Prequalification Charge Current as a percentage of IFAST-CHG.
int SetBatteryChargerEnable (chg_en_t chg_en)
 Set Charger Enable.
int GetBatteryChargerEnable (chg_en_t *chg_en)
 Get Charger Enable.
int SetBatteryPQVoltageThreshold (chg_pq_t chg_pq)
 Set Battery Prequalification Voltage Threshold (VPQ).
int GetBatteryPQVoltageThreshold (chg_pq_t *chg_pq)
 Get Battery Prequalification Voltage Threshold (VPQ).
int SetChargerTerminationCurrent (i_term_t i_term)
 Set Charger Termination Current (ITERM).
int GetChargerTerminationCurrent (i_term_t *i_term)
 Get Charger Termination Current (ITERM).
int SetTopOffTimerValue (t_topoff_t t_topoff)
 Set Top-off Timer Value.
int GetTopOffTimerValue (t_topoff_t *t_topoff)
 Get Top-off Timer Value.
int SetDieJunctionTemperature (tj_reg_t tj_reg)
 Set the Die Junction Temperature Regulation Point, TJ-REG.
int GetDieJunctionTemperature (tj_reg_t *tj_reg)
 Get the Die Junction Temperature Regulation Point, TJ-REG.
int SetSystemVoltageRegulation (vsys_reg_t vsys_reg)
 Set System Voltage Regulation (VSYS-REG).
int GetSystemVoltageRegulation (vsys_reg_t *vsys_reg)
 Get System Voltage Regulation (VSYS-REG).
int SetFastChargeCCValue (chg_cc_t chg_cc)
 Set the Fast-Charge Constant Current Value, IFAST-CHG.
int GetFastChargeCCValue (chg_cc_t *chg_cc)
 Get the Fast-Charge Constant Current Value, IFAST-CHG.
int SetFastChargSafetyTimer (t_fast_chg_t t_fast_chg)
 Set the Fast-charge Safety timer, tFC.
int GetFastChargSafetyTimer (t_fast_chg_t *t_fast_chg)
 Get the Fast-charge Safety timer, tFC.
int SetFastChargeCCJEITA (chg_cc_t chg_cc_jeita)
 Set IFAST-CHG-JEITA when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.
int GetFastChargeCCJEITA (chg_cc_t *chg_cc_jeita)
 Get IFAST-CHG-JEITA when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.
int SetThermistorEnable (thm_en_t thm_en)
 Set Thermistor Enable Bit.
int GetThermistorEnable (thm_en_t *thm_en)
 Get Thermistor enable bit.
int SetFastChargeBatteryRegVolt (chg_cv_t chg_cv)
 Set Fast-Charge Battery Regulation Voltage, VFAST-CHG.
int GetFastChargeBatteryRegVolt (chg_cv_t *chg_cv)
 Get Fast-Charge Battery Regulation Voltage, VFAST-CHG.
int SetCHGINUSBSuspendMode (usbs_t usbs)
 Set USBS.
int GetCHGINUSBSuspendMode (usbs_t *usbs)
 Get USBS.
int SetFastChargeVoltageJEITA (chg_cv_t chg_cv_jeita)
 Set the modified VFAST-CHG-JEITA for when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.
int GetFastChargeVoltageJEITA (chg_cv_t *chg_cv_jeita)
 Get the modified VFAST-CHG-JEITA for when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.
int SetDischargeCurrentFullScale (imon_dischg_scale_t imon_dischg_scale)
 Set the Battery Discharge Current Full-Scale Current Value.
int GetDischargeCurrentFullScale (imon_dischg_scale_t *imon_dischg_scale)
 Get the Battery Discharge Current Full-Scale Current Value.
int SetAMUX (mux_sel_t mux_sel)
 Set the Analog Channel to connect to AMUX.
int GetAMUX (mux_sel_t *mux_sel)
 Get the Battery Discharge Current Full-Scale Current Value.
int SetSBBTargetOutVoltage (uint8_t channel, tv_sbb_t tv_sbb)
 Set SIMO Buck-Boost Channel x Target Output Voltage.
int GetSBBTargetOutVoltage (uint8_t channel, tv_sbb_t *tv_sbb)
 Get SIMO Buck-Boost Channel x Target Output Voltage.
int SetSIMOOperationMode (uint8_t channel, op_mode_t op_mode)
 Set Operation mode of SBBx.
int GetSIMOOperationMode (uint8_t channel, op_mode_t *op_mode)
 Get Operation mode of SBBx.
int SetSBBPeakCurrentLimit (uint8_t channel, ip_sbb_t ip_sbb)
 Set SIMO Buck-Boost Channel x Peak Current Limit.
int GetSBBPeakCurrentLimit (uint8_t channel, ip_sbb_t *ip_sbb)
 Get SIMO Buck-Boost Channel x Peak Current Limit.
int SetSBBActiveDischargeEnable (uint8_t channel, ade_sbb_t ade_sbb)
 Set SIMO Buck-Boost Channel x Active-Discharge Enable.
int GetSBBActiveDischargeEnable (uint8_t channel, ade_sbb_t *ade_sbb)
 Get SIMO Buck-Boost Channel x Active-Discharge Enable.
int SetSBBEnableControl (uint8_t channel, en_sbb_t en_sbb)
 Set Enable Control for SIMO Buck-Boost Channel x.
int GetSBBEnableControl (uint8_t channel, en_sbb_t *en_sbb)
 Get Enable Control for SIMO Buck-Boost Channel x.
int SetCHGINInputCurrentLimit (ichgin_lim_def_t ichgin_lim_def)
 Set Changes how CNFG_CHG_B.ICHGIN_LIM is interpreted.
int GetCHGINInputCurrentLimit (ichgin_lim_def_t *ichgin_lim_def)
 Get Changes how CNFG_CHG_B.ICHGIN_LIM is interpreted.
int SetSBBDriveStrength (drv_sbb_t drv_sbb)
 Set SIMO Buck-Boost (all channels) Drive Strength Trim.
int GetSBBDriveStrength (drv_sbb_t *drv_sbb)
 Get SIMO Buck-Boost (all channels) Drive Strength Trim.
int SetLDOTargetOutVoltage (uint8_t channel, tv_ldo_t tv_ldo)
 Set LDO Target Output Voltage.
int GetLDOTargetOutVoltage (uint8_t channel, tv_ldo_t *tv_ldo)
 Get LDO Target Output Voltage.
int SetLDOMode (uint8_t channel, ldo_md_t ldo_md)
 Set Operation Mode of LDOx.
int GetLDOMode (uint8_t channel, ldo_md_t *ldo_md)
 Get Operation Mode of LDOx.
int SetLDOActiveDischargeEnable (uint8_t channel, ade_ldo_t ade_ldo)
 Set LDOx Active-Discharge Enable.
int GetLDOActiveDischargeEnable (uint8_t channel, ade_ldo_t *ade_ldo)
 Get LDOx Active-Discharge Enable.
int SetLDOEnableControl (uint8_t channel, en_ldo_t en_ldo)
 Set Enable Control for LDOx.
int GetLDOEnableControl (uint8_t channel, en_ldo_t *en_ldo)
 Get Enable Control for LDOx.
int IRQDisableAll ()
 Disable all interrupts.
void SetInterruptHandler (int_glbl_t id, interrupt_handler_function func, void *cb)
 Set Interrupt Handler for a Specific Interrupt ID.

Detailed Description

MAX77654 Ultra-Low Power PMIC Featuring Single-Inductor, 3-Output Buck-Boost, 2-LDOs, Power Path Charger for Small Li+, and Ship Mode.

The MAX77654 provides highly-integrated battery charging and power supply solutions for low-power applications where size and efficiency are critical.
https://www.maximintegrated.com/en/products/power/power-management-ics/MAX77654.html

Definition at line 63 of file MAX77654.h.


Member Typedef Documentation

typedef void(* interrupt_handler_function)(void *)

Function pointer type to interrupt handler function.

Definition at line 187 of file MAX77654.h.


Member Enumeration Documentation

enum ade_ldo_t

Register Configuration.

  • Register : CNFG_LDO0_B (0x39) and CNFG_LDO1_B (0x3B)
  • Bit Fields : [3]
  • Default : 0x0
  • Description : LDO0 or 1 Active-Discharge Enable.

Definition at line 3175 of file MAX77654.h.

enum ade_sbb_t

Register Configuration.

  • Register : CNFG_SBB0_B (0x2A), CNFG_SBB1_B (0x2C) (0x2B) and CNFG_SBB2_B (0x2E)
  • Bit Fields : [3]
  • Default : 0x0
  • Description : SIMO Buck-Boost Channel 0, 1 or 2 Active-Discharge Enable.

Definition at line 2841 of file MAX77654.h.

enum alt_gpio_t

Register Configuration.

  • Register : CNFG_GPIO0 (0x11), CNFG_GPIO1 (0x12) and CNFG_GPIO2 (0x13)
  • Bit Fields : [5]
  • Default : 0x0
  • Description : Alternate Mode Enable for GPIO 0, 1 or 2.

Definition at line 998 of file MAX77654.h.

enum bok_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [6]
  • Default : 0x0
  • Description : BOK Interrupt Status.

Definition at line 327 of file MAX77654.h.

enum chg_cc_t

Register Configuration.

  • Register : CNFG_CHG_E (0x24), and CNFG_CHG_F (0x25)
  • Bit Fields : [7:2]
  • Default : 0x0
  • Description : Fast-Charge Constant Current Value, IFAST-CHG or IFAST-CHG-JEITA.

Definition at line 2189 of file MAX77654.h.

enum chg_cv_t

Register Configuration.

  • Register : CNFG_CHG_G (0x26) and CNFG_CHG_H (0x27)
  • Bit Fields : [7:2]
  • Default : 0x0
  • Description : Fast-Charge Battery Regulation Voltage, VFAST-CHG or VFAST-CHG-JEITA.

Definition at line 2371 of file MAX77654.h.

enum chg_dtls_t

Register Configuration.

  • Register : STAT_CHG_B (0x03)
  • Bit Fields : [7:4]
  • Default : 0x0
  • Description : Charger Details.

Definition at line 1451 of file MAX77654.h.

enum chg_en_t

Register Configuration.

  • Register : CNFG_CHG_B (0x21)
  • Bit Fields : [0]
  • Default : 0x0
  • Description : Charger Enable.

Definition at line 1943 of file MAX77654.h.

enum chg_pq_t

Register Configuration.

  • Register : CNFG_CHG_C (0x22)
  • Bit Fields : [7:5]
  • Default : 0x0
  • Description : Battery Prequalification Voltage Threshold (VPQ).

Definition at line 1975 of file MAX77654.h.

enum chg_t

Register Configuration.

  • Register : STAT_CHG_B (0x03)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : Quick Charger Status.

Definition at line 1513 of file MAX77654.h.

Register Configuration.

  • Register : STAT_CHG_B (0x03)
  • Bit Fields : [3:2]
  • Default : 0x0
  • Description : CHGIN Status Detail.

Definition at line 1488 of file MAX77654.h.

enum dben_gpi_t

Register Configuration.

  • Register : CNFG_GPIO0 (0x11), CNFG_GPIO1 (0x12) and CNFG_GPIO2 (0x13)
  • Bit Fields : [4]
  • Default : 0x0
  • Description : General Purpose Input Debounce Timer Enable for GPIO 0, 1 or 2.

Definition at line 1032 of file MAX77654.h.

enum dben_nen_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [2]
  • Default : 0x0
  • Description : Debounce Timer Enable for the nEN Pin.

Definition at line 932 of file MAX77654.h.

enum didm_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [7]
  • Default : 0x0
  • Description : Device Identification Bits for Metal Options.

Definition at line 304 of file MAX77654.h.

enum dod0_s_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [5]
  • Default : 0x0
  • Description : LDO0 Dropout Detector Rising Status.

Definition at line 350 of file MAX77654.h.

enum dod1_s_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [4]
  • Default : 0x0
  • Description : LDO1 Dropout Detector Rising Status.

Definition at line 373 of file MAX77654.h.

enum drv_sbb_t

Register Configuration.

  • Register : CNFG_SBB_TOP (0x2F)
  • Bit Fields : [1:0]
  • Default : 0x0
  • Description : SIMO Buck-Boost (all channels) Drive Strength Trim.

Definition at line 2947 of file MAX77654.h.

enum en_ldo_t

Register Configuration.

  • Register : CNFG_LDO0_B (0x39) and CNFG_LDO1_B (0x3B)
  • Bit Fields : [2:0]
  • Default : 0x0
  • Description : Enable Control for LDO0 or 1.

Definition at line 3209 of file MAX77654.h.

enum en_sbb_t

Register Configuration.

  • Register : CNFG_SBB0_B (0x2A), CNFG_SBB1_B (0x2C) (0x2B) and CNFG_SBB2_B (0x2E)
  • Bit Fields : [5:4]
  • Default : 0x0
  • Description : Enable Control for SIMO Buck-Boost Channel 0, 1 or 2.

Definition at line 2875 of file MAX77654.h.

enum ercflag_t

Register Configuration.

  • Register : ERCFLAG (0x05)
  • Bit Fields : [7:0]
  • Default : 0x0
  • Description : Event Recorder Flags.

Definition at line 218 of file MAX77654.h.

enum gpo_di_t

Register Configuration.

  • Register : CNFG_GPIO0 (0x11), CNFG_GPIO1 (0x12) and CNFG_GPIO2 (0x13)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : GPIO Digital Input Value for GPIO 0, 1 or 2.

Definition at line 1134 of file MAX77654.h.

enum gpo_dir_t

Register Configuration.

  • Register : CNFG_GPIO0 (0x11), CNFG_GPIO1 (0x12) and CNFG_GPIO2 (0x13)
  • Bit Fields : [0]
  • Default : 0x0
  • Description : GPIO Direction for GPIO 0, 1 or 2.

Definition at line 1168 of file MAX77654.h.

enum gpo_do_t

Register Configuration.

  • Register : CNFG_GPIO0 (0x11), CNFG_GPIO1 (0x12) and CNFG_GPIO2 (0x13)
  • Bit Fields : [3]
  • Default : 0x0
  • Description : General Purpose Output Data Output for GPIO 0, 1 or 2.

Definition at line 1066 of file MAX77654.h.

enum gpo_drv_t

Register Configuration.

  • Register : CNFG_GPIO0 (0x11), CNFG_GPIO1 (0x12) and CNFG_GPIO2 (0x13)
  • Bit Fields : [2]
  • Default : 0x0
  • Description : General Purpose Output Driver Type for GPIO 0, 1 or 2.

Definition at line 1100 of file MAX77654.h.

enum i_pq_t

Register Configuration.

  • Register : CNFG_CHG_B (0x21)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : Prequalification Charge Current as a percentage of IFAST-CHG.

Definition at line 1911 of file MAX77654.h.

enum i_term_t

Register Configuration.

  • Register : CNFG_CHG_C (0x22)
  • Bit Fields : [4:3]
  • Default : 0x0
  • Description : Charger Termination Current (ITERM).

Definition at line 2013 of file MAX77654.h.

Register Configuration.

  • Register : CNFG_SBB_TOP (0x2F)
  • Bit Fields : [7]
  • Default : 0x0
  • Description : Changes how CNFG_CHG_B.ICHGIN_LIM is interpreted.

Definition at line 2915 of file MAX77654.h.

Register Configuration.

  • Register : CNFG_CHG_B (0x21)
  • Bit Fields : [4:2]
  • Default : 0x0
  • Description : CHGIN Input Current Limit.

Definition at line 1873 of file MAX77654.h.

Register Configuration.

  • Register : CNFG_CHG_I (0x28)
  • Bit Fields : [7:4]
  • Default : 0x0
  • Description : Battery Discharge Current Full-Scale Current Value.

Definition at line 2517 of file MAX77654.h.

enum int_glbl_t

Register Configuration All Interrupt Flags combined from INT_GLBL0, INT_GLBL1 and INT_CHG.

  • Register : ERCFLAG (0x05)
  • Bit Fields : [7:0]
  • Default : 0x0
  • Description : Enumerated interrupt flags

Definition at line 148 of file MAX77654.h.

enum intm_t

Register Configuration.

  • Register : INT_M_CHG (0x07), INTM_GLBL1 (0x08), and INTM_GLBL0 (0x09)
  • Bit Fields : [7:0]
  • Default : 0x0
  • Description : Interrupt Masks.

Definition at line 488 of file MAX77654.h.

enum ip_sbb_t

Register Configuration.

  • Register : CNFG_SBB0_B (0x2A), CNFG_SBB1_B (0x2C) (0x2B) and CNFG_SBB2_B (0x2E)
  • Bit Fields : [5:4]
  • Default : 0x0
  • Description : SIMO Buck-Boost Channel 0, 1 or 2 Peak Current Limit.

Definition at line 2805 of file MAX77654.h.

enum ldo_md_t

Register Configuration.

  • Register : CNFG_LDO0_B (0x39) and CNFG_LDO1_B (0x3B)
  • Bit Fields : [4]
  • Default : 0x0
  • Description : Operation Mode of LDO0 or 1.

Definition at line 3141 of file MAX77654.h.

enum mux_sel_t

Register Configuration.

  • Register : CNFG_CHG_I (0x28)
  • Bit Fields : [3:0]
  • Default : 0x0
  • Description : Analog channel to connect to AMUX.

Definition at line 2563 of file MAX77654.h.

enum nen_mode_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [3]
  • Default : 0x0
  • Description : nEN Input (ON-KEY) Default Configuration Mode.

Definition at line 900 of file MAX77654.h.

enum op_mode_t

Register Configuration.

  • Register : CNFG_SBB0_B (0x2A), CNFG_SBB1_B (0x2C) (0x2B) and CNFG_SBB2_B (0x2E)
  • Bit Fields : [6]
  • Default : 0x0
  • Description : Operation mode of SBB0, 1 or 2.

Definition at line 2771 of file MAX77654.h.

enum pu_dis_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [7]
  • Default : 0x0
  • Description : nEN Internal Pullup Resistor.

Definition at line 772 of file MAX77654.h.

enum sbia_en_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [4]
  • Default : 0x0
  • Description : Main Bias Enable Software Request.

Definition at line 868 of file MAX77654.h.

enum sbia_lpm_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [5]
  • Default : 0x0
  • Description : Main Bias Low-Power Mode Software Request.

Definition at line 836 of file MAX77654.h.

enum sft_ctrl_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [1:0]
  • Default : 0x0
  • Description : Software Reset Functions.

Definition at line 964 of file MAX77654.h.

enum stat_en_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : Debounced Status for the nEN input.

Definition at line 442 of file MAX77654.h.

enum stat_irq_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [0]
  • Default : 0x0
  • Description : Software Version of the nIRQ MOSFET gate drive.

Definition at line 465 of file MAX77654.h.

enum stat_t

Register Configuration.

  • Register : STAT_CHG_A (0x02)
  • Bit Fields : [6:3]
  • Default : 0x0
  • Description : Status bits if it is engaged or not.

Definition at line 1371 of file MAX77654.h.

Register Configuration.

  • Register : CNFG_CHG_E (0x24)
  • Bit Fields : [1:0]
  • Default : 0x0
  • Description : Fast-charge Safety timer, tFC.

Definition at line 2283 of file MAX77654.h.

enum t_mrst_t

Register Configuration.

  • Register : CNFG_GLBL (0x10)
  • Bit Fields : [6]
  • Default : 0x0
  • Description : Manual Reset Time (tMRST).

Definition at line 804 of file MAX77654.h.

enum t_topoff_t

Register Configuration.

  • Register : CNFG_CHG_C (0x22)
  • Bit Fields : [2:0]
  • Default : 0x0
  • Description : Top-off Timer Value.

Definition at line 2051 of file MAX77654.h.

enum thm_cold_t

Register Configuration.

  • Register : CNFG_CHG_A (0x20)
  • Bit Fields : [1:0]
  • Default : 0x0
  • Description : VCOLD JEITA Temperature Threshold.

Definition at line 1801 of file MAX77654.h.

enum thm_cool_t

Register Configuration.

  • Register : CNFG_CHG_A (0x20)
  • Bit Fields : [3:2]
  • Default : 0x0
  • Description : VCOOL JEITA Temperature Threshold.

Definition at line 1767 of file MAX77654.h.

enum thm_dtls_t

Register Configuration.

  • Register : STAT_CHG_A (0x02)
  • Bit Fields : [2:0]
  • Default : 0x0
  • Description : Battery Temperature Details.

Definition at line 1421 of file MAX77654.h.

enum thm_en_t

Register Configuration.

  • Register : CNFG_CHG_F (0x25)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : Thermistor Enable Bit.

Definition at line 2339 of file MAX77654.h.

enum thm_hot_t

Register Configuration.

  • Register : CNFG_CHG_A (0x20)
  • Bit Fields : [7:6]
  • Default : 0x0
  • Description : VHOT JEITA Temperature Threshold.

Definition at line 1699 of file MAX77654.h.

enum thm_warm_t

Register Configuration.

  • Register : CNFG_CHG_A (0x20)
  • Bit Fields : [5:4]
  • Default : 0x0
  • Description : VWARM JEITA Temperature Threshold.

Definition at line 1733 of file MAX77654.h.

enum time_sus_t

Register Configuration.

  • Register : STAT_CHG_B (0x03)
  • Bit Fields : [0]
  • Default : 0x0
  • Description : Time Suspend Indicator.

Definition at line 1536 of file MAX77654.h.

enum tj_reg_t

Register Configuration.

  • Register : CNFG_CHG_D (0x23)
  • Bit Fields : [7:5]
  • Default : 0x0
  • Description : Die Junction Temperature Regulation Point, TJ-REG.

Definition at line 2089 of file MAX77654.h.

enum tjal1_s_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [2]
  • Default : 0x0
  • Description : Thermal Alarm 1 Status.

Definition at line 419 of file MAX77654.h.

enum tjal2_s_t

Register Configuration.

  • Register : STAT_GLBL (0x06)
  • Bit Fields : [3]
  • Default : 0x0
  • Description : Thermal Alarm 2 Status.

Definition at line 396 of file MAX77654.h.

enum tv_ldo_t

Register Configuration.

  • Register : CNFG_LDO0_A (0x38) and CNFG_LDO1_A (0x3A)
  • Bit Fields : [6:0]
  • Default : 0x0
  • Description : LDO Target Output Voltage.

Definition at line 2981 of file MAX77654.h.

enum tv_sbb_t

Register Configuration.

  • Register : CNFG_SBB0_A (0x29), CNFG_SBB1_A (0x2B) and CNFG_SBB2_A (0x2D)
  • Bit Fields : [6:0]
  • Default : 0x0
  • Description : SIMO Buck-Boost Channel 0, 1 or 2 Target Output Voltage.

Definition at line 2609 of file MAX77654.h.

enum usbs_t

Register Configuration.

  • Register : CNFG_CHG_G (0x26)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : USB suspend mode.

Definition at line 2465 of file MAX77654.h.

Register Configuration.

  • Register : CNFG_CHG_B (0x21)
  • Bit Fields : [7:5]
  • Default : 0x0
  • Description : Minimum CHGIN Regulation Voltage.

Definition at line 1835 of file MAX77654.h.

enum vsys_reg_t

Register Configuration.

  • Register : CNFG_CHG_D (0x23)
  • Bit Fields : [4:0]
  • Default : 0x0
  • Description : System Voltage Regulation (VSYS-REG).

Definition at line 2127 of file MAX77654.h.

enum wdt_clr_t

Register Configuration.

  • Register : CNFG_WDT (0x17)
  • Bit Fields : [2]
  • Default : 0x0
  • Description : Watchdog Timer Clear Control.

Definition at line 1275 of file MAX77654.h.

enum wdt_en_t

Register Configuration.

  • Register : CNFG_WDT (0x17)
  • Bit Fields : [1]
  • Default : 0x0
  • Description : Watchdog Timer Enable.

Definition at line 1307 of file MAX77654.h.

enum wdt_lock_t

Register Configuration.

  • Register : CNFG_WDT (0x17)
  • Bit Fields : [0]
  • Default : 0x0
  • Description : Factory-Set Safety Bit for the Watchdog Timer.

Definition at line 1339 of file MAX77654.h.

enum wdt_mode_t

Register Configuration.

  • Register : CNFG_WDT (0x17)
  • Bit Fields : [3]
  • Default : 0x0
  • Description : Watchdog Timer Expired Action.

Definition at line 1243 of file MAX77654.h.

enum wdt_per_t

Register Configuration.

  • Register : CNFG_WDT (0x17)
  • Bit Fields : [5:4]
  • Default : 0x0
  • Description : Watchdog Timer Period.

Definition at line 1209 of file MAX77654.h.


Constructor & Destructor Documentation

MAX77654 ( I2C *  i2c,
PinName  IRQPin = NC 
)

MAX77654 constructor.

Definition at line 42 of file MAX77654.cpp.

~MAX77654 (  )

MAX77654 destructor.

Definition at line 64 of file MAX77654.cpp.


Member Function Documentation

int GetAlternateModeEnable ( uint8_t  channel,
alt_gpio_t alt_gpio 
)

Get Alternate Mode Enable for GPIO.

Parameters:
[in]channelChannel number: 0, 1 or 2
[out]alt_gpioAlternate mode enable for GPIO bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 922 of file MAX77654.cpp.

int GetAMUX ( mux_sel_t mux_sel )

Get the Battery Discharge Current Full-Scale Current Value.

Parameters:
[out]imon_dischg_scalethe battery discharge current full-scale current value field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2204 of file MAX77654.cpp.

int GetBatteryChargerEnable ( chg_en_t chg_en )

Get Charger Enable.

Parameters:
[out]chg_enCharger enable bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1868 of file MAX77654.cpp.

int GetBatteryPQVoltageThreshold ( chg_pq_t chg_pq )

Get Battery Prequalification Voltage Threshold (VPQ).

Parameters:
[out]chg_pqBattery prequalification voltage threshold field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1892 of file MAX77654.cpp.

int GetBatteryTemperatureDetails ( thm_dtls_t thm_dtls )

Get Battery Temperature Details.

Valid only when CHGIN_DTLS[1:0] = 0b11.

Parameters:
[out]thm_dtlsBattery temperature details field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1448 of file MAX77654.cpp.

int GetBOKInterruptStatus ( bok_t bok )

Get BOK Interrupt Status.

Parameters:
[out]bokMain bias status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 268 of file MAX77654.cpp.

int GetChargerDetails ( chg_dtls_t chg_dtls )

Get Charger Details.

Parameters:
[out]chg_dtlsCharger details field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1463 of file MAX77654.cpp.

int GetChargerTerminationCurrent ( i_term_t i_term )

Get Charger Termination Current (ITERM).

I_TERM[1:0] sets the charger termination current as a percentage of the fast charge current IFAST-CHG.

Parameters:
[out]i_termCharger termination current field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1916 of file MAX77654.cpp.

int GetCHGINCTRLMBit ( intm_t intm )

Get CHGIN_CTRL_I.

Setting this bit prevents the CHGIN_CTRL_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1580 of file MAX77654.cpp.

int GetCHGINCurrentLimitLoopStatus ( stat_t stat )

Get Input Current Limit Loop Status.

Parameters:
[out]statStatus bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1403 of file MAX77654.cpp.

int GetCHGINInputCurrentLimit ( ichgin_lim_def_t ichgin_lim_def )

Get Changes how CNFG_CHG_B.ICHGIN_LIM is interpreted.

Parameters:
[out]ichgin_lim_defCNFG_CHG_B.ICHGIN_LIM bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2508 of file MAX77654.cpp.

int GetCHGINInputCurrentLimit ( ichgin_lim_t ichgin_lim )

Get CHGIN Input Current Limit.

Parameters:
[out]ichgin_limCHGIN input current limit field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1820 of file MAX77654.cpp.

int GetCHGINMBit ( intm_t intm )

Get CHGIN_I.

Setting this bit prevents the CHGIN_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1628 of file MAX77654.cpp.

int GetCHGINStatusDetails ( chgin_dtls_t chgin_dtls )

Get CHGIN Status Detail.

Parameters:
[out]chgin_dtlsCHGIN status detail field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1478 of file MAX77654.cpp.

int GetCHGINUSBSuspendMode ( usbs_t usbs )

Get USBS.

Setting this bit places CHGIN in USB suspend mode.

Parameters:
[out]usbsUSB suspend mode bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2132 of file MAX77654.cpp.

int GetCHGMBit ( intm_t intm )

Get CHG_I.

Setting this bit prevents the CHG_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1652 of file MAX77654.cpp.

int GetCID ( void   )

Read the CID.

Read and return Chip Identification Code register value

Returns:
CID if no errors, error code on failure.

Definition at line 1256 of file MAX77654.cpp.

int GetCOLDJEITATemperature ( thm_cold_t thm_cold )

Get the VCOLD JEITA Temperature Threshold.

Parameters:
[out]thm_coldThe VCOLD JEITA temperature threshold field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1772 of file MAX77654.cpp.

int GetCOOLJEITATemperature ( thm_cool_t thm_cool )

Get the VCOOL JEITA Temperature Threshold.

Parameters:
[out]thm_coolThe VCOOL JEITA temperature threshold field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1748 of file MAX77654.cpp.

int GetDebounceTimerEnable ( dben_nen_t dben_nen )

Get Debounce Timer Enable for the nEN Pin.

Parameters:
[out]dben_nenDebounce timer enable for the nEN pin bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 862 of file MAX77654.cpp.

int GetDeviceIdentification ( didm_t didm )

Get Device Identification Bits for Metal Options.

Parameters:
[out]didmDevice identification bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 253 of file MAX77654.cpp.

int GetDieJunctionTemperature ( tj_reg_t tj_reg )

Get the Die Junction Temperature Regulation Point, TJ-REG.

Parameters:
[out]tj_regThe die junction temperature regulation point field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1964 of file MAX77654.cpp.

int GetDischargeCurrentFullScale ( imon_dischg_scale_t imon_dischg_scale )

Get the Battery Discharge Current Full-Scale Current Value.

Parameters:
[out]imon_dischg_scalethe battery discharge current full-scale current value field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2180 of file MAX77654.cpp.

int GetDropout0RisingInterruptMask ( intm_t intm )

Get LDO Dropout0 Detector Rising Interrupt Mask.

Parameters:
[out]intmLDO dropout0 detector rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 550 of file MAX77654.cpp.

int GetDropout1RisingInterruptMask ( intm_t intm )

Get LDO Dropout1 Detector Rising Interrupt Mask.

Parameters:
[out]intmLDO dropout1 detector rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 574 of file MAX77654.cpp.

int GetFactorySetSafetyBit ( wdt_lock_t wdt_lock )

Get Factory-Set Safety Bit for the Watchdog Timer.

Parameters:
[out]wdt_lockFactory-set safety bit for the watchdog timer to be read.
Returns:
0 on success, error code on failure.

Definition at line 1373 of file MAX77654.cpp.

int GetFastChargeBatteryRegVolt ( chg_cv_t chg_cv )

Get Fast-Charge Battery Regulation Voltage, VFAST-CHG.

Parameters:
[out]chg_cvFast-charge battery regulation voltage field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2108 of file MAX77654.cpp.

int GetFastChargeCCJEITA ( chg_cc_t chg_cc_jeita )

Get IFAST-CHG-JEITA when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.

Parameters:
[out]chg_cc_jeitaIFAST-CHG-JEITA field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2060 of file MAX77654.cpp.

int GetFastChargeCCValue ( chg_cc_t chg_cc )

Get the Fast-Charge Constant Current Value, IFAST-CHG.

Parameters:
[out]chg_ccthe fast-charge constant current value field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2012 of file MAX77654.cpp.

int GetFastChargeVoltageJEITA ( chg_cv_t chg_cv_jeita )

Get the modified VFAST-CHG-JEITA for when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.

Parameters:
[out]chg_cv_jeitaModified VFAST-CHG-JEITA field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2156 of file MAX77654.cpp.

int GetFastChargSafetyTimer ( t_fast_chg_t t_fast_chg )

Get the Fast-charge Safety timer, tFC.

Parameters:
[out]t_fast_chgFast-charge safety timer field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2036 of file MAX77654.cpp.

int GetGPI0FallingInterruptMask ( intm_t intm )

Get GPI0 Falling Interrupt Mask.

Parameters:
[out]intmGPI falling interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 718 of file MAX77654.cpp.

int GetGPI0RisingInterruptMask ( intm_t intm )

Get GPI0 Rising Interrupt Mask.

Parameters:
[out]intmGPI rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 694 of file MAX77654.cpp.

int GetGPI1FallingInterruptMask ( intm_t intm )

Get GPI1 Falling Mask.

Parameters:
[out]intmGPI1 falling interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 526 of file MAX77654.cpp.

int GetGPI1RisingInterruptMask ( intm_t intm )

Get GPI1 Rising Mask.

Parameters:
[out]intmGPI1 rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 502 of file MAX77654.cpp.

int GetGPI2FallingInterruptMask ( intm_t intm )

Get GPI2 Falling Mask.

Parameters:
[out]intmGPI2 falling interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 478 of file MAX77654.cpp.

int GetGPI2RisingInterruptMask ( intm_t intm )

Get GPI2 Rising Mask.

Parameters:
[out]intmGPI2 rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 454 of file MAX77654.cpp.

int GetGPIDebounceTimerEnable ( uint8_t  channel,
dben_gpi_t dben_gpi 
)

Get General Purpose Input Debounce Timer Enable.

Parameters:
[in]channelChannel number: 0, 1 or 2
[out]dben_gpiGeneral purpose input debounce timer enable bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 981 of file MAX77654.cpp.

int GetGPIODirection ( uint8_t  channel,
gpo_dir_t gpo_dir 
)

Get GPIO Direction.

Parameters:
[in]channelChannel number
[out]gpo_dirGPIO direction bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1218 of file MAX77654.cpp.

int GetGPIOInputValue ( uint8_t  channel,
gpo_di_t gpo_di 
)

Get GPIO Digital Input Value.

Parameters:
[in]channelChannel number: 0, 1 or 2
[out]gpo_diGPIO digital input value bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1159 of file MAX77654.cpp.

int GetGPODataOutput ( uint8_t  channel,
gpo_do_t gpo_do 
)

Get General Purpose Output Data Output.

Parameters:
[in]channelChannel number: 0, 1 or 2
[out]gpo_doGeneral purpose output data output bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1041 of file MAX77654.cpp.

int GetGPODriveType ( uint8_t  channel,
gpo_drv_t gpo_drv 
)

Get General Purpose Output Driver Type.

Parameters:
[in]channelChannel number: 0, 1 or 2
[out]gpo_drvGeneral purpose output driver type bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1100 of file MAX77654.cpp.

int GetHOTJEITATemperature ( thm_hot_t thm_hot )

Get the VHOT JEITA Temperature Threshold.

Parameters:
[out]thm_hotThe VHOT JEITA temperature threshold field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1700 of file MAX77654.cpp.

int GetLDO0DropoutRisingStatus ( dod0_s_t dod0_s )

Get LDO0 Dropout Detector Rising Status.

Parameters:
[out]dod0_sLDO0 dropout status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 283 of file MAX77654.cpp.

int GetLDO0FaultInterruptMask ( intm_t intm )

Get LDO1 Fault Interrupt Mask.

Parameters:
[out]intmLDO1 fault interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 406 of file MAX77654.cpp.

int GetLDO1DropoutRisingStatus ( dod1_s_t dod1_s )

Get LDO1 Dropout Detector Rising Status.

Parameters:
[out]dod1_sLDO1 dropout status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 298 of file MAX77654.cpp.

int GetLDO1FaultInterruptMask ( intm_t intm )

Get LDO1 Fault Interrupt Mask.

Parameters:
[out]intmLDO1 fault interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 382 of file MAX77654.cpp.

int GetLDOActiveDischargeEnable ( uint8_t  channel,
ade_ldo_t ade_ldo 
)

Get LDOx Active-Discharge Enable.

Parameters:
[in]channelChannel number: 0 or 1
[out]ade_ldoLDOx active-discharge enable bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2652 of file MAX77654.cpp.

int GetLDOEnableControl ( uint8_t  channel,
en_ldo_t en_ldo 
)

Get Enable Control for LDOx.

Parameters:
[in]channelChannel number: 0 or 1.
[in]en_ldoEnable control for LDOx field to be read.
Returns:
0 on success, error code on failure

Definition at line 2696 of file MAX77654.cpp.

int GetLDOMode ( uint8_t  channel,
ldo_md_t ldo_md 
)

Get Operation Mode of LDOx.

Parameters:
[in]channelChannel number: 0 or 1
[out]ldo_mdOperation mode of LDOx bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2608 of file MAX77654.cpp.

int GetLDOTargetOutVoltage ( uint8_t  channel,
tv_ldo_t tv_ldo 
)

Get LDO Target Output Voltage.

Parameters:
[in]channelChannel number: 0 or 1
[out]tv_ldoLDO target output voltage field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2564 of file MAX77654.cpp.

int GetMainBiasEnableReq ( sbia_en_t sbia_en )

Get Main Bias Enable Software Request.

Parameters:
[out]sbia_enMain bias enable software request bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 814 of file MAX77654.cpp.

int GetMainBiasLowerPowerModeReq ( sbia_lpm_t sbia_lpm )

Get Main Bias Low-Power Mode Software Request.

Parameters:
[out]sbia_lpmMain bias low-power mode software request bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 790 of file MAX77654.cpp.

int GetManualResetTime ( t_mrst_t t_mrst )

Get the Manual Reset Time (tMRST).

Parameters:
[out]t_mrstManual reset time bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 766 of file MAX77654.cpp.

int GetManualResetTimer ( ercflag_t ercflag )

Get Manual Reset Timer Flag.

Parameters:
[out]ercflagManual reset timer bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 178 of file MAX77654.cpp.

int GetMaximumJunctionTempLoopStatus ( stat_t stat )

Get Maximum Junction Temperature Regulation Loop Status.

Parameters:
[out]statStatus bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1433 of file MAX77654.cpp.

int GetMinimumCHGINVoltage ( vchgin_min_t vchgin_min )

Get Minimum CHGIN Regulation Voltage.

Parameters:
[out]vchgin_minMinimum CHGIN regulation voltage field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1796 of file MAX77654.cpp.

int GetMinimumSYSVoltageLoopStatus ( stat_t stat )

Get Minimum System Voltage Regulation Loop Status.

Parameters:
[out]statStatus bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1418 of file MAX77654.cpp.

int GetMinimumVCHGINVoltageLoopStatus ( stat_t stat )

Get Minimum Input Voltage Regulation Loop Status.

Parameters:
[out]statStatus bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1388 of file MAX77654.cpp.

int GetnENDebouncedStatus ( stat_en_t stat_en )

Get Debounced Status for the nEN input.

Parameters:
[out]stat_enDebounced status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 343 of file MAX77654.cpp.

int GetnENFallingInterruptMask ( intm_t intm )

Get nEN Falling Interrupt Mask.

Parameters:
[out]intmnEN falling interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 670 of file MAX77654.cpp.

int GetnEnInputMode ( nen_mode_t nen_mode )

Get nEN Input (ON-KEY) Default Configuration Mode.

Parameters:
[out]nen_modenEN input default configuration mode bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 838 of file MAX77654.cpp.

int GetnENInternalPullupResistor ( pu_dis_t pu_dis )

Get nEN Internal Pullup Resistor.

Parameters:
[out]pu_disnEN internal pullup resistor bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 742 of file MAX77654.cpp.

int GetnENRisingInterruptMask ( intm_t intm )

Get nEN Rising Interrupt Mask.

Parameters:
[out]intmnEN rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 646 of file MAX77654.cpp.

int GetPrequalificationChargeCurrent ( i_pq_t i_pq )

Get the Prequalification Charge Current as a percentage of IFAST-CHG.

Parameters:
[out]i_pqthe prequalification charge current bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1844 of file MAX77654.cpp.

int GetQuickChargerStatus ( chg_t chg )

Get Quick Charger Status.

Parameters:
[out]chgQuick charger status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1493 of file MAX77654.cpp.

int GetSBBActiveDischargeEnable ( uint8_t  channel,
ade_sbb_t ade_sbb 
)

Get SIMO Buck-Boost Channel x Active-Discharge Enable.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[out]ade_sbbSIMO buck-boost channel 2 active-discharge enable bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2408 of file MAX77654.cpp.

int GetSBBDriveStrength ( drv_sbb_t drv_sbb )

Get SIMO Buck-Boost (all channels) Drive Strength Trim.

Parameters:
[out]drv_sbbSIMO buck-boost drive strength trim field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2532 of file MAX77654.cpp.

int GetSBBEnableControl ( uint8_t  channel,
en_sbb_t en_sbb 
)

Get Enable Control for SIMO Buck-Boost Channel x.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[out]en_sbbEnable control for SIMO buck-boost channel x field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2464 of file MAX77654.cpp.

int GetSBBPeakCurrentLimit ( uint8_t  channel,
ip_sbb_t ip_sbb 
)

Get SIMO Buck-Boost Channel x Peak Current Limit.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[out]ip_sbbSIMO buck-boost channel 2 peak current limit field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2352 of file MAX77654.cpp.

int GetSBBTargetOutVoltage ( uint8_t  channel,
tv_sbb_t tv_sbb 
)

Get SIMO Buck-Boost Channel x Target Output Voltage.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[out]tv_sbbSIMO buck-boost channel x target output voltage field to be read.
Returns:
0 on success, error code on failure.

Definition at line 2240 of file MAX77654.cpp.

int GetSBBTimeoutMask ( intm_t intm )

Get SBB Timeout Mask.

Parameters:
[out]intmSBB timeout interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 430 of file MAX77654.cpp.

int GetSIMOOperationMode ( uint8_t  channel,
op_mode_t op_mode 
)

Get Operation mode of SBBx.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[out]op_modeOperation mode of SBBx bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2296 of file MAX77654.cpp.

int GetSoftwareColdResetFlag ( ercflag_t ercflag )

Get Software Cold Reset.

Parameters:
[out]ercflagSoftware cold reset bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 208 of file MAX77654.cpp.

int GetSoftwareOffFlag ( ercflag_t ercflag )

Get Software Off Flag.

Parameters:
[out]ercflagSoftware off bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 193 of file MAX77654.cpp.

int GetSoftwareResetFunctions ( sft_ctrl_t sft_ctrl )

Get Software Reset Functions.

Parameters:
[out]sft_ctrlSoftware reset functions field to be read.
Returns:
0 on success, error code on failure.

Definition at line 886 of file MAX77654.cpp.

int GetSoftwareVersionGateDrive ( stat_irq_t stat_irq )

Get Software Version of the nIRQ MOSFET gate drive.

Parameters:
[out]stat_enSoftware version bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 358 of file MAX77654.cpp.

int GetSYSCONFIGMBit ( intm_t intm )

Get SYS_CNFG_I.

Setting this bit prevents the SYS_CNFG_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1532 of file MAX77654.cpp.

int GetSYSCTRLMBit ( intm_t intm )

Get SYS_CTRL_I.

Setting this bit prevents the SYS_CTRL_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1556 of file MAX77654.cpp.

int GetSysOvervoltageLockout ( ercflag_t ercflag )

Get Sys Domain Overvoltage Lockout Flag.

Parameters:
[out]ercflagSys domain overvoltage lockout bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 148 of file MAX77654.cpp.

int GetSystemVoltageRegulation ( vsys_reg_t vsys_reg )

Get System Voltage Regulation (VSYS-REG).

Parameters:
[out]vsys_regSystem voltage regulation field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1988 of file MAX77654.cpp.

int GetSysUndervoltageLockout ( ercflag_t ercflag )

Get Sys Domain Undervoltage Lockout Flag.

Parameters:
[out]ercflagSys domain undervoltage lockout bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 163 of file MAX77654.cpp.

int GetThermalAlarm1RisingInterruptMask ( intm_t intm )

Get Thermal Alarm 1 Rising Interrupt Mask.

Parameters:
[out]intmThermal alarm 1 rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 622 of file MAX77654.cpp.

int GetThermalAlarm1Status ( tjal1_s_t tjal1_s )

Get Thermal Alarm 1 Status.

Parameters:
[out]tjal1_sThermal alarm 1 status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 328 of file MAX77654.cpp.

int GetThermalAlarm2RisingInterruptMask ( intm_t intm )

Get Thermal Alarm 2 Rising Interrupt Mask.

Parameters:
[out]intmThermal alarm 2 rising interrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 598 of file MAX77654.cpp.

int GetThermalAlarm2Status ( tjal2_s_t tjal2_s )

Get Thermal Alarm 2 Status.

Parameters:
[out]tjal2_sThermal alarm 2 status bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 313 of file MAX77654.cpp.

int GetThermalOverload ( ercflag_t ercflag )

Get Thermal Overload Flag.

Parameters:
[out]ercflagThermal overload bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 133 of file MAX77654.cpp.

int GetThermistorEnable ( thm_en_t thm_en )

Get Thermistor enable bit.

Parameters:
[out]thm_enThermistor enable bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 2084 of file MAX77654.cpp.

int GetTHMMBit ( intm_t intm )

Get THM_I.

Setting this bit prevents the THM_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1676 of file MAX77654.cpp.

int GetTimeSuspendedIndicator ( time_sus_t time_sus )

Get Time Suspend Indicator.

Parameters:
[out]time_susTime suspend indicator bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1508 of file MAX77654.cpp.

int GetTJREGMBit ( intm_t intm )

Get TJREG_I.

Setting this bit prevents the TJREG_I bit from causing hardware IRQs

Parameters:
[out]intmInterrupt mask bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1604 of file MAX77654.cpp.

int GetTopOffTimerValue ( t_topoff_t t_topoff )

Get Top-off Timer Value.

Parameters:
[out]t_topoffTop-off timer value field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1940 of file MAX77654.cpp.

int GetWARMJEITATemperature ( thm_warm_t thm_warm )

Get the VWARM JEITA Temperature Threshold.

Parameters:
[out]thm_warmThe VWARM JEITA temperature threshold field to be read.
Returns:
0 on success, error code on failure.

Definition at line 1724 of file MAX77654.cpp.

int GetWatchdogTimerClearControl ( wdt_clr_t wdt_clr )

Get Watchdog Timer Clear Control.

Parameters:
[out]wdt_clrWatchdog timer clear control bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1325 of file MAX77654.cpp.

int GetWatchdogTimerEnable ( wdt_en_t wdt_en )

Get Watchdog Timer Enable.

Parameters:
[out]wdt_enWatchdog timer enable bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1349 of file MAX77654.cpp.

int GetWatchdogTimerExpiredAction ( wdt_mode_t wdt_mode )

Get Watchdog Timer Expired Action.

Parameters:
[out]wdt_modeWatchdog timer expired action bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1301 of file MAX77654.cpp.

int GetWatchdogTimerOffFlag ( ercflag_t ercflag )

Get Watchdog Timer Off Flag.

Parameters:
[out]ercflagWatchdog timer off bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 223 of file MAX77654.cpp.

int GetWatchdogTimerPeriod ( wdt_per_t wdt_per )

Get Watchdog Timer Period.

Parameters:
[out]wdt_perWatchdog timer period bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 1277 of file MAX77654.cpp.

int GetWatchdogTimerResetFlag ( ercflag_t ercflag )

Get Watchdog Timer Reset Flag.

Parameters:
[out]ercflagWatchdog timer reset bit to be read.
Returns:
0 on success, error code on failure.

Definition at line 238 of file MAX77654.cpp.

int IRQDisableAll (  )

Disable all interrupts.

Returns:
0 on success, error code on failure

Definition at line 2723 of file MAX77654.cpp.

int read_register ( uint8_t  reg,
uint8_t *  value 
)

Read from a register.

Parameters:
[in]regAddress of a register to be read.
[out]valuePointer to save result value.
Returns:
0 on success, negative error code on failure.

Definition at line 79 of file MAX77654.cpp.

int SetAlternateModeEnable ( uint8_t  channel,
alt_gpio_t  alt_gpio 
)

Set Alternate Mode Enable for GPIO.

Parameters:
[in]channelChannel number: 0, 1 or 2
[in]alt_gpioAlternate mode enable for GPIO bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 901 of file MAX77654.cpp.

int SetAMUX ( mux_sel_t  mux_sel )

Set the Analog Channel to connect to AMUX.

Parameters:
[in]imon_dischg_scalethe battery discharge current full-scale current value field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2195 of file MAX77654.cpp.

int SetBatteryChargerEnable ( chg_en_t  chg_en )

Set Charger Enable.

Parameters:
[in]chg_enCharger enable bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1859 of file MAX77654.cpp.

int SetBatteryPQVoltageThreshold ( chg_pq_t  chg_pq )

Set Battery Prequalification Voltage Threshold (VPQ).

Parameters:
[in]chg_pqBattery prequalification voltage threshold field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1883 of file MAX77654.cpp.

int SetChargerTerminationCurrent ( i_term_t  i_term )

Set Charger Termination Current (ITERM).

I_TERM[1:0] sets the charger termination current as a percentage of the fast charge current IFAST-CHG.

Parameters:
[in]i_termCharger termination current field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1907 of file MAX77654.cpp.

int SetCHGINCTRLMBit ( intm_t  intm )

Set CHGIN_CTRL_I.

Setting this bit prevents the CHGIN_CTRL_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1571 of file MAX77654.cpp.

int SetCHGINInputCurrentLimit ( ichgin_lim_def_t  ichgin_lim_def )

Set Changes how CNFG_CHG_B.ICHGIN_LIM is interpreted.

Parameters:
[in]ichgin_lim_defCNFG_CHG_B.ICHGIN_LIM bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2499 of file MAX77654.cpp.

int SetCHGINInputCurrentLimit ( ichgin_lim_t  ichgin_lim )

Set CHGIN Input Current Limit.

Parameters:
[in]ichgin_limCHGIN input current limit field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1811 of file MAX77654.cpp.

int SetCHGINMBit ( intm_t  intm )

Set CHGIN_I.

Setting this bit prevents the CHGIN_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1619 of file MAX77654.cpp.

int SetCHGINUSBSuspendMode ( usbs_t  usbs )

Set USBS.

Setting this bit places CHGIN in USB suspend mode.

Parameters:
[in]usbsUSB suspend mode bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2123 of file MAX77654.cpp.

int SetCHGMBit ( intm_t  intm )

Set CHG_I.

Setting this bit prevents the CHG_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1643 of file MAX77654.cpp.

int SetCOLDJEITATemperature ( thm_cold_t  thm_cold )

Set the VCOLD JEITA Temperature Threshold.

Parameters:
[in]thm_coldThe VCOLD JEITA temperature threshold field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1763 of file MAX77654.cpp.

int SetCOOLJEITATemperature ( thm_cool_t  thm_cool )

Set the VCOOL JEITA Temperature Threshold.

Parameters:
[in]thm_coolThe VCOOL JEITA temperature threshold field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1739 of file MAX77654.cpp.

int SetDebounceTimerEnable ( dben_nen_t  dben_nen )

Set Debounce Timer Enable for the nEN Pin.

Parameters:
[in]dben_nenDebounce timer enable for the nEN pin bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 853 of file MAX77654.cpp.

int SetDieJunctionTemperature ( tj_reg_t  tj_reg )

Set the Die Junction Temperature Regulation Point, TJ-REG.

Parameters:
[in]tj_regThe die junction temperature regulation point field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1955 of file MAX77654.cpp.

int SetDischargeCurrentFullScale ( imon_dischg_scale_t  imon_dischg_scale )

Set the Battery Discharge Current Full-Scale Current Value.

Parameters:
[in]imon_dischg_scalethe battery discharge current full-scale current value field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2171 of file MAX77654.cpp.

int SetDropout0RisingInterruptMask ( intm_t  intm )

Set LDO Dropout0 Detector Rising Interrupt Mask.

Parameters:
[in]intmLDO dropout0 detector rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 541 of file MAX77654.cpp.

int SetDropout1RisingInterruptMask ( intm_t  intm )

Set LDO Dropout1 Detector Rising Interrupt Mask.

Parameters:
[in]intmLDO dropout1 detector rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 565 of file MAX77654.cpp.

int SetFactorySetSafetyBit ( wdt_lock_t  wdt_lock )

Set Factory-Set Safety Bit for the Watchdog Timer.

Parameters:
[in]wdt_lockFactory-set safety bit for the watchdog timer to be written.
Returns:
0 on success, error code on failure.

Definition at line 1364 of file MAX77654.cpp.

int SetFastChargeBatteryRegVolt ( chg_cv_t  chg_cv )

Set Fast-Charge Battery Regulation Voltage, VFAST-CHG.

Parameters:
[in]chg_cvFast-charge battery regulation voltage field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2099 of file MAX77654.cpp.

int SetFastChargeCCJEITA ( chg_cc_t  chg_cc_jeita )

Set IFAST-CHG-JEITA when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.

Parameters:
[in]chg_cc_jeitaIFAST-CHG-JEITA field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2051 of file MAX77654.cpp.

int SetFastChargeCCValue ( chg_cc_t  chg_cc )

Set the Fast-Charge Constant Current Value, IFAST-CHG.

Parameters:
[in]chg_ccthe fast-charge constant current value field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2003 of file MAX77654.cpp.

int SetFastChargeVoltageJEITA ( chg_cv_t  chg_cv_jeita )

Set the modified VFAST-CHG-JEITA for when the battery is either cool or warm as defined by the VCOOL and VWARM temperature thresholds.

Parameters:
[in]chg_cv_jeitaModified VFAST-CHG-JEITA field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2147 of file MAX77654.cpp.

int SetFastChargSafetyTimer ( t_fast_chg_t  t_fast_chg )

Set the Fast-charge Safety timer, tFC.

Parameters:
[in]t_fast_chgFast-charge safety timer field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2027 of file MAX77654.cpp.

int SetGPI0FallingInterruptMask ( intm_t  intm )

Set GPI0 Falling Interrupt Mask.

Parameters:
[in]intmGPI falling interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 709 of file MAX77654.cpp.

int SetGPI0RisingInterruptMask ( intm_t  intm )

Set GPI0 Rising Interrupt Mask.

Parameters:
[in]intmGPI rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 685 of file MAX77654.cpp.

int SetGPI1FallingInterruptMask ( intm_t  intm )

Set GPI1 Falling Interrupt Mask.

Parameters:
[in]intmGPI1 falling interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 517 of file MAX77654.cpp.

int SetGPI1RisingInterruptMask ( intm_t  intm )

Set GPI1 Rising Interrupt Mask.

Parameters:
[in]intmGPI1 rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 493 of file MAX77654.cpp.

int SetGPI2FallingInterruptMask ( intm_t  intm )

Set GPI2 Falling Interrupt Mask.

Parameters:
[in]intmGPI2 falling interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 469 of file MAX77654.cpp.

int SetGPI2RisingInterruptMask ( intm_t  intm )

Set GPI2 Rising Interrupt Mask.

Parameters:
[in]intmGPI2 rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 445 of file MAX77654.cpp.

int SetGPIDebounceTimerEnable ( uint8_t  channel,
dben_gpi_t  dben_gpi 
)

Set General Purpose Input Debounce Timer Enable.

Parameters:
[in]channelChannel number: 0, 1 or 2
[in]dben_gpiGeneral purpose input debounce timer enable bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 960 of file MAX77654.cpp.

int SetGPIODirection ( uint8_t  channel,
gpo_dir_t  gpo_dir 
)

Set GPIO Direction.

Parameters:
[in]channelChannel number: 0, 1 or 2
[in]gpo_dirGPIO direction bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1197 of file MAX77654.cpp.

int SetGPIOInputValue ( uint8_t  channel,
gpo_di_t  gpo_di 
)

Set GPIO Digital Input Value.

Parameters:
[in]channelChannel number: 0, 1 or 2
[in]gpo_diGPIO digital input value bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1138 of file MAX77654.cpp.

int SetGPODataOutput ( uint8_t  channel,
gpo_do_t  gpo_do 
)

Set General Purpose Output Data Output.

Parameters:
[in]channelChannel number: 0, 1 or 2
[in]gpo_doGeneral purpose output data output bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1019 of file MAX77654.cpp.

int SetGPODriveType ( uint8_t  channel,
gpo_drv_t  gpo_drv 
)

Set General Purpose Output Driver Type.

Parameters:
[in]channelChannel number: 0, 1 or 2
[in]gpo_drvGeneral purpose output driver type bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1079 of file MAX77654.cpp.

int SetHOTJEITATemperature ( thm_hot_t  thm_hot )

Set the VHOT JEITA Temperature Threshold.

Parameters:
[in]thm_hotThe VHOT JEITA temperature threshold field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1691 of file MAX77654.cpp.

void SetInterruptHandler ( int_glbl_t  id,
interrupt_handler_function  func,
void *  cb 
)

Set Interrupt Handler for a Specific Interrupt ID.

Parameters:
[in]idInterrupt id, one of INTR_ID_*.
[in]funcInterrupt handler function.
[in]cbInterrupt handler data.

Definition at line 2764 of file MAX77654.cpp.

int SetLDO0FaultInterruptMask ( intm_t  intm )

Set LDO0 Fault Interrupt Mask.

Parameters:
[in]intmLDO0 fault interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 397 of file MAX77654.cpp.

int SetLDO1FaultInterruptMask ( intm_t  intm )

Set LDO1 Fault Interrupt Mask.

Parameters:
[in]intmLDO1 fault interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 373 of file MAX77654.cpp.

int SetLDOActiveDischargeEnable ( uint8_t  channel,
ade_ldo_t  ade_ldo 
)

Set LDOx Active-Discharge Enable.

Parameters:
[in]channelChannel number: 0 or 1
[in]ade_ldoLDOx active-discharge enable bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2635 of file MAX77654.cpp.

int SetLDOEnableControl ( uint8_t  channel,
en_ldo_t  en_ldo 
)

Set Enable Control for LDOx.

Parameters:
[in]channelChannel number: 0 or 1.
[in]en_ldoEnable control for LDOx field to be written.
Returns:
0 on success, error code on failure

Definition at line 2679 of file MAX77654.cpp.

int SetLDOMode ( uint8_t  channel,
ldo_md_t  ldo_md 
)

Set Operation Mode of LDOx.

Parameters:
[in]channelChannel number: 0 or 1
[in]ldo_mdOperation mode of LDOx bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2591 of file MAX77654.cpp.

int SetLDOTargetOutVoltage ( uint8_t  channel,
tv_ldo_t  tv_ldo 
)

Set LDO Target Output Voltage.

Parameters:
[in]channelChannel number: 0 or 1
[in]tv_ldoLDO target output voltage field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2547 of file MAX77654.cpp.

int SetMainBiasEnableReq ( sbia_en_t  sbia_en )

Set Main Bias Enable Software Request.

Parameters:
[in]sbia_enMain bias enable software request bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 805 of file MAX77654.cpp.

int SetMainBiasLowerPowerModeReq ( sbia_lpm_t  sbia_lpm )

Set Main Bias Low-Power Mode Software Request.

Parameters:
[in]sbia_lpmmain bias low-power mode software request bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 781 of file MAX77654.cpp.

int SetManualResetTime ( t_mrst_t  t_mrst )

Set the Manual Reset Time (tMRST).

Parameters:
[in]t_mrstManual reset time bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 757 of file MAX77654.cpp.

int SetMinimumCHGINVoltage ( vchgin_min_t  vchgin_min )

Set Minimum CHGIN Regulation Voltage.

Parameters:
[in]vchgin_minMinimum CHGIN regulation voltage field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1787 of file MAX77654.cpp.

int SetnENFallingInterruptMask ( intm_t  intm )

Set nEN Falling Interrupt Mask.

Parameters:
[in]intmnEN falling interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 661 of file MAX77654.cpp.

int SetnEnInputMode ( nen_mode_t  nen_mode )

Set nEN Input (ON-KEY) Default Configuration Mode.

Parameters:
[in]nen_modenEN input default configuration mode bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 829 of file MAX77654.cpp.

int SetnENInternalPullupResistor ( pu_dis_t  pu_dis )

Set nEN Internal Pullup Resistor.

Parameters:
[in]pu_disnEN internal pullup resistor bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 733 of file MAX77654.cpp.

int SetnENRisingInterruptMask ( intm_t  intm )

Set nEN Rising Interrupt Mask.

Parameters:
[in]intmnEN rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 637 of file MAX77654.cpp.

int SetPrequalificationChargeCurrent ( i_pq_t  i_pq )

Set the Prequalification Charge Current as a percentage of IFAST-CHG.

Parameters:
[in]i_pqThe prequalification charge current bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1835 of file MAX77654.cpp.

int SetSBBActiveDischargeEnable ( uint8_t  channel,
ade_sbb_t  ade_sbb 
)

Set SIMO Buck-Boost Channel x Active-Discharge Enable.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[in]ade_sbbSIMO buck-boost channel 2 active-discharge enable bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2387 of file MAX77654.cpp.

int SetSBBDriveStrength ( drv_sbb_t  drv_sbb )

Set SIMO Buck-Boost (all channels) Drive Strength Trim.

Parameters:
[in]drv_sbbSIMO buck-boost drive strength trim field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2523 of file MAX77654.cpp.

int SetSBBEnableControl ( uint8_t  channel,
en_sbb_t  en_sbb 
)

Set Enable Control for SIMO Buck-Boost Channel x.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[in]en_sbbEnable control for SIMO buck-boost channel x field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2443 of file MAX77654.cpp.

int SetSBBPeakCurrentLimit ( uint8_t  channel,
ip_sbb_t  ip_sbb 
)

Set SIMO Buck-Boost Channel x Peak Current Limit.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[in]ip_sbbSIMO buck-boost channel 2 peak current limit field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2331 of file MAX77654.cpp.

int SetSBBTargetOutVoltage ( uint8_t  channel,
tv_sbb_t  tv_sbb 
)

Set SIMO Buck-Boost Channel x Target Output Voltage.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[in]tv_sbbSIMO buck-boost channel x target output voltage field to be written.
Returns:
0 on success, error code on failure.

Definition at line 2219 of file MAX77654.cpp.

int SetSBBTimeoutMask ( intm_t  intm )

Set SBB Timeout Mask.

Parameters:
[in]intmSBB timeout interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 421 of file MAX77654.cpp.

int SetSIMOOperationMode ( uint8_t  channel,
op_mode_t  op_mode 
)

Set Operation mode of SBBx.

Parameters:
[in]channelChannel number: 0, 1 or 2.
[in]op_modeOperation mode of SBBx bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2275 of file MAX77654.cpp.

int SetSoftwareResetFunctions ( sft_ctrl_t  sft_ctrl )

Set Software Reset Functions.

Parameters:
[in]sft_ctrlSoftware reset functions field to be written.
Returns:
0 on success, error code on failure.

Definition at line 877 of file MAX77654.cpp.

int SetSYSCONFIGMBit ( intm_t  intm )

Set SYS_CNFG_I.

Setting this bit prevents the SYS_CNFG_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1523 of file MAX77654.cpp.

int SetSYSCTRLMBit ( intm_t  intm )

Set SYS_CTRL_I.

Setting this bit prevents the SYS_CTRL_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1547 of file MAX77654.cpp.

int SetSystemVoltageRegulation ( vsys_reg_t  vsys_reg )

Set System Voltage Regulation (VSYS-REG).

Parameters:
[in]vsys_regSystem voltage regulation field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1979 of file MAX77654.cpp.

int SetThermalAlarm1RisingInterruptMask ( intm_t  intm )

Set Thermal Alarm 1 Rising Interrupt Mask.

Parameters:
[in]intmThermal alarm 1 rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 613 of file MAX77654.cpp.

int SetThermalAlarm2RisingInterruptMask ( intm_t  intm )

Set Thermal Alarm 2 Rising Interrupt Mask.

Parameters:
[in]intmThermal alarm 2 rising interrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 589 of file MAX77654.cpp.

int SetThermistorEnable ( thm_en_t  thm_en )

Set Thermistor Enable Bit.

Parameters:
[in]thm_enThermistor enable bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 2075 of file MAX77654.cpp.

int SetTHMMBit ( intm_t  intm )

Set THM_I.

Setting this bit prevents the THM_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1667 of file MAX77654.cpp.

int SetTJREGMBit ( intm_t  intm )

Set TJREG_I.

Setting this bit prevents the TJREG_I bit from causing hardware IRQs

Parameters:
[in]intmInterrupt mask bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1595 of file MAX77654.cpp.

int SetTopOffTimerValue ( t_topoff_t  t_topoff )

Set Top-off Timer Value.

Parameters:
[in]t_topoffTop-off timer value field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1931 of file MAX77654.cpp.

int SetWARMJEITATemperature ( thm_warm_t  thm_warm )

Set the VWARM JEITA Temperature Threshold.

Parameters:
[in]thm_warmThe VWARM JEITA temperature threshold field to be written.
Returns:
0 on success, error code on failure.

Definition at line 1715 of file MAX77654.cpp.

int SetWatchdogTimerClearControl ( wdt_clr_t  wdt_clr )

Set Watchdog Timer Clear Control.

Parameters:
[in]wdt_clrWatchdog timer clear control bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1316 of file MAX77654.cpp.

int SetWatchdogTimerEnable ( wdt_en_t  wdt_en )

Set Watchdog Timer Enable.

Parameters:
[in]wdt_enWatchdog timer enable bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1340 of file MAX77654.cpp.

int SetWatchdogTimerExpiredAction ( wdt_mode_t  wdt_mode )

Set Watchdog Timer Expired Action.

Parameters:
[in]wdt_modeWatchdog timer expired action bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1292 of file MAX77654.cpp.

int SetWatchdogTimerPeriod ( wdt_per_t  wdt_per )

Set Watchdog Timer Period.

Parameters:
[in]wdt_perWatchdog timer period bit to be written.
Returns:
0 on success, error code on failure.

Definition at line 1268 of file MAX77654.cpp.

int write_register ( uint8_t  reg,
const uint8_t *  value 
)

Write to a register.

Parameters:
[in]regAddress of a register to be written.
[out]valuePointer of value to be written to register.
Returns:
0 on success, negative error code on failure.

Definition at line 100 of file MAX77654.cpp.