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

Description

Used only with FIFO access test mode.

Register Layout

Bits Access Reset Description
[7:0] W 0x0 Receive FIFO Write Field
[8] W 0x0 Receive FIFO Parity Error
[9] W 0x0 Receive FIFO Framing Error
[31:10] ??? 0x0 UNDEFINED

Field : Receive FIFO Write Field - rfwd

These bits are only valid when FIFO access mode is enabled (FAR[0] is set to one). When FIFO's are enabled, the data that is written to the RFWD is pushed into the receive FIFO. Each consecutive write pushes the new data to the next write location in the receive FIFO. When FIFO's are not enabled, the data that is written to the RFWD is pushed into the RBR.

Field Access Macros:

#define ALT_UART_RFW_RFWD_LSB   0
 
#define ALT_UART_RFW_RFWD_MSB   7
 
#define ALT_UART_RFW_RFWD_WIDTH   8
 
#define ALT_UART_RFW_RFWD_SET_MSK   0x000000ff
 
#define ALT_UART_RFW_RFWD_CLR_MSK   0xffffff00
 
#define ALT_UART_RFW_RFWD_RESET   0x0
 
#define ALT_UART_RFW_RFWD_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_UART_RFW_RFWD_SET(value)   (((value) << 0) & 0x000000ff)
 

Field : Receive FIFO Parity Error - rfpe

These bits are only valid when FIFO access mode is enabled (FAR[0] is set to one). When FIFO's are enabled, this bit is used to write parity error detection information to the receive FIFO. When FIFO's are not enabled, this bit is used to write parity error detection information to the RBR.

Field Access Macros:

#define ALT_UART_RFW_RFPE_LSB   8
 
#define ALT_UART_RFW_RFPE_MSB   8
 
#define ALT_UART_RFW_RFPE_WIDTH   1
 
#define ALT_UART_RFW_RFPE_SET_MSK   0x00000100
 
#define ALT_UART_RFW_RFPE_CLR_MSK   0xfffffeff
 
#define ALT_UART_RFW_RFPE_RESET   0x0
 
#define ALT_UART_RFW_RFPE_GET(value)   (((value) & 0x00000100) >> 8)
 
#define ALT_UART_RFW_RFPE_SET(value)   (((value) << 8) & 0x00000100)
 

Field : Receive FIFO Framing Error - RFFE

These bits are only valid when FIFO access mode is enabled (FAR[0] is set to one). When FIFO's are enabled, this bit is used to write framing error detection information to the receive FIFO. When FIFO's are not enabled, this bit is used to write framing error detection information to the RBR.

Field Access Macros:

#define ALT_UART_RFW_RFFE_LSB   9
 
#define ALT_UART_RFW_RFFE_MSB   9
 
#define ALT_UART_RFW_RFFE_WIDTH   1
 
#define ALT_UART_RFW_RFFE_SET_MSK   0x00000200
 
#define ALT_UART_RFW_RFFE_CLR_MSK   0xfffffdff
 
#define ALT_UART_RFW_RFFE_RESET   0x0
 
#define ALT_UART_RFW_RFFE_GET(value)   (((value) & 0x00000200) >> 9)
 
#define ALT_UART_RFW_RFFE_SET(value)   (((value) << 9) & 0x00000200)
 

Data Structures

struct  ALT_UART_RFW_s
 

Macros

#define ALT_UART_RFW_OFST   0x78
 
#define ALT_UART_RFW_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_RFW_OFST))
 

Typedefs

typedef struct ALT_UART_RFW_s ALT_UART_RFW_t
 

Data Structure Documentation

struct ALT_UART_RFW_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_RFW.

Data Fields
uint32_t rfwd: 8 Receive FIFO Write Field
uint32_t rfpe: 1 Receive FIFO Parity Error
uint32_t RFFE: 1 Receive FIFO Framing Error
uint32_t __pad0__: 22 UNDEFINED

Macro Definitions

#define ALT_UART_RFW_RFWD_LSB   0

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

#define ALT_UART_RFW_RFWD_MSB   7

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

#define ALT_UART_RFW_RFWD_WIDTH   8

The width in bits of the ALT_UART_RFW_RFWD register field.

#define ALT_UART_RFW_RFWD_SET_MSK   0x000000ff

The mask used to set the ALT_UART_RFW_RFWD register field value.

#define ALT_UART_RFW_RFWD_CLR_MSK   0xffffff00

The mask used to clear the ALT_UART_RFW_RFWD register field value.

#define ALT_UART_RFW_RFWD_RESET   0x0

The reset value of the ALT_UART_RFW_RFWD register field.

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

Extracts the ALT_UART_RFW_RFWD field value from a register.

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

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

#define ALT_UART_RFW_RFPE_LSB   8

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

#define ALT_UART_RFW_RFPE_MSB   8

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

#define ALT_UART_RFW_RFPE_WIDTH   1

The width in bits of the ALT_UART_RFW_RFPE register field.

#define ALT_UART_RFW_RFPE_SET_MSK   0x00000100

The mask used to set the ALT_UART_RFW_RFPE register field value.

#define ALT_UART_RFW_RFPE_CLR_MSK   0xfffffeff

The mask used to clear the ALT_UART_RFW_RFPE register field value.

#define ALT_UART_RFW_RFPE_RESET   0x0

The reset value of the ALT_UART_RFW_RFPE register field.

#define ALT_UART_RFW_RFPE_GET (   value)    (((value) & 0x00000100) >> 8)

Extracts the ALT_UART_RFW_RFPE field value from a register.

#define ALT_UART_RFW_RFPE_SET (   value)    (((value) << 8) & 0x00000100)

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

#define ALT_UART_RFW_RFFE_LSB   9

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

#define ALT_UART_RFW_RFFE_MSB   9

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

#define ALT_UART_RFW_RFFE_WIDTH   1

The width in bits of the ALT_UART_RFW_RFFE register field.

#define ALT_UART_RFW_RFFE_SET_MSK   0x00000200

The mask used to set the ALT_UART_RFW_RFFE register field value.

#define ALT_UART_RFW_RFFE_CLR_MSK   0xfffffdff

The mask used to clear the ALT_UART_RFW_RFFE register field value.

#define ALT_UART_RFW_RFFE_RESET   0x0

The reset value of the ALT_UART_RFW_RFFE register field.

#define ALT_UART_RFW_RFFE_GET (   value)    (((value) & 0x00000200) >> 9)

Extracts the ALT_UART_RFW_RFFE field value from a register.

#define ALT_UART_RFW_RFFE_SET (   value)    (((value) << 9) & 0x00000200)

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

#define ALT_UART_RFW_OFST   0x78

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

#define ALT_UART_RFW_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_RFW_OFST))

The address of the ALT_UART_RFW register.

Typedef Documentation

The typedef declaration for register ALT_UART_RFW.