Function esp_idf_bindgen::rtc_sleep_start

pub unsafe extern "C" fn rtc_sleep_start(
    wakeup_opt: u32, 
    reject_opt: u32
) -> u32

@brief Enter deep or light sleep mode

This function enters the sleep mode previously configured using rtc_sleep_init function. Before entering sleep, software should configure wake up sources appropriately (set up GPIO wakeup registers, timer wakeup registers, and so on).

If deep sleep mode was configured using rtc_sleep_init, and sleep is not rejected by hardware (based on reject_opt flags), this function never returns. When the chip wakes up from deep sleep, CPU is reset and execution starts from ROM bootloader.

If light sleep mode was configured using rtc_sleep_init, this function returns on wakeup, or if sleep is rejected by hardware.

@param wakeup_opt bit mask wake up reasons to enable (RTC_xxx_TRIG_EN flags combined with OR) @param reject_opt bit mask of sleep reject reasons: - RTC_CNTL_GPIO_REJECT_EN - RTC_CNTL_SDIO_REJECT_EN These flags are used to prevent entering sleep when e.g. an external host is communicating via SDIO slave @return non-zero if sleep was rejected by hardware