Group_sleep_enums

Enumerations
enum	wiced_sleep_boot_type_t { WICED_SLEEP_COLD_BOOT, WICED_SLEEP_FAST_BOOT }
	Defines whether the boot is cold boot or fast boot. More...
enum	wiced_sleep_mode_type_t { WICED_SLEEP_MODE_NO_TRANSPORT, WICED_SLEEP_MODE_TRANSPORT }
	Defines whether to sleep with external HCI host present or not. More...
enum	wiced_sleep_wake_type_t { WICED_SLEEP_WAKE_ACTIVE_LOW, WICED_SLEEP_WAKE_ACTIVE_HIGH }
	Active interrupt level for Wake through GPIO. More...
enum	wiced_sleep_poll_type_t { WICED_SLEEP_POLL_TIME_TO_SLEEP, WICED_SLEEP_POLL_SLEEP_PERMISSION }
	Defines the poll type from the PMU. More...
enum	wiced_sleep_permission_type_t { WICED_SLEEP_NOT_ALLOWED = 0, WICED_SLEEP_ALLOWED_WITHOUT_SHUTDOWN, WICED_SLEEP_ALLOWED_WITH_SHUTDOWN }
	Defines whether to allow sleep or not. More...
enum	wiced_sleep_wake_reason_t { WICED_SLEEP_WAKE_REASON_POR = 0, WICED_SLEEP_WAKE_REASON_HIDOFF_TIMEOUT, WICED_SLEEP_WAKE_REASON_HIDOFF_GPIO }
	Lists the reason for reset. More...

Detailed Description

Enumeration Type Documentation

enum wiced_sleep_boot_type_t

Defines whether the boot is cold boot or fast boot.

Not used for CYW20819

Enumerator
WICED_SLEEP_COLD_BOOT	Cold boot.
WICED_SLEEP_FAST_BOOT	Fast boot.

enum wiced_sleep_mode_type_t

Defines whether to sleep with external HCI host present or not.

Enumerator
WICED_SLEEP_MODE_TRANSPORT	<When a external HCI host is connected (determined using the assertion of CTS line) sleep is not allowed

enum wiced_sleep_permission_type_t

Defines whether to allow sleep or not.

Enumerator
WICED_SLEEP_NOT_ALLOWED	Sleep is not allowed.
WICED_SLEEP_ALLOWED_WITHOUT_SHUTDOWN	Sleep in EPDS mode is allowed.
WICED_SLEEP_ALLOWED_WITH_SHUTDOWN	Hibernate mode.

enum wiced_sleep_poll_type_t

Defines the poll type from the PMU.

The PMU can poll for either time to sleep or type of sleep

Enumerator
WICED_SLEEP_POLL_TIME_TO_SLEEP	Maximum allowed sleep duration.
WICED_SLEEP_POLL_SLEEP_PERMISSION	Permission to sleep.

enum wiced_sleep_wake_reason_t

Lists the reason for reset.

Enumerator
WICED_SLEEP_WAKE_REASON_POR	Reset due to POR.
WICED_SLEEP_WAKE_REASON_HIDOFF_TIMEOUT	Sleep in EPDS mode is allowed.
WICED_SLEEP_WAKE_REASON_HIDOFF_GPIO	Confirm if GPIO interrupt reset.

enum wiced_sleep_wake_type_t

Active interrupt level for Wake through GPIO.

Enumerator
WICED_SLEEP_WAKE_ACTIVE_LOW	Active low interrupt wakes the chip.
WICED_SLEEP_WAKE_ACTIVE_HIGH	Active high interrupt wakes the chip.