platform_sleep.h File Reference

Functions
void	platform_idle_hook (void)
uint32_t	platform_power_down_hook (uint32_t sleep_ms)
int	platform_power_down_permission (void)

Detailed Description

Defines globally accessible powersave functions

Function Documentation

platform_idle_hook()

void platform_idle_hook ( void )

extern

Hook for RTOS for entering idle mode

platform_power_down_hook()

uint32_t platform_power_down_hook ( uint32_t sleep_ms )

extern

Hook for RTOS for entering deep sleep mode

Parameters

[in]

sleep_ms

: period in millisecond the MCU needs to sleep

Returns

period in millisecond the MCU has slept

platform_power_down_permission()

int platform_power_down_permission ( void )

extern

Hook for RTOS to ask MCU whether it want to enter power-down mode

Returns

non-zero if MCU want RTOS enter power down mode