This module contains APIs to program and use the PMIC module on the board.
See PMIC for more details.
◆ PMIC_Handle
◆ PMIC_Config
◆ PMIC_Params
◆ PMIC_init()
This function initializes the PMIC module.
◆ PMIC_deinit()
| void PMIC_deinit |
( |
void |
| ) |
|
This function de-initializes the PMIC module.
◆ PMIC_open()
Open PMIC driver.
Make sure the SOC peripheral driver is open'ed before calling this API. Drivers_open function generated by SysCfg opens the underlying SOC peripheral driver, e.g I2C
Global variables PMIC_Config gPmicConfig[] and uint32_t gPmicConfigNum is instantiated by SysCfg to describe the PMIC configuration based on user selection in SysCfg.
- Parameters
-
| instanceId | [IN] Index within PMIC_Config gPmicConfig[] denoting the PMIC driver to open |
| params | [IN] Open parameters |
- Returns
- Handle to PMIC driver which should be used in subsequent API call Else returns NULL in case of failure
◆ PMIC_getHandle()
Get handle to PMIC driver.
- Parameters
-
- Returns
- Handle to pmic driver
-
NULL in case of failure
◆ PMIC_close()
Close PMIC driver.
- Parameters
-
◆ PMIC_critSecStartFn()
| void PMIC_critSecStartFn |
( |
void |
| ) |
|
Initiates the start of a critical section for PMIC operations. This function attempts to acquire a semaphore, which is typically used to ensure exclusive access to resources during PMIC operations.
◆ PMIC_critSecStopFn()
| void PMIC_critSecStopFn |
( |
void |
| ) |
|
Concludes a critical section for PMIC operations. This function releases the semaphore, signifying the end of a critical section initiated by a corresponding "start" function.