General Description

Macros
#define	PROT_SIZE_4B_BIT_SHIFT 1U
	Constants for memory region size setting. More...

#define	PROT_SIZE_8B_BIT_SHIFT 2U
	8 bytes

#define	PROT_SIZE_16B_BIT_SHIFT 3U
	16 bytes

#define	PROT_SIZE_32B_BIT_SHIFT 4U
	32 bytes

#define	PROT_SIZE_64B_BIT_SHIFT 5U
	64 bytes

#define	PROT_SIZE_128B_BIT_SHIFT 6U
	128 bytes

#define	PROT_SIZE_256B_BIT_SHIFT 7U
	256 bytes

#define	PROT_SIZE_512B_BIT_SHIFT 8U
	512 bytes

#define	PROT_SIZE_1KB_BIT_SHIFT 9U
	1 Kilobyte

#define	PROT_SIZE_2KB_BIT_SHIFT 10U
	2 Kilobytes

#define	PROT_SIZE_4KB_BIT_SHIFT 11U
	4 Kilobytes

#define	PROT_SIZE_8KB_BIT_SHIFT 12U
	8 Kilobytes

#define	PROT_SIZE_16KB_BIT_SHIFT 13U
	16 Kilobytes

#define	PROT_SIZE_32KB_BIT_SHIFT 14U
	32 Kilobytes

#define	PROT_SIZE_64KB_BIT_SHIFT 15U
	64 Kilobytes

#define	PROT_SIZE_128KB_BIT_SHIFT 16U
	128 Kilobytes

#define	PROT_SIZE_256KB_BIT_SHIFT 17U
	256 Kilobytes

#define	PROT_SIZE_512KB_BIT_SHIFT 18U
	512 Kilobytes

#define	PROT_SIZE_1MB_BIT_SHIFT 19U
	1 Megabyte

#define	PROT_SIZE_2MB_BIT_SHIFT 20U
	2 Megabytes

#define	PROT_SIZE_4MB_BIT_SHIFT 21U
	4 Megabytes

#define	PROT_SIZE_8MB_BIT_SHIFT 22U
	8 Megabytes

#define	PROT_SIZE_16MB_BIT_SHIFT 23U
	16 Megabytes

#define	PROT_SIZE_32MB_BIT_SHIFT 24U
	32 Megabytes

#define	PROT_SIZE_64MB_BIT_SHIFT 25U
	64 Megabytes

#define	PROT_SIZE_128MB_BIT_SHIFT 26U
	128 Megabytes

#define	PROT_SIZE_256MB_BIT_SHIFT 27U
	256 Megabytes

#define	PROT_SIZE_512MB_BIT_SHIFT 28U
	512 Megabytes

#define	PROT_SIZE_1GB_BIT_SHIFT 29U
	1 Gigabyte

#define	PROT_SIZE_2GB_BIT_SHIFT 30U
	2 Gigabytes

#define	PROT_SIZE_4GB_BIT_SHIFT 31U
	4 Gigabytes

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 = PROT_SIZE_4B_BIT_SHIFT, CY_PROT_SIZE_8B = PROT_SIZE_8B_BIT_SHIFT, CY_PROT_SIZE_16B = PROT_SIZE_16B_BIT_SHIFT, CY_PROT_SIZE_32B = PROT_SIZE_32B_BIT_SHIFT, CY_PROT_SIZE_64B = PROT_SIZE_64B_BIT_SHIFT, CY_PROT_SIZE_128B = PROT_SIZE_128B_BIT_SHIFT, CY_PROT_SIZE_256B = PROT_SIZE_256B_BIT_SHIFT, CY_PROT_SIZE_512B = PROT_SIZE_512B_BIT_SHIFT, CY_PROT_SIZE_1KB = PROT_SIZE_1KB_BIT_SHIFT, CY_PROT_SIZE_2KB = PROT_SIZE_2KB_BIT_SHIFT, CY_PROT_SIZE_4KB = PROT_SIZE_4KB_BIT_SHIFT, CY_PROT_SIZE_8KB = PROT_SIZE_8KB_BIT_SHIFT, CY_PROT_SIZE_16KB = PROT_SIZE_16KB_BIT_SHIFT, CY_PROT_SIZE_32KB = PROT_SIZE_32KB_BIT_SHIFT, CY_PROT_SIZE_64KB = PROT_SIZE_64KB_BIT_SHIFT, CY_PROT_SIZE_128KB = PROT_SIZE_128KB_BIT_SHIFT, CY_PROT_SIZE_256KB = PROT_SIZE_256KB_BIT_SHIFT, CY_PROT_SIZE_512KB = PROT_SIZE_512KB_BIT_SHIFT, CY_PROT_SIZE_1MB = PROT_SIZE_1MB_BIT_SHIFT, CY_PROT_SIZE_2MB = PROT_SIZE_2MB_BIT_SHIFT, CY_PROT_SIZE_4MB = PROT_SIZE_4MB_BIT_SHIFT, CY_PROT_SIZE_8MB = PROT_SIZE_8MB_BIT_SHIFT, CY_PROT_SIZE_16MB = PROT_SIZE_16MB_BIT_SHIFT, CY_PROT_SIZE_32MB = PROT_SIZE_32MB_BIT_SHIFT, CY_PROT_SIZE_64MB = PROT_SIZE_64MB_BIT_SHIFT, CY_PROT_SIZE_128MB = PROT_SIZE_128MB_BIT_SHIFT, CY_PROT_SIZE_256MB = PROT_SIZE_256MB_BIT_SHIFT, CY_PROT_SIZE_512MB = PROT_SIZE_512MB_BIT_SHIFT, CY_PROT_SIZE_1GB = PROT_SIZE_1GB_BIT_SHIFT, CY_PROT_SIZE_2GB = PROT_SIZE_2GB_BIT_SHIFT, CY_PROT_SIZE_4GB = PROT_SIZE_4GB_BIT_SHIFT }
	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...

Macro Definition Documentation

◆ PROT_SIZE_4B_BIT_SHIFT

#define PROT_SIZE_4B_BIT_SHIFT 1U

Constants for memory region size setting.

These may be useful for pre-processor-time tests.4 bytes

Enumeration Type Documentation

◆ cy_en_prot_status_t

enum 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

enum 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

enum 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

enum 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

enum 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

enum 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

enum 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.