Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Non-periodic Transmit FIFO Size Register - gnptxfsiz

Description

The application can program the RAM size and the memory start address for the Non-periodic TxFIFO. The fields of this register change, depending on host or device mode.

Register Layout

Bits Access Reset Description
[13:0] RW 0x2000 Non-periodic Transmit RAM Start Address
[15:14] ??? 0x0 UNDEFINED
[29:16] RW 0x2000 Non-periodic TxFIFO Depth
[31:30] ??? 0x0 UNDEFINED

Field : Non-periodic Transmit RAM Start Address - nptxfstaddr

Mode: Host only. for host mode, this field is always valid.This field contains the memory start address for Non-periodic Transmit FIFO RAM. This field is set from 16-8192 32 bit words. The application can write a new value in this field. Programmed values must not exceed 8192.

Field Access Macros:

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_LSB   0
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_MSB   13
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_WIDTH   14
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET_MSK   0x00003fff
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_CLR_MSK   0xffffc000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_RESET   0x2000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_GET(value)   (((value) & 0x00003fff) >> 0)
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET(value)   (((value) << 0) & 0x00003fff)
 

Field : Non-periodic TxFIFO Depth - nptxfdep

Mode: Host only. for host mode, this field is always valid. The application can write a new value in this field. Programmed values must not exceed 8192

Field Access Macros:

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_LSB   16
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_MSB   29
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_WIDTH   14
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET_MSK   0x3fff0000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_CLR_MSK   0xc000ffff
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_RESET   0x2000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_GET(value)   (((value) & 0x3fff0000) >> 16)
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET(value)   (((value) << 16) & 0x3fff0000)
 

Data Structures

struct  ALT_USB_GLOB_GNPTXFSIZ_s
 

Macros

#define ALT_USB_GLOB_GNPTXFSIZ_OFST   0x28
 
#define ALT_USB_GLOB_GNPTXFSIZ_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_GLOB_GNPTXFSIZ_OFST))
 

Typedefs

typedef struct
ALT_USB_GLOB_GNPTXFSIZ_s 
ALT_USB_GLOB_GNPTXFSIZ_t
 

Data Structure Documentation

struct ALT_USB_GLOB_GNPTXFSIZ_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_GLOB_GNPTXFSIZ.

Data Fields
uint32_t nptxfstaddr: 14 Non-periodic Transmit RAM Start Address
uint32_t __pad0__: 2 UNDEFINED
uint32_t nptxfdep: 14 Non-periodic TxFIFO Depth
uint32_t __pad1__: 2 UNDEFINED

Macro Definitions

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_LSB   0

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_MSB   13

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_WIDTH   14

The width in bits of the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR register field.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET_MSK   0x00003fff

The mask used to set the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR register field value.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_CLR_MSK   0xffffc000

The mask used to clear the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR register field value.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_RESET   0x2000

The reset value of the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR register field.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_GET (   value)    (((value) & 0x00003fff) >> 0)

Extracts the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR field value from a register.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET (   value)    (((value) << 0) & 0x00003fff)

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_LSB   16

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_MSB   29

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_WIDTH   14

The width in bits of the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP register field.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET_MSK   0x3fff0000

The mask used to set the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP register field value.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_CLR_MSK   0xc000ffff

The mask used to clear the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP register field value.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_RESET   0x2000

The reset value of the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP register field.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_GET (   value)    (((value) & 0x3fff0000) >> 16)

Extracts the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP field value from a register.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET (   value)    (((value) << 16) & 0x3fff0000)

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

#define ALT_USB_GLOB_GNPTXFSIZ_OFST   0x28

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

#define ALT_USB_GLOB_GNPTXFSIZ_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_GLOB_GNPTXFSIZ_OFST))

The address of the ALT_USB_GLOB_GNPTXFSIZ register.

Typedef Documentation

The typedef declaration for register ALT_USB_GLOB_GNPTXFSIZ.