![]() |
Altera SoCAL
16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
|
Shadow Request to Send.
Register Layout
Bits | Access | Reset | Description |
---|---|---|---|
[0] | RW | 0x0 | ALT_UART_SRTS_SRTS |
[31:1] | R | 0x0 | ALT_UART_SRTS_RSVD_SRTS_31TO1 |
Field : srts | ||||||||||
Shadow Request to Send. This is a shadow register for the RTS bit (MCR[1]), this can be used to remove the burden of having to performing a read modify write on the MCR. This is used to directly control the Request to Send (rts_n) output. The Request To Send (rts_n) output is used to inform the modem or data set that the UART is ready to exchange data. When Auto RTS Flow Control is not enabled (MCR[5] set to zero), the rts_n signal is set low by programming MCR[1] (RTS) to a high. In Auto Flow Control, AFCE_MODE == Enabled and active (MCR[5] set to one) and FIFO's enable (FCR[0] set to one), the rts_n output is controlled in the same way, but is also gated with the receiver FIFO threshold trigger (rts_n is inactive high when above the threshold) only when RTC Flow Trigger is disabled; otherwise it is gated by the receiver FIFO almost-full trigger, where almost full refers to two available slots in the FIFO (rts_n is inactive high when above the threshold). Note that in Loopback mode (MCR[4] set to one), the rts_n output is held inactive high while the value of this location is internally looped back to an input. Field Enumeration Values:
Field Access Macros: | ||||||||||
#define | ALT_UART_SRTS_SRTS_E_LOGIC1 0x0 | |||||||||
#define | ALT_UART_SRTS_SRTS_E_LOGIC0 0x1 | |||||||||
#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) | |||||||||
Field : rsvd_srts_31to1 | |
Reserved bits [31:1] - Read Only Field Access Macros: | |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_LSB 1 |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_MSB 31 |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_WIDTH 31 |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_SET_MSK 0xfffffffe |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_CLR_MSK 0x00000001 |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_RESET 0x0 |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_GET(value) (((value) & 0xfffffffe) >> 1) |
#define | ALT_UART_SRTS_RSVD_SRTS_31TO1_SET(value) (((value) << 1) & 0xfffffffe) |
Data Structures | |
struct | ALT_UART_SRTS_s |
Macros | |
#define | ALT_UART_SRTS_RESET 0x00000000 |
#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 |
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 | ALT_UART_SRTS_SRTS |
const uint32_t | rsvd_srts_31to1: 31 | ALT_UART_SRTS_RSVD_SRTS_31TO1 |
#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_E_LOGIC0 0x1 |
Enumerated value for register field ALT_UART_SRTS_SRTS
uart_rts_n logic0
#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_RSVD_SRTS_31TO1_LSB 1 |
The Least Significant Bit (LSB) position of the ALT_UART_SRTS_RSVD_SRTS_31TO1 register field.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_MSB 31 |
The Most Significant Bit (MSB) position of the ALT_UART_SRTS_RSVD_SRTS_31TO1 register field.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_WIDTH 31 |
The width in bits of the ALT_UART_SRTS_RSVD_SRTS_31TO1 register field.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_SET_MSK 0xfffffffe |
The mask used to set the ALT_UART_SRTS_RSVD_SRTS_31TO1 register field value.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_CLR_MSK 0x00000001 |
The mask used to clear the ALT_UART_SRTS_RSVD_SRTS_31TO1 register field value.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_RESET 0x0 |
The reset value of the ALT_UART_SRTS_RSVD_SRTS_31TO1 register field.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_GET | ( | value | ) | (((value) & 0xfffffffe) >> 1) |
Extracts the ALT_UART_SRTS_RSVD_SRTS_31TO1 field value from a register.
#define ALT_UART_SRTS_RSVD_SRTS_31TO1_SET | ( | value | ) | (((value) << 1) & 0xfffffffe) |
Produces a ALT_UART_SRTS_RSVD_SRTS_31TO1 register field value suitable for setting the register.
#define ALT_UART_SRTS_RESET 0x00000000 |
The reset value of the ALT_UART_SRTS 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 struct ALT_UART_SRTS_s ALT_UART_SRTS_t |
The typedef declaration for register ALT_UART_SRTS.