npmx  1.0.0
 
Loading...
Searching...
No Matches

Analog-to-Digital Converter (ADC) peripheral driver. More...

Data Structures

struct  npmx_adc_t
 Data structure of the Analog-to-Digital Converter (ADC) driver instance. More...
 
struct  npmx_adc_config_t
 Configuration structure for ADC. More...
 
struct  npmx_adc_meas_all_t
 Structure for all measurements readings. More...
 
struct  npmx_adc_ibat_meas_status_t
 Structure for the battery current measurement status. More...
 
struct  npmx_adc_ntc_config_t
 Configuration structure for battery NTC thermistor. More...
 

Enumerations

enum  npmx_adc_task_t {
  NPMX_ADC_TASK_SINGLE_SHOT_VBAT ,
  NPMX_ADC_TASK_SINGLE_SHOT_NTC ,
  NPMX_ADC_TASK_SINGLE_SHOT_DIE_TEMP ,
  NPMX_ADC_TASK_SINGLE_SHOT_VSYS ,
  NPMX_ADC_TASK_SINGLE_SHOT_VBUS ,
  NPMX_ADC_TASK_DELAYED_MEAS_VBAT ,
  NPMX_ADC_TASK_UPDATE_AUTO_INTERVAL ,
  NPMX_ADC_TASK_COUNT
}
 ADC tasks. More...
 
enum  npmx_adc_meas_t {
  NPMX_ADC_MEAS_VBAT ,
  NPMX_ADC_MEAS_BAT_TEMP ,
  NPMX_ADC_MEAS_DIE_TEMP ,
  NPMX_ADC_MEAS_VSYS ,
  NPMX_ADC_MEAS_VBUS ,
  NPMX_ADC_MEAS_VBAT0 ,
  NPMX_ADC_MEAS_VBAT1 ,
  NPMX_ADC_MEAS_VBAT2_IBAT ,
  NPMX_ADC_MEAS_VBAT3_VBUS ,
  NPMX_ADC_MEAS_COUNT ,
  NPMX_ADC_MEAS_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Possible measurements that can be read from ADC. More...
 
enum  npmx_adc_ntc_type_t {
  NPMX_ADC_NTC_TYPE_HI_Z = ADC_ADCNTCRSEL_ADCNTCRSEL_Hi_Z ,
  NPMX_ADC_NTC_TYPE_10_K = ADC_ADCNTCRSEL_ADCNTCRSEL_10K ,
  NPMX_ADC_NTC_TYPE_47_K = ADC_ADCNTCRSEL_ADCNTCRSEL_47K ,
  NPMX_ADC_NTC_TYPE_100_K = ADC_ADCNTCRSEL_ADCNTCRSEL_100K ,
  NPMX_ADC_NTC_TYPE_COUNT ,
  NPMX_ADC_NTC_TYPE_MAX = NPMX_ADC_NTC_TYPE_100_K ,
  NPMX_ADC_NTC_TYPE_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Battery NTC type. Should be checked in battery documentation. More...
 
enum  npmx_adc_ntc_meas_interval_t {
  NPMX_ADC_NTC_MEAS_INTERVAL_4_MS = ADC_ADCAUTOTIMCONF_NTCAUTOTIM_4MS ,
  NPMX_ADC_NTC_MEAS_INTERVAL_64_MS = ADC_ADCAUTOTIMCONF_NTCAUTOTIM_64MS ,
  NPMX_ADC_NTC_MEAS_INTERVAL_128_MS = ADC_ADCAUTOTIMCONF_NTCAUTOTIM_128MS ,
  NPMX_ADC_NTC_MEAS_INTERVAL_1024_MS = ADC_ADCAUTOTIMCONF_NTCAUTOTIM_1024MS ,
  NPMX_ADC_NTC_MEAS_INTERVAL_COUNT ,
  NPMX_ADC_NTC_MEAS_INTERVAL_MAX = NPMX_ADC_NTC_MEAS_INTERVAL_1024_MS ,
  NPMX_ADC_NTC_MEAS_INTERVAL_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Intervals of automatic measurements of NTC during charging. More...
 
enum  npmx_adc_die_temp_meas_interval_t {
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_4_MS = ADC_ADCAUTOTIMCONF_TEMPAUTOTIM_4MS ,
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_8_MS = ADC_ADCAUTOTIMCONF_TEMPAUTOTIM_8MS ,
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_16_MS = ADC_ADCAUTOTIMCONF_TEMPAUTOTIM_16MS ,
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_32_MS = ADC_ADCAUTOTIMCONF_TEMPAUTOTIM_32MS ,
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_COUNT ,
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_MAX = NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_32_MS ,
  NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Intervals of automatic measurements of die temperature during charging. More...
 
enum  npmx_adc_ibat_meas_current_t {
  NPMX_ADC_IBAT_MEAS_CURRENT_TRICKLE = ADC_ADCIBATMEASSTATUS_BCHARGERICHARGE_TRICKLE ,
  NPMX_ADC_IBAT_MEAS_CURRENT_LOWTEMP = ADC_ADCIBATMEASSTATUS_BCHARGERICHARGE_LOWTEMP ,
  NPMX_ADC_IBAT_MEAS_CURRENT_RFU = ADC_ADCIBATMEASSTATUS_BCHARGERICHARGE_RFU ,
  NPMX_ADC_IBAT_MEAS_CURRENT_FAST = ADC_ADCIBATMEASSTATUS_BCHARGERICHARGE_FAST ,
  NPMX_ADC_IBAT_MEAS_CURRENT_MAX = NPMX_ADC_IBAT_MEAS_CURRENT_FAST ,
  NPMX_ADC_IBAT_MEAS_CURRENT_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Battery charging current. More...
 

Functions

npmx_adc_tnpmx_adc_get (npmx_instance_t *p_pmic, uint8_t idx)
 Function for returning ADC instance based on index.
 
npmx_adc_ntc_type_t npmx_adc_ntc_type_convert (uint32_t resistance)
 Function for converting resistance in ohms to npmx_adc_ntc_type_t enumeration.
 
bool npmx_adc_ntc_type_convert_to_ohms (npmx_adc_ntc_type_t battery_ntc, uint32_t *p_val)
 Function for converting the value from NTC enumeration type to resistance.
 
npmx_adc_ntc_meas_interval_t npmx_adc_ntc_meas_interval_convert (uint32_t time)
 Function for converting time in milliseconds to npmx_adc_ntc_meas_interval_t enumeration.
 
bool npmx_adc_ntc_meas_interval_convert_to_ms (npmx_adc_ntc_meas_interval_t enum_value, uint32_t *p_val)
 Function for converting npmx_adc_ntc_meas_interval_t enumeration to milliseconds.
 
npmx_adc_die_temp_meas_interval_t npmx_adc_die_temp_meas_interval_convert (uint32_t time)
 Function for converting time in milliseconds to npmx_adc_die_temp_meas_interval_t enumeration.
 
bool npmx_adc_die_temp_meas_interval_convert_to_ms (npmx_adc_die_temp_meas_interval_t enum_value, uint32_t *p_val)
 Function for converting npmx_adc_die_temp_meas_interval_t enumeration to milliseconds.
 
const char *const npmx_adc_ntc_type_map_to_string (npmx_adc_ntc_type_t enum_value)
 Function for mapping npmx_adc_ntc_type_t enumeration values to string.
 
npmx_error_t npmx_adc_task_trigger (npmx_adc_t const *p_instance, npmx_adc_task_t task)
 Function for activating the specified ADC task.
 
npmx_error_t npmx_adc_config_set (npmx_adc_t *p_instance, npmx_adc_config_t const *p_config)
 Function for setting the configuration for ADC.
 
npmx_error_t npmx_adc_config_get (npmx_adc_t *p_instance, npmx_adc_config_t *p_config)
 Function for reading the ADC configuration.
 
npmx_error_t npmx_adc_ntc_config_set (npmx_adc_t *p_instance, npmx_adc_ntc_config_t const *p_config)
 Function for configuring a battery NTC thermistor.
 
npmx_error_t npmx_adc_ntc_config_get (npmx_adc_t *p_instance, npmx_adc_ntc_config_t *p_config)
 Function for getting a configuration of the battery NTC thermistor.
 
npmx_error_t npmx_adc_ntc_resistance_get (npmx_adc_t const *p_instance, uint32_t *p_resistance)
 Function for getting the nominal NTC resistance.
 
npmx_error_t npmx_adc_meas_check (npmx_adc_t const *p_instance, npmx_adc_meas_t meas, bool *p_ready)
 Function for checking if measured value is ready to be read.
 
npmx_error_t npmx_adc_meas_get (npmx_adc_t const *p_instance, npmx_adc_meas_t meas, int32_t *p_value)
 Function for getting measured value.
 
npmx_error_t npmx_adc_meas_all_get (npmx_adc_t const *p_instance, npmx_adc_meas_all_t *p_values)
 Function for getting all measured values.
 
npmx_error_t npmx_adc_ntc_meas_interval_set (npmx_adc_t *p_instance, npmx_adc_ntc_meas_interval_t interval)
 Function for setting the NTC measurement interval during charging.
 
npmx_error_t npmx_adc_ntc_meas_interval_get (npmx_adc_t *p_instance, npmx_adc_ntc_meas_interval_t *p_interval)
 Function for getting NTC auto measurement interval during charging.
 
npmx_error_t npmx_adc_die_temp_meas_interval_set (npmx_adc_t *p_instance, npmx_adc_die_temp_meas_interval_t interval)
 Function for setting the die temperature measurement interval during charging.
 
npmx_error_t npmx_adc_die_temp_meas_interval_get (npmx_adc_t *p_instance, npmx_adc_die_temp_meas_interval_t *p_interval)
 Function for getting die temperature auto measurement interval during charging.
 
npmx_error_t npmx_adc_vbat_meas_delay_set (npmx_adc_t const *p_instance, uint8_t delay)
 Function for setting the delay of battery voltage measurement after going into sleep mode.
 
npmx_error_t npmx_adc_vbat_meas_delay_get (npmx_adc_t const *p_instance, uint8_t *p_delay)
 Function for getting the delay of battery voltage measurement after going into sleep mode.
 
npmx_error_t npmx_adc_ibat_meas_status_get (npmx_adc_t const *p_instance, npmx_adc_ibat_meas_status_t *p_ibat_meas_status)
 Function for getting the battery current measurement status.
 
npmx_error_t npmx_adc_ibat_meas_enable_set (npmx_adc_t const *p_instance, bool enable)
 Function for setting the auto measurement of battery current.
 
npmx_error_t npmx_adc_ibat_meas_enable_check (npmx_adc_t const *p_instance, bool *p_enable)
 Function for checking whether auto measurement of battery current is enabled.
 

Detailed Description

Analog-to-Digital Converter (ADC) peripheral driver.

Enumeration Type Documentation

◆ npmx_adc_die_temp_meas_interval_t

Intervals of automatic measurements of die temperature during charging.

Enumerator
NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_4_MS 

Interval equal to 4 ms.

NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_8_MS 

Interval equal to 8 ms.

NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_16_MS 

Interval equal to 16 ms.

NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_32_MS 

Interval equal to 32 ms.

NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_COUNT 

Interval values count.

NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_MAX 

Maximum interval value.

NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_INVALID 

Invalid interval value.

◆ npmx_adc_ibat_meas_current_t

Battery charging current.

Enumerator
NPMX_ADC_IBAT_MEAS_CURRENT_TRICKLE 

10% charge (Trickle).

NPMX_ADC_IBAT_MEAS_CURRENT_LOWTEMP 

50% charge (Low Temp).

NPMX_ADC_IBAT_MEAS_CURRENT_RFU 

10% charge (default, RFU).

NPMX_ADC_IBAT_MEAS_CURRENT_FAST 

100% charge (Fast).

NPMX_ADC_IBAT_MEAS_CURRENT_MAX 

Maximum current value.

NPMX_ADC_IBAT_MEAS_CURRENT_INVALID 

Invalid current value.

◆ npmx_adc_meas_t

Possible measurements that can be read from ADC.

Enumerator
NPMX_ADC_MEAS_VBAT 

VBAT measurement (in millivolts).

NPMX_ADC_MEAS_BAT_TEMP 

Battery temperature (in millidegrees Celsius). For proper temperature calculations, a thermistor type and NTC beta value should be set with the npmx_adc_config_set function.

NPMX_ADC_MEAS_DIE_TEMP 

Internal die temperature measurement (in millidegrees Celsius).

NPMX_ADC_MEAS_VSYS 

VSYS voltage measurement (in millivolts).

NPMX_ADC_MEAS_VBUS 

VBUS (7 Volt range) measurement (in millivolts).

NPMX_ADC_MEAS_VBAT0 

VBAT0 from burst mode measurement (in millivolts).

NPMX_ADC_MEAS_VBAT1 

VBAT1 from burst mode measurement (in millivolts).

NPMX_ADC_MEAS_VBAT2_IBAT 

Measurement of either VBAT2 in burst mode or IBAT (respectively in millivolts or milliamperes).

NPMX_ADC_MEAS_VBAT3_VBUS 

Measurement of either VBAT3 in burst mode or VBUS (both in millivolts).

NPMX_ADC_MEAS_COUNT 

ADC requests maximum count.

NPMX_ADC_MEAS_INVALID 

Invalid ADC measurement.

◆ npmx_adc_ntc_meas_interval_t

Intervals of automatic measurements of NTC during charging.

Enumerator
NPMX_ADC_NTC_MEAS_INTERVAL_4_MS 

Interval equal to 4 ms.

NPMX_ADC_NTC_MEAS_INTERVAL_64_MS 

Interval equal to 64 ms.

NPMX_ADC_NTC_MEAS_INTERVAL_128_MS 

Interval equal to 128 ms.

NPMX_ADC_NTC_MEAS_INTERVAL_1024_MS 

Interval equal to 1024 ms.

NPMX_ADC_NTC_MEAS_INTERVAL_COUNT 

Interval values count.

NPMX_ADC_NTC_MEAS_INTERVAL_MAX 

Maximum interval value.

NPMX_ADC_NTC_MEAS_INTERVAL_INVALID 

Invalid interval value.

◆ npmx_adc_ntc_type_t

Battery NTC type. Should be checked in battery documentation.

Enumerator
NPMX_ADC_NTC_TYPE_HI_Z 

No resistor.

NPMX_ADC_NTC_TYPE_10_K 

NTC10K.

NPMX_ADC_NTC_TYPE_47_K 

NTC47K.

NPMX_ADC_NTC_TYPE_100_K 

NTC100K.

NPMX_ADC_NTC_TYPE_COUNT 

NTC types count.

NPMX_ADC_NTC_TYPE_MAX 

Maximum resistance.

NPMX_ADC_NTC_TYPE_INVALID 

Invalid battery NTC type.

◆ npmx_adc_task_t

ADC tasks.

Enumerator
NPMX_ADC_TASK_SINGLE_SHOT_VBAT 

VBAT single-shot measurement trigger.

NPMX_ADC_TASK_SINGLE_SHOT_NTC 

Battery NTC single-shot measurement trigger.

NPMX_ADC_TASK_SINGLE_SHOT_DIE_TEMP 

Internal die temperature single-shot measurement trigger.

NPMX_ADC_TASK_SINGLE_SHOT_VSYS 

VSYS voltage single-shot measurement trigger.

NPMX_ADC_TASK_SINGLE_SHOT_VBUS 

VBUS (7 Volt range) single-shot measurement trigger.

NPMX_ADC_TASK_DELAYED_MEAS_VBAT 

VBAT delay measurement trigger.

NPMX_ADC_TASK_UPDATE_AUTO_INTERVAL 

Update intervals for NTC and die temperature auto measurements trigger.

NPMX_ADC_TASK_COUNT 

ADC tasks count.

Function Documentation

◆ npmx_adc_config_get()

npmx_error_t npmx_adc_config_get ( npmx_adc_t * p_instance,
npmx_adc_config_t * p_config )

Function for reading the ADC configuration.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_configPointer to the ADC configuration structure.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_config_set()

npmx_error_t npmx_adc_config_set ( npmx_adc_t * p_instance,
npmx_adc_config_t const * p_config )

Function for setting the configuration for ADC.

Parameters
[in]p_instancePointer to the ADC instance.
[in]p_configPointer to the configuration of the ADC to be applied.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_die_temp_meas_interval_convert()

npmx_adc_die_temp_meas_interval_t npmx_adc_die_temp_meas_interval_convert ( uint32_t time)

Function for converting time in milliseconds to npmx_adc_die_temp_meas_interval_t enumeration.

Parameters
[in]timeTime in milliseconds to be converted into npmx_adc_die_temp_meas_interval_t enumeration.
Returns
Result of conversion. NPMX_ADC_DIE_TEMP_MEAS_INTERVAL_INVALID if given time is not represented in enumeration.

◆ npmx_adc_die_temp_meas_interval_convert_to_ms()

bool npmx_adc_die_temp_meas_interval_convert_to_ms ( npmx_adc_die_temp_meas_interval_t enum_value,
uint32_t * p_val )

Function for converting npmx_adc_die_temp_meas_interval_t enumeration to milliseconds.

Parameters
[in]enum_valueTime defined as npmx_adc_die_temp_meas_interval_t enumeration to be converted into milliseconds.
[out]p_valPointer to the variable that stores the conversion result.
Return values
trueConversion is valid.
falseConversion is invalid - an invalid argument was passed to the function.

◆ npmx_adc_die_temp_meas_interval_get()

npmx_error_t npmx_adc_die_temp_meas_interval_get ( npmx_adc_t * p_instance,
npmx_adc_die_temp_meas_interval_t * p_interval )

Function for getting die temperature auto measurement interval during charging.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_intervalPointer to interval for die temperature auto measurement during charging.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_die_temp_meas_interval_set()

npmx_error_t npmx_adc_die_temp_meas_interval_set ( npmx_adc_t * p_instance,
npmx_adc_die_temp_meas_interval_t interval )

Function for setting the die temperature measurement interval during charging.

Parameters
[in]p_instancePointer to the ADC instance.
[in]intervalInterval value.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_get()

npmx_adc_t * npmx_adc_get ( npmx_instance_t * p_pmic,
uint8_t idx )

Function for returning ADC instance based on index.

Parameters
[in]p_pmicPointer to the PMIC instance.
[in]idxIndex of the ADC instance.
Returns
Pointer to the ADC instance.

◆ npmx_adc_ibat_meas_enable_check()

npmx_error_t npmx_adc_ibat_meas_enable_check ( npmx_adc_t const * p_instance,
bool * p_enable )

Function for checking whether auto measurement of battery current is enabled.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_enablePointer to the auto IBAT measurement variable. True if auto measurement is enabled, false otherwise.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ibat_meas_enable_set()

npmx_error_t npmx_adc_ibat_meas_enable_set ( npmx_adc_t const * p_instance,
bool enable )

Function for setting the auto measurement of battery current.

Parameters
[in]p_instancePointer to the ADC instance.
[in]enableTrue if auto IBAT measurement is to be enabled, false otherwise.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ibat_meas_status_get()

npmx_error_t npmx_adc_ibat_meas_status_get ( npmx_adc_t const * p_instance,
npmx_adc_ibat_meas_status_t * p_ibat_meas_status )

Function for getting the battery current measurement status.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_ibat_meas_statusPointer to the IBAT measurement status structure.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_meas_all_get()

npmx_error_t npmx_adc_meas_all_get ( npmx_adc_t const * p_instance,
npmx_adc_meas_all_t * p_values )

Function for getting all measured values.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_valuesPointer to structure with read values.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_meas_check()

npmx_error_t npmx_adc_meas_check ( npmx_adc_t const * p_instance,
npmx_adc_meas_t meas,
bool * p_ready )

Function for checking if measured value is ready to be read.

Note
This function should not be used when interrupt for measurement is enabled.
Parameters
[in]p_instancePointer to the ADC instance.
[in]measMeasurement value to be checked.
[out]p_readyPointer to variable for check value.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_meas_get()

npmx_error_t npmx_adc_meas_get ( npmx_adc_t const * p_instance,
npmx_adc_meas_t meas,
int32_t * p_value )

Function for getting measured value.

Parameters
[in]p_instancePointer to the ADC instance.
[in]measMeasurement value to be read.
[out]p_valuePointer to variable for read value.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_INVALID_PARAMNot possible to calculate value for given npmx_adc_meas_t.
NPMX_ERROR_IOError using IO bus line.
NPMX_ERROR_INVALID_MEASInvalid measurement for given npmx_adc_meas_t.

◆ npmx_adc_ntc_config_get()

npmx_error_t npmx_adc_ntc_config_get ( npmx_adc_t * p_instance,
npmx_adc_ntc_config_t * p_config )

Function for getting a configuration of the battery NTC thermistor.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_configPointer to the battery NTC thermistor configuration structure.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ntc_config_set()

npmx_error_t npmx_adc_ntc_config_set ( npmx_adc_t * p_instance,
npmx_adc_ntc_config_t const * p_config )

Function for configuring a battery NTC thermistor.

Parameters
[in]p_instancePointer to the ADC instance.
[in]p_configPointer to the battery NTC thermistor configuration structure.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ntc_meas_interval_convert()

npmx_adc_ntc_meas_interval_t npmx_adc_ntc_meas_interval_convert ( uint32_t time)

Function for converting time in milliseconds to npmx_adc_ntc_meas_interval_t enumeration.

Parameters
[in]timeTime in milliseconds to be converted into npmx_adc_ntc_meas_interval_t enumeration.
Returns
Result of conversion. NPMX_ADC_NTC_MEAS_INTERVAL_INVALID if given time is not represented in enumeration.

◆ npmx_adc_ntc_meas_interval_convert_to_ms()

bool npmx_adc_ntc_meas_interval_convert_to_ms ( npmx_adc_ntc_meas_interval_t enum_value,
uint32_t * p_val )

Function for converting npmx_adc_ntc_meas_interval_t enumeration to milliseconds.

Parameters
[in]enum_valueTime defined as npmx_adc_ntc_meas_interval_t enumeration to be converted into milliseconds.
[out]p_valPointer to the variable that stores the conversion result.
Return values
trueConversion is valid.
falseConversion is invalid - an invalid argument was passed to the function.

◆ npmx_adc_ntc_meas_interval_get()

npmx_error_t npmx_adc_ntc_meas_interval_get ( npmx_adc_t * p_instance,
npmx_adc_ntc_meas_interval_t * p_interval )

Function for getting NTC auto measurement interval during charging.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_intervalPointer to interval for NTC auto measurement during charging.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ntc_meas_interval_set()

npmx_error_t npmx_adc_ntc_meas_interval_set ( npmx_adc_t * p_instance,
npmx_adc_ntc_meas_interval_t interval )

Function for setting the NTC measurement interval during charging.

Parameters
[in]p_instancePointer to the ADC instance.
[in]intervalInterval value.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ntc_resistance_get()

npmx_error_t npmx_adc_ntc_resistance_get ( npmx_adc_t const * p_instance,
uint32_t * p_resistance )

Function for getting the nominal NTC resistance.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_resistancePointer to the nominal NTC resistance value in ohms.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_ntc_type_convert()

npmx_adc_ntc_type_t npmx_adc_ntc_type_convert ( uint32_t resistance)

Function for converting resistance in ohms to npmx_adc_ntc_type_t enumeration.

Parameters
[in]resistanceResistance in ohms to be converted into npmx_adc_ntc_type_t enumeration.
Returns
Result of conversion. NPMX_ADC_NTC_TYPE_INVALID if given resistance is not represented in enumeration.

◆ npmx_adc_ntc_type_convert_to_ohms()

bool npmx_adc_ntc_type_convert_to_ohms ( npmx_adc_ntc_type_t battery_ntc,
uint32_t * p_val )

Function for converting the value from NTC enumeration type to resistance.

Parameters
[in]battery_ntcBattery NTC type.
[out]p_valPointer to the variable that stores the conversion result.
Return values
trueConversion is valid.
falseConversion is invalid - an invalid argument was passed to the function.

◆ npmx_adc_ntc_type_map_to_string()

const char *const npmx_adc_ntc_type_map_to_string ( npmx_adc_ntc_type_t enum_value)

Function for mapping npmx_adc_ntc_type_t enumeration values to string.

Parameters
[in]enum_valueNTC type as npmx_adc_ntc_type_t enumeration to be mapped.
Returns
Result of conversion.

◆ npmx_adc_task_trigger()

npmx_error_t npmx_adc_task_trigger ( npmx_adc_t const * p_instance,
npmx_adc_task_t task )

Function for activating the specified ADC task.

Parameters
[in]p_instancePointer to the ADC instance.
[in]taskTask to be activated.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_vbat_meas_delay_get()

npmx_error_t npmx_adc_vbat_meas_delay_get ( npmx_adc_t const * p_instance,
uint8_t * p_delay )

Function for getting the delay of battery voltage measurement after going into sleep mode.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_delayPointer to read delay value.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_adc_vbat_meas_delay_set()

npmx_error_t npmx_adc_vbat_meas_delay_set ( npmx_adc_t const * p_instance,
uint8_t delay )

Function for setting the delay of battery voltage measurement after going into sleep mode.

Parameters
[in]p_instancePointer to the ADC instance.
[in]delayDelay value in ms, min 2, max 255.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.