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

Description

Shadow TX Empty Trigger

Register Layout

Bits Access Reset Description
[1:0] RW 0x0 ALT_UART_STET_STET
[31:2] R 0x0 ALT_UART_STET_RSVD_STET_31TO2

Field : stet

Shadow TX Empty Trigger.

This is a shadow register for the TX empty trigger bits (FCR[5:4]). This can be used

to remove the burden of having to store the previously written value to the FCR in

memory and having to mask this value so that only the TX empty trigger bit gets updated.

Writes will have no effect when THRE_MODE_USER == Disabled. This is used to select the

empty threshold level at which the THRE Interrupts will be generated when the mode is

active. These threshold levels are also described in. The following trigger levels are

supported:

00 = FIFO empty

01 = 2 characters in the FIFO

10 = FIFO � full

11 = FIFO � full

Field Enumeration Values:

Enum Value Description
ALT_UART_STET_STET_E_FIFOEMPTY 0x0 FIFO empty
ALT_UART_STET_STET_E_TWOCHARS 0x1 Two characters in FIFO
ALT_UART_STET_STET_E_QUARTERFULL 0x2 FIFO quarter full
ALT_UART_STET_STET_E_HALFFULL 0x3 FIFO half full

Field Access Macros:

#define ALT_UART_STET_STET_E_FIFOEMPTY   0x0
 
#define ALT_UART_STET_STET_E_TWOCHARS   0x1
 
#define ALT_UART_STET_STET_E_QUARTERFULL   0x2
 
#define ALT_UART_STET_STET_E_HALFFULL   0x3
 
#define ALT_UART_STET_STET_LSB   0
 
#define ALT_UART_STET_STET_MSB   1
 
#define ALT_UART_STET_STET_WIDTH   2
 
#define ALT_UART_STET_STET_SET_MSK   0x00000003
 
#define ALT_UART_STET_STET_CLR_MSK   0xfffffffc
 
#define ALT_UART_STET_STET_RESET   0x0
 
#define ALT_UART_STET_STET_GET(value)   (((value) & 0x00000003) >> 0)
 
#define ALT_UART_STET_STET_SET(value)   (((value) << 0) & 0x00000003)
 

Field : rsvd_stet_31to2

Reserved bits [31:2] - Read Only

Field Access Macros:

#define ALT_UART_STET_RSVD_STET_31TO2_LSB   2
 
#define ALT_UART_STET_RSVD_STET_31TO2_MSB   31
 
#define ALT_UART_STET_RSVD_STET_31TO2_WIDTH   30
 
#define ALT_UART_STET_RSVD_STET_31TO2_SET_MSK   0xfffffffc
 
#define ALT_UART_STET_RSVD_STET_31TO2_CLR_MSK   0x00000003
 
#define ALT_UART_STET_RSVD_STET_31TO2_RESET   0x0
 
#define ALT_UART_STET_RSVD_STET_31TO2_GET(value)   (((value) & 0xfffffffc) >> 2)
 
#define ALT_UART_STET_RSVD_STET_31TO2_SET(value)   (((value) << 2) & 0xfffffffc)
 

Data Structures

struct  ALT_UART_STET_s
 

Macros

#define ALT_UART_STET_RESET   0x00000000
 
#define ALT_UART_STET_OFST   0xa0
 
#define ALT_UART_STET_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_STET_OFST))
 

Typedefs

typedef struct ALT_UART_STET_s ALT_UART_STET_t
 

Data Structure Documentation

struct ALT_UART_STET_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_STET.

Data Fields
uint32_t stet: 2 ALT_UART_STET_STET
const uint32_t rsvd_stet_31to2: 30 ALT_UART_STET_RSVD_STET_31TO2

Macro Definitions

#define ALT_UART_STET_STET_E_FIFOEMPTY   0x0

Enumerated value for register field ALT_UART_STET_STET

FIFO empty

#define ALT_UART_STET_STET_E_TWOCHARS   0x1

Enumerated value for register field ALT_UART_STET_STET

Two characters in FIFO

#define ALT_UART_STET_STET_E_QUARTERFULL   0x2

Enumerated value for register field ALT_UART_STET_STET

FIFO quarter full

#define ALT_UART_STET_STET_E_HALFFULL   0x3

Enumerated value for register field ALT_UART_STET_STET

FIFO half full

#define ALT_UART_STET_STET_LSB   0

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

#define ALT_UART_STET_STET_MSB   1

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

#define ALT_UART_STET_STET_WIDTH   2

The width in bits of the ALT_UART_STET_STET register field.

#define ALT_UART_STET_STET_SET_MSK   0x00000003

The mask used to set the ALT_UART_STET_STET register field value.

#define ALT_UART_STET_STET_CLR_MSK   0xfffffffc

The mask used to clear the ALT_UART_STET_STET register field value.

#define ALT_UART_STET_STET_RESET   0x0

The reset value of the ALT_UART_STET_STET register field.

#define ALT_UART_STET_STET_GET (   value)    (((value) & 0x00000003) >> 0)

Extracts the ALT_UART_STET_STET field value from a register.

#define ALT_UART_STET_STET_SET (   value)    (((value) << 0) & 0x00000003)

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

#define ALT_UART_STET_RSVD_STET_31TO2_LSB   2

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

#define ALT_UART_STET_RSVD_STET_31TO2_MSB   31

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

#define ALT_UART_STET_RSVD_STET_31TO2_WIDTH   30

The width in bits of the ALT_UART_STET_RSVD_STET_31TO2 register field.

#define ALT_UART_STET_RSVD_STET_31TO2_SET_MSK   0xfffffffc

The mask used to set the ALT_UART_STET_RSVD_STET_31TO2 register field value.

#define ALT_UART_STET_RSVD_STET_31TO2_CLR_MSK   0x00000003

The mask used to clear the ALT_UART_STET_RSVD_STET_31TO2 register field value.

#define ALT_UART_STET_RSVD_STET_31TO2_RESET   0x0

The reset value of the ALT_UART_STET_RSVD_STET_31TO2 register field.

#define ALT_UART_STET_RSVD_STET_31TO2_GET (   value)    (((value) & 0xfffffffc) >> 2)

Extracts the ALT_UART_STET_RSVD_STET_31TO2 field value from a register.

#define ALT_UART_STET_RSVD_STET_31TO2_SET (   value)    (((value) << 2) & 0xfffffffc)

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

#define ALT_UART_STET_RESET   0x00000000

The reset value of the ALT_UART_STET register.

#define ALT_UART_STET_OFST   0xa0

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

#define ALT_UART_STET_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_STET_OFST))

The address of the ALT_UART_STET register.

Typedef Documentation

The typedef declaration for register ALT_UART_STET.