docs/hal_html/hal__ppu_8h_source.html

#ifndef HAL_PPU_H

#define HAL_PPU_H


#if defined(__cplusplus)

extern "C" {

#endif /* __cplusplus */


#include "hal_common.h"


enum ppu_status {

    PPU_Status_Ok                = 0,

    PPU_Status_InvalidArgument   = 1,

    PPU_Status_FeatureNotSupport = 2,

    PPU_Status_DriverError       = 3,

    PPU_Status_ConfigError       = 4,

};


enum ppu_domain_index {

    PPU_DomainCPU0        = 0,

    PPU_DomainCPU1        = 1,

    PPU_DomainDEBUG       = 2,

    PPU_DomainCRYPTO      = 3,

    PPU_DomainGMS         = 4,

    PPU_DomainGNSS        = 5,

    PPU_DomainSRAM0       = 6,

    PPU_DomainSRAM1       = 7,

    PPU_DomainSRAM2       = 8,

    PPU_DomainSRAM3       = 9,

    PPU_DomainSYS         = 10,

    PPU_DomainMax         = 10,

};


enum ppu_sense_index {

    PPU_SenseCPU0   = 1,

    PPU_SenseCPU1   = 2,

    PPU_SenseCRYPTO = 12,

    PPU_SenseGMS    = 16,

    PPU_SenseGNSS   = 17,

    PPU_SenseSRAM0  = 3,

    PPU_SenseSRAM1  = 4,

    PPU_SenseSRAM2  = 5,

    PPU_SenseSRAM3  = 6,

    PPU_SenseSYS    = 0,

};


enum ppu_power_mode {

    PPU_PowerModeOn        = 8,

    PPU_PowerModeOff       = 0,

    PPU_PowerModeMemRet    = 2,

    /* Состояния не реализованы в первых ревизиях чипа */

    PPU_PowerModeWarmRst   = 9,

    PPU_PowerModeDbgRecov  = 10,

    PPU_PowerModeFuncRet   = 7,

    PPU_PowerModeMemOff    = 6,

    PPU_PowerModeFullRet   = 5,

    PPU_PowerModeLogicRet  = 4,

    PPU_PowerModeMemRetEmu = 3,

    PPU_PowerModeOffEmu    = 1,

    PPU_PowerModeMax       = 10,

};


enum ppu_event_name {

    PPU_Locked       = 0x00000020,

    PPU_EmuDeny      = 0x00000010,

    PPU_EmuAccept    = 0x00000008,

    PPU_StaDeny      = 0x00000004,

    PPU_StaAccept    = 0x00000002,

    PPU_StaPolicyTrn = 0x00000001,

    PPU_EventNameAll = PPU_Locked |

                       PPU_EmuDeny |

                       PPU_EmuAccept |

                       PPU_StaDeny |

                       PPU_StaAccept |

                       PPU_StaPolicyTrn

                       ,

};


enum ppu_add_event_name {

    PPU_StaPolicyOp     = 0x00000010,

    PPU_STA_PolicyPwr   = 0x00000008,

    PPU_DynDeny         = 0x00000004,

    PPU_DynAccept       = 0x00000002,

    PPU_UnsptPolicy     = 0x00000001,

    PPU_AddEventNameAll = PPU_StaPolicyOp |

                          PPU_STA_PolicyPwr |

                          PPU_DynDeny |

                          PPU_DynAccept |

                          PPU_UnsptPolicy

                          ,

};


enum ppu_opportunities_idr0 {

    PPU_DYN_WRM_RST_SPT     = 1 << 29,

    PPU_DYN_ON_SPT          = 1 << 28,

    PPU_DYN_FUNC_RET_SPT    = 1 << 27,

    PPU_DYN_FULL_RET_SPT    = 1 << 26,

    PPU_DYN_MEM_OFF_SPT     = 1 << 25,

    PPU_DYN_LGC_RET_SPT     = 1 << 24,

    PPU_DYN_MEM_RET_EMU_SPT = 1 << 23,

    PPU_DYN_MEM_RET_SPT     = 1 << 22,

    PPU_DYN_OFF_EMU_SPT     = 1 << 21,

    PPU_DYN_OFF_SPT         = 1 << 20,

    PPU_STA_DBG_RECOV_SPT   = 1 << 18,

    PPU_STA_WRM_RST_SPT     = 1 << 17,

    PPU_STA_ON_SPT          = 1 << 16,

    PPU_STA_FUNC_RET_SPT    = 1 << 15,

    PPU_STA_FULL_RET_SPT    = 1 << 14,

    PPU_STA_MEM_OFF_SPT     = 1 << 13,

    PPU_STA_LGC_RET_SPT     = 1 << 12,

    PPU_STA_MEM_RET_EMU_SPT = 1 << 11,

    PPU_STA_MEM_RET_SPT     = 1 << 10,

    PPU_STA_OFF_EMU_SPT     = 1 <<  9,

    PPU_STA_OFF_SPT         = 1 <<  8,

};


enum ppu_opportunities_idr1 {

    PPU_OFF_MEM_RET_TRANS      = 1 << 12,

    PPU_OP_ACTIVE              = 1 << 10,

    PPU_STA_POLICY_OP_IRQ_SPT  = 1 <<  9,

    PPU_STA_POLICY_PWR_IRQ_SPT = 1 <<  8,

    PPU_FUNC_RET_RAM_REG       = 1 <<  6,

    PPU_FULL_RET_RAM_REG       = 1 <<  5,

    PPU_MEM_RET_RAM_REG        = 1 <<  4,

    PPU_LOCK_SPT               = 1 <<  2,

    PPU_SW_DEV_DEL_SPT         = 1 <<  1,

    PPU_PWR_MODE_ENTRY_DEL_SPT = 1 <<  0,

};


typedef void (*ReqOffForCPU)(void);


struct ppu_config {

    ReqOffForCPU reqForCPU;

};


enum ppu_status PPU_SetState(PPU_Type * base, enum ppu_power_mode mode);


enum ppu_status PPU_SetStateDynamic(PPU_Type * base, enum ppu_power_mode mode);


enum ppu_status PPU_SetPDCMPPUSense(enum ppu_domain_index pd_dst,

    enum ppu_sense_index pd_src, uint32_t sense);


enum ppu_status PPU_SetIRQStatus(PPU_Type *base, enum ppu_event_name irq,

    enum ppu_add_event_name add_irq);


enum ppu_status PPU_SetIRQMask(PPU_Type * base, enum ppu_event_name irq,

    enum ppu_add_event_name add_irq);


enum ppu_status PPU_ClrIRQStatus(PPU_Type *base, enum ppu_event_name irq,

    enum ppu_add_event_name add_irq);


enum ppu_status PPU_ClrIRQMask(PPU_Type * base, enum ppu_event_name irq,

    enum ppu_add_event_name add_irq);


enum ppu_power_mode PPU_GetPowerState(PPU_Type *base);


uint32_t PPU_GetPDxSenseFromPDy(enum ppu_domain_index pd_dst,

    enum ppu_sense_index pd_src);


enum ppu_status PPU_GetLastAPIStatus(void);


enum ppu_status PPU_GetIRQStatus(PPU_Type *base, enum ppu_event_name *irq,

    enum ppu_add_event_name *add_irq);


enum ppu_status PPU_GetIRQMask(PPU_Type *base, enum ppu_event_name *irq,

    enum ppu_add_event_name *add_irq);

enum ppu_status PPU_Init(PPU_Type * base, struct ppu_config * cfg);


void PPU_StateOffRequestHandler(void);


#if defined(__cplusplus)

}

#endif /* __cplusplus */


#endif /* HAL_PPU_H */


PPU_SetIRQStatus
enum ppu_status PPU_SetIRQStatus(PPU_Type *base, enum ppu_event_name irq, enum ppu_add_event_name add_irq)
Функция установки состояний прерываний

PPU_ClrIRQMask
enum ppu_status PPU_ClrIRQMask(PPU_Type *base, enum ppu_event_name irq, enum ppu_add_event_name add_irq)
Функция сброса масок прерываний

ppu_sense_index
ppu_sense_index
Индексы бит блоков PPU, от которых зависят другие домены
Definition hal_ppu.h:62

ppu_opportunities_idr1
ppu_opportunities_idr1
Идентификационный регистр PPU_IDR1.
Definition hal_ppu.h:210

PPU_GetLastAPIStatus
enum ppu_status PPU_GetLastAPIStatus(void)
Получение статуса выполнения функции, тип результата которой отличен от enum ppu_status.

PPU_GetPDxSenseFromPDy
uint32_t PPU_GetPDxSenseFromPDy(enum ppu_domain_index pd_dst, enum ppu_sense_index pd_src)
Функция получения зависимости доменов питания

PPU_ClrIRQStatus
enum ppu_status PPU_ClrIRQStatus(PPU_Type *base, enum ppu_event_name irq, enum ppu_add_event_name add_irq)
Функция сброса состояний прерываний

PPU_GetIRQMask
enum ppu_status PPU_GetIRQMask(PPU_Type *base, enum ppu_event_name *irq, enum ppu_add_event_name *add_irq)
Получение масок прерываний

ReqOffForCPU
void(* ReqOffForCPU)(void)
Тип функции запроса для выключения смежного ядра
Definition hal_ppu.h:245

ppu_power_mode
ppu_power_mode
Состояние домена питания
Definition hal_ppu.h:80

PPU_SetPDCMPPUSense
enum ppu_status PPU_SetPDCMPPUSense(enum ppu_domain_index pd_dst, enum ppu_sense_index pd_src, uint32_t sense)
Функция установки зависимости доменов питания

PPU_StateOffRequestHandler
void PPU_StateOffRequestHandler(void)
Функция отключения питания текущего ядра

ppu_opportunities_idr0
ppu_opportunities_idr0
Идентификационный регистр PPU_IDR0.
Definition hal_ppu.h:183

PPU_SetIRQMask
enum ppu_status PPU_SetIRQMask(PPU_Type *base, enum ppu_event_name irq, enum ppu_add_event_name add_irq)
Функция установки масок прерываний

ppu_event_name
ppu_event_name
Имена масок прерываний
Definition hal_ppu.h:124

PPU_Init
enum ppu_status PPU_Init(PPU_Type *base, struct ppu_config *cfg)
Функция инициализации блока PPU.

ppu_domain_index
ppu_domain_index
Индексы блоков PPU.
Definition hal_ppu.h:43

PPU_SetState
enum ppu_status PPU_SetState(PPU_Type *base, enum ppu_power_mode mode)
Функция запроса установки статического режима работы

PPU_GetPowerState
enum ppu_power_mode PPU_GetPowerState(PPU_Type *base)
Функция получения состояния домена

PPU_SetStateDynamic
enum ppu_status PPU_SetStateDynamic(PPU_Type *base, enum ppu_power_mode mode)
Функция запроса установки динамического режима работы

ppu_status
ppu_status
Статусы драйвера PPU.
Definition hal_ppu.h:32

ppu_add_event_name
ppu_add_event_name
Имена масок дополнительных прерываний
Definition hal_ppu.h:149

PPU_GetIRQStatus
enum ppu_status PPU_GetIRQStatus(PPU_Type *base, enum ppu_event_name *irq, enum ppu_add_event_name *add_irq)
Получение статуса прерываний

PPU_SenseSRAM1
@ PPU_SenseSRAM1
Definition hal_ppu.h:69

PPU_SenseSRAM0
@ PPU_SenseSRAM0
Definition hal_ppu.h:68

PPU_SenseGNSS
@ PPU_SenseGNSS
Definition hal_ppu.h:67

PPU_SenseSRAM3
@ PPU_SenseSRAM3
Definition hal_ppu.h:71

PPU_SenseCPU0
@ PPU_SenseCPU0
Definition hal_ppu.h:63

PPU_SenseCRYPTO
@ PPU_SenseCRYPTO
Definition hal_ppu.h:65

PPU_SenseSYS
@ PPU_SenseSYS
Definition hal_ppu.h:72

PPU_SenseCPU1
@ PPU_SenseCPU1
Definition hal_ppu.h:64

PPU_SenseGMS
@ PPU_SenseGMS
Definition hal_ppu.h:66

PPU_SenseSRAM2
@ PPU_SenseSRAM2
Definition hal_ppu.h:70

PPU_STA_POLICY_PWR_IRQ_SPT
@ PPU_STA_POLICY_PWR_IRQ_SPT
Definition hal_ppu.h:216

PPU_STA_POLICY_OP_IRQ_SPT
@ PPU_STA_POLICY_OP_IRQ_SPT
Definition hal_ppu.h:214

PPU_PWR_MODE_ENTRY_DEL_SPT
@ PPU_PWR_MODE_ENTRY_DEL_SPT
Definition hal_ppu.h:229

PPU_FULL_RET_RAM_REG
@ PPU_FULL_RET_RAM_REG
Definition hal_ppu.h:221

PPU_LOCK_SPT
@ PPU_LOCK_SPT
Definition hal_ppu.h:225

PPU_OP_ACTIVE
@ PPU_OP_ACTIVE
Definition hal_ppu.h:212

PPU_MEM_RET_RAM_REG
@ PPU_MEM_RET_RAM_REG
Definition hal_ppu.h:223

PPU_OFF_MEM_RET_TRANS
@ PPU_OFF_MEM_RET_TRANS
Definition hal_ppu.h:211

PPU_FUNC_RET_RAM_REG
@ PPU_FUNC_RET_RAM_REG
Definition hal_ppu.h:218

PPU_SW_DEV_DEL_SPT
@ PPU_SW_DEV_DEL_SPT
Definition hal_ppu.h:227

PPU_PowerModeMax
@ PPU_PowerModeMax
Definition hal_ppu.h:113

PPU_PowerModeMemRetEmu
@ PPU_PowerModeMemRetEmu
Definition hal_ppu.h:104

PPU_PowerModeFuncRet
@ PPU_PowerModeFuncRet
Definition hal_ppu.h:97

PPU_PowerModeOff
@ PPU_PowerModeOff
Definition hal_ppu.h:83

PPU_PowerModeMemOff
@ PPU_PowerModeMemOff
Definition hal_ppu.h:99

PPU_PowerModeDbgRecov
@ PPU_PowerModeDbgRecov
Definition hal_ppu.h:89

PPU_PowerModeLogicRet
@ PPU_PowerModeLogicRet
Definition hal_ppu.h:102

PPU_PowerModeOn
@ PPU_PowerModeOn
Definition hal_ppu.h:81

PPU_PowerModeWarmRst
@ PPU_PowerModeWarmRst
Definition hal_ppu.h:87

PPU_PowerModeOffEmu
@ PPU_PowerModeOffEmu
Definition hal_ppu.h:108

PPU_PowerModeFullRet
@ PPU_PowerModeFullRet
Definition hal_ppu.h:101

PPU_PowerModeMemRet
@ PPU_PowerModeMemRet
Definition hal_ppu.h:85

PPU_STA_OFF_SPT
@ PPU_STA_OFF_SPT
Definition hal_ppu.h:204

PPU_STA_MEM_RET_SPT
@ PPU_STA_MEM_RET_SPT
Definition hal_ppu.h:202

PPU_STA_LGC_RET_SPT
@ PPU_STA_LGC_RET_SPT
Definition hal_ppu.h:200

PPU_DYN_LGC_RET_SPT
@ PPU_DYN_LGC_RET_SPT
Definition hal_ppu.h:189

PPU_STA_MEM_RET_EMU_SPT
@ PPU_STA_MEM_RET_EMU_SPT
Definition hal_ppu.h:201

PPU_STA_OFF_EMU_SPT
@ PPU_STA_OFF_EMU_SPT
Definition hal_ppu.h:203

PPU_STA_WRM_RST_SPT
@ PPU_STA_WRM_RST_SPT
Definition hal_ppu.h:195

PPU_DYN_ON_SPT
@ PPU_DYN_ON_SPT
Definition hal_ppu.h:185

PPU_DYN_WRM_RST_SPT
@ PPU_DYN_WRM_RST_SPT
Definition hal_ppu.h:184

PPU_DYN_OFF_SPT
@ PPU_DYN_OFF_SPT
Definition hal_ppu.h:193

PPU_DYN_MEM_RET_EMU_SPT
@ PPU_DYN_MEM_RET_EMU_SPT
Definition hal_ppu.h:190

PPU_DYN_FUNC_RET_SPT
@ PPU_DYN_FUNC_RET_SPT
Definition hal_ppu.h:186

PPU_DYN_OFF_EMU_SPT
@ PPU_DYN_OFF_EMU_SPT
Definition hal_ppu.h:192

PPU_STA_ON_SPT
@ PPU_STA_ON_SPT
Definition hal_ppu.h:196

PPU_STA_MEM_OFF_SPT
@ PPU_STA_MEM_OFF_SPT
Definition hal_ppu.h:199

PPU_STA_FULL_RET_SPT
@ PPU_STA_FULL_RET_SPT
Definition hal_ppu.h:198

PPU_DYN_MEM_RET_SPT
@ PPU_DYN_MEM_RET_SPT
Definition hal_ppu.h:191

PPU_STA_DBG_RECOV_SPT
@ PPU_STA_DBG_RECOV_SPT
Definition hal_ppu.h:194

PPU_DYN_MEM_OFF_SPT
@ PPU_DYN_MEM_OFF_SPT
Definition hal_ppu.h:188

PPU_DYN_FULL_RET_SPT
@ PPU_DYN_FULL_RET_SPT
Definition hal_ppu.h:187

PPU_STA_FUNC_RET_SPT
@ PPU_STA_FUNC_RET_SPT
Definition hal_ppu.h:197

PPU_StaDeny
@ PPU_StaDeny
Definition hal_ppu.h:130

PPU_Locked
@ PPU_Locked
Definition hal_ppu.h:125

PPU_EmuDeny
@ PPU_EmuDeny
Definition hal_ppu.h:126

PPU_EventNameAll
@ PPU_EventNameAll
Definition hal_ppu.h:137

PPU_EmuAccept
@ PPU_EmuAccept
Definition hal_ppu.h:128

PPU_StaPolicyTrn
@ PPU_StaPolicyTrn
Definition hal_ppu.h:134

PPU_StaAccept
@ PPU_StaAccept
Definition hal_ppu.h:132

PPU_DomainSYS
@ PPU_DomainSYS
Definition hal_ppu.h:54

PPU_DomainSRAM1
@ PPU_DomainSRAM1
Definition hal_ppu.h:51

PPU_DomainGNSS
@ PPU_DomainGNSS
Definition hal_ppu.h:49

PPU_DomainMax
@ PPU_DomainMax
Definition hal_ppu.h:56

PPU_DomainGMS
@ PPU_DomainGMS
Definition hal_ppu.h:48

PPU_DomainCPU1
@ PPU_DomainCPU1
Definition hal_ppu.h:45

PPU_DomainSRAM2
@ PPU_DomainSRAM2
Definition hal_ppu.h:52

PPU_DomainCRYPTO
@ PPU_DomainCRYPTO
Definition hal_ppu.h:47

PPU_DomainSRAM0
@ PPU_DomainSRAM0
Definition hal_ppu.h:50

PPU_DomainDEBUG
@ PPU_DomainDEBUG
Definition hal_ppu.h:46

PPU_DomainSRAM3
@ PPU_DomainSRAM3
Definition hal_ppu.h:53

PPU_DomainCPU0
@ PPU_DomainCPU0
Definition hal_ppu.h:44

PPU_Status_InvalidArgument
@ PPU_Status_InvalidArgument
Definition hal_ppu.h:34

PPU_Status_FeatureNotSupport
@ PPU_Status_FeatureNotSupport
Definition hal_ppu.h:35

PPU_Status_Ok
@ PPU_Status_Ok
Definition hal_ppu.h:33

PPU_Status_ConfigError
@ PPU_Status_ConfigError
Definition hal_ppu.h:37

PPU_Status_DriverError
@ PPU_Status_DriverError
Definition hal_ppu.h:36

PPU_UnsptPolicy
@ PPU_UnsptPolicy
Definition hal_ppu.h:158

PPU_StaPolicyOp
@ PPU_StaPolicyOp
Definition hal_ppu.h:150

PPU_AddEventNameAll
@ PPU_AddEventNameAll
Definition hal_ppu.h:161

PPU_DynDeny
@ PPU_DynDeny
Definition hal_ppu.h:154

PPU_STA_PolicyPwr
@ PPU_STA_PolicyPwr
Definition hal_ppu.h:152

PPU_DynAccept
@ PPU_DynAccept
Definition hal_ppu.h:156

ppu_config
Структура для инициализации
Definition hal_ppu.h:250

ppu_config::reqForCPU
ReqOffForCPU reqForCPU
Definition hal_ppu.h:251