sys_power_mgr.h

Go to the documentation of this file.

 
#ifndef SYS_POWER_MGR_H_
#define SYS_POWER_MGR_H_
 
#include <stdint.h>
#include <stdbool.h>
#include "sdk_defs.h"
#ifdef OS_PRESENT
#include "osal.h"
#endif
 
typedef enum {
        pm_mode_active = 0,
        pm_mode_idle,
        pm_mode_extended_sleep,
        pm_mode_deep_sleep,
        pm_mode_hibernation,
        pm_mode_sleep_max,
} sleep_mode_t;
 
typedef enum {
        pm_sys_wakeup_mode_normal,
        pm_sys_wakeup_mode_fast,
} sys_wakeup_mode_t;
#ifdef OS_PRESENT
 
typedef void (*periph_init_cb)(void);
typedef int32_t pm_id_t;
 
typedef struct _adptCB {
        bool (*ad_prepare_for_sleep)(void);
        void (*ad_sleep_canceled)(void);
        void (*ad_wake_up_ind)(bool);
        void (*ad_xtalm_ready_ind)(void);
        uint8_t ad_sleep_preparation_time;
} adapter_call_backs_t;
 
 
/*
 * Variables declarations
 */
 
 
typedef void (*comp_init_func)(void *);
 
typedef struct comp_init_tree {
        comp_init_func init_fun;                     
        void *init_arg;                              
        const struct comp_init_tree * const *depend; 
} comp_init_tree_t;
 
#define COMPONENT_INIT_WITH_DEPS(_comp, _init, _init_arg, _deps, _sect) \
        __USED \
        const comp_init_tree_t _comp = { _init, (void *)_init_arg, _deps }; \
        __USED \
        const comp_init_tree_t *const _comp##_ptr __attribute__((section (#_sect "_init_section"))) = &_comp; \
 
 
#define BUS_INIT(_id, _init, _init_arg) \
        COMPONENT_INIT_WITH_DEPS(_id, (comp_init_func)_init, _init_arg, NULL, bus)
 
#define DEVICE_INIT(_id, _init, _init_arg) \
        COMPONENT_INIT_WITH_DEPS(_id, (comp_init_func)_init, _init_arg, NULL, device)
 
#define ADAPTER_INIT_WITH_DEPS(_adapter, _init, _deps) \
        COMPONENT_INIT_WITH_DEPS(_adapter, (comp_init_func)_init, NULL, _deps, adapter)
 
#define ADAPTER_INIT(_adapter, _init) \
        ADAPTER_INIT_WITH_DEPS(_adapter, _init, NULL)
 
#define ADAPTER_INIT_DEP1(_adapter, _init, _dep1) \
        extern const comp_init_tree_t _dep1; \
        __USED \
        const comp_init_tree_t *const _adapter##_dep[2] = { &_dep1, NULL }; \
        ADAPTER_INIT_WITH_DEPS(_adapter, _init, _adapter##_dep)
 
#define ADAPTER_INIT_DEP2(_adapter, _init, _dep1, _dep2) \
        extern const comp_init_tree_t _dep1; \
        extern const comp_init_tree_t _dep2; \
        __USED \
        const comp_init_tree_t *_adapter##_dep[3] = { &_dep1, &_dep2, NULL }; \
        ADAPTER_INIT_WITH_DEPS(_adapter, _init, _adapter##_dep)
 
/*
 * Function declarations
 */
 
void pm_system_init(periph_init_cb peripherals_initialization);
 
void pm_wait_debugger_detach(sleep_mode_t mode);
 
 
sleep_mode_t pm_sleep_mode_set(sleep_mode_t mode);
 
sleep_mode_t pm_sleep_mode_get(void);
 
void pm_sleep_mode_request(sleep_mode_t mode);
 
void pm_sleep_mode_release(sleep_mode_t mode);
 
pm_id_t pm_register_adapter(const adapter_call_backs_t *cb);
 
void pm_unregister_adapter(pm_id_t id);
 
 
void pm_defer_sleep_for(pm_id_t id, uint32_t time_in_LP_cycles);
 
/*
 * \brief Put the system to idle or sleep or block in a WFI() waiting for the next tick, if neither
 *        idle nor sleep is possible.
 *
 * \detail Puts the system to idle or sleep, if possible. If an exit-from-idle or a wake-up is
 *         needed, it programs the Timer1 to generate an interrupt after the specified idle or sleep
 *         period. Else, the system stays forever in idle or sleep mode.
 *         If neither idle nor sleep is possible, it blocks in a WFI() call waiting for the next
 *         (already programmed) OS tick to hit.
 *
 * \param[in] low_power_periods The number of (prescaled) low power clock periods the OS will be
 *            idle. If it is 0 then the OS indicates that it can block forever waiting for an
 *            external event. If the system goes to sleep, then it can wake up only from an external
 *            event in this case.
 *
 * \warning Must be called with interrupts disabled!
 *
 */
__RETAINED_CODE void pm_sleep_enter(uint32_t low_power_periods);
#else
/*
 * \brief Put the system to sleep
 *
 * \param[in] sleep_mode The desired sleep mode of the device.
 *
 */
__RETAINED_CODE bool pm_sleep_enter_no_os(sleep_mode_t sleep_mode);
#endif /* OS_PRESENT */
 
void pm_set_wakeup_mode(bool wait_for_xtalm);
 
bool pm_get_wakeup_mode(void);
 
 
/*
 * \brief Block in a WFI() waiting for the next tick.
 *
 * \detail Blocks in a WFI() call waiting for the next (already programmed) OS tick to hit.
 *
 */
__RETAINED_CODE void pm_execute_wfi(void);
 
void pm_set_sys_wakeup_mode(sys_wakeup_mode_t mode);
 
sys_wakeup_mode_t pm_get_sys_wakeup_mode(void);
 
uint8_t pm_get_sys_wakeup_cycles(void);
 
__RETAINED_CODE void pm_prepare_sleep(sleep_mode_t sleep_mode);
 
__RETAINED_CODE void pm_resume_from_sleep(void);
 
 
#endif /* SYS_POWER_MGR_H_ */