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

Description

Status of FIFO Operations.

Register Layout

Bits Access Reset Description
[0] ??? 0x0 UNDEFINED
[1] R 0x1 Transmit FIFO Not Full
[2] R 0x1 Transmit FIFO Empty
[3] R 0x0 Receive FIFO Not Empty
[4] R 0x0 Receive FIFO Full
[31:5] ??? 0x0 UNDEFINED

Field : Transmit FIFO Not Full - tfnf

This Bit is used to indicate that the transmit FIFO in not full. This bit is cleared when the Tx FIFO is full.

Field Enumeration Values:

Enum Value Description
ALT_UART_USR_TFNF_E_FULL 0x0 Transmit FIFO is full
ALT_UART_USR_TFNF_E_NOTFULL 0x1 Transmit FIFO is not full

Field Access Macros:

#define ALT_UART_USR_TFNF_E_FULL   0x0
 
#define ALT_UART_USR_TFNF_E_NOTFULL   0x1
 
#define ALT_UART_USR_TFNF_LSB   1
 
#define ALT_UART_USR_TFNF_MSB   1
 
#define ALT_UART_USR_TFNF_WIDTH   1
 
#define ALT_UART_USR_TFNF_SET_MSK   0x00000002
 
#define ALT_UART_USR_TFNF_CLR_MSK   0xfffffffd
 
#define ALT_UART_USR_TFNF_RESET   0x1
 
#define ALT_UART_USR_TFNF_GET(value)   (((value) & 0x00000002) >> 1)
 
#define ALT_UART_USR_TFNF_SET(value)   (((value) << 1) & 0x00000002)
 

Field : Transmit FIFO Empty - tfe

This is used to indicate that the transmit FIFO is completely empty. This bit is cleared when the Tx FIFO is no longer empty.

Field Enumeration Values:

Enum Value Description
ALT_UART_USR_TFE_E_NOTEMPTY 0x0 Transmit FIFO is not empty
ALT_UART_USR_TFE_E_EMPTY 0x1 Transmit FIFO is empty

Field Access Macros:

#define ALT_UART_USR_TFE_E_NOTEMPTY   0x0
 
#define ALT_UART_USR_TFE_E_EMPTY   0x1
 
#define ALT_UART_USR_TFE_LSB   2
 
#define ALT_UART_USR_TFE_MSB   2
 
#define ALT_UART_USR_TFE_WIDTH   1
 
#define ALT_UART_USR_TFE_SET_MSK   0x00000004
 
#define ALT_UART_USR_TFE_CLR_MSK   0xfffffffb
 
#define ALT_UART_USR_TFE_RESET   0x1
 
#define ALT_UART_USR_TFE_GET(value)   (((value) & 0x00000004) >> 2)
 
#define ALT_UART_USR_TFE_SET(value)   (((value) << 2) & 0x00000004)
 

Field : Receive FIFO Not Empty - rfne

This Bit is used to indicate that the receive FIFO contains one or more entries. This bit is cleared when the Rx FIFO is empty.

Field Enumeration Values:

Enum Value Description
ALT_UART_USR_RFNE_E_EMPTY 0x0 Receiive FIFO is empty
ALT_UART_USR_RFNE_E_NOTEMPTY 0x1 Receive FIFO is not empty

Field Access Macros:

#define ALT_UART_USR_RFNE_E_EMPTY   0x0
 
#define ALT_UART_USR_RFNE_E_NOTEMPTY   0x1
 
#define ALT_UART_USR_RFNE_LSB   3
 
#define ALT_UART_USR_RFNE_MSB   3
 
#define ALT_UART_USR_RFNE_WIDTH   1
 
#define ALT_UART_USR_RFNE_SET_MSK   0x00000008
 
#define ALT_UART_USR_RFNE_CLR_MSK   0xfffffff7
 
#define ALT_UART_USR_RFNE_RESET   0x0
 
#define ALT_UART_USR_RFNE_GET(value)   (((value) & 0x00000008) >> 3)
 
#define ALT_UART_USR_RFNE_SET(value)   (((value) << 3) & 0x00000008)
 

Field : Receive FIFO Full - rff

This Bit is used to indicate that the receive FIFO is completely full. This bit is cleared when the Rx FIFO is no longer full.

Field Enumeration Values:

Enum Value Description
ALT_UART_USR_RFF_E_NOTFULL 0x0 Receiive FIFO not full
ALT_UART_USR_RFF_E_FULL 0x1 Transmit FIFO is full

Field Access Macros:

#define ALT_UART_USR_RFF_E_NOTFULL   0x0
 
#define ALT_UART_USR_RFF_E_FULL   0x1
 
#define ALT_UART_USR_RFF_LSB   4
 
#define ALT_UART_USR_RFF_MSB   4
 
#define ALT_UART_USR_RFF_WIDTH   1
 
#define ALT_UART_USR_RFF_SET_MSK   0x00000010
 
#define ALT_UART_USR_RFF_CLR_MSK   0xffffffef
 
#define ALT_UART_USR_RFF_RESET   0x0
 
#define ALT_UART_USR_RFF_GET(value)   (((value) & 0x00000010) >> 4)
 
#define ALT_UART_USR_RFF_SET(value)   (((value) << 4) & 0x00000010)
 

Data Structures

struct  ALT_UART_USR_s
 

Macros

#define ALT_UART_USR_OFST   0x7c
 
#define ALT_UART_USR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_USR_OFST))
 

Typedefs

typedef struct ALT_UART_USR_s ALT_UART_USR_t
 

Data Structure Documentation

struct ALT_UART_USR_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_USR.

Data Fields
uint32_t __pad0__: 1 UNDEFINED
const uint32_t tfnf: 1 Transmit FIFO Not Full
const uint32_t tfe: 1 Transmit FIFO Empty
const uint32_t rfne: 1 Receive FIFO Not Empty
const uint32_t rff: 1 Receive FIFO Full
uint32_t __pad1__: 27 UNDEFINED

Macro Definitions

#define ALT_UART_USR_TFNF_E_FULL   0x0

Enumerated value for register field ALT_UART_USR_TFNF

Transmit FIFO is full

#define ALT_UART_USR_TFNF_E_NOTFULL   0x1

Enumerated value for register field ALT_UART_USR_TFNF

Transmit FIFO is not full

#define ALT_UART_USR_TFNF_LSB   1

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

#define ALT_UART_USR_TFNF_MSB   1

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

#define ALT_UART_USR_TFNF_WIDTH   1

The width in bits of the ALT_UART_USR_TFNF register field.

#define ALT_UART_USR_TFNF_SET_MSK   0x00000002

The mask used to set the ALT_UART_USR_TFNF register field value.

#define ALT_UART_USR_TFNF_CLR_MSK   0xfffffffd

The mask used to clear the ALT_UART_USR_TFNF register field value.

#define ALT_UART_USR_TFNF_RESET   0x1

The reset value of the ALT_UART_USR_TFNF register field.

#define ALT_UART_USR_TFNF_GET (   value)    (((value) & 0x00000002) >> 1)

Extracts the ALT_UART_USR_TFNF field value from a register.

#define ALT_UART_USR_TFNF_SET (   value)    (((value) << 1) & 0x00000002)

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

#define ALT_UART_USR_TFE_E_NOTEMPTY   0x0

Enumerated value for register field ALT_UART_USR_TFE

Transmit FIFO is not empty

#define ALT_UART_USR_TFE_E_EMPTY   0x1

Enumerated value for register field ALT_UART_USR_TFE

Transmit FIFO is empty

#define ALT_UART_USR_TFE_LSB   2

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

#define ALT_UART_USR_TFE_MSB   2

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

#define ALT_UART_USR_TFE_WIDTH   1

The width in bits of the ALT_UART_USR_TFE register field.

#define ALT_UART_USR_TFE_SET_MSK   0x00000004

The mask used to set the ALT_UART_USR_TFE register field value.

#define ALT_UART_USR_TFE_CLR_MSK   0xfffffffb

The mask used to clear the ALT_UART_USR_TFE register field value.

#define ALT_UART_USR_TFE_RESET   0x1

The reset value of the ALT_UART_USR_TFE register field.

#define ALT_UART_USR_TFE_GET (   value)    (((value) & 0x00000004) >> 2)

Extracts the ALT_UART_USR_TFE field value from a register.

#define ALT_UART_USR_TFE_SET (   value)    (((value) << 2) & 0x00000004)

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

#define ALT_UART_USR_RFNE_E_EMPTY   0x0

Enumerated value for register field ALT_UART_USR_RFNE

Receiive FIFO is empty

#define ALT_UART_USR_RFNE_E_NOTEMPTY   0x1

Enumerated value for register field ALT_UART_USR_RFNE

Receive FIFO is not empty

#define ALT_UART_USR_RFNE_LSB   3

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

#define ALT_UART_USR_RFNE_MSB   3

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

#define ALT_UART_USR_RFNE_WIDTH   1

The width in bits of the ALT_UART_USR_RFNE register field.

#define ALT_UART_USR_RFNE_SET_MSK   0x00000008

The mask used to set the ALT_UART_USR_RFNE register field value.

#define ALT_UART_USR_RFNE_CLR_MSK   0xfffffff7

The mask used to clear the ALT_UART_USR_RFNE register field value.

#define ALT_UART_USR_RFNE_RESET   0x0

The reset value of the ALT_UART_USR_RFNE register field.

#define ALT_UART_USR_RFNE_GET (   value)    (((value) & 0x00000008) >> 3)

Extracts the ALT_UART_USR_RFNE field value from a register.

#define ALT_UART_USR_RFNE_SET (   value)    (((value) << 3) & 0x00000008)

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

#define ALT_UART_USR_RFF_E_NOTFULL   0x0

Enumerated value for register field ALT_UART_USR_RFF

Receiive FIFO not full

#define ALT_UART_USR_RFF_E_FULL   0x1

Enumerated value for register field ALT_UART_USR_RFF

Transmit FIFO is full

#define ALT_UART_USR_RFF_LSB   4

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

#define ALT_UART_USR_RFF_MSB   4

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

#define ALT_UART_USR_RFF_WIDTH   1

The width in bits of the ALT_UART_USR_RFF register field.

#define ALT_UART_USR_RFF_SET_MSK   0x00000010

The mask used to set the ALT_UART_USR_RFF register field value.

#define ALT_UART_USR_RFF_CLR_MSK   0xffffffef

The mask used to clear the ALT_UART_USR_RFF register field value.

#define ALT_UART_USR_RFF_RESET   0x0

The reset value of the ALT_UART_USR_RFF register field.

#define ALT_UART_USR_RFF_GET (   value)    (((value) & 0x00000010) >> 4)

Extracts the ALT_UART_USR_RFF field value from a register.

#define ALT_UART_USR_RFF_SET (   value)    (((value) << 4) & 0x00000010)

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

#define ALT_UART_USR_OFST   0x7c

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

#define ALT_UART_USR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_USR_OFST))

The address of the ALT_UART_USR register.

Typedef Documentation

The typedef declaration for register ALT_UART_USR.