MTB CAT1 Peripheral driver library

General Description

Enumerations

enum  cy_en_pra_status_t {
  CY_PRA_STATUS_SUCCESS = 0x0U,
  CY_PRA_STATUS_ACCESS_DENIED = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFFFU,
  CY_PRA_STATUS_INVALID_PARAM = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFFEU,
  CY_PRA_STATUS_ERROR_PROCESSING = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFFDU,
  CY_PRA_STATUS_REQUEST_SENT = CY_PRA_ID | CY_PDL_STATUS_INFO | 0xFFCU,
  CY_PRA_STATUS_ERROR_SYSPM_FAIL = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFFBU,
  CY_PRA_STATUS_ERROR_SYSPM_TIMEOUT = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFFAU,
  CY_PRA_STATUS_ERROR_PRA_VERSION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFF9U,
  CY_PRA_STATUS_INVALID_PARAM_ECO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFEFU,
  CY_PRA_STATUS_INVALID_PARAM_EXTCLK = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFEEU,
  CY_PRA_STATUS_INVALID_PARAM_ALTHF = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFEDU,
  CY_PRA_STATUS_INVALID_PARAM_ILO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFECU,
  CY_PRA_STATUS_INVALID_PARAM_PILO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFEBU,
  CY_PRA_STATUS_INVALID_PARAM_WCO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFEAU,
  CY_PRA_STATUS_INVALID_ECO_PROVISION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFE9U,
  CY_PRA_STATUS_INVALID_EXTCLK_PROVISION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFE8U,
  CY_PRA_STATUS_INVALID_WCO_PROVISION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFE7U,
  CY_PRA_STATUS_INVALID_PARAM_PATHMUX0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFDFU,
  CY_PRA_STATUS_INVALID_PARAM_PATHMUX1 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFDEU,
  CY_PRA_STATUS_INVALID_PARAM_PATHMUX2 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFDDU,
  CY_PRA_STATUS_INVALID_PARAM_PATHMUX3 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFDCU,
  CY_PRA_STATUS_INVALID_PARAM_PATHMUX4 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFDBU,
  CY_PRA_STATUS_INVALID_PARAM_PATHMUX5 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFDAU,
  CY_PRA_STATUS_INVALID_PARAM_FLL0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFCFU,
  CY_PRA_STATUS_INVALID_PARAM_PLL0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFBFU,
  CY_PRA_STATUS_INVALID_PARAM_PLL1 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFBEU,
  CY_PRA_STATUS_INVALID_PARAM_PLL_NUM = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFBDU,
  CY_PRA_STATUS_INVALID_PARAM_CLKLF = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xFAFU,
  CY_PRA_STATUS_INVALID_PARAM_CLKHF0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF9FU,
  CY_PRA_STATUS_INVALID_PARAM_CLKHF1 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF9EU,
  CY_PRA_STATUS_INVALID_PARAM_CLKHF2 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF9DU,
  CY_PRA_STATUS_INVALID_PARAM_CLKHF3 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF9CU,
  CY_PRA_STATUS_INVALID_PARAM_CLKHF4 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF9BU,
  CY_PRA_STATUS_INVALID_PARAM_CLKHF5 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF9AU,
  CY_PRA_STATUS_INVALID_PARAM_CLKPUMP = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF8FU,
  CY_PRA_STATUS_INVALID_PARAM_CLKBAK = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF8EU,
  CY_PRA_STATUS_INVALID_PARAM_CLKFAST = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF8DU,
  CY_PRA_STATUS_INVALID_PARAM_CLKPERI = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF8CU,
  CY_PRA_STATUS_INVALID_PARAM_CLKSLOW = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF8BU,
  CY_PRA_STATUS_INVALID_PARAM_SYSTICK = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF8AU,
  CY_PRA_STATUS_INVALID_PARAM_CLKTIMER = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF89U,
  CY_PRA_STATUS_ERROR_PROCESSING_PWR = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF6FU,
  CY_PRA_STATUS_ERROR_PROCESSING_ECO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF5FU,
  CY_PRA_STATUS_ERROR_PROCESSING_EXTCLK = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF5EU,
  CY_PRA_STATUS_ERROR_PROCESSING_ALTHF = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF5DU,
  CY_PRA_STATUS_ERROR_PROCESSING_ILO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF5CU,
  CY_PRA_STATUS_ERROR_PROCESSING_PILO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF5BU,
  CY_PRA_STATUS_ERROR_PROCESSING_WCO = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF5AU,
  CY_PRA_STATUS_ERROR_PROCESSING_ECO_ENABLED = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF59U,
  CY_PRA_STATUS_ERROR_PROCESSING_ECO_PROVISION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF58U,
  CY_PRA_STATUS_ERROR_PROCESSING_EXTCLK_PROVISION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF57U,
  CY_PRA_STATUS_ERROR_PROCESSING_WCO_PROVISION = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF56U,
  CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF4FU,
  CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX1 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF4EU,
  CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX2 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF4DU,
  CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX3 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF4CU,
  CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX4 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF4BU,
  CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX5 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF4AU,
  CY_PRA_STATUS_ERROR_PROCESSING_FLL0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF3FU,
  CY_PRA_STATUS_ERROR_PROCESSING_FLL0_ENABLED = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF3EU,
  CY_PRA_STATUS_ERROR_PROCESSING_PLL0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF2FU,
  CY_PRA_STATUS_ERROR_PROCESSING_PLL1 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF2EU,
  CY_PRA_STATUS_ERROR_PROCESSING_PLL_ENABLED = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF2DU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKLF = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF1FU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKHF0 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF0FU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKHF1 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF0EU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKHF2 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF0DU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKHF3 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF0CU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKHF4 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF0BU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKHF5 = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xF0AU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKPUMP = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEFFU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKBAK = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEFEU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKFAST = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEFDU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKPERI = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEFCU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKSLOW = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEFBU,
  CY_PRA_STATUS_ERROR_PROCESSING_SYSTICK = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEFAU,
  CY_PRA_STATUS_ERROR_PROCESSING_CLKTIMER = CY_PRA_ID | CY_PDL_STATUS_ERROR | 0xEF9U
}
 Status definitions of the PRA function return values. More...
 
enum  cy_en_pra_pin_prot_type_t {
  CY_PRA_PIN_SECURE,
  CY_PRA_PIN_SECURE_UNCONSTRAINED,
  CY_PRA_PIN_SECURE_NONE
}
 GPIO PIN protection type. More...
 

Enumeration Type Documentation

◆ cy_en_pra_status_t

Status definitions of the PRA function return values.

Enumerator
CY_PRA_STATUS_SUCCESS 

Returns success.

CY_PRA_STATUS_ACCESS_DENIED 

Access denied - PRA does not allow a call from Non-Secure.

CY_PRA_STATUS_INVALID_PARAM 

Invalid parameter.

CY_PRA_STATUS_ERROR_PROCESSING 

An error while applying the device configuration.

CY_PRA_STATUS_REQUEST_SENT 

The IPC message status when sent from Non-Secure to Secure.

CY_PRA_STATUS_ERROR_SYSPM_FAIL 

SysPM failure.

CY_PRA_STATUS_ERROR_SYSPM_TIMEOUT 

SysPM operation timeout.

CY_PRA_STATUS_ERROR_PRA_VERSION 

The driver version mismatch between Cortex-M0+ and Cortex-M4.

CY_PRA_STATUS_INVALID_PARAM_ECO 

Returns Error while validating the ECO parameters.

CY_PRA_STATUS_INVALID_PARAM_EXTCLK 

Returns Error while validating the CLK_EXT parameters.

CY_PRA_STATUS_INVALID_PARAM_ALTHF 

Returns Error while validating the CLK_ALTHF parameters.

CY_PRA_STATUS_INVALID_PARAM_ILO 

Returns Error while validating the CLK_ILO parameters.

CY_PRA_STATUS_INVALID_PARAM_PILO 

Returns Error while validating the CLK_PILO parameters.

CY_PRA_STATUS_INVALID_PARAM_WCO 

Returns Error while validating the CLK_WCO parameters.

CY_PRA_STATUS_INVALID_ECO_PROVISION 

Returns Error while validating the provisioned CLK_ECO policy.

CY_PRA_STATUS_INVALID_EXTCLK_PROVISION 

Returns Error while validating the provisioned CLK_EXT policy.

CY_PRA_STATUS_INVALID_WCO_PROVISION 

Returns Error while validating the provisioned CLK_WCO policy.

CY_PRA_STATUS_INVALID_PARAM_PATHMUX0 

Returns Error while validating PATH_MUX0.

CY_PRA_STATUS_INVALID_PARAM_PATHMUX1 

Returns Error while validating PATH_MUX1.

CY_PRA_STATUS_INVALID_PARAM_PATHMUX2 

Returns Error while validating PATH_MUX2.

CY_PRA_STATUS_INVALID_PARAM_PATHMUX3 

Returns Error while validating PATH_MUX3.

CY_PRA_STATUS_INVALID_PARAM_PATHMUX4 

Returns Error while validating PATH_MUX4.

CY_PRA_STATUS_INVALID_PARAM_PATHMUX5 

Returns Error while validating PATH_MUX5.

CY_PRA_STATUS_INVALID_PARAM_FLL0 

Returns Error while validating FLL.

CY_PRA_STATUS_INVALID_PARAM_PLL0 

Returns Error while validating PLL0.

CY_PRA_STATUS_INVALID_PARAM_PLL1 

Returns Error while validating PLL1.

CY_PRA_STATUS_INVALID_PARAM_PLL_NUM 

Returns Error for the invalid PLL number.

CY_PRA_STATUS_INVALID_PARAM_CLKLF 

Returns Error while validating CLK_LF.

CY_PRA_STATUS_INVALID_PARAM_CLKHF0 

Returns Error while validating CLK_HF0.

CY_PRA_STATUS_INVALID_PARAM_CLKHF1 

Returns Error while validating CLK_HF1.

CY_PRA_STATUS_INVALID_PARAM_CLKHF2 

Returns Error while validating CLK_HF2.

CY_PRA_STATUS_INVALID_PARAM_CLKHF3 

Returns Error while validating CLK_HF3.

CY_PRA_STATUS_INVALID_PARAM_CLKHF4 

Returns Error while validating CLK_HF4.

CY_PRA_STATUS_INVALID_PARAM_CLKHF5 

Returns Error while validating CLK_HF5.

CY_PRA_STATUS_INVALID_PARAM_CLKPUMP 

Returns Error while validating CLK_PUMP.

CY_PRA_STATUS_INVALID_PARAM_CLKBAK 

Returns Error while validating CLK_BAK.

CY_PRA_STATUS_INVALID_PARAM_CLKFAST 

Returns Error while validating CLK_FAST.

CY_PRA_STATUS_INVALID_PARAM_CLKPERI 

Returns Error while validating CLK_PERI.

CY_PRA_STATUS_INVALID_PARAM_CLKSLOW 

Returns Error while validating CLK_SLOW.

CY_PRA_STATUS_INVALID_PARAM_SYSTICK 

Returns Error while validating CLK_ALT_SYS_TICK.

CY_PRA_STATUS_INVALID_PARAM_CLKTIMER 

Returns Error while validating CLK_TIMER.

CY_PRA_STATUS_ERROR_PROCESSING_PWR 

Returns Error while initializing power.

CY_PRA_STATUS_ERROR_PROCESSING_ECO 

Returns Error while initializing ECO.

CY_PRA_STATUS_ERROR_PROCESSING_EXTCLK 

Returns Error while enabling CLK_EXT.

CY_PRA_STATUS_ERROR_PROCESSING_ALTHF 

Returns Error while enabling CLK_ALTHF.

CY_PRA_STATUS_ERROR_PROCESSING_ILO 

Returns Error while enabling/disabling CLK_ILO.

CY_PRA_STATUS_ERROR_PROCESSING_PILO 

Returns Error while enabling/disabling CLK_ALTHF.

CY_PRA_STATUS_ERROR_PROCESSING_WCO 

Returns Error while enabling/disabling CLK_WCO.

CY_PRA_STATUS_ERROR_PROCESSING_ECO_ENABLED 

Returns Error while enabling CLK_ECO.

CY_PRA_STATUS_ERROR_PROCESSING_ECO_PROVISION 

Returns Error if failed to process the provisioned CLK_ECO policy.

CY_PRA_STATUS_ERROR_PROCESSING_EXTCLK_PROVISION 

Returns Error if failed to process the provisioned CLK_EXT policy.

CY_PRA_STATUS_ERROR_PROCESSING_WCO_PROVISION 

Returns Error if failed to process the provisioned CLK_WCO policy.

CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX0 

Returns Error while setting PATH_MUX0.

CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX1 

Returns Error while setting PATH_MUX1.

CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX2 

Returns Error while setting PATH_MUX2.

CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX3 

Returns Error while setting PATH_MUX3.

CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX4 

Returns Error while setting PATH_MUX4.

CY_PRA_STATUS_ERROR_PROCESSING_PATHMUX5 

Returns Error while setting PATH_MUX5.

CY_PRA_STATUS_ERROR_PROCESSING_FLL0 

Returns Error while enabling/disabling FLL.

CY_PRA_STATUS_ERROR_PROCESSING_FLL0_ENABLED 

Returns Error while trying to enable an already enabled FLL.

CY_PRA_STATUS_ERROR_PROCESSING_PLL0 

Returns Error while enabling/disabling PLL0.

CY_PRA_STATUS_ERROR_PROCESSING_PLL1 

Returns Error while enabling/disabling PLL1.

CY_PRA_STATUS_ERROR_PROCESSING_PLL_ENABLED 

Returns Error while trying to enable an already enabled PLL.

CY_PRA_STATUS_ERROR_PROCESSING_CLKLF 

Returns Error while enabling/disabling CLK_LF.

CY_PRA_STATUS_ERROR_PROCESSING_CLKHF0 

Returns Error while enabling/disabling CLK_HF0.

CY_PRA_STATUS_ERROR_PROCESSING_CLKHF1 

Returns Error while enabling/disabling CLK_HF1.

CY_PRA_STATUS_ERROR_PROCESSING_CLKHF2 

Returns Error while enabling/disabling CLK_HF2.

CY_PRA_STATUS_ERROR_PROCESSING_CLKHF3 

Returns Error while enabling/disabling CLK_HF3.

CY_PRA_STATUS_ERROR_PROCESSING_CLKHF4 

Returns Error while enabling/disabling CLK_HF4.

CY_PRA_STATUS_ERROR_PROCESSING_CLKHF5 

Returns Error while enabling/disabling CLK_HF5.

CY_PRA_STATUS_ERROR_PROCESSING_CLKPUMP 

Returns Error while enabling/disabling CLK_PUMP.

CY_PRA_STATUS_ERROR_PROCESSING_CLKBAK 

Returns Error while enabling/disabling CLK_BAK.

CY_PRA_STATUS_ERROR_PROCESSING_CLKFAST 

Returns Error while enabling/disabling CLK_FAST.

CY_PRA_STATUS_ERROR_PROCESSING_CLKPERI 

Returns Error while enabling/disabling CLK_PERI.

CY_PRA_STATUS_ERROR_PROCESSING_CLKSLOW 

Returns Error while enabling/disabling CLK_SLOW.

CY_PRA_STATUS_ERROR_PROCESSING_SYSTICK 

Returns Error while enabling/disabling CLK_ALT_SYS_TICK.

CY_PRA_STATUS_ERROR_PROCESSING_CLKTIMER 

Returns Error while enabling/disabling CLK_TIMER.

◆ cy_en_pra_pin_prot_type_t

GPIO PIN protection type.

Enumerator
CY_PRA_PIN_SECURE 

Is a secure PIN.

Can't be updated from CM4 application through register level PRA policy. This PIN can only be updated through service-level policy

CY_PRA_PIN_SECURE_UNCONSTRAINED 

Is a secure PIN.

Can be updated from CM4 application through register level PRA policy

CY_PRA_PIN_SECURE_NONE 

Not a secure PIN.