Coulomb Counter API#

sl_coulomb_counter_prescaler_t#

sl_coulomb_counter_prescaler_t

Coulomb counter prescaler enum.

Each count in the counter results registers represents 2^(16 - 2 * prescaler).

sl_coulomb_counter_threshold_t#

sl_coulomb_counter_threshold_t

Coulomb counter threshold for counter full interrupt enum.

Expressed in percentage, the interrupt full interrupt will be raised (if unmasked) when at least one of the counters reaches that threshold.

sl_coulomb_counter_calibration_status_t#

sl_coulomb_counter_calibration_status_t

Coulomb counter calibration status enum.

sl_coulomb_counter_output_mask_t#

typedef uint32_t sl_coulomb_counter_output_mask_t

Bitmask of outputs to operate on.

sl_coulomb_counter_int_enable#

sl_status_t sl_coulomb_counter_int_enable (uint8_t flag)

Enable interrupt.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_int_disable#

sl_status_t sl_coulomb_counter_int_disable (uint8_t flag)

Disable interrupt.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_int_is_set#

sl_status_t sl_coulomb_counter_int_is_set (uint8_t flag, bool * is_set)

Check if interrupt flag is set.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_int_clear#

sl_status_t sl_coulomb_counter_int_clear (uint8_t flag)

Clear interrupt flag.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_init#

sl_status_t sl_coulomb_counter_init (void )

Initialize Coulomb counter peripheral.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_start#

sl_status_t sl_coulomb_counter_start (void )

Start counting coulombs.

This starts the coulomb counter. Outputs selected for measurements must be calibrated when this function is called, or it will fail. When counting, calibration is not permitted.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_stop#

sl_status_t sl_coulomb_counter_stop (void )

Stop counting coulombs.

This stops the coulomb counter. Note that the counter must be stopped before calling sl_coulomb_counter_calibrate().

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_read#

sl_status_t sl_coulomb_counter_read (sl_coulomb_counter_output_mask_t * outputs_need_calibration_mask)

Read coulomb counters.

Read coulomb counters for all outputs selected via configuration header. Note that all outputs must be read at once, as counters are automatically cleared after reading. Values read are accumulated into internal counters. Each count in the counters represents 2^(16 - 2 * prescaler) PFM pulses. This function only reads the counters registers and accumulate these values with counters stored in the driver, to get the charge, one must call sl_coulomb_counter_get_charge() or sl_coulomb_counter_get_total_charge().

Warnings

• Some counters increment slowly, especially when counting in EM2 mode, so if this function is called in a tight loop, it is possible that it keeps reading 0 because the number of PFM pulses is never high enough to reach 2^(16 - 2 * prescaler) and because counters are cleared after being read. That can lead to some PFM cycles not being counted, thus inaccurate results.

Note

• Outputs' modes of operation can change between two reads. If that happens, counters will be accumulated with current calibration settings, and outputs will be set in the out parameter. Subsequent reads of these outputs will be skipped until they are recalibrated.

Returns

• 0 if successful, error code otherwise.

sl_coulomb_counter_get_charge#

float sl_coulomb_counter_get_charge (sl_coulomb_counter_output_mask_t outputs_mask)

Return total charge only for selected outputs.

Return total charge that has flown through selected outputs. This is computed using values accumulated via sl_coulomb_counter_read() and calibration settings.

Returns

• Returns total charge for selected outputs.

sl_coulomb_counter_get_total_charge#

float sl_coulomb_counter_get_total_charge (void )

Return total charge.

Return total charge for all outputs that were selected during initialization.

Returns

• Returns total charge for selected outputs.

sl_coulomb_counter_outputs_available#

sl_coulomb_counter_output_mask_t sl_coulomb_counter_outputs_available (void )

Return available outputs.

Depending on the configuration option, this driver use different peripherals for Coulomb counting. This function returns outputs that are available on the selected peripheral.

Returns

• Returns a mask of available outputs for the selected peripheral.

sl_coulomb_counter_outputs_need_calibration#

sl_coulomb_counter_output_mask_t sl_coulomb_counter_outputs_need_calibration (void )

Return outputs that must be recalibrated.

Some events might require an output to be recalibrated to correctly measure the charge, for instance, if a DCDC changes its operating mode.

Returns

• Returns a mask of outputs that needs to be recalibrated.

sl_coulomb_counter_calibrate_init#

sl_coulomb_counter_calibration_status_t sl_coulomb_counter_calibrate_init (sl_coulomb_counter_output_mask_t outputs_mask)

Setup calibration for selected outputs.

Calibrate, or recalibrate, selected outputs. The counter must be off for calibration to be possible.

Warnings

• During calibration, power consumption of the system must remain stable.

Returns

• SL_COULOMB_COUNTER_CALIBRATION_IN_PROGRESS if successful, SL_COULOMB_COUNTER_CALIBRATION_ERROR otherwise.

sl_coulomb_counter_calibrate_wait#

sl_coulomb_counter_calibration_status_t sl_coulomb_counter_calibrate_wait (void )

Wait for current step of the calibration routine to complete.

This routine waits for the current calibration step to complete before returning. When calibrating in polling mode, this function must be called when sl_coulomb_counter_calibrate() returns SL_COULOMB_COUNTER_CALIBRATION_IN_PROGRESS. When calibrating in interrupt mode, this function is not used.

Returns

• SL_COULOMB_COUNTER_CALIBRATION_IN_PROGRESS if successful, SL_COULOMB_COUNTER_CALIBRATION_ERROR otherwise.

sl_coulomb_counter_calibrate#

sl_coulomb_counter_calibration_status_t sl_coulomb_counter_calibrate (void )

Step function for calibration.

This function is to be called repeatedly either from a loop or from interrupt handler (when STATUS_G.CCC_ISDONE is set) to iterate over the calibration process.

Warnings

• During calibration, power consumption of the system must remain stable.

Returns

• SL_COULOMB_COUNTER_CALIBRATION_DONE when calibration is complete; or SL_COULOMB_COUNTER_CALIBRATION_ERROR in case of error; or SL_COULOMB_COUNTER_CALIBRATION_PEAK_CURRENT_EM0 or SL_COULOMB_COUNTER_CALIBRATION_PEAK_CURRENT_EM2 if the peak current must be changed; or SL_COULOMB_COUNTER_CALIBRATION_IN_PROGRESS. In last three cases, sl_coulomb_counter_calibrate() must be called again to continue the calibration process.

SL_COULOMB_COUNTER_OUTPUT_EFP_VOA#

#define SL_COULOMB_COUNTER_OUTPUT_EFP_VOA

((sl_coulomb_counter_output_mask_t)0x01)

EFP's Output VOA.

SL_COULOMB_COUNTER_OUTPUT_EFP_VOB_EM0#

#define SL_COULOMB_COUNTER_OUTPUT_EFP_VOB_EM0

((sl_coulomb_counter_output_mask_t)0x02)

EFP's Output VOB in EM0 mode.

SL_COULOMB_COUNTER_OUTPUT_EFP_VOB_EM2#

#define SL_COULOMB_COUNTER_OUTPUT_EFP_VOB_EM2

((sl_coulomb_counter_output_mask_t)0x04)

EFP's Output VOB in EM2 mode.

SL_COULOMB_COUNTER_OUTPUT_EFP_VOC#

#define SL_COULOMB_COUNTER_OUTPUT_EFP_VOC

((sl_coulomb_counter_output_mask_t)0x08)

EFP's Output VOC.

SL_COULOMB_COUNTER_OUTPUT_ALL#

#define SL_COULOMB_COUNTER_OUTPUT_ALL

((sl_coulomb_counter_output_mask_t)0x0F)

All Outputs.

SL_COULOMB_COUNTER_OUTPUT_ALL#

#define SL_COULOMB_COUNTER_OUTPUT_ALL

((sl_coulomb_counter_output_mask_t)0x03)

All Outputs.

SL_COULOMB_COUNTER_OUTPUT_DCDC_EM0#

#define SL_COULOMB_COUNTER_OUTPUT_DCDC_EM0

((sl_coulomb_counter_output_mask_t)0x01)

DCDC's Output VOB in EM0 mode.

SL_COULOMB_COUNTER_OUTPUT_DCDC_EM2#

#define SL_COULOMB_COUNTER_OUTPUT_DCDC_EM2

((sl_coulomb_counter_output_mask_t)0x02)

DCDC's Output VOB in EM2 mode.

SL_COULOMB_COUNTER_INT_CALIBRATION_DONE#

#define SL_COULOMB_COUNTER_INT_CALIBRATION_DONE

0x1

Calibration done interrupt flag.

SL_COULOMB_COUNTER_INT_COUNTER_FULL#

#define SL_COULOMB_COUNTER_INT_COUNTER_FULL

0x2

Counter full interrupt flag.