Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : sdmam

Description

Shadow DMA Mode.

Register Layout

Bits Access Reset Description
[0] RW 0x0 ALT_UART_SDMAM_SDMAM
[31:1] R 0x0 ALT_UART_SDMAM_RSVD_SDMAM_31TO1

Field : sdmam

Shadow DMA Mode.

This is a shadow register for the DMA mode bit (FCR[3]). This can be used to remove

the burden of having to store the previously written value to the FCR in memory and

having to mask this value so that only the DMA Mode bit gets updated.

This determines the DMA signalling mode used for the dma_tx_req_n and dma_rx_req_n

output signals when additional DMA handshaking signals are not selected

(DMA_EXTRA == NO). See section 5.9 on page 54 for details on DMA support.

0 = mode 0

1 = mode 1

Field Enumeration Values:

Enum Value Description
ALT_UART_SDMAM_SDMAM_E_SINGLE 0x0 Single DMA Transfer Mode
ALT_UART_SDMAM_SDMAM_E_MULT 0x1 Multiple DMA Transfer Mode

Field Access Macros:

#define ALT_UART_SDMAM_SDMAM_E_SINGLE   0x0
 
#define ALT_UART_SDMAM_SDMAM_E_MULT   0x1
 
#define ALT_UART_SDMAM_SDMAM_LSB   0
 
#define ALT_UART_SDMAM_SDMAM_MSB   0
 
#define ALT_UART_SDMAM_SDMAM_WIDTH   1
 
#define ALT_UART_SDMAM_SDMAM_SET_MSK   0x00000001
 
#define ALT_UART_SDMAM_SDMAM_CLR_MSK   0xfffffffe
 
#define ALT_UART_SDMAM_SDMAM_RESET   0x0
 
#define ALT_UART_SDMAM_SDMAM_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_UART_SDMAM_SDMAM_SET(value)   (((value) << 0) & 0x00000001)
 

Field : rsvd_sdmam_31to1

Reserved bits [31:1] - Read Only

Field Access Macros:

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_LSB   1
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_MSB   31
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_WIDTH   31
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_SET_MSK   0xfffffffe
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_CLR_MSK   0x00000001
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_RESET   0x0
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_GET(value)   (((value) & 0xfffffffe) >> 1)
 
#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_SET(value)   (((value) << 1) & 0xfffffffe)
 

Data Structures

struct  ALT_UART_SDMAM_s
 

Macros

#define ALT_UART_SDMAM_RESET   0x00000000
 
#define ALT_UART_SDMAM_OFST   0x94
 
#define ALT_UART_SDMAM_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SDMAM_OFST))
 

Typedefs

typedef struct ALT_UART_SDMAM_s ALT_UART_SDMAM_t
 

Data Structure Documentation

struct ALT_UART_SDMAM_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_UART_SDMAM.

Data Fields
uint32_t sdmam: 1 ALT_UART_SDMAM_SDMAM
const uint32_t rsvd_sdmam_31to1: 31 ALT_UART_SDMAM_RSVD_SDMAM_31TO1

Macro Definitions

#define ALT_UART_SDMAM_SDMAM_E_SINGLE   0x0

Enumerated value for register field ALT_UART_SDMAM_SDMAM

Single DMA Transfer Mode

#define ALT_UART_SDMAM_SDMAM_E_MULT   0x1

Enumerated value for register field ALT_UART_SDMAM_SDMAM

Multiple DMA Transfer Mode

#define ALT_UART_SDMAM_SDMAM_LSB   0

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

#define ALT_UART_SDMAM_SDMAM_MSB   0

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

#define ALT_UART_SDMAM_SDMAM_WIDTH   1

The width in bits of the ALT_UART_SDMAM_SDMAM register field.

#define ALT_UART_SDMAM_SDMAM_SET_MSK   0x00000001

The mask used to set the ALT_UART_SDMAM_SDMAM register field value.

#define ALT_UART_SDMAM_SDMAM_CLR_MSK   0xfffffffe

The mask used to clear the ALT_UART_SDMAM_SDMAM register field value.

#define ALT_UART_SDMAM_SDMAM_RESET   0x0

The reset value of the ALT_UART_SDMAM_SDMAM register field.

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

Extracts the ALT_UART_SDMAM_SDMAM field value from a register.

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

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

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_LSB   1

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

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_MSB   31

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

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_WIDTH   31

The width in bits of the ALT_UART_SDMAM_RSVD_SDMAM_31TO1 register field.

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_SET_MSK   0xfffffffe

The mask used to set the ALT_UART_SDMAM_RSVD_SDMAM_31TO1 register field value.

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_CLR_MSK   0x00000001

The mask used to clear the ALT_UART_SDMAM_RSVD_SDMAM_31TO1 register field value.

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_RESET   0x0

The reset value of the ALT_UART_SDMAM_RSVD_SDMAM_31TO1 register field.

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_GET (   value)    (((value) & 0xfffffffe) >> 1)

Extracts the ALT_UART_SDMAM_RSVD_SDMAM_31TO1 field value from a register.

#define ALT_UART_SDMAM_RSVD_SDMAM_31TO1_SET (   value)    (((value) << 1) & 0xfffffffe)

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

#define ALT_UART_SDMAM_RESET   0x00000000

The reset value of the ALT_UART_SDMAM register.

#define ALT_UART_SDMAM_OFST   0x94

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

#define ALT_UART_SDMAM_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SDMAM_OFST))

The address of the ALT_UART_SDMAM register.

Typedef Documentation

The typedef declaration for register ALT_UART_SDMAM.