Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : DMA Peripheral Configuration Register - dmaper

Description

Register Layout

Bits Access Reset Description
[3:0] RW 0x0 Number of Single Bytes
[7:4] R 0x0 Reserved
[11:8] RW 0x0 Number of Burst Bytes
[31:12] R 0x0 Reserved

Field : Number of Single Bytes - numsglreqbytes

Number of bytes in a single type request on the DMA peripheral request. A programmed value of 0 represents a single byte. This should be setup before starting the indirect read or write operation. The actual number of bytes used is 2**(value in this register) which will simplify implementation.

Field Access Macros:

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_LSB   0
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_MSB   3
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_WIDTH   4
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_SET_MSK   0x0000000f
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_CLR_MSK   0xfffffff0
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_RESET   0x0
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_GET(value)   (((value) & 0x0000000f) >> 0)
 
#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_SET(value)   (((value) << 0) & 0x0000000f)
 

Field : Reserved - dma_periph_resv1_fld

Field Access Macros:

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_LSB   4
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_MSB   7
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_WIDTH   4
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_SET_MSK   0x000000f0
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_CLR_MSK   0xffffff0f
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_RESET   0x0
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_GET(value)   (((value) & 0x000000f0) >> 4)
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_SET(value)   (((value) << 4) & 0x000000f0)
 

Field : Number of Burst Bytes - numburstreqbytes

Number of bytes in a burst type request on the DMA peripheral request. A programmed value of 0 represents a single byte. This should be setup before starting the indirect read or write operation. The actual number of bytes used is 2**(value in this register) which will simplify implementation.

Field Access Macros:

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_LSB   8
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_MSB   11
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_WIDTH   4
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_SET_MSK   0x00000f00
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_CLR_MSK   0xfffff0ff
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_RESET   0x0
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_GET(value)   (((value) & 0x00000f00) >> 8)
 
#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_SET(value)   (((value) << 8) & 0x00000f00)
 

Field : Reserved - dma_periph_resv2_fld

Field Access Macros:

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_LSB   12
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_MSB   31
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_WIDTH   20
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_SET_MSK   0xfffff000
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_CLR_MSK   0x00000fff
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_RESET   0x0
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_GET(value)   (((value) & 0xfffff000) >> 12)
 
#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_SET(value)   (((value) << 12) & 0xfffff000)
 

Data Structures

struct  ALT_QSPI_DMAPER_s
 

Macros

#define ALT_QSPI_DMAPER_RESET   0x00000000
 
#define ALT_QSPI_DMAPER_OFST   0x20
 

Typedefs

typedef struct ALT_QSPI_DMAPER_s ALT_QSPI_DMAPER_t
 

Data Structure Documentation

struct ALT_QSPI_DMAPER_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_DMAPER.

Data Fields
uint32_t numsglreqbytes: 4 Number of Single Bytes
const uint32_t dma_periph_resv1_fld: 4 Reserved
uint32_t numburstreqbytes: 4 Number of Burst Bytes
const uint32_t dma_periph_resv2_fld: 20 Reserved

Macro Definitions

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_LSB   0

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

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_MSB   3

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

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_WIDTH   4

The width in bits of the ALT_QSPI_DMAPER_NUMSGLREQBYTES register field.

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_SET_MSK   0x0000000f

The mask used to set the ALT_QSPI_DMAPER_NUMSGLREQBYTES register field value.

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_CLR_MSK   0xfffffff0

The mask used to clear the ALT_QSPI_DMAPER_NUMSGLREQBYTES register field value.

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_RESET   0x0

The reset value of the ALT_QSPI_DMAPER_NUMSGLREQBYTES register field.

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_GET (   value)    (((value) & 0x0000000f) >> 0)

Extracts the ALT_QSPI_DMAPER_NUMSGLREQBYTES field value from a register.

#define ALT_QSPI_DMAPER_NUMSGLREQBYTES_SET (   value)    (((value) << 0) & 0x0000000f)

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

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_LSB   4

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

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_MSB   7

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

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_WIDTH   4

The width in bits of the ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD register field.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_SET_MSK   0x000000f0

The mask used to set the ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD register field value.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_CLR_MSK   0xffffff0f

The mask used to clear the ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD register field value.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_RESET   0x0

The reset value of the ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD register field.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_GET (   value)    (((value) & 0x000000f0) >> 4)

Extracts the ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD field value from a register.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV1_FLD_SET (   value)    (((value) << 4) & 0x000000f0)

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

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_LSB   8

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

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_MSB   11

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

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_WIDTH   4

The width in bits of the ALT_QSPI_DMAPER_NUMBURSTREQBYTES register field.

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_SET_MSK   0x00000f00

The mask used to set the ALT_QSPI_DMAPER_NUMBURSTREQBYTES register field value.

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_CLR_MSK   0xfffff0ff

The mask used to clear the ALT_QSPI_DMAPER_NUMBURSTREQBYTES register field value.

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_RESET   0x0

The reset value of the ALT_QSPI_DMAPER_NUMBURSTREQBYTES register field.

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_GET (   value)    (((value) & 0x00000f00) >> 8)

Extracts the ALT_QSPI_DMAPER_NUMBURSTREQBYTES field value from a register.

#define ALT_QSPI_DMAPER_NUMBURSTREQBYTES_SET (   value)    (((value) << 8) & 0x00000f00)

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

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_LSB   12

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

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_MSB   31

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

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_WIDTH   20

The width in bits of the ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD register field.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_SET_MSK   0xfffff000

The mask used to set the ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD register field value.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_CLR_MSK   0x00000fff

The mask used to clear the ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD register field value.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_RESET   0x0

The reset value of the ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD register field.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_GET (   value)    (((value) & 0xfffff000) >> 12)

Extracts the ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD field value from a register.

#define ALT_QSPI_DMAPER_DMA_PERIPH_RESV2_FLD_SET (   value)    (((value) << 12) & 0xfffff000)

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

#define ALT_QSPI_DMAPER_RESET   0x00000000

The reset value of the ALT_QSPI_DMAPER register.

#define ALT_QSPI_DMAPER_OFST   0x20

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

Typedef Documentation

The typedef declaration for register ALT_QSPI_DMAPER.