2 Common Libarary for PEI USB
4 Copyright (c) 2006 - 2010, 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.
18 #include "PeiUsbLib.h"
21 Get a given usb descriptor.
23 @param PeiServices General-purpose services that are available to every PEIM.
24 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
25 @param Value Request Value.
26 @param Index Request Index.
27 @param DescriptorLength Request descriptor Length.
28 @param Descriptor Request descriptor.
31 @retval EFI_SUCCESS Usb descriptor is obtained successfully.
32 @retval EFI_DEVICE_ERROR Cannot get the usb descriptor due to a hardware error.
33 @retval Others Other failure occurs.
38 IN EFI_PEI_SERVICES
**PeiServices
,
39 IN PEI_USB_IO_PPI
*UsbIoPpi
,
42 IN UINT16 DescriptorLength
,
46 EFI_USB_DEVICE_REQUEST DevReq
;
48 ASSERT (UsbIoPpi
!= NULL
);
50 DevReq
.RequestType
= USB_DEV_GET_DESCRIPTOR_REQ_TYPE
;
51 DevReq
.Request
= USB_DEV_GET_DESCRIPTOR
;
54 DevReq
.Length
= DescriptorLength
;
56 return UsbIoPpi
->UsbControlTransfer (
61 PcdGet32 (PcdUsbTransferTimeoutValue
),
68 Set a usb device with a specified address.
70 @param PeiServices General-purpose services that are available to every PEIM.
71 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
72 @param AddressValue The address to assign.
74 @retval EFI_SUCCESS Usb device address is set successfully.
75 @retval EFI_DEVICE_ERROR Cannot set the usb address due to a hardware error.
76 @retval Others Other failure occurs.
80 PeiUsbSetDeviceAddress (
81 IN EFI_PEI_SERVICES
**PeiServices
,
82 IN PEI_USB_IO_PPI
*UsbIoPpi
,
83 IN UINT16 AddressValue
86 EFI_USB_DEVICE_REQUEST DevReq
;
88 ASSERT (UsbIoPpi
!= NULL
);
90 DevReq
.RequestType
= USB_DEV_SET_ADDRESS_REQ_TYPE
;
91 DevReq
.Request
= USB_DEV_SET_ADDRESS
;
92 DevReq
.Value
= AddressValue
;
96 return UsbIoPpi
->UsbControlTransfer (
101 PcdGet32 (PcdUsbTransferTimeoutValue
),
108 Clear a given usb feature.
110 @param PeiServices General-purpose services that are available to every PEIM.
111 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
112 @param Recipient The recipient of ClearFeature Request, should be one of Device/Interface/Endpoint.
113 @param Value Request Value.
114 @param Target Request Index.
116 @retval EFI_SUCCESS Usb feature is cleared successfully.
117 @retval EFI_DEVICE_ERROR Cannot clear the usb feature due to a hardware error.
118 @retval Others Other failure occurs.
122 PeiUsbClearDeviceFeature (
123 IN EFI_PEI_SERVICES
**PeiServices
,
124 IN PEI_USB_IO_PPI
*UsbIoPpi
,
125 IN EFI_USB_RECIPIENT Recipient
,
130 EFI_USB_DEVICE_REQUEST DevReq
;
132 ASSERT (UsbIoPpi
!= NULL
);
136 DevReq
.RequestType
= USB_DEV_CLEAR_FEATURE_REQ_TYPE_D
;
139 case EfiUsbInterface
:
140 DevReq
.RequestType
= USB_DEV_CLEAR_FEATURE_REQ_TYPE_I
;
144 DevReq
.RequestType
= USB_DEV_CLEAR_FEATURE_REQ_TYPE_E
;
148 DevReq
.Request
= USB_DEV_CLEAR_FEATURE
;
149 DevReq
.Value
= Value
;
150 DevReq
.Index
= Target
;
153 return UsbIoPpi
->UsbControlTransfer (
158 PcdGet32 (PcdUsbTransferTimeoutValue
),
165 Configure a usb device to Configuration 1.
167 @param PeiServices General-purpose services that are available to every PEIM.
168 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
170 @retval EFI_SUCCESS Usb device is set to use Configuration 1 successfully.
171 @retval EFI_DEVICE_ERROR Cannot set the usb device due to a hardware error.
172 @retval Others Other failure occurs.
176 PeiUsbSetConfiguration (
177 IN EFI_PEI_SERVICES
**PeiServices
,
178 IN PEI_USB_IO_PPI
*UsbIoPpi
181 EFI_USB_DEVICE_REQUEST DevReq
;
182 ZeroMem (&DevReq
, sizeof (EFI_USB_DEVICE_REQUEST
));
184 DevReq
.RequestType
= USB_DEV_SET_CONFIGURATION_REQ_TYPE
;
185 DevReq
.Request
= USB_DEV_SET_CONFIGURATION
;
188 return UsbIoPpi
->UsbControlTransfer (
193 PcdGet32 (PcdUsbTransferTimeoutValue
),
202 @param PeiServices General-purpose services that are available to every PEIM.
203 @param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
204 @param EndpointAddress The endpoint address.
206 @retval EFI_SUCCESS Endpoint halt is cleared successfully.
207 @retval EFI_DEVICE_ERROR Cannot clear the endpoint halt status due to a hardware error.
208 @retval Others Other failure occurs.
212 PeiUsbClearEndpointHalt (
213 IN EFI_PEI_SERVICES
**PeiServices
,
214 IN PEI_USB_IO_PPI
*UsbIoPpi
,
215 IN UINT8 EndpointAddress
219 PEI_USB_DEVICE
*PeiUsbDev
;
220 EFI_USB_ENDPOINT_DESCRIPTOR
*EndpointDescriptor
;
224 PeiUsbDev
= PEI_USB_DEVICE_FROM_THIS (UsbIoPpi
);
226 while (EndpointIndex
< MAX_ENDPOINT
) {
227 Status
= UsbIoPpi
->UsbGetEndpointDescriptor (PeiServices
, UsbIoPpi
, EndpointIndex
, &EndpointDescriptor
);
228 if (EFI_ERROR (Status
)) {
229 return EFI_INVALID_PARAMETER
;
232 if (EndpointDescriptor
->EndpointAddress
== EndpointAddress
) {
239 if (EndpointIndex
== MAX_ENDPOINT
) {
240 return EFI_INVALID_PARAMETER
;
243 Status
= PeiUsbClearDeviceFeature (
252 // set data toggle to zero.
254 if ((PeiUsbDev
->DataToggle
& (1 << EndpointIndex
)) != 0) {
255 PeiUsbDev
->DataToggle
= (UINT8
) (PeiUsbDev
->DataToggle
^ (1 << EndpointIndex
));
262 Judge if the port is connected with a usb device or not.
264 @param PortStatus The usb port status gotten.
266 @retval TRUE A usb device is connected with the port.
267 @retval FALSE No usb device is connected with the port.
276 // return the bit 0 value of PortStatus
278 if ((PortStatus
& USB_PORT_STAT_CONNECTION
) != 0) {
286 Judge if the port is connected with a low-speed usb device or not.
288 @param PortStatus The usb port status gotten.
290 @retval TRUE A low-speed usb device is connected with the port.
291 @retval FALSE No low-speed usb device is connected with the port.
295 IsPortLowSpeedDeviceAttached (
300 // return the bit 9 value of PortStatus
302 if ((PortStatus
& USB_PORT_STAT_LOW_SPEED
) != 0) {
303 return EFI_USB_SPEED_LOW
;
304 } else if ((PortStatus
& USB_PORT_STAT_HIGH_SPEED
) != 0){
305 return EFI_USB_SPEED_HIGH
;
307 return EFI_USB_SPEED_FULL
;
312 Judge if the port is in "connection change" status or not.
314 @param PortChangeStatus The usb port change status gotten.
316 @retval TRUE The port is in "connection change" status.
317 @retval FALSE The port is NOT in "connection change" status.
321 IsPortConnectChange (
322 IN UINT16 PortChangeStatus
326 // return the bit 0 value of PortChangeStatus
328 if ((PortChangeStatus
& USB_PORT_STAT_C_CONNECTION
) != 0) {