![]() |
Altera SoCAL
16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
|
Shadow Break Control Register.
Register Layout
Bits | Access | Reset | Description |
---|---|---|---|
[0] | RW | 0x0 | ALT_UART_SBCR_SBCR |
[31:1] | R | 0x0 | ALT_UART_SBCR_RSVD_SBCR_31TO1 |
Field : sbcr | ||||||||||
Shadow Break Control Bit. This is a shadow register for the Break bit (LCR[6]), this can be used to remove the burden of having to performing a read modify write on the LCR. This is used to cause a break condition to be transmitted to the receiving device. If set to one the serial output is forced to the spacing (logic 0) state. When not in Loopback Mode, as determined by MCR[4], the sout line is forced low until the Break bit is cleared. If SIR_MODE == Enabled and active (MCR[6] set to one) the sir_out_n line is continuously pulsed. When in Loopback Mode, the break condition is internally looped back to the receiver. Field Enumeration Values:
Field Access Macros: | ||||||||||
#define | ALT_UART_SBCR_SBCR_E_DISD 0x0 | |||||||||
#define | ALT_UART_SBCR_SBCR_E_END 0x1 | |||||||||
#define | ALT_UART_SBCR_SBCR_LSB 0 | |||||||||
#define | ALT_UART_SBCR_SBCR_MSB 0 | |||||||||
#define | ALT_UART_SBCR_SBCR_WIDTH 1 | |||||||||
#define | ALT_UART_SBCR_SBCR_SET_MSK 0x00000001 | |||||||||
#define | ALT_UART_SBCR_SBCR_CLR_MSK 0xfffffffe | |||||||||
#define | ALT_UART_SBCR_SBCR_RESET 0x0 | |||||||||
#define | ALT_UART_SBCR_SBCR_GET(value) (((value) & 0x00000001) >> 0) | |||||||||
#define | ALT_UART_SBCR_SBCR_SET(value) (((value) << 0) & 0x00000001) | |||||||||
Field : rsvd_sbcr_31to1 | |
Reserved bits [31:1] - Read Only Field Access Macros: | |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_LSB 1 |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_MSB 31 |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_WIDTH 31 |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_SET_MSK 0xfffffffe |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_CLR_MSK 0x00000001 |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_RESET 0x0 |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_GET(value) (((value) & 0xfffffffe) >> 1) |
#define | ALT_UART_SBCR_RSVD_SBCR_31TO1_SET(value) (((value) << 1) & 0xfffffffe) |
Data Structures | |
struct | ALT_UART_SBCR_s |
Macros | |
#define | ALT_UART_SBCR_RESET 0x00000000 |
#define | ALT_UART_SBCR_OFST 0x90 |
#define | ALT_UART_SBCR_ADDR(base) ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SBCR_OFST)) |
Typedefs | |
typedef struct ALT_UART_SBCR_s | ALT_UART_SBCR_t |
struct ALT_UART_SBCR_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_SBCR.
Data Fields | ||
---|---|---|
uint32_t | sbcr: 1 | ALT_UART_SBCR_SBCR |
const uint32_t | rsvd_sbcr_31to1: 31 | ALT_UART_SBCR_RSVD_SBCR_31TO1 |
#define ALT_UART_SBCR_SBCR_E_DISD 0x0 |
Enumerated value for register field ALT_UART_SBCR_SBCR
no break
#define ALT_UART_SBCR_SBCR_E_END 0x1 |
Enumerated value for register field ALT_UART_SBCR_SBCR
break serial output spacing
#define ALT_UART_SBCR_SBCR_LSB 0 |
The Least Significant Bit (LSB) position of the ALT_UART_SBCR_SBCR register field.
#define ALT_UART_SBCR_SBCR_MSB 0 |
The Most Significant Bit (MSB) position of the ALT_UART_SBCR_SBCR register field.
#define ALT_UART_SBCR_SBCR_WIDTH 1 |
The width in bits of the ALT_UART_SBCR_SBCR register field.
#define ALT_UART_SBCR_SBCR_SET_MSK 0x00000001 |
The mask used to set the ALT_UART_SBCR_SBCR register field value.
#define ALT_UART_SBCR_SBCR_CLR_MSK 0xfffffffe |
The mask used to clear the ALT_UART_SBCR_SBCR register field value.
#define ALT_UART_SBCR_SBCR_RESET 0x0 |
The reset value of the ALT_UART_SBCR_SBCR register field.
#define ALT_UART_SBCR_SBCR_GET | ( | value | ) | (((value) & 0x00000001) >> 0) |
Extracts the ALT_UART_SBCR_SBCR field value from a register.
#define ALT_UART_SBCR_SBCR_SET | ( | value | ) | (((value) << 0) & 0x00000001) |
Produces a ALT_UART_SBCR_SBCR register field value suitable for setting the register.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_LSB 1 |
The Least Significant Bit (LSB) position of the ALT_UART_SBCR_RSVD_SBCR_31TO1 register field.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_MSB 31 |
The Most Significant Bit (MSB) position of the ALT_UART_SBCR_RSVD_SBCR_31TO1 register field.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_WIDTH 31 |
The width in bits of the ALT_UART_SBCR_RSVD_SBCR_31TO1 register field.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_SET_MSK 0xfffffffe |
The mask used to set the ALT_UART_SBCR_RSVD_SBCR_31TO1 register field value.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_CLR_MSK 0x00000001 |
The mask used to clear the ALT_UART_SBCR_RSVD_SBCR_31TO1 register field value.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_RESET 0x0 |
The reset value of the ALT_UART_SBCR_RSVD_SBCR_31TO1 register field.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_GET | ( | value | ) | (((value) & 0xfffffffe) >> 1) |
Extracts the ALT_UART_SBCR_RSVD_SBCR_31TO1 field value from a register.
#define ALT_UART_SBCR_RSVD_SBCR_31TO1_SET | ( | value | ) | (((value) << 1) & 0xfffffffe) |
Produces a ALT_UART_SBCR_RSVD_SBCR_31TO1 register field value suitable for setting the register.
#define ALT_UART_SBCR_RESET 0x00000000 |
The reset value of the ALT_UART_SBCR register.
#define ALT_UART_SBCR_OFST 0x90 |
The byte offset of the ALT_UART_SBCR register from the beginning of the component.
#define ALT_UART_SBCR_ADDR | ( | base | ) | ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SBCR_OFST)) |
The address of the ALT_UART_SBCR register.
typedef struct ALT_UART_SBCR_s ALT_UART_SBCR_t |
The typedef declaration for register ALT_UART_SBCR.