SNIP_CLASSIC_PWM_SECTION_8_3_12_Pwm_PreparePowerState

8.3.12 Pwm_PreparePowerState [SWS_Pwm_00183] Definition of API function Pwm_PreparePowerState ⌈ Service Name Pwm_PreparePowerState Syntax Std_ReturnType Pwm_PreparePowerState ( Pwm_PowerStateType PowerState, Pwm_PowerStateRequestResultType* Result ) Service ID [hex] 0x0c Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) PowerState The target power state intended to be attained Parameters (inout) None Parameters (out) Result If the API returns E_OK: PWM_SERVICE_ACCEPTED: PWM Module power state preparation was started. If the API returns E_NOT_OK: PWM_NOT_INIT: PWM Module not initialized. PWM_SEQUENCE_ERROR: wrong API call sequence (Current Power State = Target Power State). PWM_ POWER_STATE_NOT_SUPP: PWM Module does not support the requested power state. PWM_TRANS_NOT_POSSIBLE: PWM Module cannot transition directly from the current power state to the requested power state or the HW peripheral is still busy. Return value Std_ReturnType E_OK: Preparation process started E_NOT_OK: Service is rejected Description This API starts the needed process to allow the PWM HW module to enter the requested power state. Available via Pwm.h ⌋ [SWS_Pwm_00184] ⌈This API initiates all actions needed to enable a HW module to enter the target power state. The possibility to operate the periphery depends on the power state and the HW features. These properties should be known to the integrator and the decision whether to use the periphery or not is in his responsibility.⌋ [SWS_Pwm_00185] ⌈In case the target power state is the same as the current one, no action is executed and the API returns immediately with an E_OK result. The responsibility of the preconditions is left to the environment.⌋ In case development error reporting is activated: [SWS_Pwm_00186] ⌈The API shall report the development error PWM_E_UNINIT in case this API is called before having initialized the HW unit.⌋ [SWS_Pwm_00187] ⌈The API shall report the development error PWM_E_POWER_STATE_NOT_SUPPORTED in case this API is called with an unsupported power state is requested or the peripheral does not support low power states at all.⌋ [SWS_Pwm_00188] ⌈The API shall report the development error PWM_E_TRANSITION_NOT_POSSIBLE in case the requested power state cannot be directly reached from the current power state. All asynchronous operation needed to reach the target power state can be executed in background in the context of Pwm_Main_PowerTransitionManager.⌋