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

Description

Used to accomadate burst accesses from the master.

Register Layout

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

Field : Shadow Transmit Buffer - sthr

This is a shadow register for the THR and has been allocated sixteen 32-bit locations so as to accommodate burst accesses from the master. This register contains data to be transmitted on the serial output port (sout). Data should only be written to the THR when the THR Empty (THRE) bit (LSR[5]) is set. If FIFO's are disabled bit [0] of register FCR set to zero and THRE is set, writing a single character to the THR clears the THRE. Any additional writes to the THR before the THRE is set again causes the THR data to be overwritten. If FIFO's are enabled bit [0] of register FCR set to one and THRE is set, 128 characters of data may be written to the THR before the FIFO is full. The UART FIFO depth is configured for 128 characters. Any attempt to write data when the FIFO is full results in the write data being lost.

Field Access Macros:

#define ALT_UART_STHR_STHR_LSB   0
 
#define ALT_UART_STHR_STHR_MSB   7
 
#define ALT_UART_STHR_STHR_WIDTH   8
 
#define ALT_UART_STHR_STHR_SET_MSK   0x000000ff
 
#define ALT_UART_STHR_STHR_CLR_MSK   0xffffff00
 
#define ALT_UART_STHR_STHR_RESET   0x0
 
#define ALT_UART_STHR_STHR_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_UART_STHR_STHR_SET(value)   (((value) << 0) & 0x000000ff)
 

Data Structures

struct  ALT_UART_STHR_s
 

Macros

#define ALT_UART_STHR_OFST   0x34
 
#define ALT_UART_STHR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_STHR_OFST))
 

Typedefs

typedef struct ALT_UART_STHR_s ALT_UART_STHR_t
 

Data Structure Documentation

struct ALT_UART_STHR_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_STHR.

Data Fields
uint32_t sthr: 8 Shadow Transmit Buffer
uint32_t __pad0__: 24 UNDEFINED

Macro Definitions

#define ALT_UART_STHR_STHR_LSB   0

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

#define ALT_UART_STHR_STHR_MSB   7

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

#define ALT_UART_STHR_STHR_WIDTH   8

The width in bits of the ALT_UART_STHR_STHR register field.

#define ALT_UART_STHR_STHR_SET_MSK   0x000000ff

The mask used to set the ALT_UART_STHR_STHR register field value.

#define ALT_UART_STHR_STHR_CLR_MSK   0xffffff00

The mask used to clear the ALT_UART_STHR_STHR register field value.

#define ALT_UART_STHR_STHR_RESET   0x0

The reset value of the ALT_UART_STHR_STHR register field.

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

Extracts the ALT_UART_STHR_STHR field value from a register.

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

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

#define ALT_UART_STHR_OFST   0x34

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

#define ALT_UART_STHR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_STHR_OFST))

The address of the ALT_UART_STHR register.

Typedef Documentation

The typedef declaration for register ALT_UART_STHR.