Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Host Channel 2 Interrupt Mask Register - hcintmsk2

Description

This register reflects the mask for each channel status described in the previous section.

Register Layout

Bits Access Reset Description
[0] RW 0x0 Transfer Completed Mask
[1] RW 0x0 Channel Halted Mask
[2] RW 0x0 AHB Error Mask
[10:3] ??? 0x0 UNDEFINED
[11] RW 0x0 BNA Interrupt mask
[12] ??? 0x0 UNDEFINED
[13] RW 0x0 Framelist Rollover Interrupt Mask
[31:14] ??? 0x0 UNDEFINED

Field : Transfer Completed Mask - xfercomplmsk

Transfer complete.

Field Enumeration Values:

Enum Value Description
ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_E_MSK 0x0 Mask
ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_E_NOMSK 0x1 No mask

Field Access Macros:

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_E_MSK   0x0
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_E_NOMSK   0x1
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_LSB   0
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_MSB   0
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_WIDTH   1
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_SET_MSK   0x00000001
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_CLR_MSK   0xfffffffe
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_RESET   0x0
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_SET(value)   (((value) << 0) & 0x00000001)
 

Field : Channel Halted Mask - chhltdmsk

Channel Halted.

Field Enumeration Values:

Enum Value Description
ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_E_MSK 0x0 Mask
ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_E_NOMSK 0x1 No mask

Field Access Macros:

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_E_MSK   0x0
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_E_NOMSK   0x1
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_LSB   1
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_MSB   1
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_WIDTH   1
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_SET_MSK   0x00000002
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_CLR_MSK   0xfffffffd
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_RESET   0x0
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_GET(value)   (((value) & 0x00000002) >> 1)
 
#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_SET(value)   (((value) << 1) & 0x00000002)
 

Field : AHB Error Mask - ahberrmsk

In scatter/gather DMA mode for host, interrupts will not be generated due to the corresponding bits set in HCINTn.

Field Enumeration Values:

Enum Value Description
ALT_USB_HOST_HCINTMSK2_AHBERRMSK_E_MSK 0x0 Mask
ALT_USB_HOST_HCINTMSK2_AHBERRMSK_E_NOMSK 0x1 No mask

Field Access Macros:

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_E_MSK   0x0
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_E_NOMSK   0x1
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_LSB   2
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_MSB   2
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_WIDTH   1
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_SET_MSK   0x00000004
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_CLR_MSK   0xfffffffb
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_RESET   0x0
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_GET(value)   (((value) & 0x00000004) >> 2)
 
#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_SET(value)   (((value) << 2) & 0x00000004)
 

Field : BNA Interrupt mask - bnaintrmsk

This bit is valid only when Scatter/Gather DMA mode is enabled.

Field Enumeration Values:

Enum Value Description
ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_E_MSK 0x0 Mask
ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_E_NOMSK 0x1 No mask

Field Access Macros:

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_E_MSK   0x0
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_E_NOMSK   0x1
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_LSB   11
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_MSB   11
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_WIDTH   1
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_SET_MSK   0x00000800
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_CLR_MSK   0xfffff7ff
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_RESET   0x0
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_GET(value)   (((value) & 0x00000800) >> 11)
 
#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_SET(value)   (((value) << 11) & 0x00000800)
 

Field : Framelist Rollover Interrupt Mask - frm_lst_rollintrmsk

This bit is valid only when Scatter/Gather DMA mode is enabled.

Field Enumeration Values:

Enum Value Description
ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_E_MSK 0x0 Mask
ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_E_NOMSK 0x1 No mask

Field Access Macros:

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_E_MSK   0x0
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_E_NOMSK   0x1
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_LSB   13
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_MSB   13
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_WIDTH   1
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_SET_MSK   0x00002000
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_CLR_MSK   0xffffdfff
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_RESET   0x0
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_GET(value)   (((value) & 0x00002000) >> 13)
 
#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_SET(value)   (((value) << 13) & 0x00002000)
 

Data Structures

struct  ALT_USB_HOST_HCINTMSK2_s
 

Macros

#define ALT_USB_HOST_HCINTMSK2_OFST   0x14c
 
#define ALT_USB_HOST_HCINTMSK2_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_HOST_HCINTMSK2_OFST))
 

Typedefs

typedef struct
ALT_USB_HOST_HCINTMSK2_s 
ALT_USB_HOST_HCINTMSK2_t
 

Data Structure Documentation

struct ALT_USB_HOST_HCINTMSK2_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_HCINTMSK2.

Data Fields
uint32_t xfercomplmsk: 1 Transfer Completed Mask
uint32_t chhltdmsk: 1 Channel Halted Mask
uint32_t ahberrmsk: 1 AHB Error Mask
uint32_t __pad0__: 8 UNDEFINED
uint32_t bnaintrmsk: 1 BNA Interrupt mask
uint32_t __pad1__: 1 UNDEFINED
uint32_t frm_lst_rollintrmsk: 1 Framelist Rollover Interrupt Mask
uint32_t __pad2__: 18 UNDEFINED

Macro Definitions

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_E_MSK   0x0

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK

Mask

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_E_NOMSK   0x1

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK

No mask

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_LSB   0

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

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_MSB   0

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

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_WIDTH   1

The width in bits of the ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK register field.

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_SET_MSK   0x00000001

The mask used to set the ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_CLR_MSK   0xfffffffe

The mask used to clear the ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_RESET   0x0

The reset value of the ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK register field.

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_GET (   value)    (((value) & 0x00000001) >> 0)

Extracts the ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK field value from a register.

#define ALT_USB_HOST_HCINTMSK2_XFERCOMPLMSK_SET (   value)    (((value) << 0) & 0x00000001)

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

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_E_MSK   0x0

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_CHHLTDMSK

Mask

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_E_NOMSK   0x1

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_CHHLTDMSK

No mask

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_LSB   1

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

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_MSB   1

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

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_WIDTH   1

The width in bits of the ALT_USB_HOST_HCINTMSK2_CHHLTDMSK register field.

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_SET_MSK   0x00000002

The mask used to set the ALT_USB_HOST_HCINTMSK2_CHHLTDMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_CLR_MSK   0xfffffffd

The mask used to clear the ALT_USB_HOST_HCINTMSK2_CHHLTDMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_RESET   0x0

The reset value of the ALT_USB_HOST_HCINTMSK2_CHHLTDMSK register field.

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_GET (   value)    (((value) & 0x00000002) >> 1)

Extracts the ALT_USB_HOST_HCINTMSK2_CHHLTDMSK field value from a register.

#define ALT_USB_HOST_HCINTMSK2_CHHLTDMSK_SET (   value)    (((value) << 1) & 0x00000002)

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

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_E_MSK   0x0

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_AHBERRMSK

Mask

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_E_NOMSK   0x1

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_AHBERRMSK

No mask

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_LSB   2

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

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_MSB   2

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

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_WIDTH   1

The width in bits of the ALT_USB_HOST_HCINTMSK2_AHBERRMSK register field.

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_SET_MSK   0x00000004

The mask used to set the ALT_USB_HOST_HCINTMSK2_AHBERRMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_CLR_MSK   0xfffffffb

The mask used to clear the ALT_USB_HOST_HCINTMSK2_AHBERRMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_RESET   0x0

The reset value of the ALT_USB_HOST_HCINTMSK2_AHBERRMSK register field.

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_GET (   value)    (((value) & 0x00000004) >> 2)

Extracts the ALT_USB_HOST_HCINTMSK2_AHBERRMSK field value from a register.

#define ALT_USB_HOST_HCINTMSK2_AHBERRMSK_SET (   value)    (((value) << 2) & 0x00000004)

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

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_E_MSK   0x0

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_BNAINTRMSK

Mask

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_E_NOMSK   0x1

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_BNAINTRMSK

No mask

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_LSB   11

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

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_MSB   11

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

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_WIDTH   1

The width in bits of the ALT_USB_HOST_HCINTMSK2_BNAINTRMSK register field.

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_SET_MSK   0x00000800

The mask used to set the ALT_USB_HOST_HCINTMSK2_BNAINTRMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_CLR_MSK   0xfffff7ff

The mask used to clear the ALT_USB_HOST_HCINTMSK2_BNAINTRMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_RESET   0x0

The reset value of the ALT_USB_HOST_HCINTMSK2_BNAINTRMSK register field.

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_GET (   value)    (((value) & 0x00000800) >> 11)

Extracts the ALT_USB_HOST_HCINTMSK2_BNAINTRMSK field value from a register.

#define ALT_USB_HOST_HCINTMSK2_BNAINTRMSK_SET (   value)    (((value) << 11) & 0x00000800)

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

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_E_MSK   0x0

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK

Mask

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_E_NOMSK   0x1

Enumerated value for register field ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK

No mask

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_LSB   13

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

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_MSB   13

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

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_WIDTH   1

The width in bits of the ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK register field.

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_SET_MSK   0x00002000

The mask used to set the ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_CLR_MSK   0xffffdfff

The mask used to clear the ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK register field value.

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_RESET   0x0

The reset value of the ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK register field.

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_GET (   value)    (((value) & 0x00002000) >> 13)

Extracts the ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK field value from a register.

#define ALT_USB_HOST_HCINTMSK2_FRM_LST_ROLLINTRMSK_SET (   value)    (((value) << 13) & 0x00002000)

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

#define ALT_USB_HOST_HCINTMSK2_OFST   0x14c

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

#define ALT_USB_HOST_HCINTMSK2_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_HOST_HCINTMSK2_OFST))

The address of the ALT_USB_HOST_HCINTMSK2 register.

Typedef Documentation

The typedef declaration for register ALT_USB_HOST_HCINTMSK2.