Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Device IN Endpoint Transmit FIFO Status Register 4 - dtxfsts4

Description

This register contains the free space information for the Device IN endpoint TxFIFO.

Register Layout

Bits Access Reset Description
[15:0] R 0x2000 IN Endpoint TxFIFO Space Avail
[31:16] ??? 0x0 UNDEFINED

Field : IN Endpoint TxFIFO Space Avail - ineptxfspcavail

Indicates the amount of free space available in the Endpoint TxFIFO. Values are in terms of 32-bit words. 16'h0: Endpoint TxFIFO is full 16'h1: 1 word available 16'h2: 2 words available 16'hn: n words available (where 0 n 32,768) 16'h8000: 32,768 words available Others: Reserved

Field Access Macros:

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_LSB   0
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_MSB   15
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_WIDTH   16
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_SET_MSK   0x0000ffff
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_CLR_MSK   0xffff0000
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_RESET   0x2000
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_GET(value)   (((value) & 0x0000ffff) >> 0)
 
#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_SET(value)   (((value) << 0) & 0x0000ffff)
 

Data Structures

struct  ALT_USB_DEV_DTXFSTS4_s
 

Macros

#define ALT_USB_DEV_DTXFSTS4_OFST   0x198
 
#define ALT_USB_DEV_DTXFSTS4_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_DEV_DTXFSTS4_OFST))
 

Typedefs

typedef struct
ALT_USB_DEV_DTXFSTS4_s 
ALT_USB_DEV_DTXFSTS4_t
 

Data Structure Documentation

struct ALT_USB_DEV_DTXFSTS4_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_USB_DEV_DTXFSTS4.

Data Fields
const uint32_t ineptxfspcavail: 16 IN Endpoint TxFIFO Space Avail
uint32_t __pad0__: 16 UNDEFINED

Macro Definitions

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_LSB   0

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

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_MSB   15

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

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_WIDTH   16

The width in bits of the ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL register field.

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_SET_MSK   0x0000ffff

The mask used to set the ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL register field value.

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_CLR_MSK   0xffff0000

The mask used to clear the ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL register field value.

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_RESET   0x2000

The reset value of the ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL register field.

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_GET (   value)    (((value) & 0x0000ffff) >> 0)

Extracts the ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL field value from a register.

#define ALT_USB_DEV_DTXFSTS4_INEPTXFSPCAVAIL_SET (   value)    (((value) << 0) & 0x0000ffff)

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

#define ALT_USB_DEV_DTXFSTS4_OFST   0x198

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

#define ALT_USB_DEV_DTXFSTS4_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_DEV_DTXFSTS4_OFST))

The address of the ALT_USB_DEV_DTXFSTS4 register.

Typedef Documentation

The typedef declaration for register ALT_USB_DEV_DTXFSTS4.