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

Description

Host Periodic Transmit FIFO Size Register

Register Layout

Bits Access Reset Description
[14:0] RW 0x4000 ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR
[15] ??? 0x0 UNDEFINED
[29:16] RW 0x2000 ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE
[31:30] ??? 0x0 UNDEFINED

Field : ptxfstaddr

Host Periodic TxFIFO Start Address (PTxFStAddr)

The power-on reset value of this register is the sum of the Largest Rx Data

FIFO Depth and Largest Non-periodic Tx Data FIFO Depth

Programmed values must not exceed the power-on value

Field Access Macros:

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_LSB   0
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_MSB   14
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_WIDTH   15
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_SET_MSK   0x00007fff
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_CLR_MSK   0xffff8000
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_RESET   0x4000
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_GET(value)   (((value) & 0x00007fff) >> 0)
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_SET(value)   (((value) << 0) & 0x00007fff)
 

Field : ptxfsize

Host Periodic TxFIFO Depth (PTxFSize)

This value is in terms of 32-bit words.

Minimum value is 16

Maximum value is 32,768

The power-on reset value of this register is specified as the Largest Host

Mode Periodic Tx Data FIFO Depth.

Programmed values must not exceed the power-on value.

Field Access Macros:

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_LSB   16
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_MSB   29
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_WIDTH   14
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_SET_MSK   0x3fff0000
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_CLR_MSK   0xc000ffff
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_RESET   0x2000
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_GET(value)   (((value) & 0x3fff0000) >> 16)
 
#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_SET(value)   (((value) << 16) & 0x3fff0000)
 

Data Structures

struct  ALT_USB_GLOB_HPTXFSIZ_s
 

Macros

#define ALT_USB_GLOB_HPTXFSIZ_RESET   0x20004000
 
#define ALT_USB_GLOB_HPTXFSIZ_OFST   0x100
 
#define ALT_USB_GLOB_HPTXFSIZ_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_GLOB_HPTXFSIZ_OFST))
 

Typedefs

typedef struct
ALT_USB_GLOB_HPTXFSIZ_s 
ALT_USB_GLOB_HPTXFSIZ_t
 

Data Structure Documentation

struct ALT_USB_GLOB_HPTXFSIZ_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_HPTXFSIZ.

Data Fields
uint32_t ptxfstaddr: 15 ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR
uint32_t __pad0__: 1 UNDEFINED
uint32_t ptxfsize: 14 ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE
uint32_t __pad1__: 2 UNDEFINED

Macro Definitions

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_LSB   0

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

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_MSB   14

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

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_WIDTH   15

The width in bits of the ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR register field.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_SET_MSK   0x00007fff

The mask used to set the ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR register field value.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_CLR_MSK   0xffff8000

The mask used to clear the ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR register field value.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_RESET   0x4000

The reset value of the ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR register field.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_GET (   value)    (((value) & 0x00007fff) >> 0)

Extracts the ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR field value from a register.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSTADDR_SET (   value)    (((value) << 0) & 0x00007fff)

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

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_LSB   16

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

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_MSB   29

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

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_WIDTH   14

The width in bits of the ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE register field.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_SET_MSK   0x3fff0000

The mask used to set the ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE register field value.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_CLR_MSK   0xc000ffff

The mask used to clear the ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE register field value.

#define ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE_RESET   0x2000

The reset value of the ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE register field.

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

Extracts the ALT_USB_GLOB_HPTXFSIZ_PTXFSIZE field value from a register.

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

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

#define ALT_USB_GLOB_HPTXFSIZ_RESET   0x20004000

The reset value of the ALT_USB_GLOB_HPTXFSIZ register.

#define ALT_USB_GLOB_HPTXFSIZ_OFST   0x100

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

#define ALT_USB_GLOB_HPTXFSIZ_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_GLOB_HPTXFSIZ_OFST))

The address of the ALT_USB_GLOB_HPTXFSIZ register.

Typedef Documentation

The typedef declaration for register ALT_USB_GLOB_HPTXFSIZ.