4b1bf81c20
Signed-off-by: jljusten Reviewed-by: mdkinney Reviewed-by: geekboy15a git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11901 6f19259b-4bc3-4df7-8a09-765794883524
538 lines
14 KiB
C
538 lines
14 KiB
C
/** @file
|
|
Usb Hub Request Support In PEI Phase
|
|
|
|
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
|
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions
|
|
of the BSD License which accompanies this distribution. The
|
|
full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include "UsbPeim.h"
|
|
#include "HubPeim.h"
|
|
#include "PeiUsbLib.h"
|
|
|
|
/**
|
|
Get a given hub port status.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param Port Usb hub port number (starting from 1).
|
|
@param PortStatus Current Hub port status and change status.
|
|
|
|
@retval EFI_SUCCESS Port status is obtained successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot get the port status due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiHubGetPortStatus (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINT8 Port,
|
|
OUT UINT32 *PortStatus
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DeviceRequest;
|
|
|
|
ZeroMem (&DeviceRequest, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DeviceRequest.RequestType = USB_HUB_GET_PORT_STATUS_REQ_TYPE;
|
|
DeviceRequest.Request = USB_HUB_GET_PORT_STATUS;
|
|
DeviceRequest.Index = Port;
|
|
DeviceRequest.Length = (UINT16) sizeof (UINT32);
|
|
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DeviceRequest,
|
|
EfiUsbDataIn,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
PortStatus,
|
|
sizeof (UINT32)
|
|
);
|
|
|
|
}
|
|
|
|
/**
|
|
Set specified feature to a given hub port.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param Port Usb hub port number (starting from 1).
|
|
@param Value New feature value.
|
|
|
|
@retval EFI_SUCCESS Port feature is set successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot set the port feature due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiHubSetPortFeature (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINT8 Port,
|
|
IN UINT8 Value
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DeviceRequest;
|
|
|
|
ZeroMem (&DeviceRequest, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DeviceRequest.RequestType = USB_HUB_SET_PORT_FEATURE_REQ_TYPE;
|
|
DeviceRequest.Request = USB_HUB_SET_PORT_FEATURE;
|
|
DeviceRequest.Value = Value;
|
|
DeviceRequest.Index = Port;
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DeviceRequest,
|
|
EfiUsbNoData,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
NULL,
|
|
0
|
|
);
|
|
}
|
|
|
|
/**
|
|
Clear specified feature on a given hub port.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param Port Usb hub port number (starting from 1).
|
|
@param Value Feature value that will be cleared from the hub port.
|
|
|
|
@retval EFI_SUCCESS Port feature is cleared successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot clear the port feature due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiHubClearPortFeature (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINT8 Port,
|
|
IN UINT8 Value
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DeviceRequest;
|
|
|
|
ZeroMem (&DeviceRequest, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DeviceRequest.RequestType = USB_HUB_CLEAR_FEATURE_PORT_REQ_TYPE;
|
|
DeviceRequest.Request = USB_HUB_CLEAR_FEATURE_PORT;
|
|
DeviceRequest.Value = Value;
|
|
DeviceRequest.Index = Port;
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DeviceRequest,
|
|
EfiUsbNoData,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
NULL,
|
|
0
|
|
);
|
|
}
|
|
|
|
/**
|
|
Get a given hub status.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param HubStatus Current Hub status and change status.
|
|
|
|
@retval EFI_SUCCESS Hub status is obtained successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot get the hub status due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiHubGetHubStatus (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
OUT UINT32 *HubStatus
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DeviceRequest;
|
|
|
|
ZeroMem (&DeviceRequest, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DeviceRequest.RequestType = USB_HUB_GET_HUB_STATUS_REQ_TYPE;
|
|
DeviceRequest.Request = USB_HUB_GET_HUB_STATUS;
|
|
DeviceRequest.Length = (UINT16) sizeof (UINT32);
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DeviceRequest,
|
|
EfiUsbDataIn,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
HubStatus,
|
|
sizeof (UINT32)
|
|
);
|
|
}
|
|
|
|
/**
|
|
Set specified feature to a given hub.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param Value New feature value.
|
|
|
|
@retval EFI_SUCCESS Port feature is set successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot set the port feature due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiHubSetHubFeature (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINT8 Value
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DeviceRequest;
|
|
|
|
ZeroMem (&DeviceRequest, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DeviceRequest.RequestType = USB_HUB_SET_HUB_FEATURE_REQ_TYPE;
|
|
DeviceRequest.Request = USB_HUB_SET_HUB_FEATURE;
|
|
DeviceRequest.Value = Value;
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DeviceRequest,
|
|
EfiUsbNoData,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
NULL,
|
|
0
|
|
);
|
|
}
|
|
|
|
/**
|
|
Clear specified feature on a given hub.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param Value Feature value that will be cleared from the hub port.
|
|
|
|
@retval EFI_SUCCESS Hub feature is cleared successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot clear the hub feature due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiHubClearHubFeature (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINT8 Value
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DeviceRequest;
|
|
|
|
ZeroMem (&DeviceRequest, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DeviceRequest.RequestType = USB_HUB_CLEAR_FEATURE_REQ_TYPE;
|
|
DeviceRequest.Request = USB_HUB_CLEAR_FEATURE;
|
|
DeviceRequest.Value = Value;
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DeviceRequest,
|
|
EfiUsbNoData,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
NULL,
|
|
0
|
|
);
|
|
}
|
|
|
|
/**
|
|
Get a given hub descriptor.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param DescriptorSize The length of Hub Descriptor buffer.
|
|
@param HubDescriptor Caller allocated buffer to store the hub descriptor if
|
|
successfully returned.
|
|
|
|
@retval EFI_SUCCESS Hub descriptor is obtained successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot get the hub descriptor due to a hardware error.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiGetHubDescriptor (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINTN DescriptorSize,
|
|
OUT EFI_USB_HUB_DESCRIPTOR *HubDescriptor
|
|
)
|
|
{
|
|
EFI_USB_DEVICE_REQUEST DevReq;
|
|
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
|
|
|
|
//
|
|
// Fill Device request packet
|
|
//
|
|
DevReq.RequestType = USB_RT_HUB | 0x80;
|
|
DevReq.Request = USB_HUB_GET_DESCRIPTOR;
|
|
DevReq.Value = USB_DT_HUB << 8;
|
|
DevReq.Length = (UINT16)DescriptorSize;
|
|
|
|
return UsbIoPpi->UsbControlTransfer (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
&DevReq,
|
|
EfiUsbDataIn,
|
|
PcdGet32 (PcdUsbTransferTimeoutValue),
|
|
HubDescriptor,
|
|
(UINT16)DescriptorSize
|
|
);
|
|
}
|
|
|
|
/**
|
|
Configure a given hub.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param PeiUsbDevice Indicating the hub controller device that will be configured
|
|
|
|
@retval EFI_SUCCESS Hub configuration is done successfully.
|
|
@retval EFI_DEVICE_ERROR Cannot configure the hub due to a hardware error.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
PeiDoHubConfig (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_DEVICE *PeiUsbDevice
|
|
)
|
|
{
|
|
EFI_USB_HUB_DESCRIPTOR HubDescriptor;
|
|
EFI_STATUS Status;
|
|
EFI_USB_HUB_STATUS HubStatus;
|
|
UINTN Index;
|
|
UINT32 PortStatus;
|
|
PEI_USB_IO_PPI *UsbIoPpi;
|
|
|
|
ZeroMem (&HubDescriptor, sizeof (HubDescriptor));
|
|
UsbIoPpi = &PeiUsbDevice->UsbIoPpi;
|
|
|
|
//
|
|
// First get the hub descriptor length
|
|
//
|
|
Status = PeiGetHubDescriptor (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
2,
|
|
&HubDescriptor
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
return EFI_DEVICE_ERROR;
|
|
}
|
|
//
|
|
// First get the whole descriptor, then
|
|
// get the number of hub ports
|
|
//
|
|
Status = PeiGetHubDescriptor (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
HubDescriptor.Length,
|
|
&HubDescriptor
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
return EFI_DEVICE_ERROR;
|
|
}
|
|
|
|
PeiUsbDevice->DownStreamPortNo = HubDescriptor.NbrPorts;
|
|
|
|
Status = PeiHubGetHubStatus (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
(UINT32 *) &HubStatus
|
|
);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
return EFI_DEVICE_ERROR;
|
|
}
|
|
//
|
|
// Get all hub ports status
|
|
//
|
|
for (Index = 0; Index < PeiUsbDevice->DownStreamPortNo; Index++) {
|
|
|
|
Status = PeiHubGetPortStatus (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
(UINT8) (Index + 1),
|
|
&PortStatus
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
continue;
|
|
}
|
|
}
|
|
//
|
|
// Power all the hub ports
|
|
//
|
|
for (Index = 0; Index < PeiUsbDevice->DownStreamPortNo; Index++) {
|
|
Status = PeiHubSetPortFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
(UINT8) (Index + 1),
|
|
EfiUsbPortPower
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
continue;
|
|
}
|
|
}
|
|
//
|
|
// Clear Hub Status Change
|
|
//
|
|
Status = PeiHubGetHubStatus (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
(UINT32 *) &HubStatus
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
return EFI_DEVICE_ERROR;
|
|
} else {
|
|
//
|
|
// Hub power supply change happens
|
|
//
|
|
if ((HubStatus.HubChangeStatus & HUB_CHANGE_LOCAL_POWER) != 0) {
|
|
PeiHubClearHubFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
C_HUB_LOCAL_POWER
|
|
);
|
|
}
|
|
//
|
|
// Hub change overcurrent happens
|
|
//
|
|
if ((HubStatus.HubChangeStatus & HUB_CHANGE_OVERCURRENT) != 0) {
|
|
PeiHubClearHubFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
C_HUB_OVER_CURRENT
|
|
);
|
|
}
|
|
}
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Send reset signal over the given root hub port.
|
|
|
|
@param PeiServices General-purpose services that are available to every PEIM.
|
|
@param UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
|
|
@param PortNum Usb hub port number (starting from 1).
|
|
|
|
**/
|
|
VOID
|
|
PeiResetHubPort (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_USB_IO_PPI *UsbIoPpi,
|
|
IN UINT8 PortNum
|
|
)
|
|
{
|
|
UINT8 Try;
|
|
EFI_USB_PORT_STATUS HubPortStatus;
|
|
|
|
|
|
MicroSecondDelay (100 * 1000);
|
|
|
|
//
|
|
// reset root port
|
|
//
|
|
PeiHubSetPortFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
PortNum,
|
|
EfiUsbPortReset
|
|
);
|
|
|
|
Try = 10;
|
|
do {
|
|
PeiHubGetPortStatus (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
PortNum,
|
|
(UINT32 *) &HubPortStatus
|
|
);
|
|
|
|
MicroSecondDelay (2 * 1000);
|
|
Try -= 1;
|
|
} while ((HubPortStatus.PortChangeStatus & USB_PORT_STAT_C_RESET) == 0 && Try > 0);
|
|
|
|
//
|
|
// clear reset root port
|
|
//
|
|
PeiHubClearPortFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
PortNum,
|
|
EfiUsbPortReset
|
|
);
|
|
|
|
MicroSecondDelay (1 * 1000);
|
|
|
|
PeiHubClearPortFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
PortNum,
|
|
EfiUsbPortConnectChange
|
|
);
|
|
|
|
//
|
|
// Set port enable
|
|
//
|
|
PeiHubSetPortFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
PortNum,
|
|
EfiUsbPortEnable
|
|
);
|
|
|
|
//
|
|
// Clear any change status
|
|
//
|
|
|
|
PeiHubClearPortFeature (
|
|
PeiServices,
|
|
UsbIoPpi,
|
|
PortNum,
|
|
EfiUsbPortEnableChange
|
|
);
|
|
|
|
MicroSecondDelay (10 * 1000);
|
|
|
|
return;
|
|
}
|