USBX_Init_t Struct ReferencePlatform Middleware > USBXpress
USBXpress initialization function parameter typedef.
User should instantiate and pass by reference to USBX_init() .
Definition at line
234
of file
em_usbxpress.h
.
#include <
em_usbxpress.h
>
Data Fields |
|
| void const * | manufacturerString |
| uint8_t | maxPower |
| uint8_t | powerAttribute |
| uint16_t | productId |
| void const * | productString |
| uint16_t | releaseBcd |
| void const * | serialString |
| uint8_t | useFifo |
| uint16_t | vendorId |
Field Documentation
| void const* USBX_Init_t::manufacturerString |
Pointer to a character string. See AN571 Appendix B for formatting. NULL pointer will be treated as a valid address.
Definition at line
245
of file
em_usbxpress.h
.
| uint8_t USBX_Init_t::maxPower |
Specifies how much bus current a device requires. Set to one half the number of milliamperes required. The maximum allowed current is 500 milliamperes, and hence any value above 0xFA will be automatically set to 0xFA. Example: Set to 0x32 to request 100 mA.
Definition at line
257
of file
em_usbxpress.h
.
| uint8_t USBX_Init_t::powerAttribute |
Set bit 6 to 1 if the device is self- powered and to 0 if it is bus-powered. Set bit 5 to 1 if the device supports the remote wakeup feature. Bits 0 through 4 must be 0 and bit 7 must be 1. Example: Set to 0x80 to specify a bus-powered device that does not support remote wakeup.
Definition at line
265
of file
em_usbxpress.h
.
| uint16_t USBX_Init_t::productId |
16-bit Product ID to be returned to the host's Operating System during USB enumeration. Set to 0xEA61 to associate with the default VCP driver.
Definition at line
240
of file
em_usbxpress.h
.
| void const* USBX_Init_t::productString |
Pointer to a character string. See AN571 Appendix B for formatting. NULL pointer will be treated as a valid address.
Definition at line
249
of file
em_usbxpress.h
.
| uint16_t USBX_Init_t::releaseBcd |
The device's release number in BCD (binary-coded decimal) format. In BCD, the upper byte represents the integer, the next four bits are tenths, and the final four bits are hundredths. Example: 2.13 is denoted by 0x0213.
Definition at line
274
of file
em_usbxpress.h
.
| void const* USBX_Init_t::serialString |
Pointer to a character string. See Appendix B for formatting. NULL pointer will be treated as a valid address.
Definition at line
253
of file
em_usbxpress.h
.
| uint8_t USBX_Init_t::useFifo |
Whether to use the USB FIFO space to store VCP variables or else store them in user XRAM. The addresses of the variables are the same either way. If the current device does not support the use of the USB FIFO space form variable storage, this option does nothing.
Definition at line
281
of file
em_usbxpress.h
.
| uint16_t USBX_Init_t::vendorId |
16-bit Vendor ID to be returned to the host's Operating System during USB enumeration. Set to 0x10C4 to use the default Silicon Laboratories Vendor ID.
Definition at line
235
of file
em_usbxpress.h
.
The documentation for this struct was generated from the following file:
-
C:/repos/super_h1/platform/middleware/usbxpress/inc/
em_usbxpress.h