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

Description

Shadow FIFO Enable

Register Layout

Bits Access Reset Description
[0] RW 0x0 ALT_UART_SFE_SFE
[31:1] R 0x0 ALT_UART_SFE_RSVD_SFE_31TO1

Field : sfe

Shadow FIFO Enable.

This is a shadow register for the FIFO enable bit (FCR[0]). 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 FIFO enable bit gets updated.

This enables/disables the transmit (XMIT) and receive (RCVR) FIFO's. If this

bit is set to zero (disabled) after being enabled then both the XMIT and RCVR

controller portion of FIFO's will be reset.

Field Enumeration Values:

Enum Value Description
ALT_UART_SFE_SFE_E_DISD 0x0 Disable Rx/Tx
ALT_UART_SFE_SFE_E_END 0x1 Enable Rx/Tx

Field Access Macros:

#define ALT_UART_SFE_SFE_E_DISD   0x0
 
#define ALT_UART_SFE_SFE_E_END   0x1
 
#define ALT_UART_SFE_SFE_LSB   0
 
#define ALT_UART_SFE_SFE_MSB   0
 
#define ALT_UART_SFE_SFE_WIDTH   1
 
#define ALT_UART_SFE_SFE_SET_MSK   0x00000001
 
#define ALT_UART_SFE_SFE_CLR_MSK   0xfffffffe
 
#define ALT_UART_SFE_SFE_RESET   0x0
 
#define ALT_UART_SFE_SFE_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_UART_SFE_SFE_SET(value)   (((value) << 0) & 0x00000001)
 

Field : rsvd_sfe_31to1

Reserved bits [31:1] - Read Only

Field Access Macros:

#define ALT_UART_SFE_RSVD_SFE_31TO1_LSB   1
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_MSB   31
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_WIDTH   31
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_SET_MSK   0xfffffffe
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_CLR_MSK   0x00000001
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_RESET   0x0
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_GET(value)   (((value) & 0xfffffffe) >> 1)
 
#define ALT_UART_SFE_RSVD_SFE_31TO1_SET(value)   (((value) << 1) & 0xfffffffe)
 

Data Structures

struct  ALT_UART_SFE_s
 

Macros

#define ALT_UART_SFE_RESET   0x00000000
 
#define ALT_UART_SFE_OFST   0x98
 
#define ALT_UART_SFE_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SFE_OFST))
 

Typedefs

typedef struct ALT_UART_SFE_s ALT_UART_SFE_t
 

Data Structure Documentation

struct ALT_UART_SFE_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_SFE.

Data Fields
uint32_t sfe: 1 ALT_UART_SFE_SFE
const uint32_t rsvd_sfe_31to1: 31 ALT_UART_SFE_RSVD_SFE_31TO1

Macro Definitions

#define ALT_UART_SFE_SFE_E_DISD   0x0

Enumerated value for register field ALT_UART_SFE_SFE

Disable Rx/Tx

#define ALT_UART_SFE_SFE_E_END   0x1

Enumerated value for register field ALT_UART_SFE_SFE

Enable Rx/Tx

#define ALT_UART_SFE_SFE_LSB   0

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

#define ALT_UART_SFE_SFE_MSB   0

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

#define ALT_UART_SFE_SFE_WIDTH   1

The width in bits of the ALT_UART_SFE_SFE register field.

#define ALT_UART_SFE_SFE_SET_MSK   0x00000001

The mask used to set the ALT_UART_SFE_SFE register field value.

#define ALT_UART_SFE_SFE_CLR_MSK   0xfffffffe

The mask used to clear the ALT_UART_SFE_SFE register field value.

#define ALT_UART_SFE_SFE_RESET   0x0

The reset value of the ALT_UART_SFE_SFE register field.

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

Extracts the ALT_UART_SFE_SFE field value from a register.

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

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

#define ALT_UART_SFE_RSVD_SFE_31TO1_LSB   1

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

#define ALT_UART_SFE_RSVD_SFE_31TO1_MSB   31

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

#define ALT_UART_SFE_RSVD_SFE_31TO1_WIDTH   31

The width in bits of the ALT_UART_SFE_RSVD_SFE_31TO1 register field.

#define ALT_UART_SFE_RSVD_SFE_31TO1_SET_MSK   0xfffffffe

The mask used to set the ALT_UART_SFE_RSVD_SFE_31TO1 register field value.

#define ALT_UART_SFE_RSVD_SFE_31TO1_CLR_MSK   0x00000001

The mask used to clear the ALT_UART_SFE_RSVD_SFE_31TO1 register field value.

#define ALT_UART_SFE_RSVD_SFE_31TO1_RESET   0x0

The reset value of the ALT_UART_SFE_RSVD_SFE_31TO1 register field.

#define ALT_UART_SFE_RSVD_SFE_31TO1_GET (   value)    (((value) & 0xfffffffe) >> 1)

Extracts the ALT_UART_SFE_RSVD_SFE_31TO1 field value from a register.

#define ALT_UART_SFE_RSVD_SFE_31TO1_SET (   value)    (((value) << 1) & 0xfffffffe)

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

#define ALT_UART_SFE_RESET   0x00000000

The reset value of the ALT_UART_SFE register.

#define ALT_UART_SFE_OFST   0x98

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

#define ALT_UART_SFE_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SFE_OFST))

The address of the ALT_UART_SFE register.

Typedef Documentation

The typedef declaration for register ALT_UART_SFE.