PPU Group (GR) v1 Functions

General Description

Functions
cy_en_prot_status_t	Cy_Prot_ConfigPpuFixedGrMasterStruct (PERI_PPU_GR_Type *base, const cy_stc_ppu_gr_cfg_t *config)
	Configures a Fixed Peripheral Group Protection Unit (PPU GR) master protection struct with its protection attributes. More...
cy_en_prot_status_t	Cy_Prot_ConfigPpuFixedGrSlaveStruct (PERI_PPU_GR_Type *base, const cy_stc_ppu_gr_cfg_t *config)
	Configures a Fixed Peripheral Group Protection Unit (PPU GR) slave protection struct with its protection attributes. More...
cy_en_prot_status_t	Cy_Prot_EnablePpuFixedGrMasterStruct (PERI_PPU_GR_Type *base)
	Enables the Master PPU GR structure. More...
cy_en_prot_status_t	Cy_Prot_DisablePpuFixedGrMasterStruct (PERI_PPU_GR_Type *base)
	Disables the Master PPU GR structure. More...
cy_en_prot_status_t	Cy_Prot_EnablePpuFixedGrSlaveStruct (PERI_PPU_GR_Type *base)
	Enables the Slave PPU GR structure. More...
cy_en_prot_status_t	Cy_Prot_DisablePpuFixedGrSlaveStruct (PERI_PPU_GR_Type *base)
	Disables the Slave PPU GR structure. More...

Function Documentation

Cy_Prot_ConfigPpuFixedGrMasterStruct()

cy_en_prot_status_t Cy_Prot_ConfigPpuFixedGrMasterStruct	(	PERI_PPU_GR_Type *	base,
		const cy_stc_ppu_gr_cfg_t *	config
	)

Configures a Fixed Peripheral Group Protection Unit (PPU GR) master protection struct with its protection attributes.

This function configures the master struct governing the corresponding slave struct pair. It is a mechanism to protect the slave PPU GR struct. Since the memory location of the slave struct is known, the address, regionSize and subregions of the configuration struct are not applicable.

Note that only the user/privileged write permissions are configurable. The read and execute permissions are read-only and cannot be configured.

Note

This function is applicable for CPUSS ver_1 only.

Parameters

base	The register base address of the protection struct being configured.
config	Initialization structure with all the protection attributes.

Returns

Status of the function call.

Status	Description
CY_PROT_SUCCESS	PPU GR master struct was successfully configured.
CY_PROT_FAILURE	The resource is locked.
CY_PROT_BAD_PARAM	An incorrect/invalid parameter was passed.
CY_PROT_INVALID_STATE	The function was called on the device with an unsupported PERI HW version.

Function Usage

    /* Scenario: A bus master must not be able to access the PERI_PPU_GR_MMIO0 master
                 and slave structs unless operating with PC=0, "secure" and
                 "privileged" access settings. The PERI_PPU_GR0 slave struct is 
                 already configured and enabled. */
    
    cy_stc_ppu_gr_cfg_t grPpuCfg_m = {
        /*.userPermission =*/ CY_PROT_PERM_R,       /* Read access always available for Master */
        /*.privPermission =*/ CY_PROT_PERM_RW,      /*  Allow read and write privileged mode accesses */
        /*.secure =*/ true,                         /* Only allow "secure" bus masters */
        /*.pcMatch =*/ false,                       /* Perform access evaluation */
        /*.pcMask =*/ (uint16_t)0UL                 /* Only allow PC=0 bus masters */
    };
    
    /* Configure the master struct of PPU MMIO Group #0 */
    if(CY_PROT_SUCCESS != Cy_Prot_ConfigPpuFixedGrMasterStruct(PERI_PPU_GR_MMIO0, &grPpuCfg_m))
    {
        /* Insert error handling */
    }
    else
    {
        /* Enable the master struct of PPU MMIO Group #0 */
        if(CY_PROT_SUCCESS != Cy_Prot_EnablePpuFixedGrMasterStruct(PERI_PPU_GR_MMIO0))
        {
            /* Insert error handling */
        }
    }

Cy_Prot_ConfigPpuFixedGrSlaveStruct()

cy_en_prot_status_t Cy_Prot_ConfigPpuFixedGrSlaveStruct	(	PERI_PPU_GR_Type *	base,
		const cy_stc_ppu_gr_cfg_t *	config
	)

Configures a Fixed Peripheral Group Protection Unit (PPU GR) slave protection struct with its protection attributes.

This function configures the slave struct of a PPU GR pair, which can protect an entire peripheral MMIO group from invalid bus master accesses. Refer to the device Technical Reference manual for details on peripheral MMIO grouping and which peripherals belong to which groups.

Each fixed PPU GR is devoted to a defined MMIO group. Hence the address, regionSize and subregions of the configuration struct are not applicable.

Note that the user/privileged execute accesses are read-only and are always enabled.

Note

This function is applicable for CPUSS ver_1 only.

Parameters

base	The register base address of the protection structure being configured.
config	Initialization structure with all the protection attributes.

Returns

Status of the function call.

Status	Description
CY_PROT_SUCCESS	PPU GR slave struct was successfully configured.
CY_PROT_FAILURE	The resource is locked.
CY_PROT_BAD_PARAM	An incorrect/invalid parameter was passed.
CY_PROT_INVALID_STATE	The function was called on the device with an unsupported PERI HW version.

Function Usage

    /* Scenario: A bus master must not be able to access the Peripheral group 0 MMIO
                 registers (0x40000000 ~ 0x400FFFFF) unless it has the "secure"
                 attribute and is operating in "privileged" mode at PC=0 or PC=2. */
    
    cy_stc_ppu_gr_cfg_t grPpuCfg_s = {
        /*.userPermission =*/ CY_PROT_PERM_DISABLED,/* Disallow all user mode accesses */
        /*.privPermission =*/ CY_PROT_PERM_RW,      /* Allow Read and Write privileged mode accesses */
        /*.secure =*/ true,                         /* Only allow "secure" bus masters */
        /*.pcMatch =*/ false,                       /* Perform access evaluation */
        /*.pcMask =*/ (uint16_t)CY_PROT_PCMASK2     /* Allow PC=0 and PC=2 accesses */
    };
    
    /* Configure the slave struct of PPU MMIO Group #0 */
    if(CY_PROT_SUCCESS != Cy_Prot_ConfigPpuFixedGrSlaveStruct(PERI_PPU_GR_MMIO0, &grPpuCfg_s))
    {
        /* Insert error handling */
    }
    else
    {
        /* Enable the slave struct of PPU MMIO Group #0 */
        if(CY_PROT_SUCCESS != Cy_Prot_EnablePpuFixedGrSlaveStruct(PERI_PPU_GR_MMIO0))
        {
            /* Insert error handling */
        }
    }

Cy_Prot_EnablePpuFixedGrMasterStruct()

cy_en_prot_status_t Cy_Prot_EnablePpuFixedGrMasterStruct

(

PERI_PPU_GR_Type *

base

)

Enables the Master PPU GR structure.

This is a PPU GR master struct enable function. The PPU GR protection settings will take effect after successful completion of this function call.

Note

This function is applicable for CPUSS ver_1 only.

Parameters

base	The base address for the protection unit structure being configured.

Returns

Status of the function call.

Status	Description
CY_PROT_SUCCESS	The Master PU struct was enabled.
CY_PROT_FAILURE	The Master PU struct is disabled and possibly locked.
CY_PROT_INVALID_STATE	The function was called on the device with an unsupported PERI HW version.

Function Usage

    /* Scenario: The master struct of PERI_PPU_GR_MMIO0 is configured to protect
                 its slave struct and needs to be enabled. */
    
    if(CY_PROT_SUCCESS != Cy_Prot_EnablePpuFixedGrMasterStruct(PERI_PPU_GR_MMIO0))
    {
        /* Insert error handling */
    }

Cy_Prot_DisablePpuFixedGrMasterStruct()

cy_en_prot_status_t Cy_Prot_DisablePpuFixedGrMasterStruct

(

PERI_PPU_GR_Type *

base

)

Disables the Master PPU GR structure.

This is a PPU GR master struct disable function. The PPU GR protection settings will seize to take effect after successful completion of this function call.

Note

This function is applicable for CPUSS ver_1 only.

Parameters

base	The base address for the protection unit structure being configured.

Returns

Status of the function call.

Status	Description
CY_PROT_SUCCESS	The Master PU struct was disabled.
CY_PROT_FAILURE	The Master PU struct is enabled and possibly locked.
CY_PROT_INVALID_STATE	The function was called on the device with an unsupported PERI HW version.

Function Usage

    /* Scenario: The master struct of PERI_PPU_GR_MMIO0 needs to be disabled. Or
                 it needs to be reconfigured and hence must first be disabled. */
    
    if(CY_PROT_SUCCESS != Cy_Prot_DisablePpuFixedGrMasterStruct(PERI_PPU_GR_MMIO0))
    {
        /* Insert error handling */
    }

Cy_Prot_EnablePpuFixedGrSlaveStruct()

cy_en_prot_status_t Cy_Prot_EnablePpuFixedGrSlaveStruct

(

PERI_PPU_GR_Type *

base

)

Enables the Slave PPU GR structure.

This is a PPU GR slave struct enable function. The PPU GR protection settings will take effect after successful completion of this function call.

Note

This function is applicable for CPUSS ver_1 only.

Parameters

base	The base address for the protection unit structure being configured.

Returns

Status of the function call.

Status	Description
CY_PROT_SUCCESS	The Slave PU struct was enabled.
CY_PROT_FAILURE	The Slave PU struct is disabled and possibly locked.
CY_PROT_INVALID_STATE	The function was called on the device with an unsupported PERI HW version.

Function Usage

    /* Scenario: The slave struct of PERI_PPU_GR_MMIO0 is configured to protect
                 MMIO #0 and needs to be enabled. */
    
    if(CY_PROT_SUCCESS != Cy_Prot_EnablePpuFixedGrSlaveStruct(PERI_PPU_GR_MMIO0))
    {
        /* Insert error handling */
    }

Cy_Prot_DisablePpuFixedGrSlaveStruct()

cy_en_prot_status_t Cy_Prot_DisablePpuFixedGrSlaveStruct

(

PERI_PPU_GR_Type *

base

)

Disables the Slave PPU GR structure.

This is a PPU GR slave struct disable function. The PPU GR protection settings will seize to take effect after successful completion of this function call.

Note

This function is applicable for CPUSS ver_1 only.

Parameters

base	The base address for the protection unit structure being configured.

Returns

Status of the function call.

Status	Description
CY_PROT_SUCCESS	The Slave PU struct was disabled.
CY_PROT_FAILURE	The Slave PU struct is enabled and possibly locked.
CY_PROT_INVALID_STATE	The function was called on the device with an unsupported PERI HW version.

Function Usage

    
    /* Scenario: The slave struct of PERI_PPU_GR_MMIO0 needs to be disabled. Or
                 it needs to be reconfigured and hence must first be disabled. */
    
    if(CY_PROT_SUCCESS != Cy_Prot_DisablePpuFixedGrSlaveStruct(PERI_PPU_GR_MMIO0))
    {
        /* Insert error handling */
    }