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

Description

Host Frame Interval Register

Register Layout

Bits Access Reset Description
[15:0] RW 0xea60 ALT_USB_HOST_HFIR_FRINT
[16] RW 0x0 ALT_USB_HOST_HFIR_HFIRRLDCTL
[31:17] ??? 0x0 UNDEFINED

Field : frint

Frame Interval (FrInt)

The value that the application programs to this field specifies

the interval between two consecutive SOFs (FS) or micro-

SOFs (HS) or Keep-Alive tokens (HS). This field contains the

number of PHY clocks that constitute the required frame

interval. The Default value Set in this field For a FS operation

when the PHY clock frequency is 60 MHz. The application can

write a value to this register only after the Port Enable bit of the

Host Port Control and Status register (HPRT.PrtEnaPort) has

been Set. If no value is programmed, the core calculates the

value based on the PHY clock specified in the FS/LS PHY

Clock Select field of the Host Configuration register

(HCFG.FSLSPclkSel). Do not change the value of this field

after the initial configuration.

125 s * (PHY clock frequency For HS)

1 ms * (PHY clock frequency For FS/LS)

Field Access Macros:

#define ALT_USB_HOST_HFIR_FRINT_LSB   0
 
#define ALT_USB_HOST_HFIR_FRINT_MSB   15
 
#define ALT_USB_HOST_HFIR_FRINT_WIDTH   16
 
#define ALT_USB_HOST_HFIR_FRINT_SET_MSK   0x0000ffff
 
#define ALT_USB_HOST_HFIR_FRINT_CLR_MSK   0xffff0000
 
#define ALT_USB_HOST_HFIR_FRINT_RESET   0xea60
 
#define ALT_USB_HOST_HFIR_FRINT_GET(value)   (((value) & 0x0000ffff) >> 0)
 
#define ALT_USB_HOST_HFIR_FRINT_SET(value)   (((value) << 0) & 0x0000ffff)
 

Field : hfirrldctrl

Reload Control (HFIRRldCtrl)

This bit allows dynamic reloading of the HFIR register during run time.

1'b0 : The HFIR cannot be reloaded dynamically

1'b1: the HFIR can be dynamically reloaded during runtime.

This bit needs to be programmed during initial configuration and its value should not be changed during runtime.

Field Enumeration Values:

Enum Value Description
ALT_USB_HOST_HFIR_HFIRRLDCTL_E_DISD 0x0 The HFIR cannot be reloaded dynamically
ALT_USB_HOST_HFIR_HFIRRLDCTL_E_END 0x1 The HFIR can be dynamically reloaded during
: runtime

Field Access Macros:

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_E_DISD   0x0
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_E_END   0x1
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_LSB   16
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_MSB   16
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_WIDTH   1
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_SET_MSK   0x00010000
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_CLR_MSK   0xfffeffff
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_RESET   0x0
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_GET(value)   (((value) & 0x00010000) >> 16)
 
#define ALT_USB_HOST_HFIR_HFIRRLDCTL_SET(value)   (((value) << 16) & 0x00010000)
 

Data Structures

struct  ALT_USB_HOST_HFIR_s
 

Macros

#define ALT_USB_HOST_HFIR_RESET   0x0000ea60
 
#define ALT_USB_HOST_HFIR_OFST   0x4
 
#define ALT_USB_HOST_HFIR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_HOST_HFIR_OFST))
 

Typedefs

typedef struct ALT_USB_HOST_HFIR_s ALT_USB_HOST_HFIR_t
 

Data Structure Documentation

struct ALT_USB_HOST_HFIR_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_HOST_HFIR.

Data Fields
uint32_t frint: 16 ALT_USB_HOST_HFIR_FRINT
uint32_t hfirrldctrl: 1 ALT_USB_HOST_HFIR_HFIRRLDCTL
uint32_t __pad0__: 15 UNDEFINED

Macro Definitions

#define ALT_USB_HOST_HFIR_FRINT_LSB   0

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

#define ALT_USB_HOST_HFIR_FRINT_MSB   15

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

#define ALT_USB_HOST_HFIR_FRINT_WIDTH   16

The width in bits of the ALT_USB_HOST_HFIR_FRINT register field.

#define ALT_USB_HOST_HFIR_FRINT_SET_MSK   0x0000ffff

The mask used to set the ALT_USB_HOST_HFIR_FRINT register field value.

#define ALT_USB_HOST_HFIR_FRINT_CLR_MSK   0xffff0000

The mask used to clear the ALT_USB_HOST_HFIR_FRINT register field value.

#define ALT_USB_HOST_HFIR_FRINT_RESET   0xea60

The reset value of the ALT_USB_HOST_HFIR_FRINT register field.

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

Extracts the ALT_USB_HOST_HFIR_FRINT field value from a register.

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

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

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_E_DISD   0x0

Enumerated value for register field ALT_USB_HOST_HFIR_HFIRRLDCTL

The HFIR cannot be reloaded dynamically

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_E_END   0x1

Enumerated value for register field ALT_USB_HOST_HFIR_HFIRRLDCTL

The HFIR can be dynamically reloaded during runtime

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_LSB   16

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

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_MSB   16

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

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_WIDTH   1

The width in bits of the ALT_USB_HOST_HFIR_HFIRRLDCTL register field.

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_SET_MSK   0x00010000

The mask used to set the ALT_USB_HOST_HFIR_HFIRRLDCTL register field value.

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_CLR_MSK   0xfffeffff

The mask used to clear the ALT_USB_HOST_HFIR_HFIRRLDCTL register field value.

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_RESET   0x0

The reset value of the ALT_USB_HOST_HFIR_HFIRRLDCTL register field.

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_GET (   value)    (((value) & 0x00010000) >> 16)

Extracts the ALT_USB_HOST_HFIR_HFIRRLDCTL field value from a register.

#define ALT_USB_HOST_HFIR_HFIRRLDCTL_SET (   value)    (((value) << 16) & 0x00010000)

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

#define ALT_USB_HOST_HFIR_RESET   0x0000ea60

The reset value of the ALT_USB_HOST_HFIR register.

#define ALT_USB_HOST_HFIR_OFST   0x4

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

#define ALT_USB_HOST_HFIR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_HOST_HFIR_OFST))

The address of the ALT_USB_HOST_HFIR register.

Typedef Documentation

The typedef declaration for register ALT_USB_HOST_HFIR.