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

Description

This register is used in FIFO access testing.

Register Layout

Bits Access Reset Description
[0] RW 0x0 FIFO ACCESS Bit
[31:1] ??? 0x0 UNDEFINED

Field : FIFO ACCESS Bit - srbr_sthr

This register is used to enable a FIFO access mode for testing, so that the receive FIFO can be written by the master and the transmit FIFO can be read by the master when FIFO's are enabled. When FIFO's are not enabled it allows the RBR to be written by the master and the THR to be read by the master

Note: That when the FIFO access mode is enabled/disabled, the control portion of the receive FIFO and transmit FIFO is reset and the FIFO's are treated as empty.

Field Enumeration Values:

Enum Value Description
ALT_UART_FAR_SRBR_STHR_E_DISD 0x0 FIFO access mode disabled
ALT_UART_FAR_SRBR_STHR_E_END 0x1 FIFO access mode enabled

Field Access Macros:

#define ALT_UART_FAR_SRBR_STHR_E_DISD   0x0
 
#define ALT_UART_FAR_SRBR_STHR_E_END   0x1
 
#define ALT_UART_FAR_SRBR_STHR_LSB   0
 
#define ALT_UART_FAR_SRBR_STHR_MSB   0
 
#define ALT_UART_FAR_SRBR_STHR_WIDTH   1
 
#define ALT_UART_FAR_SRBR_STHR_SET_MSK   0x00000001
 
#define ALT_UART_FAR_SRBR_STHR_CLR_MSK   0xfffffffe
 
#define ALT_UART_FAR_SRBR_STHR_RESET   0x0
 
#define ALT_UART_FAR_SRBR_STHR_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_UART_FAR_SRBR_STHR_SET(value)   (((value) << 0) & 0x00000001)
 

Data Structures

struct  ALT_UART_FAR_s
 

Macros

#define ALT_UART_FAR_OFST   0x70
 
#define ALT_UART_FAR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_FAR_OFST))
 

Typedefs

typedef struct ALT_UART_FAR_s ALT_UART_FAR_t
 

Data Structure Documentation

struct ALT_UART_FAR_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_FAR.

Data Fields
uint32_t srbr_sthr: 1 FIFO ACCESS Bit
uint32_t __pad0__: 31 UNDEFINED

Macro Definitions

#define ALT_UART_FAR_SRBR_STHR_E_DISD   0x0

Enumerated value for register field ALT_UART_FAR_SRBR_STHR

FIFO access mode disabled

#define ALT_UART_FAR_SRBR_STHR_E_END   0x1

Enumerated value for register field ALT_UART_FAR_SRBR_STHR

FIFO access mode enabled

#define ALT_UART_FAR_SRBR_STHR_LSB   0

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

#define ALT_UART_FAR_SRBR_STHR_MSB   0

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

#define ALT_UART_FAR_SRBR_STHR_WIDTH   1

The width in bits of the ALT_UART_FAR_SRBR_STHR register field.

#define ALT_UART_FAR_SRBR_STHR_SET_MSK   0x00000001

The mask used to set the ALT_UART_FAR_SRBR_STHR register field value.

#define ALT_UART_FAR_SRBR_STHR_CLR_MSK   0xfffffffe

The mask used to clear the ALT_UART_FAR_SRBR_STHR register field value.

#define ALT_UART_FAR_SRBR_STHR_RESET   0x0

The reset value of the ALT_UART_FAR_SRBR_STHR register field.

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

Extracts the ALT_UART_FAR_SRBR_STHR field value from a register.

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

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

#define ALT_UART_FAR_OFST   0x70

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

#define ALT_UART_FAR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_FAR_OFST))

The address of the ALT_UART_FAR register.

Typedef Documentation

The typedef declaration for register ALT_UART_FAR.