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

Description

Used in FIFO Access test mode.

Register Layout

Bits Access Reset Description
[7:0] R 0x0 Transmit FIFO Read
[31:8] ??? 0x0 UNDEFINED

Field : Transmit FIFO Read - tfr

These bits are only valid when FIFO access mode is enabled (FAR[0] is set to one). When FIFO's are enabled, reading this register gives the data at the top of the transmit FIFO. Each consecutive read pops the transmit FIFO and gives the next data value that is currently at the top of the FIFO. When FIFO's are not enabled, reading this register gives the data in the THR.

Field Access Macros:

#define ALT_UART_TFR_TFR_LSB   0
 
#define ALT_UART_TFR_TFR_MSB   7
 
#define ALT_UART_TFR_TFR_WIDTH   8
 
#define ALT_UART_TFR_TFR_SET_MSK   0x000000ff
 
#define ALT_UART_TFR_TFR_CLR_MSK   0xffffff00
 
#define ALT_UART_TFR_TFR_RESET   0x0
 
#define ALT_UART_TFR_TFR_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_UART_TFR_TFR_SET(value)   (((value) << 0) & 0x000000ff)
 

Data Structures

struct  ALT_UART_TFR_s
 

Macros

#define ALT_UART_TFR_OFST   0x74
 
#define ALT_UART_TFR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_TFR_OFST))
 

Typedefs

typedef struct ALT_UART_TFR_s ALT_UART_TFR_t
 

Data Structure Documentation

struct ALT_UART_TFR_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_TFR.

Data Fields
const uint32_t tfr: 8 Transmit FIFO Read
uint32_t __pad0__: 24 UNDEFINED

Macro Definitions

#define ALT_UART_TFR_TFR_LSB   0

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

#define ALT_UART_TFR_TFR_MSB   7

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

#define ALT_UART_TFR_TFR_WIDTH   8

The width in bits of the ALT_UART_TFR_TFR register field.

#define ALT_UART_TFR_TFR_SET_MSK   0x000000ff

The mask used to set the ALT_UART_TFR_TFR register field value.

#define ALT_UART_TFR_TFR_CLR_MSK   0xffffff00

The mask used to clear the ALT_UART_TFR_TFR register field value.

#define ALT_UART_TFR_TFR_RESET   0x0

The reset value of the ALT_UART_TFR_TFR register field.

#define ALT_UART_TFR_TFR_GET (   value)    (((value) & 0x000000ff) >> 0)

Extracts the ALT_UART_TFR_TFR field value from a register.

#define ALT_UART_TFR_TFR_SET (   value)    (((value) << 0) & 0x000000ff)

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

#define ALT_UART_TFR_OFST   0x74

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

#define ALT_UART_TFR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_TFR_OFST))

The address of the ALT_UART_TFR register.

Typedef Documentation

The typedef declaration for register ALT_UART_TFR.