Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Write Protection Control Register - wrprot

Description

Register Layout

Bits Access Reset Description
[0] RW 0x0 Write Protection Inversion Bit
[1] RW 0x0 Write Protection Enable Bit
[31:2] R 0x0 Reserved

Field : Write Protection Inversion Bit - inv

When set to 1, the protection region defined in the lower and upper write protection registers is inverted meaning it is the region that the system is permitted to write to. When set to 0, the protection region defined in the lower and upper write protection registers is the region that the system is not permitted to write to.

Field Enumeration Values:

Enum Value Description
ALT_QSPI_WRPROT_INV_E_DIS 0x0 Write Region not allowed
ALT_QSPI_WRPROT_INV_E_EN 0x1 Write Region allowed

Field Access Macros:

#define ALT_QSPI_WRPROT_INV_E_DIS   0x0
 
#define ALT_QSPI_WRPROT_INV_E_EN   0x1
 
#define ALT_QSPI_WRPROT_INV_LSB   0
 
#define ALT_QSPI_WRPROT_INV_MSB   0
 
#define ALT_QSPI_WRPROT_INV_WIDTH   1
 
#define ALT_QSPI_WRPROT_INV_SET_MSK   0x00000001
 
#define ALT_QSPI_WRPROT_INV_CLR_MSK   0xfffffffe
 
#define ALT_QSPI_WRPROT_INV_RESET   0x0
 
#define ALT_QSPI_WRPROT_INV_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_QSPI_WRPROT_INV_SET(value)   (((value) << 0) & 0x00000001)
 

Field : Write Protection Enable Bit - en

When set to 1, any AHB write access with an address within the protection region defined in the lower and upper write protection registers is rejected. An AHB error response is generated and an interrupt source triggered. When set to 0, the protection region is disabled.

Field Enumeration Values:

Enum Value Description
ALT_QSPI_WRPROT_EN_E_DIS 0x0 Protection Region Disabled
ALT_QSPI_WRPROT_EN_E_EN 0x1 AHB Write Access rejected

Field Access Macros:

#define ALT_QSPI_WRPROT_EN_E_DIS   0x0
 
#define ALT_QSPI_WRPROT_EN_E_EN   0x1
 
#define ALT_QSPI_WRPROT_EN_LSB   1
 
#define ALT_QSPI_WRPROT_EN_MSB   1
 
#define ALT_QSPI_WRPROT_EN_WIDTH   1
 
#define ALT_QSPI_WRPROT_EN_SET_MSK   0x00000002
 
#define ALT_QSPI_WRPROT_EN_CLR_MSK   0xfffffffd
 
#define ALT_QSPI_WRPROT_EN_RESET   0x0
 
#define ALT_QSPI_WRPROT_EN_GET(value)   (((value) & 0x00000002) >> 1)
 
#define ALT_QSPI_WRPROT_EN_SET(value)   (((value) << 1) & 0x00000002)
 

Field : Reserved - wr_prot_ctrl_resv_fld

Field Access Macros:

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_LSB   2
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_MSB   31
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_WIDTH   30
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_SET_MSK   0xfffffffc
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_CLR_MSK   0x00000003
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_RESET   0x0
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_GET(value)   (((value) & 0xfffffffc) >> 2)
 
#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_SET(value)   (((value) << 2) & 0xfffffffc)
 

Data Structures

struct  ALT_QSPI_WRPROT_s
 

Macros

#define ALT_QSPI_WRPROT_RESET   0x00000000
 
#define ALT_QSPI_WRPROT_OFST   0x58
 

Typedefs

typedef struct ALT_QSPI_WRPROT_s ALT_QSPI_WRPROT_t
 

Data Structure Documentation

struct ALT_QSPI_WRPROT_s

WARNING: The C register and register group struct declarations are provided for convenience and illustrative purposes. They should, however, be used with caution as the C language standard provides no guarantees about the alignment or atomicity of device memory accesses. The recommended practice for writing hardware drivers is to use the SoCAL access macros and alt_read_word() and alt_write_word() functions.

The struct declaration for register ALT_QSPI_WRPROT.

Data Fields
uint32_t inv: 1 Write Protection Inversion Bit
uint32_t en: 1 Write Protection Enable Bit
const uint32_t wr_prot_ctrl_resv_fld: 30 Reserved

Macro Definitions

#define ALT_QSPI_WRPROT_INV_E_DIS   0x0

Enumerated value for register field ALT_QSPI_WRPROT_INV

Write Region not allowed

#define ALT_QSPI_WRPROT_INV_E_EN   0x1

Enumerated value for register field ALT_QSPI_WRPROT_INV

Write Region allowed

#define ALT_QSPI_WRPROT_INV_LSB   0

The Least Significant Bit (LSB) position of the ALT_QSPI_WRPROT_INV register field.

#define ALT_QSPI_WRPROT_INV_MSB   0

The Most Significant Bit (MSB) position of the ALT_QSPI_WRPROT_INV register field.

#define ALT_QSPI_WRPROT_INV_WIDTH   1

The width in bits of the ALT_QSPI_WRPROT_INV register field.

#define ALT_QSPI_WRPROT_INV_SET_MSK   0x00000001

The mask used to set the ALT_QSPI_WRPROT_INV register field value.

#define ALT_QSPI_WRPROT_INV_CLR_MSK   0xfffffffe

The mask used to clear the ALT_QSPI_WRPROT_INV register field value.

#define ALT_QSPI_WRPROT_INV_RESET   0x0

The reset value of the ALT_QSPI_WRPROT_INV register field.

#define ALT_QSPI_WRPROT_INV_GET (   value)    (((value) & 0x00000001) >> 0)

Extracts the ALT_QSPI_WRPROT_INV field value from a register.

#define ALT_QSPI_WRPROT_INV_SET (   value)    (((value) << 0) & 0x00000001)

Produces a ALT_QSPI_WRPROT_INV register field value suitable for setting the register.

#define ALT_QSPI_WRPROT_EN_E_DIS   0x0

Enumerated value for register field ALT_QSPI_WRPROT_EN

Protection Region Disabled

#define ALT_QSPI_WRPROT_EN_E_EN   0x1

Enumerated value for register field ALT_QSPI_WRPROT_EN

AHB Write Access rejected

#define ALT_QSPI_WRPROT_EN_LSB   1

The Least Significant Bit (LSB) position of the ALT_QSPI_WRPROT_EN register field.

#define ALT_QSPI_WRPROT_EN_MSB   1

The Most Significant Bit (MSB) position of the ALT_QSPI_WRPROT_EN register field.

#define ALT_QSPI_WRPROT_EN_WIDTH   1

The width in bits of the ALT_QSPI_WRPROT_EN register field.

#define ALT_QSPI_WRPROT_EN_SET_MSK   0x00000002

The mask used to set the ALT_QSPI_WRPROT_EN register field value.

#define ALT_QSPI_WRPROT_EN_CLR_MSK   0xfffffffd

The mask used to clear the ALT_QSPI_WRPROT_EN register field value.

#define ALT_QSPI_WRPROT_EN_RESET   0x0

The reset value of the ALT_QSPI_WRPROT_EN register field.

#define ALT_QSPI_WRPROT_EN_GET (   value)    (((value) & 0x00000002) >> 1)

Extracts the ALT_QSPI_WRPROT_EN field value from a register.

#define ALT_QSPI_WRPROT_EN_SET (   value)    (((value) << 1) & 0x00000002)

Produces a ALT_QSPI_WRPROT_EN register field value suitable for setting the register.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_LSB   2

The Least Significant Bit (LSB) position of the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_MSB   31

The Most Significant Bit (MSB) position of the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_WIDTH   30

The width in bits of the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_SET_MSK   0xfffffffc

The mask used to set the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field value.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_CLR_MSK   0x00000003

The mask used to clear the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field value.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_RESET   0x0

The reset value of the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_GET (   value)    (((value) & 0xfffffffc) >> 2)

Extracts the ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD field value from a register.

#define ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD_SET (   value)    (((value) << 2) & 0xfffffffc)

Produces a ALT_QSPI_WRPROT_WR_PROT_CTL_RESV_FLD register field value suitable for setting the register.

#define ALT_QSPI_WRPROT_RESET   0x00000000

The reset value of the ALT_QSPI_WRPROT register.

#define ALT_QSPI_WRPROT_OFST   0x58

The byte offset of the ALT_QSPI_WRPROT register from the beginning of the component.

Typedef Documentation

The typedef declaration for register ALT_QSPI_WRPROT.