docs/hal_html/hal__power_8h_source.html

#ifndef HAL_POWER_H

#define HAL_POWER_H


#if defined(__cplusplus)

extern "C" {

#endif /* __cplusplus */


#include "hal_common.h"


enum power_status {

    POWER_Status_Ok   = 0U,

    POWER_Status_Fail = 1U,

};


enum power_dcdc_vlevel {

    POWER_DcdcVLevel0,

    POWER_DcdcVLevel1,

    POWER_DcdcVLevel2

};


enum power_dcdc_vlevel_value {

    POWER_DcdcVLevel_0_85V,

    POWER_DcdcVLevel_0_86V,

    POWER_DcdcVLevel_0_87V,

    POWER_DcdcVLevel_0_88V,

    POWER_DcdcVLevel_0_89V,

    POWER_DcdcVLevel_0_90V,

    POWER_DcdcVLevel_0_91V,

    POWER_DcdcVLevel_0_92V,

    POWER_DcdcVLevel_0_93V,

    POWER_DcdcVLevel_0_94V,

    POWER_DcdcVLevel_0_95V,

    POWER_DcdcVLevel_0_96V,

    POWER_DcdcVLevel_0_97V,

    POWER_DcdcVLevel_0_98V,

    POWER_DcdcVLevel_0_99V,

    POWER_DcdcVLevel_1_00V,

    POWER_DcdcVLevel_1_01V,

    POWER_DcdcVLevel_1_02V,

    POWER_DcdcVLevel_1_03V,

    POWER_DcdcVLevel_1_04V,

    POWER_DcdcVLevel_1_05V,

    POWER_DcdcVLevel_1_06V,

    POWER_DcdcVLevel_1_07V,

    POWER_DcdcVLevel_1_08V,

    POWER_DcdcVLevel_1_09V,

    POWER_DcdcVLevel_1_10V,

    POWER_DcdcVLevel_1_11V,

    POWER_DcdcVLevel_1_12V,

    POWER_DcdcVLevel_1_13V,

    POWER_DcdcVLevel_1_14V,

    POWER_DcdcVLevel_1_15V,

    POWER_DcdcVLevel_1_16V

};


enum power_dcdc_mode {

    POWER_DcdcModeAuto,

    POWER_DcdcModePwm,

    POWER_DcdcModePwmFccm,

    POWER_DcdcModePfm

};


enum power_eco_mode {

    POWER_EcoOff,

    POWER_EcoDcdc,

    POWER_EcoReserved,

    POWER_EcoDcdcAndApc

};


enum power_dcdc_threshold {

    POWER_DcdcThreshold_0_60V,

    POWER_DcdcThreshold_0_62V,

    POWER_DcdcThreshold_0_64V,

    POWER_DcdcThreshold_0_66V,

    POWER_DcdcThreshold_0_68V,

    POWER_DcdcThreshold_0_70V,

    POWER_DcdcThreshold_0_72V,

    POWER_DcdcThreshold_0_74V,

    POWER_DcdcThreshold_0_76V,

    POWER_DcdcThreshold_0_78V,

    POWER_DcdcThreshold_0_80V,

    POWER_DcdcThreshold_0_82V,

    POWER_DcdcThreshold_0_84V,

    POWER_DcdcThreshold_0_86V,

    POWER_DcdcThreshold_0_88V,

    POWER_DcdcThreshold_0_90V

};


enum power_flash_mode {

    POWER_FlashModeNormal,

    POWER_FlashModeSleep,

    POWER_FlashModePowerDown

};


enum power_test_block {

    POWER_TestBlockApc,

    POWER_TestBlockDcdc,

    POWER_TestBlockJtm,

    POWER_TestBlockRwc

};


enum power_interrupt {

    POWER_VmonRising,

    POWER_VmonFalling,

};


struct power_mode_config {

    enum power_dcdc_vlevel    dcdc_level;

    enum power_dcdc_mode      dcdc_mode;

    uint8_t                   dcdc_swdrv;

    bool                      dcdc_sink_enable;

    bool                      dcdc_ccm_enable;

    bool                      dcdc_low_consumption_enable;

    enum power_eco_mode       eco_mode;

    bool                      apc_low_clk_enable;

    enum power_dcdc_threshold apc_eco_threshold;

    enum power_flash_mode     flash_power_mode;

};


struct power_trim_config {

    uint8_t apc_vref_it;

    uint8_t apc_vref_tt;

    uint8_t apc_vref_vt;

    bool    apc_force_trim;

    uint8_t dcdc_imax;

    uint8_t dcdc_imin;

    uint8_t dcdc_trimlc;

};


struct power_config {

    struct power_mode_config     run_configuration;

    struct power_mode_config     standby_configuration;

    struct power_trim_config     trim_configuration;

    bool                         flash_low_voltage_read_enable;

    bool                         dcdc_enable;

    enum power_dcdc_vlevel_value vlevel0;

    enum power_dcdc_vlevel_value vlevel1;

    enum power_dcdc_vlevel_value vlevel2;

};


struct power_state {

    bool                  vdda_is_lower_threshold;

    bool                  dcdc_is_ready;

    enum power_flash_mode flash_power_mode;

    bool                  flash_low_voltage_read_enabled;

};


struct power_handle;


typedef void (*power_callback_t)(PWRCTR_Type *base, struct power_handle *handle,

    uint8_t interrupt_mask, void *user_data);


struct power_handle {

    power_callback_t callback;

    void             *user_data;

};


void POWER_GetCurrentConfig(PWRCTR_Type *base, struct power_config *config);


void POWER_SetConfig(PWRCTR_Type *base, struct power_config *config);


void POWER_GetStatus(PWRCTR_Type *base, struct power_state *status);


void POWER_EnableInterrupt(PWRCTR_Type *base, enum power_interrupt idx);


void POWER_EnableInterruptMask(PWRCTR_Type *base, uint8_t mask);


bool POWER_IsInterruptEnabled(PWRCTR_Type *base, enum power_interrupt idx);


uint8_t POWER_GetEnabledInterruptMask(PWRCTR_Type *base);


void POWER_DisableInterrupt(PWRCTR_Type *base, enum power_interrupt idx);


void POWER_DisableInterruptMask(PWRCTR_Type *base, uint8_t mask);


bool POWER_GetInterruptStatus(PWRCTR_Type *base, enum power_interrupt idx);


uint8_t POWER_GetInterruptStatusMask(PWRCTR_Type *base);


void POWER_ClearInterrupts(PWRCTR_Type *base);


enum power_status POWER_CreateHandle(PWRCTR_Type *base,

    struct power_handle *handle, power_callback_t callback, void *user_data);


void POWER_StartTestMode(PWRCTR_Type *base, enum power_test_block test_block);


void POWER_StopTestMode(PWRCTR_Type *base);


void POWER_DeepSleepThisCpu();


enum power_status POWER_Standby(PWRCTR_Type * base);


enum power_status POWER_Shutdown(PWRCTR_Type * base);


#if defined(__cplusplus)

}

#endif /* __cplusplus */


#endif /* HAL_POWER_H */


power_test_block
power_test_block
Перечисление блоков для тестирования
Definition hal_power.h:142

power_dcdc_threshold
power_dcdc_threshold
Перечисление пороговых напряжений DC-DC.
Definition hal_power.h:111

POWER_GetStatus
void POWER_GetStatus(PWRCTR_Type *base, struct power_state *status)
Установка параметров блока POWER.

POWER_SetConfig
void POWER_SetConfig(PWRCTR_Type *base, struct power_config *config)
Установка параметров блока POWER.

POWER_StartTestMode
void POWER_StartTestMode(PWRCTR_Type *base, enum power_test_block test_block)
Запуск тестового режима

POWER_GetCurrentConfig
void POWER_GetCurrentConfig(PWRCTR_Type *base, struct power_config *config)
Получение текущих значений параметров блока POWER.

POWER_GetInterruptStatusMask
uint8_t POWER_GetInterruptStatusMask(PWRCTR_Type *base)
Получение маски активных прерываний

power_dcdc_mode
power_dcdc_mode
Перечисление режимов работы встроенного регулятора DC-DC.
Definition hal_power.h:91

power_interrupt
power_interrupt
Перечисление типов фронтов прерываний
Definition hal_power.h:152

POWER_StopTestMode
void POWER_StopTestMode(PWRCTR_Type *base)
Останов тестового режима

POWER_DisableInterruptMask
void POWER_DisableInterruptMask(PWRCTR_Type *base, uint8_t mask)
Запрет прерываний по маске

POWER_CreateHandle
enum power_status POWER_CreateHandle(PWRCTR_Type *base, struct power_handle *handle, power_callback_t callback, void *user_data)
Инициализация обработчика прерываний блока POWER.

POWER_Shutdown
enum power_status POWER_Shutdown(PWRCTR_Type *base)
Функция погружения процессора в глубокий сон

power_dcdc_vlevel_value
power_dcdc_vlevel_value
Перечисление значений для уровней 0-2 выходных напряжений встроенного регулятора DC-DC.
Definition hal_power.h:53

power_status
power_status
Коды возврата функций драйвера POWER.
Definition hal_power.h:32

power_dcdc_vlevel
power_dcdc_vlevel
Перечисление выходных напряжений встроенного регулятора DC-DC.
Definition hal_power.h:40

POWER_EnableInterrupt
void POWER_EnableInterrupt(PWRCTR_Type *base, enum power_interrupt idx)
Разрешение прерывания

POWER_DeepSleepThisCpu
void POWER_DeepSleepThisCpu()
Функция погружения ядра процессора в сон Погружается в сон то ядро, на котором выполнится данная функ...

power_eco_mode
power_eco_mode
Перечисление режимов ECO DC-DC и APC.
Definition hal_power.h:101

POWER_IsInterruptEnabled
bool POWER_IsInterruptEnabled(PWRCTR_Type *base, enum power_interrupt idx)
Запрос - разрешено ли прерывание

POWER_GetInterruptStatus
bool POWER_GetInterruptStatus(PWRCTR_Type *base, enum power_interrupt idx)
Получение состояния флага прерывания

POWER_DisableInterrupt
void POWER_DisableInterrupt(PWRCTR_Type *base, enum power_interrupt idx)
Запрет прерывания

POWER_EnableInterruptMask
void POWER_EnableInterruptMask(PWRCTR_Type *base, uint8_t mask)
Разрешение прерываний по маске

power_callback_t
void(* power_callback_t)(PWRCTR_Type *base, struct power_handle *handle, uint8_t interrupt_mask, void *user_data)
Функция обратного вызова для обработки прерывания POWER.
Definition hal_power.h:221

power_flash_mode
power_flash_mode
Перечисление пороговых напряжений DC-DC.
Definition hal_power.h:133

POWER_ClearInterrupts
void POWER_ClearInterrupts(PWRCTR_Type *base)
Сброс признаков активных прерываний

POWER_GetEnabledInterruptMask
uint8_t POWER_GetEnabledInterruptMask(PWRCTR_Type *base)
Запрос маски разрешенных прерываний

POWER_Standby
enum power_status POWER_Standby(PWRCTR_Type *base)
Функция погружения процессора в сон

POWER_TestBlockApc
@ POWER_TestBlockApc
Definition hal_power.h:143

POWER_TestBlockJtm
@ POWER_TestBlockJtm
Definition hal_power.h:145

POWER_TestBlockRwc
@ POWER_TestBlockRwc
Definition hal_power.h:146

POWER_TestBlockDcdc
@ POWER_TestBlockDcdc
Definition hal_power.h:144

POWER_DcdcThreshold_0_70V
@ POWER_DcdcThreshold_0_70V
Definition hal_power.h:117

POWER_DcdcThreshold_0_84V
@ POWER_DcdcThreshold_0_84V
Definition hal_power.h:124

POWER_DcdcThreshold_0_86V
@ POWER_DcdcThreshold_0_86V
Definition hal_power.h:125

POWER_DcdcThreshold_0_76V
@ POWER_DcdcThreshold_0_76V
Definition hal_power.h:120

POWER_DcdcThreshold_0_78V
@ POWER_DcdcThreshold_0_78V
Definition hal_power.h:121

POWER_DcdcThreshold_0_74V
@ POWER_DcdcThreshold_0_74V
Definition hal_power.h:119

POWER_DcdcThreshold_0_82V
@ POWER_DcdcThreshold_0_82V
Definition hal_power.h:123

POWER_DcdcThreshold_0_66V
@ POWER_DcdcThreshold_0_66V
Definition hal_power.h:115

POWER_DcdcThreshold_0_60V
@ POWER_DcdcThreshold_0_60V
Definition hal_power.h:112

POWER_DcdcThreshold_0_88V
@ POWER_DcdcThreshold_0_88V
Definition hal_power.h:126

POWER_DcdcThreshold_0_90V
@ POWER_DcdcThreshold_0_90V
Definition hal_power.h:127

POWER_DcdcThreshold_0_72V
@ POWER_DcdcThreshold_0_72V
Definition hal_power.h:118

POWER_DcdcThreshold_0_68V
@ POWER_DcdcThreshold_0_68V
Definition hal_power.h:116

POWER_DcdcThreshold_0_80V
@ POWER_DcdcThreshold_0_80V
Definition hal_power.h:122

POWER_DcdcThreshold_0_62V
@ POWER_DcdcThreshold_0_62V
Definition hal_power.h:113

POWER_DcdcThreshold_0_64V
@ POWER_DcdcThreshold_0_64V
Definition hal_power.h:114

POWER_DcdcModePwm
@ POWER_DcdcModePwm
Definition hal_power.h:93

POWER_DcdcModePfm
@ POWER_DcdcModePfm
Definition hal_power.h:95

POWER_DcdcModePwmFccm
@ POWER_DcdcModePwmFccm
Definition hal_power.h:94

POWER_DcdcModeAuto
@ POWER_DcdcModeAuto
Definition hal_power.h:92

POWER_VmonFalling
@ POWER_VmonFalling
Definition hal_power.h:154

POWER_VmonRising
@ POWER_VmonRising
Definition hal_power.h:153

POWER_DcdcVLevel_1_00V
@ POWER_DcdcVLevel_1_00V
Definition hal_power.h:69

POWER_DcdcVLevel_0_88V
@ POWER_DcdcVLevel_0_88V
Definition hal_power.h:57

POWER_DcdcVLevel_0_99V
@ POWER_DcdcVLevel_0_99V
Definition hal_power.h:68

POWER_DcdcVLevel_1_05V
@ POWER_DcdcVLevel_1_05V
Definition hal_power.h:74

POWER_DcdcVLevel_1_10V
@ POWER_DcdcVLevel_1_10V
Definition hal_power.h:79

POWER_DcdcVLevel_0_96V
@ POWER_DcdcVLevel_0_96V
Definition hal_power.h:65

POWER_DcdcVLevel_0_93V
@ POWER_DcdcVLevel_0_93V
Definition hal_power.h:62

POWER_DcdcVLevel_1_07V
@ POWER_DcdcVLevel_1_07V
Definition hal_power.h:76

POWER_DcdcVLevel_0_91V
@ POWER_DcdcVLevel_0_91V
Definition hal_power.h:60

POWER_DcdcVLevel_0_85V
@ POWER_DcdcVLevel_0_85V
Definition hal_power.h:54

POWER_DcdcVLevel_1_01V
@ POWER_DcdcVLevel_1_01V
Definition hal_power.h:70

POWER_DcdcVLevel_0_90V
@ POWER_DcdcVLevel_0_90V
Definition hal_power.h:59

POWER_DcdcVLevel_0_95V
@ POWER_DcdcVLevel_0_95V
Definition hal_power.h:64

POWER_DcdcVLevel_1_06V
@ POWER_DcdcVLevel_1_06V
Definition hal_power.h:75

POWER_DcdcVLevel_0_98V
@ POWER_DcdcVLevel_0_98V
Definition hal_power.h:67

POWER_DcdcVLevel_1_16V
@ POWER_DcdcVLevel_1_16V
Definition hal_power.h:85

POWER_DcdcVLevel_0_92V
@ POWER_DcdcVLevel_0_92V
Definition hal_power.h:61

POWER_DcdcVLevel_1_15V
@ POWER_DcdcVLevel_1_15V
Definition hal_power.h:84

POWER_DcdcVLevel_1_04V
@ POWER_DcdcVLevel_1_04V
Definition hal_power.h:73

POWER_DcdcVLevel_0_94V
@ POWER_DcdcVLevel_0_94V
Definition hal_power.h:63

POWER_DcdcVLevel_1_09V
@ POWER_DcdcVLevel_1_09V
Definition hal_power.h:78

POWER_DcdcVLevel_1_02V
@ POWER_DcdcVLevel_1_02V
Definition hal_power.h:71

POWER_DcdcVLevel_1_13V
@ POWER_DcdcVLevel_1_13V
Definition hal_power.h:82

POWER_DcdcVLevel_0_87V
@ POWER_DcdcVLevel_0_87V
Definition hal_power.h:56

POWER_DcdcVLevel_0_97V
@ POWER_DcdcVLevel_0_97V
Definition hal_power.h:66

POWER_DcdcVLevel_1_08V
@ POWER_DcdcVLevel_1_08V
Definition hal_power.h:77

POWER_DcdcVLevel_1_12V
@ POWER_DcdcVLevel_1_12V
Definition hal_power.h:81

POWER_DcdcVLevel_1_11V
@ POWER_DcdcVLevel_1_11V
Definition hal_power.h:80

POWER_DcdcVLevel_0_86V
@ POWER_DcdcVLevel_0_86V
Definition hal_power.h:55

POWER_DcdcVLevel_1_03V
@ POWER_DcdcVLevel_1_03V
Definition hal_power.h:72

POWER_DcdcVLevel_0_89V
@ POWER_DcdcVLevel_0_89V
Definition hal_power.h:58

POWER_DcdcVLevel_1_14V
@ POWER_DcdcVLevel_1_14V
Definition hal_power.h:83

POWER_Status_Fail
@ POWER_Status_Fail
Definition hal_power.h:34

POWER_Status_Ok
@ POWER_Status_Ok
Definition hal_power.h:33

POWER_DcdcVLevel1
@ POWER_DcdcVLevel1
Definition hal_power.h:42

POWER_DcdcVLevel2
@ POWER_DcdcVLevel2
Definition hal_power.h:43

POWER_DcdcVLevel0
@ POWER_DcdcVLevel0
Definition hal_power.h:41

POWER_EcoDcdc
@ POWER_EcoDcdc
Definition hal_power.h:103

POWER_EcoOff
@ POWER_EcoOff
Definition hal_power.h:102

POWER_EcoDcdcAndApc
@ POWER_EcoDcdcAndApc
Definition hal_power.h:105

POWER_EcoReserved
@ POWER_EcoReserved
Definition hal_power.h:104

POWER_FlashModeSleep
@ POWER_FlashModeSleep
Definition hal_power.h:135

POWER_FlashModePowerDown
@ POWER_FlashModePowerDown
Definition hal_power.h:136

POWER_FlashModeNormal
@ POWER_FlashModeNormal
Definition hal_power.h:134

power_config
Структура конфигурации блока POWER.
Definition hal_power.h:190

power_config::vlevel2
enum power_dcdc_vlevel_value vlevel2
Definition hal_power.h:198

power_config::vlevel1
enum power_dcdc_vlevel_value vlevel1
Definition hal_power.h:197

power_config::flash_low_voltage_read_enable
bool flash_low_voltage_read_enable
Definition hal_power.h:194

power_config::standby_configuration
struct power_mode_config standby_configuration
Definition hal_power.h:192

power_config::dcdc_enable
bool dcdc_enable
Definition hal_power.h:195

power_config::vlevel0
enum power_dcdc_vlevel_value vlevel0
Definition hal_power.h:196

power_config::trim_configuration
struct power_trim_config trim_configuration
Definition hal_power.h:193

power_config::run_configuration
struct power_mode_config run_configuration
Definition hal_power.h:191

power_handle
Структура обработчика драйвера I2S.
Definition hal_power.h:227

power_handle::callback
power_callback_t callback
Definition hal_power.h:228

power_handle::user_data
void * user_data
Definition hal_power.h:229

power_mode_config
Структура параметров режима питания
Definition hal_power.h:160

power_mode_config::apc_eco_threshold
enum power_dcdc_threshold apc_eco_threshold
Definition hal_power.h:169

power_mode_config::eco_mode
enum power_eco_mode eco_mode
Definition hal_power.h:167

power_mode_config::dcdc_level
enum power_dcdc_vlevel dcdc_level
Definition hal_power.h:161

power_mode_config::dcdc_low_consumption_enable
bool dcdc_low_consumption_enable
Definition hal_power.h:166

power_mode_config::dcdc_ccm_enable
bool dcdc_ccm_enable
Definition hal_power.h:165

power_mode_config::flash_power_mode
enum power_flash_mode flash_power_mode
Definition hal_power.h:170

power_mode_config::dcdc_swdrv
uint8_t dcdc_swdrv
Definition hal_power.h:163

power_mode_config::apc_low_clk_enable
bool apc_low_clk_enable
Definition hal_power.h:168

power_mode_config::dcdc_sink_enable
bool dcdc_sink_enable
Definition hal_power.h:164

power_mode_config::dcdc_mode
enum power_dcdc_mode dcdc_mode
Definition hal_power.h:162

power_state
Структура параметров состояния блока POWER.
Definition hal_power.h:204

power_state::vdda_is_lower_threshold
bool vdda_is_lower_threshold
Definition hal_power.h:205

power_state::dcdc_is_ready
bool dcdc_is_ready
Definition hal_power.h:206

power_state::flash_low_voltage_read_enabled
bool flash_low_voltage_read_enabled
Definition hal_power.h:208

power_state::flash_power_mode
enum power_flash_mode flash_power_mode
Definition hal_power.h:207

power_trim_config
Структура подстроечных параметров APC и DC-DC.
Definition hal_power.h:176

power_trim_config::dcdc_trimlc
uint8_t dcdc_trimlc
Definition hal_power.h:183

power_trim_config::dcdc_imin
uint8_t dcdc_imin
Definition hal_power.h:182

power_trim_config::apc_force_trim
bool apc_force_trim
Definition hal_power.h:180

power_trim_config::dcdc_imax
uint8_t dcdc_imax
Definition hal_power.h:181

power_trim_config::apc_vref_tt
uint8_t apc_vref_tt
Definition hal_power.h:178

power_trim_config::apc_vref_vt
uint8_t apc_vref_vt
Definition hal_power.h:179

power_trim_config::apc_vref_it
uint8_t apc_vref_it
Definition hal_power.h:177