PSoC 6 Peripheral Driver Library
Enumerated Types

General Description

Enumerations

enum  cy_en_prot_status_t {
  CY_PROT_SUCCESS = 0x00U,
  CY_PROT_BAD_PARAM = CY_PROT_ID | CY_PDL_STATUS_ERROR | 0x01U,
  CY_PROT_INVALID_STATE = CY_PROT_ID | CY_PDL_STATUS_ERROR | 0x02U,
  CY_PROT_FAILURE = CY_PROT_ID | CY_PDL_STATUS_ERROR | 0x03U,
  CY_PROT_UNAVAILABLE = CY_PROT_ID | CY_PDL_STATUS_ERROR | 0x04U
}
 Prot Driver error codes. More...
 
enum  cy_en_prot_perm_t {
  CY_PROT_PERM_DISABLED = 0x00U,
  CY_PROT_PERM_R = 0x01U,
  CY_PROT_PERM_W = 0x02U,
  CY_PROT_PERM_RW = 0x03U,
  CY_PROT_PERM_X = 0x04U,
  CY_PROT_PERM_RX = 0x05U,
  CY_PROT_PERM_WX = 0x06U,
  CY_PROT_PERM_RWX = 0x07U
}
 User/Privileged permission. More...
 
enum  cy_en_prot_size_t {
  CY_PROT_SIZE_4B = 1U,
  CY_PROT_SIZE_8B = 2U,
  CY_PROT_SIZE_16B = 3U,
  CY_PROT_SIZE_32B = 4U,
  CY_PROT_SIZE_64B = 5U,
  CY_PROT_SIZE_128B = 6U,
  CY_PROT_SIZE_256B = 7U,
  CY_PROT_SIZE_512B = 8U,
  CY_PROT_SIZE_1KB = 9U,
  CY_PROT_SIZE_2KB = 10U,
  CY_PROT_SIZE_4KB = 11U,
  CY_PROT_SIZE_8KB = 12U,
  CY_PROT_SIZE_16KB = 13U,
  CY_PROT_SIZE_32KB = 14U,
  CY_PROT_SIZE_64KB = 15U,
  CY_PROT_SIZE_128KB = 16U,
  CY_PROT_SIZE_256KB = 17U,
  CY_PROT_SIZE_512KB = 18U,
  CY_PROT_SIZE_1MB = 19U,
  CY_PROT_SIZE_2MB = 20U,
  CY_PROT_SIZE_4MB = 21U,
  CY_PROT_SIZE_8MB = 22U,
  CY_PROT_SIZE_16MB = 23U,
  CY_PROT_SIZE_32MB = 24U,
  CY_PROT_SIZE_64MB = 25U,
  CY_PROT_SIZE_128MB = 26U,
  CY_PROT_SIZE_256MB = 27U,
  CY_PROT_SIZE_512MB = 28U,
  CY_PROT_SIZE_1GB = 29U,
  CY_PROT_SIZE_2GB = 30U,
  CY_PROT_SIZE_4GB = 31U
}
 Memory region size. More...
 
enum  cy_en_prot_pc_t {
  CY_PROT_PC1 = 1U,
  CY_PROT_PC2 = 2U,
  CY_PROT_PC3 = 3U,
  CY_PROT_PC4 = 4U,
  CY_PROT_PC5 = 5U,
  CY_PROT_PC6 = 6U,
  CY_PROT_PC7 = 7U,
  CY_PROT_PC8 = 8U,
  CY_PROT_PC9 = 9U,
  CY_PROT_PC10 = 10U,
  CY_PROT_PC11 = 11U,
  CY_PROT_PC12 = 12U,
  CY_PROT_PC13 = 13U,
  CY_PROT_PC14 = 14U,
  CY_PROT_PC15 = 15U
}
 Protection Context (PC) More...
 
enum  cy_en_prot_subreg_t {
  CY_PROT_SUBREGION_DIS0 = 0x01U,
  CY_PROT_SUBREGION_DIS1 = 0x02U,
  CY_PROT_SUBREGION_DIS2 = 0x04U,
  CY_PROT_SUBREGION_DIS3 = 0x08U,
  CY_PROT_SUBREGION_DIS4 = 0x10U,
  CY_PROT_SUBREGION_DIS5 = 0x20U,
  CY_PROT_SUBREGION_DIS6 = 0x40U,
  CY_PROT_SUBREGION_DIS7 = 0x80U
}
 Subregion disable (0-7) More...
 
enum  cy_en_prot_pcmask_t {
  CY_PROT_PCMASK1 = 0x0001U,
  CY_PROT_PCMASK2 = 0x0002U,
  CY_PROT_PCMASK3 = 0x0004U,
  CY_PROT_PCMASK4 = 0x0008U,
  CY_PROT_PCMASK5 = 0x0010U,
  CY_PROT_PCMASK6 = 0x0020U,
  CY_PROT_PCMASK7 = 0x0040U,
  CY_PROT_PCMASK8 = 0x0080U,
  CY_PROT_PCMASK9 = 0x0100U,
  CY_PROT_PCMASK10 = 0x0200U,
  CY_PROT_PCMASK11 = 0x0400U,
  CY_PROT_PCMASK12 = 0x0800U,
  CY_PROT_PCMASK13 = 0x1000U,
  CY_PROT_PCMASK14 = 0x2000U,
  CY_PROT_PCMASK15 = 0x4000U
}
 Protection context mask (PC_MASK) More...
 
enum  cy_en_prot_req_mode_t {
  CY_PROT_REQMODE_HIGHPRIOR = 0U,
  CY_PROT_REQMODE_LOWPRIOR = 1U,
  CY_PROT_REQMODE_INDEX = 2U
}
 Request mode to get the SMPU or programmed PU structure. More...
 

Enumeration Type Documentation

◆ cy_en_prot_status_t

Prot Driver error codes.

Enumerator
CY_PROT_SUCCESS 

Returned successful.

CY_PROT_BAD_PARAM 

Bad parameter was passed.

CY_PROT_INVALID_STATE 

The operation is not setup.

CY_PROT_FAILURE 

The resource is locked.

CY_PROT_UNAVAILABLE 

The resource is unavailable.

◆ cy_en_prot_perm_t

User/Privileged permission.

Enumerator
CY_PROT_PERM_DISABLED 

Read, Write and Execute disabled.

CY_PROT_PERM_R 

Read enabled.

CY_PROT_PERM_W 

Write enabled.

CY_PROT_PERM_RW 

Read and Write enabled.

CY_PROT_PERM_X 

Execute enabled.

CY_PROT_PERM_RX 

Read and Execute enabled.

CY_PROT_PERM_WX 

Write and Execute enabled.

CY_PROT_PERM_RWX 

Read, Write and Execute enabled.

◆ cy_en_prot_size_t

Memory region size.

Enumerator
CY_PROT_SIZE_4B 

4 bytes

CY_PROT_SIZE_8B 

8 bytes

CY_PROT_SIZE_16B 

16 bytes

CY_PROT_SIZE_32B 

32 bytes

CY_PROT_SIZE_64B 

64 bytes

CY_PROT_SIZE_128B 

128 bytes

CY_PROT_SIZE_256B 

256 bytes

CY_PROT_SIZE_512B 

512 bytes

CY_PROT_SIZE_1KB 

1 Kilobyte

CY_PROT_SIZE_2KB 

2 Kilobytes

CY_PROT_SIZE_4KB 

4 Kilobytes

CY_PROT_SIZE_8KB 

8 Kilobytes

CY_PROT_SIZE_16KB 

16 Kilobytes

CY_PROT_SIZE_32KB 

32 Kilobytes

CY_PROT_SIZE_64KB 

64 Kilobytes

CY_PROT_SIZE_128KB 

128 Kilobytes

CY_PROT_SIZE_256KB 

256 Kilobytes

CY_PROT_SIZE_512KB 

512 Kilobytes

CY_PROT_SIZE_1MB 

1 Megabyte

CY_PROT_SIZE_2MB 

2 Megabytes

CY_PROT_SIZE_4MB 

4 Megabytes

CY_PROT_SIZE_8MB 

8 Megabytes

CY_PROT_SIZE_16MB 

16 Megabytes

CY_PROT_SIZE_32MB 

32 Megabytes

CY_PROT_SIZE_64MB 

64 Megabytes

CY_PROT_SIZE_128MB 

128 Megabytes

CY_PROT_SIZE_256MB 

256 Megabytes

CY_PROT_SIZE_512MB 

512 Megabytes

CY_PROT_SIZE_1GB 

1 Gigabyte

CY_PROT_SIZE_2GB 

2 Gigabytes

CY_PROT_SIZE_4GB 

4 Gigabytes

◆ cy_en_prot_pc_t

Protection Context (PC)

Enumerator
CY_PROT_PC1 

PC = 1.

CY_PROT_PC2 

PC = 2.

CY_PROT_PC3 

PC = 3.

CY_PROT_PC4 

PC = 4.

CY_PROT_PC5 

PC = 5.

CY_PROT_PC6 

PC = 6.

CY_PROT_PC7 

PC = 7.

CY_PROT_PC8 

PC = 8.

CY_PROT_PC9 

PC = 9.

CY_PROT_PC10 

PC = 10.

CY_PROT_PC11 

PC = 11.

CY_PROT_PC12 

PC = 12.

CY_PROT_PC13 

PC = 13.

CY_PROT_PC14 

PC = 14.

CY_PROT_PC15 

PC = 15.

◆ cy_en_prot_subreg_t

Subregion disable (0-7)

Enumerator
CY_PROT_SUBREGION_DIS0 

Disable subregion 0.

CY_PROT_SUBREGION_DIS1 

Disable subregion 1.

CY_PROT_SUBREGION_DIS2 

Disable subregion 2.

CY_PROT_SUBREGION_DIS3 

Disable subregion 3.

CY_PROT_SUBREGION_DIS4 

Disable subregion 4.

CY_PROT_SUBREGION_DIS5 

Disable subregion 5.

CY_PROT_SUBREGION_DIS6 

Disable subregion 6.

CY_PROT_SUBREGION_DIS7 

Disable subregion 7.

◆ cy_en_prot_pcmask_t

Protection context mask (PC_MASK)

Enumerator
CY_PROT_PCMASK1 

Mask to allow PC = 1.

CY_PROT_PCMASK2 

Mask to allow PC = 2.

CY_PROT_PCMASK3 

Mask to allow PC = 3.

CY_PROT_PCMASK4 

Mask to allow PC = 4.

CY_PROT_PCMASK5 

Mask to allow PC = 5.

CY_PROT_PCMASK6 

Mask to allow PC = 6.

CY_PROT_PCMASK7 

Mask to allow PC = 7.

CY_PROT_PCMASK8 

Mask to allow PC = 8.

CY_PROT_PCMASK9 

Mask to allow PC = 9.

CY_PROT_PCMASK10 

Mask to allow PC = 10.

CY_PROT_PCMASK11 

Mask to allow PC = 11.

CY_PROT_PCMASK12 

Mask to allow PC = 12.

CY_PROT_PCMASK13 

Mask to allow PC = 13.

CY_PROT_PCMASK14 

Mask to allow PC = 14.

CY_PROT_PCMASK15 

Mask to allow PC = 15.

◆ cy_en_prot_req_mode_t

Request mode to get the SMPU or programmed PU structure.

Enumerator
CY_PROT_REQMODE_HIGHPRIOR 

Request mode to return PU structure with highest priority.

CY_PROT_REQMODE_LOWPRIOR 

Request mode to return PU structure with lowest priority.

CY_PROT_REQMODE_INDEX 

Request mode to return PU structure with specific index.