SNIP_CLASSIC_OS_SECTION_8_4_29_ControlIdle

8.4.29 ControlIdle [SWS_Os_00769] Definition of API function ControlIdle Upstream requirements: SRS_Os_80022 ⌈ Service Name ControlIdle Syntax StatusType ControlIdle ( CoreIdType CoreID, IdleModeType IdleMode ) Service ID [hex] 0x1d Sync/Async Synchronous Reentrancy Non Reentrant CoreID selects the core which idle mode is set Parameters (in) IdleMode the mode which shall be performed during idle time Parameters (inout) None Parameters (out) None Return value StatusType E_OK: No Error E_OS_ID (only EXTENDED status): Invalid core and/or invalid idleMode Description This API allows the caller to select the idle mode action which is performed during idle time of the OS (e.g. if no Task/ISR is active). It can be used to implement energy savings. The real idle modes are hardware dependent and not standardized. The default idle mode on each core is IDLE_NO_HALT. Available via Os.h ⌋ [SWS_Os_00770] Upstream requirements: SRS_Os_80023 ⌈The function ControlIdle shall return E_OK if no error was detected and the parameters are valid⌋ [SWS_Os_00771] Upstream requirements: SRS_Os_80023 ⌈The function ControlIdle shall return E_OS_ID if the parameter CoreID or Idle Mode is invalid (e.g. refered core does not exist; idle mode is not known). In single core systems the check of CoreID shall be omitted.⌋ [SWS_Os_00802] Upstream requirements: SRS_Os_80023 ⌈If the core (given by CoreID) is already in another idle mode (different to the given Idle Mode) the new IdleMode shall become effective the next time that core enters the idle mode.⌋