 |
AIROC™ BTSDK v4.6 - Documentation | |||
|
AIROC™ BTSDK v4.6 - Documentation | |||
> More...
Data Structures | |
| struct | wiced_sleep_config_t |
| This structure defines the sleep configuration parameters to be passed to wiced_sleep_configure API. More... | |
Macros | |
| #define | WICED_SLEEP_MAX_TIME_TO_SLEEP |
| #define | WICED_SLEEP_WAKE_SOURCE_KEYSCAN (1<<0) |
| Wake sources. More... | |
| #define | WICED_SLEEP_WAKE_SOURCE_QUAD (1<<1) |
| Enable wake from quadrature sensor. | |
| #define | WICED_SLEEP_WAKE_SOURCE_GPIO (1<<2) |
| Enable wake from GPIO. | |
| #define | WICED_SLEEP_WAKE_SOURCE_MASK |
| All wake sources. More... | |
Typedefs | |
| typedef uint32_t(* | wiced_sleep_allow_check_callback )(wiced_sleep_poll_type_t type) |
| Prototype for the callback function that needs to be defined by the application. More... | |
| typedef void(* | wiced_sleep_post_sleep_callback )(wiced_bool_t restore_configuration) |
| Application implements call back of this type to perform post sleep actions. More... | |
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... | |
Functions | |
| wiced_result_t | wiced_sleep_configure (wiced_sleep_config_t *p_sleep_config) |
| This API is used to configure various sleep mode parameters (see ) such as interrupt source, GPIO to be used as interrupt etc. More... | |
| wiced_sleep_boot_type_t | wiced_sleep_get_boot_mode (void) |
| This API is used request the type of reboot. More... | |
| wiced_result_t | wiced_sleep_enter_hid_off (uint32_t wakeup_time, uint32_t wake_gpio_pin, wiced_sleep_wake_type_t wake_active_mode) |
| This API is used to enter HID OFF mode. More... | |
| wiced_sleep_wake_reason_t | wiced_sleep_hid_off_wake_reason (void) |
| API to get reset reason. More... | |
>
Provides the API definitions for low power modes.
This software, including source code, documentation and related materials ("Software") is owned by Cypress Semiconductor Corporation or one of its affiliates ("Cypress") and is protected by and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty provisions. Therefore, you may use this Software only as provided in the license agreement accompanying the software package from which you obtained this Software ("EULA"). If no EULA applies, Cypress hereby grants you a personal, non-exclusive, non-transferable license to copy, modify, and compile the Software source code solely for use in connection with Cypress's integrated circuit products. Any reproduction, modification, translation, compilation, or representation of this Software except as specified above is prohibited without the express written permission of Cypress.
Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes to the Software without notice. Cypress does not assume any liability arising out of the application or use of the Software or any product or circuit described in the Software. Cypress does not authorize its products for use in any products where a malfunction or failure of the Cypress product may reasonably be expected to result in significant property damage, injury or death ("High Risk Product"). By including Cypress's product in a High Risk Product, the manufacturer of such system or application assumes all risk of such use and in doing so agrees to indemnify Cypress against all liability.
