![]() |
ISF
2.2 rev 5
Intelligent Sensing Framework for Kinetis with Processor Expert
|
isf_pm.h describes the API definitions, types, and macros for the Intelligent Sensing Framework (ISF) Power Manager (PM). More...
Go to the source code of this file.
Typedefs | |
typedef pm_power_level_enum | power_level_t |
Type for the power levels supported by the Power Manager. More... | |
Enumerations | |
enum | pm_power_level_enum { ISF_POWER_NORMAL = 1, ISF_POWER_LOW = 2, ISF_POWER_SLEEP = 3 } |
ISF power management settings. More... | |
Functions | |
isf_status_t | pm_init (void) |
This API initializes the Power Manager. More... | |
power_level_t | isf_power_set (power_level_t aLevel) |
This API sets the requested power level for power management. More... | |
power_level_t | isf_power_get (void) |
This API returns the current power level for power management. More... | |
isf_pm.h describes the API definitions, types, and macros for the Intelligent Sensing Framework (ISF) Power Manager (PM).
Definition in file isf_pm.h.
typedef pm_power_level_enum power_level_t |
enum pm_power_level_enum |
ISF power management settings.
power_level_t isf_power_get | ( | void | ) |
This API returns the current power level for power management.
The current power level setting of the Power Manager is returned.
power_level_t isf_power_set | ( | power_level_t | aLevel | ) |
This API sets the requested power level for power management.
The Power Manager provides the capability to automatically control the power mode when the system is idle. Part of the power management is an idle task running at the lowest system priority. When all higher-priority tasks are blocked waiting for events, the idle task is executed. In the idle task, the system power state is set to one of the states described by the pm_power_level_enum values as specified as the argument to this API call.
The user may retrieves the current power level setting by invoking isf_power_get().
[in] | aLevel | Power level of type power_level_t to set in the Power Manager. |
isf_status_t pm_init | ( | void | ) |
This API initializes the Power Manager.
The Power Manager requires a one-time initialization at system startup performed by this API call. It creates and initializes internal variables, and installs an interrupt service routine for the digital frame interrupt.
ISF_SUCCESS | The initialization completes successfully. |
ISF_ERR_LIB_INIT | Internal synchronization objects could not be created. |