2 Common Libarary for PEI USB.
4 Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions
8 of the BSD License which accompanies this distribution. The
9 full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef _PEI_USB_LIB_H_
18 #define _PEI_USB_LIB_H_
20 // Standard device request and request type
21 // By [Spec-USB20/Chapter-9.4]
23 #define USB_DEV_GET_STATUS 0x00
24 #define USB_DEV_GET_STATUS_REQ_TYPE_D 0x80 // Receiver : Device
25 #define USB_DEV_GET_STATUS_REQ_TYPE_I 0x81 // Receiver : Interface
26 #define USB_DEV_GET_STATUS_REQ_TYPE_E 0x82 // Receiver : Endpoint
28 #define USB_DEV_CLEAR_FEATURE 0x01
29 #define USB_DEV_CLEAR_FEATURE_REQ_TYPE_D 0x00 // Receiver : Device
30 #define USB_DEV_CLEAR_FEATURE_REQ_TYPE_I 0x01 // Receiver : Interface
31 #define USB_DEV_CLEAR_FEATURE_REQ_TYPE_E 0x02 // Receiver : Endpoint
33 #define USB_DEV_SET_FEATURE 0x03
34 #define USB_DEV_SET_FEATURE_REQ_TYPE_D 0x00 // Receiver : Device
35 #define USB_DEV_SET_FEATURE_REQ_TYPE_I 0x01 // Receiver : Interface
36 #define USB_DEV_SET_FEATURE_REQ_TYPE_E 0x02 // Receiver : Endpoint
38 #define USB_DEV_SET_ADDRESS 0x05
39 #define USB_DEV_SET_ADDRESS_REQ_TYPE 0x00
41 #define USB_DEV_GET_DESCRIPTOR 0x06
42 #define USB_DEV_GET_DESCRIPTOR_REQ_TYPE 0x80
44 #define USB_DEV_SET_DESCRIPTOR 0x07
45 #define USB_DEV_SET_DESCRIPTOR_REQ_TYPE 0x00
47 #define USB_DEV_GET_CONFIGURATION 0x08
48 #define USB_DEV_GET_CONFIGURATION_REQ_TYPE 0x80
50 #define USB_DEV_SET_CONFIGURATION 0x09
51 #define USB_DEV_SET_CONFIGURATION_REQ_TYPE 0x00
53 #define USB_DEV_GET_INTERFACE 0x0A
54 #define USB_DEV_GET_INTERFACE_REQ_TYPE 0x81
56 #define USB_DEV_SET_INTERFACE 0x0B
57 #define USB_DEV_SET_INTERFACE_REQ_TYPE 0x01
59 #define USB_DEV_SYNCH_FRAME 0x0C
60 #define USB_DEV_SYNCH_FRAME_REQ_TYPE 0x82
63 // USB Descriptor types
65 #define USB_DT_DEVICE 0x01
66 #define USB_DT_CONFIG 0x02
67 #define USB_DT_STRING 0x03
68 #define USB_DT_INTERFACE 0x04
69 #define USB_DT_ENDPOINT 0x05
70 #define USB_DT_HUB 0x29
71 #define USB_DT_HID 0x21
76 #define USB_TYPE_STANDARD (0x00 << 5)
77 #define USB_TYPE_CLASS (0x01 << 5)
78 #define USB_TYPE_VENDOR (0x02 << 5)
79 #define USB_TYPE_RESERVED (0x03 << 5)
82 // USB request targer device
84 #define USB_RECIP_DEVICE 0x00
85 #define USB_RECIP_INTERFACE 0x01
86 #define USB_RECIP_ENDPOINT 0x02
87 #define USB_RECIP_OTHER 0x03
91 EfiUsbDeviceRemoteWakeup
92 } EFI_USB_STANDARD_FEATURE_SELECTOR
;
95 // Usb Data recipient type
105 Clear a given usb feature.
107 @param PeiServices General-purpose services that are available to every PEIM.
108 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
109 @param Recipient The recipient of ClearFeature Request, should be one of Device/Interface/Endpoint.
110 @param Value Request Value.
111 @param Target Request Index.
113 @retval EFI_SUCCESS Usb feature is cleared successfully.
114 @retval EFI_DEVICE_ERROR Cannot clear the usb feature due to a hardware error.
115 @retval Others Other failure occurs.
119 PeiUsbClearDeviceFeature (
120 IN EFI_PEI_SERVICES
**PeiServices
,
121 IN PEI_USB_IO_PPI
*UsbIoPpi
,
122 IN EFI_USB_RECIPIENT Recipient
,
131 @param PeiServices General-purpose services that are available to every PEIM.
132 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
133 @param EndpointAddress The endpoint address.
135 @retval EFI_SUCCESS Endpoint halt is cleared successfully.
136 @retval EFI_DEVICE_ERROR Cannot clear the endpoint halt status due to a hardware error.
137 @retval Others Other failure occurs.
141 PeiUsbClearEndpointHalt (
142 IN EFI_PEI_SERVICES
**PeiServices
,
143 IN PEI_USB_IO_PPI
*UsbIoPpi
,
144 IN UINT8 EndpointAddress