Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Shadow Receive Buffer Register - srbr

Description

Used to accomadate burst accesses from the master.

Register Layout

Bits Access Reset Description
[7:0] RW 0x0 Shadow Receive Buffer
[31:8] ??? 0x0 UNDEFINED

Field : Shadow Receive Buffer - srbr

This is a shadow register for the RBR and has been allocated one 32-bit location so as to accommodate burst accesses from the master.This register contains the data byte received on the serial input port (sin). The data in this register is valid only if the Data Ready (DR) bit in the Line status Register (LSR) is set. If FIFOs are disabled, bit [0] of register FCR set to zero, the data in the RBR must be read before the next data arrives, otherwise it will be overwritten, resulting in an overrun error. If FIFOs are enabled (FCR[0] set to one), this register accesses the head of the receive FIFO. If the receive FIFO is full and this register is not read before the next data character arrives, then the data already in the FIFO will be preserved but any incoming data will be lost. An overrun error will also occur.

Field Access Macros:

#define ALT_UART_SRBR_SRBR_LSB   0
 
#define ALT_UART_SRBR_SRBR_MSB   7
 
#define ALT_UART_SRBR_SRBR_WIDTH   8
 
#define ALT_UART_SRBR_SRBR_SET_MSK   0x000000ff
 
#define ALT_UART_SRBR_SRBR_CLR_MSK   0xffffff00
 
#define ALT_UART_SRBR_SRBR_RESET   0x0
 
#define ALT_UART_SRBR_SRBR_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_UART_SRBR_SRBR_SET(value)   (((value) << 0) & 0x000000ff)
 

Data Structures

struct  ALT_UART_SRBR_s
 

Macros

#define ALT_UART_SRBR_OFST   0x30
 
#define ALT_UART_SRBR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SRBR_OFST))
 

Typedefs

typedef struct ALT_UART_SRBR_s ALT_UART_SRBR_t
 

Data Structure Documentation

struct ALT_UART_SRBR_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_SRBR.

Data Fields
uint32_t srbr: 8 Shadow Receive Buffer
uint32_t __pad0__: 24 UNDEFINED

Macro Definitions

#define ALT_UART_SRBR_SRBR_LSB   0

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

#define ALT_UART_SRBR_SRBR_MSB   7

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

#define ALT_UART_SRBR_SRBR_WIDTH   8

The width in bits of the ALT_UART_SRBR_SRBR register field.

#define ALT_UART_SRBR_SRBR_SET_MSK   0x000000ff

The mask used to set the ALT_UART_SRBR_SRBR register field value.

#define ALT_UART_SRBR_SRBR_CLR_MSK   0xffffff00

The mask used to clear the ALT_UART_SRBR_SRBR register field value.

#define ALT_UART_SRBR_SRBR_RESET   0x0

The reset value of the ALT_UART_SRBR_SRBR register field.

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

Extracts the ALT_UART_SRBR_SRBR field value from a register.

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

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

#define ALT_UART_SRBR_OFST   0x30

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

#define ALT_UART_SRBR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SRBR_OFST))

The address of the ALT_UART_SRBR register.

Typedef Documentation

The typedef declaration for register ALT_UART_SRBR.