Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Shadow Request to Send - srts

Description

This is a shadow register for the RTS status (MCR[1]), this can be used to remove the burden of having to performing a read modify write on the MCR.

Register Layout

Bits Access Reset Description
[0] RW 0x0 Shadow Request to Send
[31:1] ??? 0x0 UNDEFINED

Field : Shadow Request to Send - srts

This is used to directly control the Request to Send (uart_rts_n) output. The Request to Send (uart_rts_n) output is used to inform the modem or data set that the UART is read to exchange data. The uart_rts_n signal is set low by programming MCR[1] (RTS) to a high. In Auto Flow Control, (MCR[5] set to one) and FIFO's are enabled (FCR[0] set to one), the uart_rts_n output is controlled in the same way, but is also gated with the receiver FIFO threshold trigger (uart_rts_n is inactive high when above the threshold).

Note that in Loopback mode (MCR[4] set to one), the uart_rts_n output is held inactive high while the value of this location is internally looped back to an input.

Field Enumeration Values:

Enum Value Description
ALT_UART_SRTS_SRTS_E_LOGIC0 0x1 uart_rts_n logic0
ALT_UART_SRTS_SRTS_E_LOGIC1 0x0 uart_rts_n logic1

Field Access Macros:

#define ALT_UART_SRTS_SRTS_E_LOGIC0   0x1
 
#define ALT_UART_SRTS_SRTS_E_LOGIC1   0x0
 
#define ALT_UART_SRTS_SRTS_LSB   0
 
#define ALT_UART_SRTS_SRTS_MSB   0
 
#define ALT_UART_SRTS_SRTS_WIDTH   1
 
#define ALT_UART_SRTS_SRTS_SET_MSK   0x00000001
 
#define ALT_UART_SRTS_SRTS_CLR_MSK   0xfffffffe
 
#define ALT_UART_SRTS_SRTS_RESET   0x0
 
#define ALT_UART_SRTS_SRTS_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_UART_SRTS_SRTS_SET(value)   (((value) << 0) & 0x00000001)
 

Data Structures

struct  ALT_UART_SRTS_s
 

Macros

#define ALT_UART_SRTS_OFST   0x8c
 
#define ALT_UART_SRTS_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SRTS_OFST))
 

Typedefs

typedef struct ALT_UART_SRTS_s ALT_UART_SRTS_t
 

Data Structure Documentation

struct ALT_UART_SRTS_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_SRTS.

Data Fields
uint32_t srts: 1 Shadow Request to Send
uint32_t __pad0__: 31 UNDEFINED

Macro Definitions

#define ALT_UART_SRTS_SRTS_E_LOGIC0   0x1

Enumerated value for register field ALT_UART_SRTS_SRTS

uart_rts_n logic0

#define ALT_UART_SRTS_SRTS_E_LOGIC1   0x0

Enumerated value for register field ALT_UART_SRTS_SRTS

uart_rts_n logic1

#define ALT_UART_SRTS_SRTS_LSB   0

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

#define ALT_UART_SRTS_SRTS_MSB   0

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

#define ALT_UART_SRTS_SRTS_WIDTH   1

The width in bits of the ALT_UART_SRTS_SRTS register field.

#define ALT_UART_SRTS_SRTS_SET_MSK   0x00000001

The mask used to set the ALT_UART_SRTS_SRTS register field value.

#define ALT_UART_SRTS_SRTS_CLR_MSK   0xfffffffe

The mask used to clear the ALT_UART_SRTS_SRTS register field value.

#define ALT_UART_SRTS_SRTS_RESET   0x0

The reset value of the ALT_UART_SRTS_SRTS register field.

#define ALT_UART_SRTS_SRTS_GET (   value)    (((value) & 0x00000001) >> 0)

Extracts the ALT_UART_SRTS_SRTS field value from a register.

#define ALT_UART_SRTS_SRTS_SET (   value)    (((value) << 0) & 0x00000001)

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

#define ALT_UART_SRTS_OFST   0x8c

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

#define ALT_UART_SRTS_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SRTS_OFST))

The address of the ALT_UART_SRTS register.

Typedef Documentation

The typedef declaration for register ALT_UART_SRTS.