VBUS input (VBUSIN) peripheral driver. More...
Data Structures | |
struct | npmx_vbusin_t |
Data structure of the VBUSIN driver instance. More... | |
Enumerations | |
enum | npmx_vbusin_task_t { NPMX_VBUSIN_TASK_APPLY_CURRENT_LIMIT , NPMX_VBUSIN_TASK_COUNT } |
VBUSIN tasks. More... | |
enum | npmx_vbusin_current_t { NPMX_VBUSIN_CURRENT_100_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_100MA , NPMX_VBUSIN_CURRENT_500_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_500MA , NPMX_VBUSIN_CURRENT_600_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_600MA , NPMX_VBUSIN_CURRENT_700_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_700MA , NPMX_VBUSIN_CURRENT_800_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_800MA , NPMX_VBUSIN_CURRENT_900_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_900MA , NPMX_VBUSIN_CURRENT_1000_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_1000MA , NPMX_VBUSIN_CURRENT_1100_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_1100MA , NPMX_VBUSIN_CURRENT_1200_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_1200MA , NPMX_VBUSIN_CURRENT_1300_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_1300MA , NPMX_VBUSIN_CURRENT_1400_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_1400MA , NPMX_VBUSIN_CURRENT_1500_MA = VBUSIN_VBUSINILIM0_VBUSINILIM0_1500MA , NPMX_VBUSIN_CURRENT_COUNT , NPMX_VBUSIN_CURRENT_DEFAULT = NPMX_VBUSIN_CURRENT_500_MA , NPMX_VBUSIN_CURRENT_MAX = NPMX_VBUSIN_CURRENT_1500_MA , NPMX_VBUSIN_CURRENT_INVALID = NPMX_INVALID_ENUM_VALUE } |
Available current limits for VBUS. More... | |
enum | npmx_vbusin_cc_t { NPMX_VBUSIN_CC_NOT_CONNECTED = VBUSIN_USBCDETECTSTATUS_VBUSINCC1CMP_NOCONNECTION , NPMX_VBUSIN_CC_DEFAULT = VBUSIN_USBCDETECTSTATUS_VBUSINCC1CMP_DEFAULTUSB , NPMX_VBUSIN_CC_HIGH_POWER_1A5 = VBUSIN_USBCDETECTSTATUS_VBUSINCC1CMP_1A5HIGHPOWER , NPMX_VBUSIN_CC_HIGH_POWER_3A0 = VBUSIN_USBCDETECTSTATUS_VBUSINCC1CMP_3AHIGHPOWER , NPMX_VBUSIN_CC_COUNT , NPMX_VBUSIN_CC_INVALID = NPMX_INVALID_ENUM_VALUE } |
Available CCx pins status connections. More... | |
enum | npmx_vbusin_status_mask_t { NPMX_VBUSIN_STATUS_CONNECTED_MASK = VBUSIN_VBUSINSTATUS_VBUSINPRESENT_Msk , NPMX_VBUSIN_STATUS_CURRENT_LIMIT_MASK = VBUSIN_VBUSINSTATUS_VBUSINCURRLIMACTIVE_Msk , NPMX_VBUSIN_STATUS_OVER_VOLTAGE_MASK = VBUSIN_VBUSINSTATUS_VBUSINOVRPROTACTIVE_Msk , NPMX_VBUSIN_STATUS_UNDER_VOLTAGE_MASK = VBUSIN_VBUSINSTATUS_VBUSINUNDERVOLTAGE_Msk , NPMX_VBUSIN_STATUS_SUSPEND_MODE_MASK = VBUSIN_VBUSINSTATUS_VBUSINSUSPENDMODEACTIVE_Msk } |
VBUS status flag mask. More... | |
Functions | |
npmx_vbusin_t * | npmx_vbusin_get (npmx_instance_t *p_pmic, uint8_t idx) |
Function for returning VBUSIN instance based on index. | |
npmx_vbusin_current_t | npmx_vbusin_current_convert (uint32_t milliamperes) |
Function for converting milliamperes to npmx_vbusin_current_t enumeration. | |
bool | npmx_vbusin_current_convert_to_ma (npmx_vbusin_current_t enum_value, uint32_t *p_val) |
Function for converting npmx_vbusin_current_t enumeration to milliamperes. | |
const char *const | npmx_vbusin_cc_status_map_to_string (npmx_vbusin_cc_t enum_value) |
Function for mapping npmx_vbusin_cc_t enumeration values to string. | |
npmx_error_t | npmx_vbusin_task_trigger (npmx_vbusin_t const *p_instance, npmx_vbusin_task_t task) |
Function for activating the specified VBUSIN task. | |
npmx_error_t | npmx_vbusin_current_limit_set (npmx_vbusin_t const *p_instance, npmx_vbusin_current_t current_limit) |
Function for setting the current limit for VBUS. | |
npmx_error_t | npmx_vbusin_current_limit_get (npmx_vbusin_t const *p_instance, npmx_vbusin_current_t *p_current_limit) |
Function for getting the current limit for VBUS. | |
npmx_error_t | npmx_vbusin_suspend_mode_enable_set (npmx_vbusin_t const *p_instance, bool enable) |
Function for enabling and disabling the suspend mode. | |
npmx_error_t | npmx_vbusin_suspend_mode_enable_get (npmx_vbusin_t const *p_instance, bool *p_enable) |
Function for reading the suspend mode. | |
npmx_error_t | npmx_vbusin_cc_status_get (npmx_vbusin_t const *p_instance, npmx_vbusin_cc_t *p_cc1, npmx_vbusin_cc_t *p_cc2) |
Function for reading status of USB CCx pins. | |
npmx_error_t | npmx_vbusin_vbus_status_get (npmx_vbusin_t const *p_instance, uint8_t *p_status_mask) |
Function for reading VBUS status register. | |
VBUS input (VBUSIN) peripheral driver.
enum npmx_vbusin_cc_t |
Available CCx pins status connections.
Available current limits for VBUS.
VBUS status flag mask.
enum npmx_vbusin_task_t |
VBUSIN tasks.
Enumerator | |
---|---|
NPMX_VBUSIN_TASK_APPLY_CURRENT_LIMIT | Applying the selected current limit set with npmx_vbusin_current_limit_set(). |
NPMX_VBUSIN_TASK_COUNT | VBUSIN tasks count. |
npmx_error_t npmx_vbusin_cc_status_get | ( | npmx_vbusin_t const * | p_instance, |
npmx_vbusin_cc_t * | p_cc1, | ||
npmx_vbusin_cc_t * | p_cc2 ) |
Function for reading status of USB CCx pins.
[in] | p_instance | Pointer to the VBUSIN instance. |
[out] | p_cc1 | Pointer to the CC1 status variable. |
[out] | p_cc2 | Pointer to the CC2 status variable. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |
const char *const npmx_vbusin_cc_status_map_to_string | ( | npmx_vbusin_cc_t | enum_value | ) |
Function for mapping npmx_vbusin_cc_t enumeration values to string.
[in] | enum_value | CC status defined as npmx_vbusin_cc_t enumeration to be mapped to string. |
npmx_vbusin_current_t npmx_vbusin_current_convert | ( | uint32_t | milliamperes | ) |
Function for converting milliamperes to npmx_vbusin_current_t enumeration.
[in] | milliamperes | Current in milliamperes to be converted into npmx_vbusin_current_t enumeration. |
bool npmx_vbusin_current_convert_to_ma | ( | npmx_vbusin_current_t | enum_value, |
uint32_t * | p_val ) |
Function for converting npmx_vbusin_current_t enumeration to milliamperes.
[in] | enum_value | Current defined as npmx_vbusin_current_t enumeration to be converted into milliamperes. |
[out] | p_val | Pointer to the variable that stores the conversion result. |
true | Conversion is valid. |
false | Conversion is invalid - an invalid argument was passed to the function. |
npmx_error_t npmx_vbusin_current_limit_get | ( | npmx_vbusin_t const * | p_instance, |
npmx_vbusin_current_t * | p_current_limit ) |
Function for getting the current limit for VBUS.
[in] | p_instance | Pointer to the VBUSIN instance. |
[out] | p_current_limit | Pointer to the current limit variable. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |
npmx_error_t npmx_vbusin_current_limit_set | ( | npmx_vbusin_t const * | p_instance, |
npmx_vbusin_current_t | current_limit ) |
Function for setting the current limit for VBUS.
[in] | p_instance | Pointer to the VBUSIN instance. |
[in] | current_limit | Current limit to set. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |
npmx_vbusin_t * npmx_vbusin_get | ( | npmx_instance_t * | p_pmic, |
uint8_t | idx ) |
Function for returning VBUSIN instance based on index.
[in] | p_pmic | Pointer to the PMIC instance. |
[in] | idx | Index of the VBUSIN instance. |
npmx_error_t npmx_vbusin_suspend_mode_enable_get | ( | npmx_vbusin_t const * | p_instance, |
bool * | p_enable ) |
Function for reading the suspend mode.
[in] | p_instance | Pointer to the VBUSIN instance. |
[out] | p_enable | Pointer to the suspend mode variable. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |
npmx_error_t npmx_vbusin_suspend_mode_enable_set | ( | npmx_vbusin_t const * | p_instance, |
bool | enable ) |
Function for enabling and disabling the suspend mode.
[in] | p_instance | Pointer to the VBUSIN instance. |
[in] | enable | True if device is to enter the suspend mode, false if it is to exit from the suspend mode. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |
npmx_error_t npmx_vbusin_task_trigger | ( | npmx_vbusin_t const * | p_instance, |
npmx_vbusin_task_t | task ) |
Function for activating the specified VBUSIN task.
p_instance | Pointer to the VBUSIN instance. |
task | Task to be activated. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |
npmx_error_t npmx_vbusin_vbus_status_get | ( | npmx_vbusin_t const * | p_instance, |
uint8_t * | p_status_mask ) |
Function for reading VBUS status register.
[in] | p_instance | Pointer to the VBUSIN instance. |
[out] | p_status_mask | Pointer to the VBUS status mask composed of values from npmx_vbusin_status_mask_t. |
NPMX_SUCCESS | Operation performed successfully. |
NPMX_ERROR_IO | Error using IO bus line. |