Usb.h File Reference
Support for USB 2.0 standard. More...
Go to the source code of this file.
Data Structures | |
| struct | USB_DEVICE_REQUEST |
| Format of Setup Data for USB Device Requests USB 2.0 spec, Section 9.3. More... | |
| struct | USB_DEVICE_DESCRIPTOR |
| Standard Device Descriptor USB 2.0 spec, Section 9.6.1. More... | |
| struct | USB_CONFIG_DESCRIPTOR |
| Standard Configuration Descriptor USB 2.0 spec, Section 9.6.3. More... | |
| struct | USB_INTERFACE_ASSOCIATION_DESCRIPTOR |
| Standard Interface Association Descriptor USB 3.0 spec, Section 9.6.4. More... | |
| struct | USB_INTERFACE_DESCRIPTOR |
| Standard Interface Descriptor USB 2.0 spec, Section 9.6.5. More... | |
| struct | USB_ENDPOINT_DESCRIPTOR |
| Standard Endpoint Descriptor USB 2.0 spec, Section 9.6.6. More... | |
| struct | EFI_USB_STRING_DESCRIPTOR |
| UNICODE String Descriptor USB 2.0 spec, Section 9.6.7. More... | |
| struct | hid_class_descriptor |
| Descriptor header for Report/Physical Descriptors HID 1.1, section 6.2.1. More... | |
| struct | hid_descriptor |
| The HID descriptor identifies the length and type of subordinate descriptors for a device. More... | |
Typedefs | |
| typedef struct hid_class_descriptor | EFI_USB_HID_CLASS_DESCRIPTOR |
| Descriptor header for Report/Physical Descriptors HID 1.1, section 6.2.1. | |
| typedef struct hid_descriptor | EFI_USB_HID_DESCRIPTOR |
| The HID descriptor identifies the length and type of subordinate descriptors for a device. | |
Functions | |
| FILE_LICENCE (BSD2_PATENT) | |
| FILE_SECBOOT (PERMITTED) | |
Detailed Description
Support for USB 2.0 standard.
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
Copyright (c) 2024, American Megatrends International LLC. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file Usb.h.
Macro Definition Documentation
◆ USB_MASS_STORE_CLASS
◆ USB_MASS_STORE_RBC
◆ USB_MASS_STORE_8020I
| #define USB_MASS_STORE_8020I 0x02 |
◆ USB_MASS_STORE_QIC
◆ USB_MASS_STORE_UFI
| #define USB_MASS_STORE_UFI 0x04 |
◆ USB_MASS_STORE_8070I
| #define USB_MASS_STORE_8070I 0x05 |
◆ USB_MASS_STORE_SCSI
◆ USB_MASS_STORE_CBI0
| #define USB_MASS_STORE_CBI0 0x00 |
◆ USB_MASS_STORE_CBI1
| #define USB_MASS_STORE_CBI1 0x01 |
◆ USB_MASS_STORE_BOT
◆ USB_DEV_GET_STATUS
◆ USB_DEV_GET_STATUS_REQ_TYPE_D
◆ USB_DEV_GET_STATUS_REQ_TYPE_I
◆ USB_DEV_GET_STATUS_REQ_TYPE_E
◆ USB_DEV_CLEAR_FEATURE
◆ USB_DEV_CLEAR_FEATURE_REQ_TYPE_D
◆ USB_DEV_CLEAR_FEATURE_REQ_TYPE_I
◆ USB_DEV_CLEAR_FEATURE_REQ_TYPE_E
◆ USB_DEV_SET_FEATURE
◆ USB_DEV_SET_FEATURE_REQ_TYPE_D
◆ USB_DEV_SET_FEATURE_REQ_TYPE_I
◆ USB_DEV_SET_FEATURE_REQ_TYPE_E
◆ USB_DEV_SET_ADDRESS
◆ USB_DEV_SET_ADDRESS_REQ_TYPE
◆ USB_DEV_GET_DESCRIPTOR
◆ USB_DEV_GET_DESCRIPTOR_REQ_TYPE
◆ USB_DEV_SET_DESCRIPTOR
◆ USB_DEV_SET_DESCRIPTOR_REQ_TYPE
◆ USB_DEV_GET_CONFIGURATION
◆ USB_DEV_GET_CONFIGURATION_REQ_TYPE
◆ USB_DEV_SET_CONFIGURATION
◆ USB_DEV_SET_CONFIGURATION_REQ_TYPE
◆ USB_DEV_GET_INTERFACE
◆ USB_DEV_GET_INTERFACE_REQ_TYPE
◆ USB_DEV_SET_INTERFACE
◆ USB_DEV_SET_INTERFACE_REQ_TYPE
◆ USB_DEV_SYNCH_FRAME
◆ USB_DEV_SYNCH_FRAME_REQ_TYPE
◆ USB_HID_GET_DESCRIPTOR_REQ_TYPE
◆ USB_HID_CLASS_GET_REQ_TYPE
◆ USB_HID_CLASS_SET_REQ_TYPE
◆ HID_ITEM_FORMAT_SHORT
◆ HID_ITEM_FORMAT_LONG
◆ HID_ITEM_TAG_LONG
◆ HID_ITEM_TYPE_MAIN
◆ HID_ITEM_TYPE_GLOBAL
◆ HID_ITEM_TYPE_LOCAL
◆ HID_ITEM_TYPE_RESERVED
◆ HID_MAIN_ITEM_TAG_INPUT
◆ HID_MAIN_ITEM_TAG_OUTPUT
◆ HID_MAIN_ITEM_TAG_FEATURE
◆ HID_MAIN_ITEM_TAG_BEGIN_COLLECTION
◆ HID_MAIN_ITEM_TAG_END_COLLECTION
◆ HID_MAIN_ITEM_CONSTANT
◆ HID_MAIN_ITEM_VARIABLE
◆ HID_MAIN_ITEM_RELATIVE
◆ HID_MAIN_ITEM_WRAP
◆ HID_MAIN_ITEM_NONLINEAR
◆ HID_MAIN_ITEM_NO_PREFERRED
◆ HID_MAIN_ITEM_NULL_STATE
◆ HID_MAIN_ITEM_VOLATILE
◆ HID_MAIN_ITEM_BUFFERED_BYTE
◆ HID_COLLECTION_PHYSICAL
◆ HID_COLLECTION_APPLICATION
◆ HID_COLLECTION_LOGICAL
◆ HID_GLOBAL_ITEM_TAG_USAGE_PAGE
◆ HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM
◆ HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM
◆ HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM
◆ HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM
◆ HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT
◆ HID_GLOBAL_ITEM_TAG_UNIT
◆ HID_GLOBAL_ITEM_TAG_REPORT_SIZE
◆ HID_GLOBAL_ITEM_TAG_REPORT_ID
◆ HID_GLOBAL_ITEM_TAG_REPORT_COUNT
◆ HID_GLOBAL_ITEM_TAG_PUSH
◆ HID_GLOBAL_ITEM_TAG_POP
◆ HID_LOCAL_ITEM_TAG_USAGE
◆ HID_LOCAL_ITEM_TAG_USAGE_MINIMUM
◆ HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM
◆ HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX
◆ HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM
◆ HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM
◆ HID_LOCAL_ITEM_TAG_STRING_INDEX
◆ HID_LOCAL_ITEM_TAG_STRING_MINIMUM
◆ HID_LOCAL_ITEM_TAG_STRING_MAXIMUM
◆ HID_LOCAL_ITEM_TAG_DELIMITER
◆ HID_INPUT_REPORT
◆ HID_OUTPUT_REPORT
◆ HID_FEATURE_REPORT
◆ EFI_USB_GET_REPORT_REQUEST
◆ EFI_USB_GET_IDLE_REQUEST
◆ EFI_USB_GET_PROTOCOL_REQUEST
◆ EFI_USB_SET_REPORT_REQUEST
◆ EFI_USB_SET_IDLE_REQUEST
◆ EFI_USB_SET_PROTOCOL_REQUEST
Typedef Documentation
◆ EFI_USB_HID_CLASS_DESCRIPTOR
| typedef struct hid_class_descriptor EFI_USB_HID_CLASS_DESCRIPTOR |
Descriptor header for Report/Physical Descriptors HID 1.1, section 6.2.1.
◆ EFI_USB_HID_DESCRIPTOR
| typedef struct hid_descriptor EFI_USB_HID_DESCRIPTOR |
The HID descriptor identifies the length and type of subordinate descriptors for a device.
HID 1.1, section 6.2.1
Enumeration Type Documentation
◆ USB_TYPES_DEFINITION
| enum USB_TYPES_DEFINITION |
Definition at line 195 of file Usb.h.
195 {
196 //
197 // USB request type
198 //
199 USB_REQ_TYPE_STANDARD = (0x00 << 5),
200 USB_REQ_TYPE_CLASS = (0x01 << 5),
201 USB_REQ_TYPE_VENDOR = (0x02 << 5),
202
203 //
204 // Standard control transfer request type, or the value
205 // to fill in EFI_USB_DEVICE_REQUEST.Request
206 //
207 USB_REQ_GET_STATUS = 0x00,
208 USB_REQ_CLEAR_FEATURE = 0x01,
209 USB_REQ_SET_FEATURE = 0x03,
210 USB_REQ_SET_ADDRESS = 0x05,
211 USB_REQ_GET_DESCRIPTOR = 0x06,
212 USB_REQ_SET_DESCRIPTOR = 0x07,
213 USB_REQ_GET_CONFIG = 0x08,
214 USB_REQ_SET_CONFIG = 0x09,
215 USB_REQ_GET_INTERFACE = 0x0A,
216 USB_REQ_SET_INTERFACE = 0x0B,
217 USB_REQ_SYNCH_FRAME = 0x0C,
218
219 //
220 // Usb control transfer target
221 //
222 USB_TARGET_DEVICE = 0,
223 USB_TARGET_INTERFACE = 0x01,
224 USB_TARGET_ENDPOINT = 0x02,
225 USB_TARGET_OTHER = 0x03,
226
227 //
228 // USB Descriptor types
229 //
230 USB_DESC_TYPE_DEVICE = 0x01,
231 USB_DESC_TYPE_CONFIG = 0x02,
232 USB_DESC_TYPE_STRING = 0x03,
233 USB_DESC_TYPE_INTERFACE = 0x04,
234 USB_DESC_TYPE_ENDPOINT = 0x05,
235 USB_DESC_TYPE_INTERFACE_ASSOCIATION = 0x0b,
236 USB_DESC_TYPE_HID = 0x21,
237 USB_DESC_TYPE_REPORT = 0x22,
238 USB_DESC_TYPE_CS_INTERFACE = 0x24,
239 USB_DESC_TYPE_CS_ENDPOINT = 0x25,
240
241 //
242 // Features to be cleared by CLEAR_FEATURE requests
243 //
244 USB_FEATURE_ENDPOINT_HALT = 0,
245
246 //
247 // USB endpoint types: 00: control, 01: isochronous, 10: bulk, 11: interrupt
248 //
249 USB_ENDPOINT_CONTROL = 0x00,
250 USB_ENDPOINT_ISO = 0x01,
251 USB_ENDPOINT_BULK = 0x02,
252 USB_ENDPOINT_INTERRUPT = 0x03,
253
254 USB_ENDPOINT_TYPE_MASK = 0x03,
255 USB_ENDPOINT_DIR_IN = 0x80,
256
257 //
258 // Use 200 ms to increase the error handling response time
259 //
260 EFI_USB_INTERRUPT_DELAY = 2000000
261} USB_TYPES_DEFINITION;
Function Documentation
◆ FILE_LICENCE()
| FILE_LICENCE | ( | BSD2_PATENT | ) |
◆ FILE_SECBOOT()
| FILE_SECBOOT | ( | PERMITTED | ) |
Generated by
1.14.0