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

Description

Shadow RCVR Trigger

Register Layout

Bits Access Reset Description
[1:0] RW 0x0 ALT_UART_SRT_SRT
[31:2] R 0x0 ALT_UART_SRT_RSVD_SRT_31TO2

Field : srt

Shadow RCVR Trigger.

This is a shadow register for the RCVR trigger bits (FCR[7:6]). 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 RCVR trigger bit gets updated.

This is used to select the trigger level in the receiver FIFO at which the Received

Data Available Interrupt will be generated. It also determines when the dma_rx_req_n

signal will be asserted when DMA Mode (FCR[3]) is set to one. The following trigger

levels are supported:

00 = 1 character in the FIFO

01 = FIFO � full

10 = FIFO � full

11 = FIFO 2 less than full

Field Enumeration Values:

Enum Value Description
ALT_UART_SRT_SRT_E_ONECHAR 0x0 one character in fifo
ALT_UART_SRT_SRT_E_QUARTERFULL 0x1 FIFO 1/4 full
ALT_UART_SRT_SRT_E_HALFFULL 0x2 FIFO 1/2 full
ALT_UART_SRT_SRT_E_FULLLESS2 0x3 FIFO 2 less than full

Field Access Macros:

#define ALT_UART_SRT_SRT_E_ONECHAR   0x0
 
#define ALT_UART_SRT_SRT_E_QUARTERFULL   0x1
 
#define ALT_UART_SRT_SRT_E_HALFFULL   0x2
 
#define ALT_UART_SRT_SRT_E_FULLLESS2   0x3
 
#define ALT_UART_SRT_SRT_LSB   0
 
#define ALT_UART_SRT_SRT_MSB   1
 
#define ALT_UART_SRT_SRT_WIDTH   2
 
#define ALT_UART_SRT_SRT_SET_MSK   0x00000003
 
#define ALT_UART_SRT_SRT_CLR_MSK   0xfffffffc
 
#define ALT_UART_SRT_SRT_RESET   0x0
 
#define ALT_UART_SRT_SRT_GET(value)   (((value) & 0x00000003) >> 0)
 
#define ALT_UART_SRT_SRT_SET(value)   (((value) << 0) & 0x00000003)
 

Field : rsvd_srt_31to2

Reserved bits [31:2] - Read Only

Field Access Macros:

#define ALT_UART_SRT_RSVD_SRT_31TO2_LSB   2
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_MSB   31
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_WIDTH   30
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_SET_MSK   0xfffffffc
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_CLR_MSK   0x00000003
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_RESET   0x0
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_GET(value)   (((value) & 0xfffffffc) >> 2)
 
#define ALT_UART_SRT_RSVD_SRT_31TO2_SET(value)   (((value) << 2) & 0xfffffffc)
 

Data Structures

struct  ALT_UART_SRT_s
 

Macros

#define ALT_UART_SRT_RESET   0x00000000
 
#define ALT_UART_SRT_OFST   0x9c
 
#define ALT_UART_SRT_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SRT_OFST))
 

Typedefs

typedef struct ALT_UART_SRT_s ALT_UART_SRT_t
 

Data Structure Documentation

struct ALT_UART_SRT_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_SRT.

Data Fields
uint32_t srt: 2 ALT_UART_SRT_SRT
const uint32_t rsvd_srt_31to2: 30 ALT_UART_SRT_RSVD_SRT_31TO2

Macro Definitions

#define ALT_UART_SRT_SRT_E_ONECHAR   0x0

Enumerated value for register field ALT_UART_SRT_SRT

one character in fifo

#define ALT_UART_SRT_SRT_E_QUARTERFULL   0x1

Enumerated value for register field ALT_UART_SRT_SRT

FIFO 1/4 full

#define ALT_UART_SRT_SRT_E_HALFFULL   0x2

Enumerated value for register field ALT_UART_SRT_SRT

FIFO 1/2 full

#define ALT_UART_SRT_SRT_E_FULLLESS2   0x3

Enumerated value for register field ALT_UART_SRT_SRT

FIFO 2 less than full

#define ALT_UART_SRT_SRT_LSB   0

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

#define ALT_UART_SRT_SRT_MSB   1

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

#define ALT_UART_SRT_SRT_WIDTH   2

The width in bits of the ALT_UART_SRT_SRT register field.

#define ALT_UART_SRT_SRT_SET_MSK   0x00000003

The mask used to set the ALT_UART_SRT_SRT register field value.

#define ALT_UART_SRT_SRT_CLR_MSK   0xfffffffc

The mask used to clear the ALT_UART_SRT_SRT register field value.

#define ALT_UART_SRT_SRT_RESET   0x0

The reset value of the ALT_UART_SRT_SRT register field.

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

Extracts the ALT_UART_SRT_SRT field value from a register.

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

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

#define ALT_UART_SRT_RSVD_SRT_31TO2_LSB   2

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

#define ALT_UART_SRT_RSVD_SRT_31TO2_MSB   31

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

#define ALT_UART_SRT_RSVD_SRT_31TO2_WIDTH   30

The width in bits of the ALT_UART_SRT_RSVD_SRT_31TO2 register field.

#define ALT_UART_SRT_RSVD_SRT_31TO2_SET_MSK   0xfffffffc

The mask used to set the ALT_UART_SRT_RSVD_SRT_31TO2 register field value.

#define ALT_UART_SRT_RSVD_SRT_31TO2_CLR_MSK   0x00000003

The mask used to clear the ALT_UART_SRT_RSVD_SRT_31TO2 register field value.

#define ALT_UART_SRT_RSVD_SRT_31TO2_RESET   0x0

The reset value of the ALT_UART_SRT_RSVD_SRT_31TO2 register field.

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

Extracts the ALT_UART_SRT_RSVD_SRT_31TO2 field value from a register.

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

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

#define ALT_UART_SRT_RESET   0x00000000

The reset value of the ALT_UART_SRT register.

#define ALT_UART_SRT_OFST   0x9c

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

#define ALT_UART_SRT_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SRT_OFST))

The address of the ALT_UART_SRT register.

Typedef Documentation

The typedef declaration for register ALT_UART_SRT.