![]() |
Altera SoCAL
16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
|
Halt TX
Register Layout
Bits | Access | Reset | Description |
---|---|---|---|
[0] | RW | 0x0 | ALT_UART_HTX_HTX |
[31:1] | R | 0x0 | ALT_UART_HTX_RSVD_HTX_31TO1 |
Field : htx | ||||||||||
Halt TX. Writes will have no effect when FIFO_MODE == NONE, always readable. This register is use to halt transmissions for testing, so that the transmit FIFO can be filled by the master when FIFO's are implemented and enabled. Note, if FIFO's are implemented and not enabled the setting of the halt TX register will have no effect on operation. 0 = Halt TX disabled 1 = Halt TX enabled Field Enumeration Values:
Field Access Macros: | ||||||||||
#define | ALT_UART_HTX_HTX_E_DISD 0x0 | |||||||||
#define | ALT_UART_HTX_HTX_E_END 0x1 | |||||||||
#define | ALT_UART_HTX_HTX_LSB 0 | |||||||||
#define | ALT_UART_HTX_HTX_MSB 0 | |||||||||
#define | ALT_UART_HTX_HTX_WIDTH 1 | |||||||||
#define | ALT_UART_HTX_HTX_SET_MSK 0x00000001 | |||||||||
#define | ALT_UART_HTX_HTX_CLR_MSK 0xfffffffe | |||||||||
#define | ALT_UART_HTX_HTX_RESET 0x0 | |||||||||
#define | ALT_UART_HTX_HTX_GET(value) (((value) & 0x00000001) >> 0) | |||||||||
#define | ALT_UART_HTX_HTX_SET(value) (((value) << 0) & 0x00000001) | |||||||||
Field : rsvd_htx_31to1 | |
Reserved bits [31:1] - Read Only Field Access Macros: | |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_LSB 1 |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_MSB 31 |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_WIDTH 31 |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_SET_MSK 0xfffffffe |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_CLR_MSK 0x00000001 |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_RESET 0x0 |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_GET(value) (((value) & 0xfffffffe) >> 1) |
#define | ALT_UART_HTX_RSVD_HTX_31TO1_SET(value) (((value) << 1) & 0xfffffffe) |
Data Structures | |
struct | ALT_UART_HTX_s |
Macros | |
#define | ALT_UART_HTX_RESET 0x00000000 |
#define | ALT_UART_HTX_OFST 0xa4 |
#define | ALT_UART_HTX_ADDR(base) ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_HTX_OFST)) |
Typedefs | |
typedef struct ALT_UART_HTX_s | ALT_UART_HTX_t |
struct ALT_UART_HTX_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_HTX.
Data Fields | ||
---|---|---|
uint32_t | htx: 1 | ALT_UART_HTX_HTX |
const uint32_t | rsvd_htx_31to1: 31 | ALT_UART_HTX_RSVD_HTX_31TO1 |
#define ALT_UART_HTX_HTX_E_DISD 0x0 |
Enumerated value for register field ALT_UART_HTX_HTX
Halt Tx disabled
#define ALT_UART_HTX_HTX_E_END 0x1 |
Enumerated value for register field ALT_UART_HTX_HTX
Halt Tx enabled
#define ALT_UART_HTX_HTX_LSB 0 |
The Least Significant Bit (LSB) position of the ALT_UART_HTX_HTX register field.
#define ALT_UART_HTX_HTX_MSB 0 |
The Most Significant Bit (MSB) position of the ALT_UART_HTX_HTX register field.
#define ALT_UART_HTX_HTX_WIDTH 1 |
The width in bits of the ALT_UART_HTX_HTX register field.
#define ALT_UART_HTX_HTX_SET_MSK 0x00000001 |
The mask used to set the ALT_UART_HTX_HTX register field value.
#define ALT_UART_HTX_HTX_CLR_MSK 0xfffffffe |
The mask used to clear the ALT_UART_HTX_HTX register field value.
#define ALT_UART_HTX_HTX_RESET 0x0 |
The reset value of the ALT_UART_HTX_HTX register field.
#define ALT_UART_HTX_HTX_GET | ( | value | ) | (((value) & 0x00000001) >> 0) |
Extracts the ALT_UART_HTX_HTX field value from a register.
#define ALT_UART_HTX_HTX_SET | ( | value | ) | (((value) << 0) & 0x00000001) |
Produces a ALT_UART_HTX_HTX register field value suitable for setting the register.
#define ALT_UART_HTX_RSVD_HTX_31TO1_LSB 1 |
The Least Significant Bit (LSB) position of the ALT_UART_HTX_RSVD_HTX_31TO1 register field.
#define ALT_UART_HTX_RSVD_HTX_31TO1_MSB 31 |
The Most Significant Bit (MSB) position of the ALT_UART_HTX_RSVD_HTX_31TO1 register field.
#define ALT_UART_HTX_RSVD_HTX_31TO1_WIDTH 31 |
The width in bits of the ALT_UART_HTX_RSVD_HTX_31TO1 register field.
#define ALT_UART_HTX_RSVD_HTX_31TO1_SET_MSK 0xfffffffe |
The mask used to set the ALT_UART_HTX_RSVD_HTX_31TO1 register field value.
#define ALT_UART_HTX_RSVD_HTX_31TO1_CLR_MSK 0x00000001 |
The mask used to clear the ALT_UART_HTX_RSVD_HTX_31TO1 register field value.
#define ALT_UART_HTX_RSVD_HTX_31TO1_RESET 0x0 |
The reset value of the ALT_UART_HTX_RSVD_HTX_31TO1 register field.
#define ALT_UART_HTX_RSVD_HTX_31TO1_GET | ( | value | ) | (((value) & 0xfffffffe) >> 1) |
Extracts the ALT_UART_HTX_RSVD_HTX_31TO1 field value from a register.
#define ALT_UART_HTX_RSVD_HTX_31TO1_SET | ( | value | ) | (((value) << 1) & 0xfffffffe) |
Produces a ALT_UART_HTX_RSVD_HTX_31TO1 register field value suitable for setting the register.
#define ALT_UART_HTX_RESET 0x00000000 |
The reset value of the ALT_UART_HTX register.
#define ALT_UART_HTX_OFST 0xa4 |
The byte offset of the ALT_UART_HTX register from the beginning of the component.
#define ALT_UART_HTX_ADDR | ( | base | ) | ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_HTX_OFST)) |
The address of the ALT_UART_HTX register.
typedef struct ALT_UART_HTX_s ALT_UART_HTX_t |
The typedef declaration for register ALT_UART_HTX.