PMM_Sleep

Definition: This function puts the system to sleep if possible.

Syntax

PMM_Status_t PMM_Sleep(PMM_SleepReq_t *req);

Input Parameter

Table 1. Input Parameter
Parameter Name	Parameter Type	Description
`req`	`PMM_SleepReq_t`	Pointer to sleep request structure when being called from application

Note: PMM_SleepReq_t – Definition is available in pmm.h.

Return Type and Values

Table 2. Return Type
Parameter Name	Parameter Type	Description
`PMM_Status_t`	ENUM	Describes the status of power manager for a sleep request

Note: PMM_Status_t – Definition is available in pmm.h.

Table 3. Return Values
Return Value	Reason
`PMM_SLEEP_REQ_DENIED`	PMM denies the request because system is not ready to sleep at the instance of sleep call
`PMM_SLEEP_REQ_PROCESSED`	Power manager accepted and have already processed the request

API Type – Synchronous