![]() |
Altera SoCAL
16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
|
Host Channel 11 Transfer Size Register
Register Layout
Bits | Access | Reset | Description |
---|---|---|---|
[18:0] | RW | 0x0 | ALT_USB_HOST_HCTSIZ11_XFERSIZE |
[28:19] | RW | 0x0 | ALT_USB_HOST_HCTSIZ11_PKTCNT |
[30:29] | RW | 0x0 | ALT_USB_HOST_HCTSIZ11_PID |
[31] | RW | 0x0 | ALT_USB_HOST_HCTSIZ11_DOPNG |
Field : xfersize | |
Transfer Size (XferSize) For an OUT, this field is the number of data bytes the host sends during the transfer. For an IN, this field is the buffer size that the application has Reserved For the transfer. The application is expected to program this field as an integer multiple of the maximum packet size For IN transactions (periodic and non-periodic). The width of this counter is specified as Width of Transfer Size Counters Field Access Macros: | |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_LSB 0 |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_MSB 18 |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_WIDTH 19 |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_SET_MSK 0x0007ffff |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_CLR_MSK 0xfff80000 |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_RESET 0x0 |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_GET(value) (((value) & 0x0007ffff) >> 0) |
#define | ALT_USB_HOST_HCTSIZ11_XFERSIZE_SET(value) (((value) << 0) & 0x0007ffff) |
Field : pktcnt | |
Packet Count (PktCnt) This field is programmed by the application with the expected number of packets to be transmitted (OUT) or received (IN). The host decrements this count on every successful transmission or reception of an OUT/IN packet. Once this count reaches zero, the application is interrupted to indicate normal completion. The width of this counter is specified as Width of Packet Counters Field Access Macros: | |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_LSB 19 |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_MSB 28 |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_WIDTH 10 |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_SET_MSK 0x1ff80000 |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_CLR_MSK 0xe007ffff |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_RESET 0x0 |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_GET(value) (((value) & 0x1ff80000) >> 19) |
#define | ALT_USB_HOST_HCTSIZ11_PKTCNT_SET(value) (((value) << 19) & 0x1ff80000) |
Field : pid | ||||||||||||||||
PID (Pid) The application programs this field with the type of PID to use For the initial transaction. The host maintains this field For the rest of the transfer. 2'b00: DATA0 2'b01: DATA2 2'b10: DATA1 2'b11: MDATA (non-control)/SETUP (control) Field Enumeration Values:
Field Access Macros: | ||||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_E_DATA0 0x0 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_E_DATA2 0x1 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_E_DATA1 0x2 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_E_MDATA 0x3 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_LSB 29 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_MSB 30 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_WIDTH 2 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_SET_MSK 0x60000000 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_CLR_MSK 0x9fffffff | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_RESET 0x0 | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_GET(value) (((value) & 0x60000000) >> 29) | |||||||||||||||
#define | ALT_USB_HOST_HCTSIZ11_PID_SET(value) (((value) << 29) & 0x60000000) | |||||||||||||||
Field : dopng | ||||||||||
Do Ping (DoPng) This bit is used only For OUT transfers. Setting this field to 1 directs the host to do PING protocol. Note: Do not Set this bit For IN transfers. If this bit is Set For for IN transfers it disables the channel. Field Enumeration Values:
Field Access Macros: | ||||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_E_NOPING 0x0 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_E_PING 0x1 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_LSB 31 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_MSB 31 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_WIDTH 1 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_SET_MSK 0x80000000 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_CLR_MSK 0x7fffffff | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_RESET 0x0 | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_GET(value) (((value) & 0x80000000) >> 31) | |||||||||
#define | ALT_USB_HOST_HCTSIZ11_DOPNG_SET(value) (((value) << 31) & 0x80000000) | |||||||||
Data Structures | |
struct | ALT_USB_HOST_HCTSIZ11_s |
Macros | |
#define | ALT_USB_HOST_HCTSIZ11_RESET 0x00000000 |
#define | ALT_USB_HOST_HCTSIZ11_OFST 0x270 |
#define | ALT_USB_HOST_HCTSIZ11_ADDR(base) ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_HOST_HCTSIZ11_OFST)) |
Typedefs | |
typedef struct ALT_USB_HOST_HCTSIZ11_s | ALT_USB_HOST_HCTSIZ11_t |
struct ALT_USB_HOST_HCTSIZ11_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_HCTSIZ11.
Data Fields | ||
---|---|---|
uint32_t | xfersize: 19 | ALT_USB_HOST_HCTSIZ11_XFERSIZE |
uint32_t | pktcnt: 10 | ALT_USB_HOST_HCTSIZ11_PKTCNT |
uint32_t | pid: 2 | ALT_USB_HOST_HCTSIZ11_PID |
uint32_t | dopng: 1 | ALT_USB_HOST_HCTSIZ11_DOPNG |
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_LSB 0 |
The Least Significant Bit (LSB) position of the ALT_USB_HOST_HCTSIZ11_XFERSIZE register field.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_MSB 18 |
The Most Significant Bit (MSB) position of the ALT_USB_HOST_HCTSIZ11_XFERSIZE register field.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_WIDTH 19 |
The width in bits of the ALT_USB_HOST_HCTSIZ11_XFERSIZE register field.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_SET_MSK 0x0007ffff |
The mask used to set the ALT_USB_HOST_HCTSIZ11_XFERSIZE register field value.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_CLR_MSK 0xfff80000 |
The mask used to clear the ALT_USB_HOST_HCTSIZ11_XFERSIZE register field value.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_RESET 0x0 |
The reset value of the ALT_USB_HOST_HCTSIZ11_XFERSIZE register field.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_GET | ( | value | ) | (((value) & 0x0007ffff) >> 0) |
Extracts the ALT_USB_HOST_HCTSIZ11_XFERSIZE field value from a register.
#define ALT_USB_HOST_HCTSIZ11_XFERSIZE_SET | ( | value | ) | (((value) << 0) & 0x0007ffff) |
Produces a ALT_USB_HOST_HCTSIZ11_XFERSIZE register field value suitable for setting the register.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_LSB 19 |
The Least Significant Bit (LSB) position of the ALT_USB_HOST_HCTSIZ11_PKTCNT register field.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_MSB 28 |
The Most Significant Bit (MSB) position of the ALT_USB_HOST_HCTSIZ11_PKTCNT register field.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_WIDTH 10 |
The width in bits of the ALT_USB_HOST_HCTSIZ11_PKTCNT register field.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_SET_MSK 0x1ff80000 |
The mask used to set the ALT_USB_HOST_HCTSIZ11_PKTCNT register field value.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_CLR_MSK 0xe007ffff |
The mask used to clear the ALT_USB_HOST_HCTSIZ11_PKTCNT register field value.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_RESET 0x0 |
The reset value of the ALT_USB_HOST_HCTSIZ11_PKTCNT register field.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_GET | ( | value | ) | (((value) & 0x1ff80000) >> 19) |
Extracts the ALT_USB_HOST_HCTSIZ11_PKTCNT field value from a register.
#define ALT_USB_HOST_HCTSIZ11_PKTCNT_SET | ( | value | ) | (((value) << 19) & 0x1ff80000) |
Produces a ALT_USB_HOST_HCTSIZ11_PKTCNT register field value suitable for setting the register.
#define ALT_USB_HOST_HCTSIZ11_PID_E_DATA0 0x0 |
Enumerated value for register field ALT_USB_HOST_HCTSIZ11_PID
DATA0
#define ALT_USB_HOST_HCTSIZ11_PID_E_DATA2 0x1 |
Enumerated value for register field ALT_USB_HOST_HCTSIZ11_PID
DATA2
#define ALT_USB_HOST_HCTSIZ11_PID_E_DATA1 0x2 |
Enumerated value for register field ALT_USB_HOST_HCTSIZ11_PID
DATA1
#define ALT_USB_HOST_HCTSIZ11_PID_E_MDATA 0x3 |
Enumerated value for register field ALT_USB_HOST_HCTSIZ11_PID
MDATA (non-control)/SETUP (control)
#define ALT_USB_HOST_HCTSIZ11_PID_LSB 29 |
The Least Significant Bit (LSB) position of the ALT_USB_HOST_HCTSIZ11_PID register field.
#define ALT_USB_HOST_HCTSIZ11_PID_MSB 30 |
The Most Significant Bit (MSB) position of the ALT_USB_HOST_HCTSIZ11_PID register field.
#define ALT_USB_HOST_HCTSIZ11_PID_WIDTH 2 |
The width in bits of the ALT_USB_HOST_HCTSIZ11_PID register field.
#define ALT_USB_HOST_HCTSIZ11_PID_SET_MSK 0x60000000 |
The mask used to set the ALT_USB_HOST_HCTSIZ11_PID register field value.
#define ALT_USB_HOST_HCTSIZ11_PID_CLR_MSK 0x9fffffff |
The mask used to clear the ALT_USB_HOST_HCTSIZ11_PID register field value.
#define ALT_USB_HOST_HCTSIZ11_PID_RESET 0x0 |
The reset value of the ALT_USB_HOST_HCTSIZ11_PID register field.
#define ALT_USB_HOST_HCTSIZ11_PID_GET | ( | value | ) | (((value) & 0x60000000) >> 29) |
Extracts the ALT_USB_HOST_HCTSIZ11_PID field value from a register.
#define ALT_USB_HOST_HCTSIZ11_PID_SET | ( | value | ) | (((value) << 29) & 0x60000000) |
Produces a ALT_USB_HOST_HCTSIZ11_PID register field value suitable for setting the register.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_E_NOPING 0x0 |
Enumerated value for register field ALT_USB_HOST_HCTSIZ11_DOPNG
No ping protocol
#define ALT_USB_HOST_HCTSIZ11_DOPNG_E_PING 0x1 |
Enumerated value for register field ALT_USB_HOST_HCTSIZ11_DOPNG
Ping protocol
#define ALT_USB_HOST_HCTSIZ11_DOPNG_LSB 31 |
The Least Significant Bit (LSB) position of the ALT_USB_HOST_HCTSIZ11_DOPNG register field.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_MSB 31 |
The Most Significant Bit (MSB) position of the ALT_USB_HOST_HCTSIZ11_DOPNG register field.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_WIDTH 1 |
The width in bits of the ALT_USB_HOST_HCTSIZ11_DOPNG register field.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_SET_MSK 0x80000000 |
The mask used to set the ALT_USB_HOST_HCTSIZ11_DOPNG register field value.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_CLR_MSK 0x7fffffff |
The mask used to clear the ALT_USB_HOST_HCTSIZ11_DOPNG register field value.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_RESET 0x0 |
The reset value of the ALT_USB_HOST_HCTSIZ11_DOPNG register field.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_GET | ( | value | ) | (((value) & 0x80000000) >> 31) |
Extracts the ALT_USB_HOST_HCTSIZ11_DOPNG field value from a register.
#define ALT_USB_HOST_HCTSIZ11_DOPNG_SET | ( | value | ) | (((value) << 31) & 0x80000000) |
Produces a ALT_USB_HOST_HCTSIZ11_DOPNG register field value suitable for setting the register.
#define ALT_USB_HOST_HCTSIZ11_RESET 0x00000000 |
The reset value of the ALT_USB_HOST_HCTSIZ11 register.
#define ALT_USB_HOST_HCTSIZ11_OFST 0x270 |
The byte offset of the ALT_USB_HOST_HCTSIZ11 register from the beginning of the component.
#define ALT_USB_HOST_HCTSIZ11_ADDR | ( | base | ) | ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_USB_HOST_HCTSIZ11_OFST)) |
The address of the ALT_USB_HOST_HCTSIZ11 register.
typedef struct ALT_USB_HOST_HCTSIZ11_s ALT_USB_HOST_HCTSIZ11_t |
The typedef declaration for register ALT_USB_HOST_HCTSIZ11.