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

Description

Non-periodic Transmit FIFO Size Register

Register Layout

Bits Access Reset Description
[15:0] RW 0x2000 ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR
[31:16] RW 0x2000 ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP

Field : nptxfstaddr

Mode: Host only

Non-periodic Transmit RAM Start Address (NPTxFStAddr)

For host mode, this field is always valid. This field contains the memory start address

For Non-periodic Transmit FIFO RAM.

Programmed values must not exceed the power-on value.

Mode: Device only

IN Endpoint FIFO0 Transmit RAM Start Address

(INEPTxF0StAddr)

This field contains the memory start address For IN Endpoint

Transmit FIFO# 0.

Programmed values must not exceed the power-on value.

Field Access Macros:

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_LSB   0
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_MSB   15
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_WIDTH   16
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET_MSK   0x0000ffff
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_CLR_MSK   0xffff0000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_RESET   0x2000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_GET(value)   (((value) & 0x0000ffff) >> 0)
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET(value)   (((value) << 0) & 0x0000ffff)
 

Field : nptxfdep

Mode: Host only

Non-periodic TxFIFO Depth (NPTxFDep)

For host mode, this field is always valid.

For Device mode, this field is valid for shared fifo

This value is in terms of 32-bit words.

Minimum value is 16

Maximum value is 32,768

Programmed values must not exceed the power-on value.

Mode: Device only

IN Endpoint TxFIFO 0 Depth (INEPTxF0Dep)

This value is in terms of 32-bit words.

Minimum value is 16

Maximum value is 32,768

This field is determined by Enable Dynamic FIFO Sizing

Programmed values must not

exceed the power-on value.

Field Access Macros:

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_LSB   16
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_MSB   31
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_WIDTH   16
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET_MSK   0xffff0000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_CLR_MSK   0x0000ffff
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_RESET   0x2000
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_GET(value)   (((value) & 0xffff0000) >> 16)
 
#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET(value)   (((value) << 16) & 0xffff0000)
 

Data Structures

struct  ALT_USB_GLOB_GNPTXFSIZ_s
 

Macros

#define ALT_USB_GLOB_GNPTXFSIZ_RESET   0x20002000
 
#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: 16 ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR
uint32_t nptxfdep: 16 ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP

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   15

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_WIDTH   16

The width in bits of the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR register field.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_SET_MSK   0x0000ffff

The mask used to set the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR register field value.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR_CLR_MSK   0xffff0000

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) & 0x0000ffff) >> 0)

Extracts the ALT_USB_GLOB_GNPTXFSIZ_NPTXFSTADDR field value from a register.

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

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   31

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

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_WIDTH   16

The width in bits of the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP register field.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_SET_MSK   0xffff0000

The mask used to set the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP register field value.

#define ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP_CLR_MSK   0x0000ffff

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) & 0xffff0000) >> 16)

Extracts the ALT_USB_GLOB_GNPTXFSIZ_NPTXFDEP field value from a register.

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

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

#define ALT_USB_GLOB_GNPTXFSIZ_RESET   0x20002000

The reset value of the ALT_USB_GLOB_GNPTXFSIZ 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.