From 4b738c76f56f8eda171f14b8f9b20e34b66be476 Mon Sep 17 00:00:00 2001 From: "Tian, Hot" Date: Wed, 22 Jan 2014 08:38:50 +0000 Subject: [PATCH] Fix CRLF format Signed-off-by: Tian, Hot git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15155 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Ata/AtaAtapiPassThru/AtaAtapiPassThru.h | 2598 +++++----- .../Pci/NvmExpressDxe/NvmExpressDiskInfo.c | 324 +- .../Pci/NvmExpressDxe/NvmExpressDiskInfo.h | 258 +- MdeModulePkg/Bus/Pci/XhciDxe/Xhci.c | 4410 ++++++++--------- MdeModulePkg/Include/Library/TcpIoLib.h | 118 +- .../Library/DxeTcpIoLib/DxeTcpIoLib.c | 424 +- .../Universal/DebugSupportDxe/X64/AsmFuncs.S | 1102 ++-- .../Network/UefiPxeBcDxe/PxeBcDriver.c | 16 +- .../Network/UefiPxeBcDxe/PxeBcImpl.h | 2 +- .../Variable/RuntimeDxe/VariableSmm.inf | 194 +- 10 files changed, 4723 insertions(+), 4723 deletions(-) diff --git a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h index 1d50c30d7b..0d93e54467 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h @@ -1,1299 +1,1299 @@ -/** @file - Header file for ATA/ATAPI PASS THRU driver. - - Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.
- 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. - -**/ -#ifndef __ATA_ATAPI_PASS_THRU_H__ -#define __ATA_ATAPI_PASS_THRU_H__ - -#include - -#include -#include -#include - -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "IdeMode.h" -#include "AhciMode.h" - -extern EFI_DRIVER_BINDING_PROTOCOL gAtaAtapiPassThruDriverBinding; -extern EFI_COMPONENT_NAME_PROTOCOL gAtaAtapiPassThruComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gAtaAtapiPassThruComponentName2; - -#define ATA_ATAPI_PASS_THRU_SIGNATURE SIGNATURE_32 ('a', 'a', 'p', 't') -#define ATA_ATAPI_DEVICE_SIGNATURE SIGNATURE_32 ('a', 'd', 'e', 'v') -#define ATA_NONBLOCKING_TASK_SIGNATURE SIGNATURE_32 ('a', 't', 's', 'k') - -typedef struct _ATA_NONBLOCK_TASK ATA_NONBLOCK_TASK; - -typedef enum { - EfiAtaIdeMode, - EfiAtaAhciMode, - EfiAtaRaidMode, - EfiAtaUnknownMode -} EFI_ATA_HC_WORK_MODE; - -typedef enum { - EfiIdeCdrom, /* ATAPI CDROM */ - EfiIdeHarddisk, /* Hard Disk */ - EfiPortMultiplier, /* Port Multiplier */ - EfiIdeUnknown -} EFI_ATA_DEVICE_TYPE; - -// -// Ahci mode device info -// -typedef struct { - UINT32 Signature; - LIST_ENTRY Link; - - UINT16 Port; - UINT16 PortMultiplier; - EFI_ATA_DEVICE_TYPE Type; - - EFI_IDENTIFY_DATA *IdentifyData; -} EFI_ATA_DEVICE_INFO; - -typedef struct { - UINT32 Signature; - - EFI_HANDLE ControllerHandle; - EFI_PCI_IO_PROTOCOL *PciIo; - EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit; - - EFI_ATA_PASS_THRU_MODE AtaPassThruMode; - EFI_ATA_PASS_THRU_PROTOCOL AtaPassThru; - EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode; - EFI_EXT_SCSI_PASS_THRU_PROTOCOL ExtScsiPassThru; - - EFI_ATA_HC_WORK_MODE Mode; - - EFI_IDE_REGISTERS IdeRegisters[EfiIdeMaxChannel]; - EFI_AHCI_REGISTERS AhciRegisters; - - // - // The attached device list - // - LIST_ENTRY DeviceList; - UINT64 OriginalPciAttributes; - - // - // For AtaPassThru protocol, using the following bytes to record the previous call in - // GetNextPort()/GetNextDevice(). - // - UINT16 PreviousPort; - UINT16 PreviousPortMultiplier; - // - // For ExtScsiPassThru protocol, using the following bytes to record the previous call in - // GetNextTarget()/GetNextTargetLun(). - // - UINT16 PreviousTargetId; - UINT64 PreviousLun; - - // - // For Non-blocking. - // - EFI_EVENT TimerEvent; - LIST_ENTRY NonBlockingTaskList; -} ATA_ATAPI_PASS_THRU_INSTANCE; - -// -// Task for Non-blocking mode. -// -struct _ATA_NONBLOCK_TASK { - UINT32 Signature; - LIST_ENTRY Link; - - UINT16 Port; - UINT16 PortMultiplier; - EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet; - BOOLEAN IsStart; - EFI_EVENT Event; - UINT64 RetryTimes; - VOID *Map; // Pointer to map. - VOID *TableMap;// Pointer to PRD table map. - EFI_ATA_DMA_PRD *MapBaseAddress; // Pointer to range Base address for Map. - UINTN PageCount; // The page numbers used by PCIO freebuffer. -}; - -// -// Timeout value which uses 100ns as a unit. -// It means 3 second span. -// -#define ATA_ATAPI_TIMEOUT EFI_TIMER_PERIOD_SECONDS(3) - -#define IS_ALIGNED(addr, size) (((UINTN) (addr) & (size - 1)) == 0) - -#define ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \ - CR (a, \ - ATA_ATAPI_PASS_THRU_INSTANCE, \ - AtaPassThru, \ - ATA_ATAPI_PASS_THRU_SIGNATURE \ - ) - -#define EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \ - CR (a, \ - ATA_ATAPI_PASS_THRU_INSTANCE, \ - ExtScsiPassThru, \ - ATA_ATAPI_PASS_THRU_SIGNATURE \ - ) - -#define ATA_ATAPI_DEVICE_INFO_FROM_THIS(a) \ - CR (a, \ - EFI_ATA_DEVICE_INFO, \ - Link, \ - ATA_ATAPI_DEVICE_SIGNATURE \ - ); - -#define ATA_NON_BLOCK_TASK_FROM_ENTRY(a) \ - CR (a, \ - ATA_NONBLOCK_TASK, \ - Link, \ - ATA_NONBLOCKING_TASK_SIGNATURE \ - ); - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param DriverName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -AtaAtapiPassThruComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param ControllerHandle[in] The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param ChildHandle[in] The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param ControllerName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -AtaAtapiPassThruComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - -/** - Tests to see if this driver supports a given controller. If a child device is provided, - it further tests to see if this driver supports creating a handle for the specified child device. - - This function checks to see if the driver specified by This supports the device specified by - ControllerHandle. Drivers will typically use the device path attached to - ControllerHandle and/or the services from the bus I/O abstraction attached to - ControllerHandle to determine if the driver supports ControllerHandle. This function - may be called many times during platform initialization. In order to reduce boot times, the tests - performed by this function must be very small, and take as little time as possible to execute. This - function must not change the state of any hardware devices, and this function must be aware that the - device specified by ControllerHandle may already be managed by the same driver or a - different driver. This function must match its calls to AllocatePages() with FreePages(), - AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). - Because ControllerHandle may have been previously started by the same driver, if a protocol is - already in the opened state, then it must not be closed with CloseProtocol(). This is required - to guarantee the state of ControllerHandle is not modified by this function. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to test. This handle - must support a protocol interface that supplies - an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This - parameter is ignored by device drivers, and is optional for bus - drivers. For bus drivers, if this parameter is not NULL, then - the bus driver must determine if the bus controller specified - by ControllerHandle and the child controller specified - by RemainingDevicePath are both supported by this - bus driver. - - @retval EFI_SUCCESS The device specified by ControllerHandle and - RemainingDevicePath is supported by the driver specified by This. - @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and - RemainingDevicePath is already being managed by the driver - specified by This. - @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and - RemainingDevicePath is already being managed by a different - driver or an application that requires exclusive access. - Currently not implemented. - @retval EFI_UNSUPPORTED The device specified by ControllerHandle and - RemainingDevicePath is not supported by the driver specified by This. -**/ -EFI_STATUS -EFIAPI -AtaAtapiPassThruSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ); - -/** - Starts a device controller or a bus controller. - - The Start() function is designed to be invoked from the EFI boot service ConnectController(). - As a result, much of the error checking on the parameters to Start() has been moved into this - common boot service. It is legal to call Start() from other locations, - but the following calling restrictions must be followed, or the system behavior will not be deterministic. - 1. ControllerHandle must be a valid EFI_HANDLE. - 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned - EFI_DEVICE_PATH_PROTOCOL. - 3. Prior to calling Start(), the Supported() function for the driver specified by This must - have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to start. This handle - must support a protocol interface that supplies - an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This - parameter is ignored by device drivers, and is optional for bus - drivers. For a bus driver, if this parameter is NULL, then handles - for all the children of Controller are created by this driver. - If this parameter is not NULL and the first Device Path Node is - not the End of Device Path Node, then only the handle for the - child device specified by the first Device Path Node of - RemainingDevicePath is created by this driver. - If the first Device Path Node of RemainingDevicePath is - the End of Device Path Node, no child handle is created by this - driver. - - @retval EFI_SUCCESS The device was started. - @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval Others The driver failded to start the device. - -**/ -EFI_STATUS -EFIAPI -AtaAtapiPassThruStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ); - -/** - Stops a device controller or a bus controller. - - The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). - As a result, much of the error checking on the parameters to Stop() has been moved - into this common boot service. It is legal to call Stop() from other locations, - but the following calling restrictions must be followed, or the system behavior will not be deterministic. - 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this - same driver's Start() function. - 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid - EFI_HANDLE. In addition, all of these handles must have been created in this driver's - Start() function, and the Start() function must have called OpenProtocol() on - ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle A handle to the device being stopped. The handle must - support a bus specific I/O protocol for the driver - to use to stop the device. - @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. - @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL - if NumberOfChildren is 0. - - @retval EFI_SUCCESS The device was stopped. - @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. - -**/ -EFI_STATUS -EFIAPI -AtaAtapiPassThruStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -/** - Traverse the attached ATA devices list to find out the device to access. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - @param[in] Port The port number of the ATA device to send the command. - @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. - If there is no port multiplier, then specify 0. - @param[in] DeviceType The device type of the ATA device. - - @retval The pointer to the data structure of the device info to access. - -**/ -LIST_ENTRY * -EFIAPI -SearchDeviceInfoList ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, - IN UINT16 Port, - IN UINT16 PortMultiplier, - IN EFI_ATA_DEVICE_TYPE DeviceType - ); - -/** - Allocate device info data structure to contain device info. - And insert the data structure to the tail of device list for tracing. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - @param[in] Port The port number of the ATA device to send the command. - @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. - If there is no port multiplier, then specify 0. - @param[in] DeviceType The device type of the ATA device. - @param[in] IdentifyData The data buffer to store the output of the IDENTIFY cmd. - - @retval EFI_SUCCESS Successfully insert the ata device to the tail of device list. - @retval EFI_OUT_OF_RESOURCES Can not allocate enough resource for use. - -**/ -EFI_STATUS -EFIAPI -CreateNewDeviceInfo ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, - IN UINT16 Port, - IN UINT16 PortMultiplier, - IN EFI_ATA_DEVICE_TYPE DeviceType, - IN EFI_IDENTIFY_DATA *IdentifyData - ); - -/** - Destroy all attached ATA devices info. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - -**/ -VOID -EFIAPI -DestroyDeviceInfoList ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance - ); - -/** - Destroy all pending non blocking tasks. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - @param[in] IsSigEvent Indicate whether signal the task event when remove the - task. - -**/ -VOID -EFIAPI -DestroyAsynTaskList ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, - IN BOOLEAN IsSigEvent - ); - -/** - Enumerate all attached ATA devices at IDE mode or AHCI mode separately. - - The function is designed to enumerate all attached ATA devices. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - - @retval EFI_SUCCESS Successfully enumerate attached ATA devices. - @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. - -**/ -EFI_STATUS -EFIAPI -EnumerateAttachedDevice ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance - ); - -/** - Call back funtion when the timer event is signaled. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registered to the - Event. - -**/ -VOID -EFIAPI -AsyncNonBlockingTransferRoutine ( - EFI_EVENT Event, - VOID* Context - ); - -/** - Sends an ATA command to an ATA device that is attached to the ATA controller. This function - supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required, - and the non-blocking I/O functionality is optional. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] Port The port number of the ATA device to send the command. - @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. - If there is no port multiplier, then specify 0. - @param[in, out] Packet A pointer to the ATA command to send to the ATA device specified by Port - and PortMultiplierPort. - @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking - I/O is performed. If Event is NULL, then blocking I/O is performed. If - Event is not NULL and non blocking I/O is supported, then non-blocking - I/O is performed, and Event will be signaled when the ATA command completes. - - @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands, - InTransferLength bytes were transferred from InDataBuffer. For write and - bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. - @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred - is returned in InTransferLength. For write and bi-directional commands, - OutTransferLength bytes were transferred by OutDataBuffer. - @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands - already queued. The caller may retry again later. - @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the ATA command. - @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA - command was not sent, so no additional status information is available. - -**/ -EFI_STATUS -EFIAPI -AtaPassThruPassThru ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN UINT16 Port, - IN UINT16 PortMultiplierPort, - IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet, - IN EFI_EVENT Event OPTIONAL - ); - -/** - Used to retrieve the list of legal port numbers for ATA devices on an ATA controller. - These can either be the list of ports where ATA devices are actually present or the - list of legal port numbers for the ATA controller. Regardless, the caller of this - function must probe the port number returned to see if an ATA device is actually - present at that location on the ATA controller. - - The GetNextPort() function retrieves the port number on an ATA controller. If on input - Port is 0xFFFF, then the port number of the first port on the ATA controller is returned - in Port and EFI_SUCCESS is returned. - - If Port is a port number that was returned on a previous call to GetNextPort(), then the - port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS - is returned. If Port is not 0xFFFF and Port was not returned on a previous call to - GetNextPort(), then EFI_INVALID_PARAMETER is returned. - - If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is - returned. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in, out] Port On input, a pointer to the port number on the ATA controller. - On output, a pointer to the next port number on the ATA - controller. An input value of 0xFFFF retrieves the first port - number on the ATA controller. - - @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port. - @retval EFI_NOT_FOUND There are no more ports on this ATA controller. - @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call - to GetNextPort(). - -**/ -EFI_STATUS -EFIAPI -AtaPassThruGetNextPort ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN OUT UINT16 *Port - ); - -/** - Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA - controller. These can either be the list of port multiplier ports where ATA devices are actually - present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this - function must probe the port number and port multiplier port number returned to see if an ATA - device is actually present. - - The GetNextDevice() function retrieves the port multiplier port number of an ATA device - present on a port of an ATA controller. - - If PortMultiplierPort points to a port multiplier port number value that was returned on a - previous call to GetNextDevice(), then the port multiplier port number of the next ATA device - on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is - returned. - - If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first - ATA device on port of the ATA controller is returned in PortMultiplierPort and - EFI_SUCCESS is returned. - - If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort - was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER - is returned. - - If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of - the ATA controller, then EFI_NOT_FOUND is returned. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] Port The port number present on the ATA controller. - @param[in, out] PortMultiplierPort On input, a pointer to the port multiplier port number of an - ATA device present on the ATA controller. - If on input a PortMultiplierPort of 0xFFFF is specified, - then the port multiplier port number of the first ATA device - is returned. On output, a pointer to the port multiplier port - number of the next ATA device present on an ATA controller. - - @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port - of the ATA controller was returned in PortMultiplierPort. - @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller. - @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not - returned on a previous call to GetNextDevice(). - -**/ -EFI_STATUS -EFIAPI -AtaPassThruGetNextDevice ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN UINT16 Port, - IN OUT UINT16 *PortMultiplierPort - ); - -/** - Used to allocate and build a device path node for an ATA device on an ATA controller. - - The BuildDevicePath() function allocates and builds a single device node for the ATA - device specified by Port and PortMultiplierPort. If the ATA device specified by Port and - PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned. - If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough - resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned. - - Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of - DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort, - and EFI_SUCCESS is returned. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] Port Port specifies the port number of the ATA device for which a - device path node is to be allocated and built. - @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a - device path node is to be allocated and built. If there is no - port multiplier, then specify 0. - @param[in, out] DevicePath A pointer to a single device path node that describes the ATA - device specified by Port and PortMultiplierPort. This function - is responsible for allocating the buffer DevicePath with the - boot service AllocatePool(). It is the caller's responsibility - to free DevicePath when the caller is finished with DevicePath. - @retval EFI_SUCCESS The device path node that describes the ATA device specified by - Port and PortMultiplierPort was allocated and returned in DevicePath. - @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not - exist on the ATA controller. - @retval EFI_INVALID_PARAMETER DevicePath is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath. - -**/ -EFI_STATUS -EFIAPI -AtaPassThruBuildDevicePath ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN UINT16 Port, - IN UINT16 PortMultiplierPort, - IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath - ); - -/** - Used to translate a device path node to a port number and port multiplier port number. - - The GetDevice() function determines the port and port multiplier port number associated with - the ATA device described by DevicePath. If DevicePath is a device path node type that the - ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents - DevicePath into a port number and port multiplier port number. - - If this translation is successful, then that port number and port multiplier port number are returned - in Port and PortMultiplierPort, and EFI_SUCCESS is returned. - - If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned. - - If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then - EFI_UNSUPPORTED is returned. - - If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not - a valid translation from DevicePath to a port number and port multiplier port number, then - EFI_NOT_FOUND is returned. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] DevicePath A pointer to the device path node that describes an ATA device on the - ATA controller. - @param[out] Port On return, points to the port number of an ATA device on the ATA controller. - @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device - on the ATA controller. - - @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier - port number, and they were returned in Port and PortMultiplierPort. - @retval EFI_INVALID_PARAMETER DevicePath is NULL. - @retval EFI_INVALID_PARAMETER Port is NULL. - @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL. - @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath. - @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier - port number does not exist. - -**/ -EFI_STATUS -EFIAPI -AtaPassThruGetDevice ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, - OUT UINT16 *Port, - OUT UINT16 *PortMultiplierPort - ); - -/** - Resets a specific port on the ATA controller. This operation also resets all the ATA devices - connected to the port. - - The ResetChannel() function resets an a specific port on an ATA controller. This operation - resets all the ATA devices connected to that port. If this ATA controller does not support - a reset port operation, then EFI_UNSUPPORTED is returned. - - If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is - returned. - - If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned. - - If the port reset operation is completed, then EFI_SUCCESS is returned. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] Port The port number on the ATA controller. - - @retval EFI_SUCCESS The ATA controller port was reset. - @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation. - @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port. - @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port. - -**/ -EFI_STATUS -EFIAPI -AtaPassThruResetPort ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN UINT16 Port - ); - -/** - Resets an ATA device that is connected to an ATA controller. - - The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort. - If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is - returned. - - If Port or PortMultiplierPort are not in a valid range for this ATA controller, then - EFI_INVALID_PARAMETER is returned. - - If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR - is returned. - - If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is - returned. - - If the device reset operation is completed, then EFI_SUCCESS is returned. - - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] Port Port represents the port number of the ATA device to be reset. - @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset. - If there is no port multiplier, then specify 0. - @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset. - @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation. - @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid. - @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device - specified by Port and PortMultiplierPort. - @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device - specified by Port and PortMultiplierPort. - -**/ -EFI_STATUS -EFIAPI -AtaPassThruResetDevice ( - IN EFI_ATA_PASS_THRU_PROTOCOL *This, - IN UINT16 Port, - IN UINT16 PortMultiplierPort - ); - -/** - Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function - supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the - nonblocking I/O functionality is optional. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - @param Target The Target is an array of size TARGET_MAX_BYTES and it represents - the id of the SCSI device to send the SCSI Request Packet. Each - transport driver may choose to utilize a subset of this size to suit the needs - of transport target representation. For example, a Fibre Channel driver - may use only 8 bytes (WWN) to represent an FC target. - @param Lun The LUN of the SCSI device to send the SCSI Request Packet. - @param Packet A pointer to the SCSI Request Packet to send to the SCSI device - specified by Target and Lun. - @param Event If nonblocking I/O is not supported then Event is ignored, and blocking - I/O is performed. If Event is NULL, then blocking I/O is performed. If - Event is not NULL and non blocking I/O is supported, then - nonblocking I/O is performed, and Event will be signaled when the - SCSI Request Packet completes. - - @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional - commands, InTransferLength bytes were transferred from - InDataBuffer. For write and bi-directional commands, - OutTransferLength bytes were transferred by - OutDataBuffer. - @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that - could be transferred is returned in InTransferLength. For write - and bi-directional commands, OutTransferLength bytes were - transferred by OutDataBuffer. - @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many - SCSI Request Packets already queued. The caller may retry again later. - @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request - Packet. - @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid. - @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported - by the host adapter. This includes the case of Bi-directional SCSI - commands not supported by the implementation. The SCSI Request - Packet was not sent, so no additional status information is available. - @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruPassThru ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, - IN UINT8 *Target, - IN UINT64 Lun, - IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, - IN EFI_EVENT Event OPTIONAL - ); - -/** - Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These - can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal - Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the - Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI - channel. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - @param Target On input, a pointer to the Target ID (an array of size - TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. - On output, a pointer to the Target ID (an array of - TARGET_MAX_BYTES) of the next SCSI device present on a SCSI - channel. An input value of 0xF(all bytes in the array are 0xF) in the - Target array retrieves the Target ID of the first SCSI device present on a - SCSI channel. - @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI - channel. On output, a pointer to the LUN of the next SCSI device present - on a SCSI channel. - - @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI - channel was returned in Target and Lun. - @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were - not returned on a previous call to GetNextTargetLun(). - @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruGetNextTargetLun ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, - IN OUT UINT8 **Target, - IN OUT UINT64 *Lun - ); - -/** - Used to allocate and build a device path node for a SCSI device on a SCSI channel. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the - Target ID of the SCSI device for which a device path node is to be - allocated and built. Transport drivers may chose to utilize a subset of - this size to suit the representation of targets. For example, a Fibre - Channel driver may use only 8 bytes (WWN) in the array to represent a - FC target. - @param Lun The LUN of the SCSI device for which a device path node is to be - allocated and built. - @param DevicePath A pointer to a single device path node that describes the SCSI device - specified by Target and Lun. This function is responsible for - allocating the buffer DevicePath with the boot service - AllocatePool(). It is the caller's responsibility to free - DevicePath when the caller is finished with DevicePath. - - @retval EFI_SUCCESS The device path node that describes the SCSI device specified by - Target and Lun was allocated and returned in - DevicePath. - @retval EFI_INVALID_PARAMETER DevicePath is NULL. - @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist - on the SCSI channel. - @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruBuildDevicePath ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, - IN UINT8 *Target, - IN UINT64 Lun, - IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath - ); - -/** - Used to translate a device path node to a Target ID and LUN. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - @param DevicePath A pointer to a single device path node that describes the SCSI device - on the SCSI channel. - @param Target A pointer to the Target Array which represents the ID of a SCSI device - on the SCSI channel. - @param Lun A pointer to the LUN of a SCSI device on the SCSI channel. - - @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and - LUN, and they were returned in Target and Lun. - @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL. - @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN - does not exist. - @retval EFI_UNSUPPORTED This driver does not support the device path node type in - DevicePath. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruGetTargetLun ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, - IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, - OUT UINT8 **Target, - OUT UINT64 *Lun - ); - -/** - Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - - @retval EFI_SUCCESS The SCSI channel was reset. - @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel. - @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel. - @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruResetChannel ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This - ); - -/** - Resets a SCSI logical unit that is connected to a SCSI channel. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the - target port ID of the SCSI device containing the SCSI logical unit to - reset. Transport drivers may chose to utilize a subset of this array to suit - the representation of their targets. - @param Lun The LUN of the SCSI device to reset. - - @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset. - @retval EFI_INVALID_PARAMETER Target or Lun is NULL. - @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device - specified by Target and Lun. - @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation. - @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device - specified by Target and Lun. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruResetTargetLun ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, - IN UINT8 *Target, - IN UINT64 Lun - ); - -/** - Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either - be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs - for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to - see if a SCSI device is actually present at that location on the SCSI channel. - - @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. - @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. - On output, a pointer to the Target ID (an array of - TARGET_MAX_BYTES) of the next SCSI device present on a SCSI - channel. An input value of 0xF(all bytes in the array are 0xF) in the - Target array retrieves the Target ID of the first SCSI device present on a - SCSI channel. - - @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI - channel was returned in Target. - @retval EFI_INVALID_PARAMETER Target or Lun is NULL. - @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not - returned on a previous call to GetNextTarget(). - @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. - -**/ -EFI_STATUS -EFIAPI -ExtScsiPassThruGetNextTarget ( - IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, - IN OUT UINT8 **Target - ); - -/** - Initialize ATA host controller at IDE mode. - - The function is designed to initialize ATA host controller. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - -**/ -EFI_STATUS -EFIAPI -IdeModeInitialization ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance - ); - -/** - Initialize ATA host controller at AHCI mode. - - The function is designed to initialize ATA host controller. - - @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. - -**/ -EFI_STATUS -EFIAPI -AhciModeInitialization ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance - ); - -/** - Start a non data transfer on specific port. - - @param[in] PciIo The PCI IO protocol instance. - @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS. - @param[in] Port The number of port. - @param[in] PortMultiplier The timeout value of stop. - @param[in] AtapiCommand The atapi command will be used for the - transfer. - @param[in] AtapiCommandLength The length of the atapi command. - @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data. - @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data. - @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit. - @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK - used by non-blocking mode. - - @retval EFI_DEVICE_ERROR The non data transfer abort with error occurs. - @retval EFI_TIMEOUT The operation is time out. - @retval EFI_UNSUPPORTED The device is not ready for transfer. - @retval EFI_SUCCESS The non data transfer executes successfully. - -**/ -EFI_STATUS -EFIAPI -AhciNonDataTransfer ( - IN EFI_PCI_IO_PROTOCOL *PciIo, - IN EFI_AHCI_REGISTERS *AhciRegisters, - IN UINT8 Port, - IN UINT8 PortMultiplier, - IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL, - IN UINT8 AtapiCommandLength, - IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, - IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, - IN UINT64 Timeout, - IN ATA_NONBLOCK_TASK *Task - ); - -/** - Start a DMA data transfer on specific port - - @param[in] Instance The ATA_ATAPI_PASS_THRU_INSTANCE protocol instance. - @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS. - @param[in] Port The number of port. - @param[in] PortMultiplier The timeout value of stop. - @param[in] AtapiCommand The atapi command will be used for the - transfer. - @param[in] AtapiCommandLength The length of the atapi command. - @param[in] Read The transfer direction. - @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data. - @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data. - @param[in, out] MemoryAddr The pointer to the data buffer. - @param[in] DataCount The data count to be transferred. - @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit. - @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK - used by non-blocking mode. - - @retval EFI_DEVICE_ERROR The DMA data transfer abort with error occurs. - @retval EFI_TIMEOUT The operation is time out. - @retval EFI_UNSUPPORTED The device is not ready for transfer. - @retval EFI_SUCCESS The DMA data transfer executes successfully. - -**/ -EFI_STATUS -EFIAPI -AhciDmaTransfer ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, - IN EFI_AHCI_REGISTERS *AhciRegisters, - IN UINT8 Port, - IN UINT8 PortMultiplier, - IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL, - IN UINT8 AtapiCommandLength, - IN BOOLEAN Read, - IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, - IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, - IN OUT VOID *MemoryAddr, - IN UINT32 DataCount, - IN UINT64 Timeout, - IN ATA_NONBLOCK_TASK *Task - ); - -/** - Start a PIO data transfer on specific port. - - @param[in] PciIo The PCI IO protocol instance. - @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS. - @param[in] Port The number of port. - @param[in] PortMultiplier The timeout value of stop. - @param[in] AtapiCommand The atapi command will be used for the - transfer. - @param[in] AtapiCommandLength The length of the atapi command. - @param[in] Read The transfer direction. - @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data. - @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data. - @param[in, out] MemoryAddr The pointer to the data buffer. - @param[in] DataCount The data count to be transferred. - @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit. - @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK - used by non-blocking mode. - - @retval EFI_DEVICE_ERROR The PIO data transfer abort with error occurs. - @retval EFI_TIMEOUT The operation is time out. - @retval EFI_UNSUPPORTED The device is not ready for transfer. - @retval EFI_SUCCESS The PIO data transfer executes successfully. - -**/ -EFI_STATUS -EFIAPI -AhciPioTransfer ( - IN EFI_PCI_IO_PROTOCOL *PciIo, - IN EFI_AHCI_REGISTERS *AhciRegisters, - IN UINT8 Port, - IN UINT8 PortMultiplier, - IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL, - IN UINT8 AtapiCommandLength, - IN BOOLEAN Read, - IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, - IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, - IN OUT VOID *MemoryAddr, - IN UINT32 DataCount, - IN UINT64 Timeout, - IN ATA_NONBLOCK_TASK *Task - ); - -/** - Send ATA command into device with NON_DATA protocol - - @param[in] PciIo A pointer to ATA_ATAPI_PASS_THRU_INSTANCE - data structure. - @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure. - @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data - structure. - @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure. - @param[in] Timeout The time to complete the command, uses 100ns as a unit. - @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK - used by non-blocking mode. - - @retval EFI_SUCCESS Reading succeed - @retval EFI_ABORTED Command failed - @retval EFI_DEVICE_ERROR Device status error. - -**/ -EFI_STATUS -EFIAPI -AtaNonDataCommandIn ( - IN EFI_PCI_IO_PROTOCOL *PciIo, - IN EFI_IDE_REGISTERS *IdeRegisters, - IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, - IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, - IN UINT64 Timeout, - IN ATA_NONBLOCK_TASK *Task - ); - -/** - Perform an ATA Udma operation (Read, ReadExt, Write, WriteExt). - - @param[in] Instance A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data - structure. - @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure. - @param[in] Read Flag used to determine the data transfer - direction. Read equals 1, means data transferred - from device to host;Read equals 0, means data - transferred from host to device. - @param[in] DataBuffer A pointer to the source buffer for the data. - @param[in] DataLength The length of the data. - @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure. - @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure. - @param[in] Timeout The time to complete the command, uses 100ns as a unit. - @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK - used by non-blocking mode. - - @retval EFI_SUCCESS the operation is successful. - @retval EFI_OUT_OF_RESOURCES Build PRD table failed - @retval EFI_UNSUPPORTED Unknown channel or operations command - @retval EFI_DEVICE_ERROR Ata command execute failed - -**/ -EFI_STATUS -EFIAPI -AtaUdmaInOut ( - IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, - IN EFI_IDE_REGISTERS *IdeRegisters, - IN BOOLEAN Read, - IN VOID *DataBuffer, - IN UINT64 DataLength, - IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, - IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, - IN UINT64 Timeout, - IN ATA_NONBLOCK_TASK *Task - ); - -/** - This function is used to send out ATA commands conforms to the PIO Data In Protocol. - - @param[in] PciIo A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data - structure. - @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure. - @param[in, out] Buffer A pointer to the source buffer for the data. - @param[in] ByteCount The length of the data. - @param[in] Read Flag used to determine the data transfer direction. - Read equals 1, means data transferred from device - to host;Read equals 0, means data transferred - from host to device. - @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure. - @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure. - @param[in] Timeout The time to complete the command, uses 100ns as a unit. - @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK - used by non-blocking mode. - - @retval EFI_SUCCESS send out the ATA command and device send required data successfully. - @retval EFI_DEVICE_ERROR command sent failed. - -**/ -EFI_STATUS -EFIAPI -AtaPioDataInOut ( - IN EFI_PCI_IO_PROTOCOL *PciIo, - IN EFI_IDE_REGISTERS *IdeRegisters, - IN OUT VOID *Buffer, - IN UINT64 ByteCount, - IN BOOLEAN Read, - IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, - IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, - IN UINT64 Timeout, - IN ATA_NONBLOCK_TASK *Task - ); - -#endif - +/** @file + Header file for ATA/ATAPI PASS THRU driver. + + Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.
+ 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. + +**/ +#ifndef __ATA_ATAPI_PASS_THRU_H__ +#define __ATA_ATAPI_PASS_THRU_H__ + +#include + +#include +#include +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "IdeMode.h" +#include "AhciMode.h" + +extern EFI_DRIVER_BINDING_PROTOCOL gAtaAtapiPassThruDriverBinding; +extern EFI_COMPONENT_NAME_PROTOCOL gAtaAtapiPassThruComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gAtaAtapiPassThruComponentName2; + +#define ATA_ATAPI_PASS_THRU_SIGNATURE SIGNATURE_32 ('a', 'a', 'p', 't') +#define ATA_ATAPI_DEVICE_SIGNATURE SIGNATURE_32 ('a', 'd', 'e', 'v') +#define ATA_NONBLOCKING_TASK_SIGNATURE SIGNATURE_32 ('a', 't', 's', 'k') + +typedef struct _ATA_NONBLOCK_TASK ATA_NONBLOCK_TASK; + +typedef enum { + EfiAtaIdeMode, + EfiAtaAhciMode, + EfiAtaRaidMode, + EfiAtaUnknownMode +} EFI_ATA_HC_WORK_MODE; + +typedef enum { + EfiIdeCdrom, /* ATAPI CDROM */ + EfiIdeHarddisk, /* Hard Disk */ + EfiPortMultiplier, /* Port Multiplier */ + EfiIdeUnknown +} EFI_ATA_DEVICE_TYPE; + +// +// Ahci mode device info +// +typedef struct { + UINT32 Signature; + LIST_ENTRY Link; + + UINT16 Port; + UINT16 PortMultiplier; + EFI_ATA_DEVICE_TYPE Type; + + EFI_IDENTIFY_DATA *IdentifyData; +} EFI_ATA_DEVICE_INFO; + +typedef struct { + UINT32 Signature; + + EFI_HANDLE ControllerHandle; + EFI_PCI_IO_PROTOCOL *PciIo; + EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit; + + EFI_ATA_PASS_THRU_MODE AtaPassThruMode; + EFI_ATA_PASS_THRU_PROTOCOL AtaPassThru; + EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode; + EFI_EXT_SCSI_PASS_THRU_PROTOCOL ExtScsiPassThru; + + EFI_ATA_HC_WORK_MODE Mode; + + EFI_IDE_REGISTERS IdeRegisters[EfiIdeMaxChannel]; + EFI_AHCI_REGISTERS AhciRegisters; + + // + // The attached device list + // + LIST_ENTRY DeviceList; + UINT64 OriginalPciAttributes; + + // + // For AtaPassThru protocol, using the following bytes to record the previous call in + // GetNextPort()/GetNextDevice(). + // + UINT16 PreviousPort; + UINT16 PreviousPortMultiplier; + // + // For ExtScsiPassThru protocol, using the following bytes to record the previous call in + // GetNextTarget()/GetNextTargetLun(). + // + UINT16 PreviousTargetId; + UINT64 PreviousLun; + + // + // For Non-blocking. + // + EFI_EVENT TimerEvent; + LIST_ENTRY NonBlockingTaskList; +} ATA_ATAPI_PASS_THRU_INSTANCE; + +// +// Task for Non-blocking mode. +// +struct _ATA_NONBLOCK_TASK { + UINT32 Signature; + LIST_ENTRY Link; + + UINT16 Port; + UINT16 PortMultiplier; + EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet; + BOOLEAN IsStart; + EFI_EVENT Event; + UINT64 RetryTimes; + VOID *Map; // Pointer to map. + VOID *TableMap;// Pointer to PRD table map. + EFI_ATA_DMA_PRD *MapBaseAddress; // Pointer to range Base address for Map. + UINTN PageCount; // The page numbers used by PCIO freebuffer. +}; + +// +// Timeout value which uses 100ns as a unit. +// It means 3 second span. +// +#define ATA_ATAPI_TIMEOUT EFI_TIMER_PERIOD_SECONDS(3) + +#define IS_ALIGNED(addr, size) (((UINTN) (addr) & (size - 1)) == 0) + +#define ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \ + CR (a, \ + ATA_ATAPI_PASS_THRU_INSTANCE, \ + AtaPassThru, \ + ATA_ATAPI_PASS_THRU_SIGNATURE \ + ) + +#define EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS(a) \ + CR (a, \ + ATA_ATAPI_PASS_THRU_INSTANCE, \ + ExtScsiPassThru, \ + ATA_ATAPI_PASS_THRU_SIGNATURE \ + ) + +#define ATA_ATAPI_DEVICE_INFO_FROM_THIS(a) \ + CR (a, \ + EFI_ATA_DEVICE_INFO, \ + Link, \ + ATA_ATAPI_DEVICE_SIGNATURE \ + ); + +#define ATA_NON_BLOCK_TASK_FROM_ENTRY(a) \ + CR (a, \ + ATA_NONBLOCK_TASK, \ + Link, \ + ATA_NONBLOCKING_TASK_SIGNATURE \ + ); + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param DriverName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +AtaAtapiPassThruComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param ControllerHandle[in] The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param ChildHandle[in] The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param ControllerName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +AtaAtapiPassThruComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + +/** + Tests to see if this driver supports a given controller. If a child device is provided, + it further tests to see if this driver supports creating a handle for the specified child device. + + This function checks to see if the driver specified by This supports the device specified by + ControllerHandle. Drivers will typically use the device path attached to + ControllerHandle and/or the services from the bus I/O abstraction attached to + ControllerHandle to determine if the driver supports ControllerHandle. This function + may be called many times during platform initialization. In order to reduce boot times, the tests + performed by this function must be very small, and take as little time as possible to execute. This + function must not change the state of any hardware devices, and this function must be aware that the + device specified by ControllerHandle may already be managed by the same driver or a + different driver. This function must match its calls to AllocatePages() with FreePages(), + AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). + Because ControllerHandle may have been previously started by the same driver, if a protocol is + already in the opened state, then it must not be closed with CloseProtocol(). This is required + to guarantee the state of ControllerHandle is not modified by this function. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle The handle of the controller to test. This handle + must support a protocol interface that supplies + an I/O abstraction to the driver. + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This + parameter is ignored by device drivers, and is optional for bus + drivers. For bus drivers, if this parameter is not NULL, then + the bus driver must determine if the bus controller specified + by ControllerHandle and the child controller specified + by RemainingDevicePath are both supported by this + bus driver. + + @retval EFI_SUCCESS The device specified by ControllerHandle and + RemainingDevicePath is supported by the driver specified by This. + @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and + RemainingDevicePath is already being managed by the driver + specified by This. + @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and + RemainingDevicePath is already being managed by a different + driver or an application that requires exclusive access. + Currently not implemented. + @retval EFI_UNSUPPORTED The device specified by ControllerHandle and + RemainingDevicePath is not supported by the driver specified by This. +**/ +EFI_STATUS +EFIAPI +AtaAtapiPassThruSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ); + +/** + Starts a device controller or a bus controller. + + The Start() function is designed to be invoked from the EFI boot service ConnectController(). + As a result, much of the error checking on the parameters to Start() has been moved into this + common boot service. It is legal to call Start() from other locations, + but the following calling restrictions must be followed, or the system behavior will not be deterministic. + 1. ControllerHandle must be a valid EFI_HANDLE. + 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned + EFI_DEVICE_PATH_PROTOCOL. + 3. Prior to calling Start(), the Supported() function for the driver specified by This must + have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle The handle of the controller to start. This handle + must support a protocol interface that supplies + an I/O abstraction to the driver. + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This + parameter is ignored by device drivers, and is optional for bus + drivers. For a bus driver, if this parameter is NULL, then handles + for all the children of Controller are created by this driver. + If this parameter is not NULL and the first Device Path Node is + not the End of Device Path Node, then only the handle for the + child device specified by the first Device Path Node of + RemainingDevicePath is created by this driver. + If the first Device Path Node of RemainingDevicePath is + the End of Device Path Node, no child handle is created by this + driver. + + @retval EFI_SUCCESS The device was started. + @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval Others The driver failded to start the device. + +**/ +EFI_STATUS +EFIAPI +AtaAtapiPassThruStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ); + +/** + Stops a device controller or a bus controller. + + The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). + As a result, much of the error checking on the parameters to Stop() has been moved + into this common boot service. It is legal to call Stop() from other locations, + but the following calling restrictions must be followed, or the system behavior will not be deterministic. + 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this + same driver's Start() function. + 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid + EFI_HANDLE. In addition, all of these handles must have been created in this driver's + Start() function, and the Start() function must have called OpenProtocol() on + ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle A handle to the device being stopped. The handle must + support a bus specific I/O protocol for the driver + to use to stop the device. + @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. + @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL + if NumberOfChildren is 0. + + @retval EFI_SUCCESS The device was stopped. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. + +**/ +EFI_STATUS +EFIAPI +AtaAtapiPassThruStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +/** + Traverse the attached ATA devices list to find out the device to access. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + @param[in] Port The port number of the ATA device to send the command. + @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. + If there is no port multiplier, then specify 0. + @param[in] DeviceType The device type of the ATA device. + + @retval The pointer to the data structure of the device info to access. + +**/ +LIST_ENTRY * +EFIAPI +SearchDeviceInfoList ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, + IN UINT16 Port, + IN UINT16 PortMultiplier, + IN EFI_ATA_DEVICE_TYPE DeviceType + ); + +/** + Allocate device info data structure to contain device info. + And insert the data structure to the tail of device list for tracing. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + @param[in] Port The port number of the ATA device to send the command. + @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. + If there is no port multiplier, then specify 0. + @param[in] DeviceType The device type of the ATA device. + @param[in] IdentifyData The data buffer to store the output of the IDENTIFY cmd. + + @retval EFI_SUCCESS Successfully insert the ata device to the tail of device list. + @retval EFI_OUT_OF_RESOURCES Can not allocate enough resource for use. + +**/ +EFI_STATUS +EFIAPI +CreateNewDeviceInfo ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, + IN UINT16 Port, + IN UINT16 PortMultiplier, + IN EFI_ATA_DEVICE_TYPE DeviceType, + IN EFI_IDENTIFY_DATA *IdentifyData + ); + +/** + Destroy all attached ATA devices info. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + +**/ +VOID +EFIAPI +DestroyDeviceInfoList ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance + ); + +/** + Destroy all pending non blocking tasks. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + @param[in] IsSigEvent Indicate whether signal the task event when remove the + task. + +**/ +VOID +EFIAPI +DestroyAsynTaskList ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, + IN BOOLEAN IsSigEvent + ); + +/** + Enumerate all attached ATA devices at IDE mode or AHCI mode separately. + + The function is designed to enumerate all attached ATA devices. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + + @retval EFI_SUCCESS Successfully enumerate attached ATA devices. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. + +**/ +EFI_STATUS +EFIAPI +EnumerateAttachedDevice ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance + ); + +/** + Call back funtion when the timer event is signaled. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registered to the + Event. + +**/ +VOID +EFIAPI +AsyncNonBlockingTransferRoutine ( + EFI_EVENT Event, + VOID* Context + ); + +/** + Sends an ATA command to an ATA device that is attached to the ATA controller. This function + supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required, + and the non-blocking I/O functionality is optional. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] Port The port number of the ATA device to send the command. + @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. + If there is no port multiplier, then specify 0. + @param[in, out] Packet A pointer to the ATA command to send to the ATA device specified by Port + and PortMultiplierPort. + @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking + I/O is performed. If Event is NULL, then blocking I/O is performed. If + Event is not NULL and non blocking I/O is supported, then non-blocking + I/O is performed, and Event will be signaled when the ATA command completes. + + @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands, + InTransferLength bytes were transferred from InDataBuffer. For write and + bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. + @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred + is returned in InTransferLength. For write and bi-directional commands, + OutTransferLength bytes were transferred by OutDataBuffer. + @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands + already queued. The caller may retry again later. + @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the ATA command. + @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA + command was not sent, so no additional status information is available. + +**/ +EFI_STATUS +EFIAPI +AtaPassThruPassThru ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN UINT16 Port, + IN UINT16 PortMultiplierPort, + IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet, + IN EFI_EVENT Event OPTIONAL + ); + +/** + Used to retrieve the list of legal port numbers for ATA devices on an ATA controller. + These can either be the list of ports where ATA devices are actually present or the + list of legal port numbers for the ATA controller. Regardless, the caller of this + function must probe the port number returned to see if an ATA device is actually + present at that location on the ATA controller. + + The GetNextPort() function retrieves the port number on an ATA controller. If on input + Port is 0xFFFF, then the port number of the first port on the ATA controller is returned + in Port and EFI_SUCCESS is returned. + + If Port is a port number that was returned on a previous call to GetNextPort(), then the + port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS + is returned. If Port is not 0xFFFF and Port was not returned on a previous call to + GetNextPort(), then EFI_INVALID_PARAMETER is returned. + + If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is + returned. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in, out] Port On input, a pointer to the port number on the ATA controller. + On output, a pointer to the next port number on the ATA + controller. An input value of 0xFFFF retrieves the first port + number on the ATA controller. + + @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port. + @retval EFI_NOT_FOUND There are no more ports on this ATA controller. + @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call + to GetNextPort(). + +**/ +EFI_STATUS +EFIAPI +AtaPassThruGetNextPort ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN OUT UINT16 *Port + ); + +/** + Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA + controller. These can either be the list of port multiplier ports where ATA devices are actually + present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this + function must probe the port number and port multiplier port number returned to see if an ATA + device is actually present. + + The GetNextDevice() function retrieves the port multiplier port number of an ATA device + present on a port of an ATA controller. + + If PortMultiplierPort points to a port multiplier port number value that was returned on a + previous call to GetNextDevice(), then the port multiplier port number of the next ATA device + on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is + returned. + + If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first + ATA device on port of the ATA controller is returned in PortMultiplierPort and + EFI_SUCCESS is returned. + + If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort + was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER + is returned. + + If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of + the ATA controller, then EFI_NOT_FOUND is returned. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] Port The port number present on the ATA controller. + @param[in, out] PortMultiplierPort On input, a pointer to the port multiplier port number of an + ATA device present on the ATA controller. + If on input a PortMultiplierPort of 0xFFFF is specified, + then the port multiplier port number of the first ATA device + is returned. On output, a pointer to the port multiplier port + number of the next ATA device present on an ATA controller. + + @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port + of the ATA controller was returned in PortMultiplierPort. + @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller. + @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not + returned on a previous call to GetNextDevice(). + +**/ +EFI_STATUS +EFIAPI +AtaPassThruGetNextDevice ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN UINT16 Port, + IN OUT UINT16 *PortMultiplierPort + ); + +/** + Used to allocate and build a device path node for an ATA device on an ATA controller. + + The BuildDevicePath() function allocates and builds a single device node for the ATA + device specified by Port and PortMultiplierPort. If the ATA device specified by Port and + PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned. + If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough + resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned. + + Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of + DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort, + and EFI_SUCCESS is returned. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] Port Port specifies the port number of the ATA device for which a + device path node is to be allocated and built. + @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a + device path node is to be allocated and built. If there is no + port multiplier, then specify 0. + @param[in, out] DevicePath A pointer to a single device path node that describes the ATA + device specified by Port and PortMultiplierPort. This function + is responsible for allocating the buffer DevicePath with the + boot service AllocatePool(). It is the caller's responsibility + to free DevicePath when the caller is finished with DevicePath. + @retval EFI_SUCCESS The device path node that describes the ATA device specified by + Port and PortMultiplierPort was allocated and returned in DevicePath. + @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not + exist on the ATA controller. + @retval EFI_INVALID_PARAMETER DevicePath is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath. + +**/ +EFI_STATUS +EFIAPI +AtaPassThruBuildDevicePath ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN UINT16 Port, + IN UINT16 PortMultiplierPort, + IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath + ); + +/** + Used to translate a device path node to a port number and port multiplier port number. + + The GetDevice() function determines the port and port multiplier port number associated with + the ATA device described by DevicePath. If DevicePath is a device path node type that the + ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents + DevicePath into a port number and port multiplier port number. + + If this translation is successful, then that port number and port multiplier port number are returned + in Port and PortMultiplierPort, and EFI_SUCCESS is returned. + + If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned. + + If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then + EFI_UNSUPPORTED is returned. + + If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not + a valid translation from DevicePath to a port number and port multiplier port number, then + EFI_NOT_FOUND is returned. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] DevicePath A pointer to the device path node that describes an ATA device on the + ATA controller. + @param[out] Port On return, points to the port number of an ATA device on the ATA controller. + @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device + on the ATA controller. + + @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier + port number, and they were returned in Port and PortMultiplierPort. + @retval EFI_INVALID_PARAMETER DevicePath is NULL. + @retval EFI_INVALID_PARAMETER Port is NULL. + @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL. + @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath. + @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier + port number does not exist. + +**/ +EFI_STATUS +EFIAPI +AtaPassThruGetDevice ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, + OUT UINT16 *Port, + OUT UINT16 *PortMultiplierPort + ); + +/** + Resets a specific port on the ATA controller. This operation also resets all the ATA devices + connected to the port. + + The ResetChannel() function resets an a specific port on an ATA controller. This operation + resets all the ATA devices connected to that port. If this ATA controller does not support + a reset port operation, then EFI_UNSUPPORTED is returned. + + If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is + returned. + + If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned. + + If the port reset operation is completed, then EFI_SUCCESS is returned. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] Port The port number on the ATA controller. + + @retval EFI_SUCCESS The ATA controller port was reset. + @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation. + @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port. + @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port. + +**/ +EFI_STATUS +EFIAPI +AtaPassThruResetPort ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN UINT16 Port + ); + +/** + Resets an ATA device that is connected to an ATA controller. + + The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort. + If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is + returned. + + If Port or PortMultiplierPort are not in a valid range for this ATA controller, then + EFI_INVALID_PARAMETER is returned. + + If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR + is returned. + + If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is + returned. + + If the device reset operation is completed, then EFI_SUCCESS is returned. + + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] Port Port represents the port number of the ATA device to be reset. + @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset. + If there is no port multiplier, then specify 0. + @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset. + @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation. + @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid. + @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device + specified by Port and PortMultiplierPort. + @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device + specified by Port and PortMultiplierPort. + +**/ +EFI_STATUS +EFIAPI +AtaPassThruResetDevice ( + IN EFI_ATA_PASS_THRU_PROTOCOL *This, + IN UINT16 Port, + IN UINT16 PortMultiplierPort + ); + +/** + Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function + supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the + nonblocking I/O functionality is optional. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + @param Target The Target is an array of size TARGET_MAX_BYTES and it represents + the id of the SCSI device to send the SCSI Request Packet. Each + transport driver may choose to utilize a subset of this size to suit the needs + of transport target representation. For example, a Fibre Channel driver + may use only 8 bytes (WWN) to represent an FC target. + @param Lun The LUN of the SCSI device to send the SCSI Request Packet. + @param Packet A pointer to the SCSI Request Packet to send to the SCSI device + specified by Target and Lun. + @param Event If nonblocking I/O is not supported then Event is ignored, and blocking + I/O is performed. If Event is NULL, then blocking I/O is performed. If + Event is not NULL and non blocking I/O is supported, then + nonblocking I/O is performed, and Event will be signaled when the + SCSI Request Packet completes. + + @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional + commands, InTransferLength bytes were transferred from + InDataBuffer. For write and bi-directional commands, + OutTransferLength bytes were transferred by + OutDataBuffer. + @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that + could be transferred is returned in InTransferLength. For write + and bi-directional commands, OutTransferLength bytes were + transferred by OutDataBuffer. + @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many + SCSI Request Packets already queued. The caller may retry again later. + @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request + Packet. + @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid. + @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported + by the host adapter. This includes the case of Bi-directional SCSI + commands not supported by the implementation. The SCSI Request + Packet was not sent, so no additional status information is available. + @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruPassThru ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, + IN UINT8 *Target, + IN UINT64 Lun, + IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, + IN EFI_EVENT Event OPTIONAL + ); + +/** + Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These + can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal + Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the + Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI + channel. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + @param Target On input, a pointer to the Target ID (an array of size + TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. + On output, a pointer to the Target ID (an array of + TARGET_MAX_BYTES) of the next SCSI device present on a SCSI + channel. An input value of 0xF(all bytes in the array are 0xF) in the + Target array retrieves the Target ID of the first SCSI device present on a + SCSI channel. + @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI + channel. On output, a pointer to the LUN of the next SCSI device present + on a SCSI channel. + + @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI + channel was returned in Target and Lun. + @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were + not returned on a previous call to GetNextTargetLun(). + @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruGetNextTargetLun ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, + IN OUT UINT8 **Target, + IN OUT UINT64 *Lun + ); + +/** + Used to allocate and build a device path node for a SCSI device on a SCSI channel. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the + Target ID of the SCSI device for which a device path node is to be + allocated and built. Transport drivers may chose to utilize a subset of + this size to suit the representation of targets. For example, a Fibre + Channel driver may use only 8 bytes (WWN) in the array to represent a + FC target. + @param Lun The LUN of the SCSI device for which a device path node is to be + allocated and built. + @param DevicePath A pointer to a single device path node that describes the SCSI device + specified by Target and Lun. This function is responsible for + allocating the buffer DevicePath with the boot service + AllocatePool(). It is the caller's responsibility to free + DevicePath when the caller is finished with DevicePath. + + @retval EFI_SUCCESS The device path node that describes the SCSI device specified by + Target and Lun was allocated and returned in + DevicePath. + @retval EFI_INVALID_PARAMETER DevicePath is NULL. + @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist + on the SCSI channel. + @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruBuildDevicePath ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, + IN UINT8 *Target, + IN UINT64 Lun, + IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath + ); + +/** + Used to translate a device path node to a Target ID and LUN. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + @param DevicePath A pointer to a single device path node that describes the SCSI device + on the SCSI channel. + @param Target A pointer to the Target Array which represents the ID of a SCSI device + on the SCSI channel. + @param Lun A pointer to the LUN of a SCSI device on the SCSI channel. + + @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and + LUN, and they were returned in Target and Lun. + @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL. + @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN + does not exist. + @retval EFI_UNSUPPORTED This driver does not support the device path node type in + DevicePath. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruGetTargetLun ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, + OUT UINT8 **Target, + OUT UINT64 *Lun + ); + +/** + Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + + @retval EFI_SUCCESS The SCSI channel was reset. + @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel. + @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel. + @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruResetChannel ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This + ); + +/** + Resets a SCSI logical unit that is connected to a SCSI channel. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the + target port ID of the SCSI device containing the SCSI logical unit to + reset. Transport drivers may chose to utilize a subset of this array to suit + the representation of their targets. + @param Lun The LUN of the SCSI device to reset. + + @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset. + @retval EFI_INVALID_PARAMETER Target or Lun is NULL. + @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device + specified by Target and Lun. + @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation. + @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device + specified by Target and Lun. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruResetTargetLun ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, + IN UINT8 *Target, + IN UINT64 Lun + ); + +/** + Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either + be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs + for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to + see if a SCSI device is actually present at that location on the SCSI channel. + + @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. + @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. + On output, a pointer to the Target ID (an array of + TARGET_MAX_BYTES) of the next SCSI device present on a SCSI + channel. An input value of 0xF(all bytes in the array are 0xF) in the + Target array retrieves the Target ID of the first SCSI device present on a + SCSI channel. + + @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI + channel was returned in Target. + @retval EFI_INVALID_PARAMETER Target or Lun is NULL. + @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not + returned on a previous call to GetNextTarget(). + @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. + +**/ +EFI_STATUS +EFIAPI +ExtScsiPassThruGetNextTarget ( + IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, + IN OUT UINT8 **Target + ); + +/** + Initialize ATA host controller at IDE mode. + + The function is designed to initialize ATA host controller. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + +**/ +EFI_STATUS +EFIAPI +IdeModeInitialization ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance + ); + +/** + Initialize ATA host controller at AHCI mode. + + The function is designed to initialize ATA host controller. + + @param[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance. + +**/ +EFI_STATUS +EFIAPI +AhciModeInitialization ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance + ); + +/** + Start a non data transfer on specific port. + + @param[in] PciIo The PCI IO protocol instance. + @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS. + @param[in] Port The number of port. + @param[in] PortMultiplier The timeout value of stop. + @param[in] AtapiCommand The atapi command will be used for the + transfer. + @param[in] AtapiCommandLength The length of the atapi command. + @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data. + @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data. + @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit. + @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK + used by non-blocking mode. + + @retval EFI_DEVICE_ERROR The non data transfer abort with error occurs. + @retval EFI_TIMEOUT The operation is time out. + @retval EFI_UNSUPPORTED The device is not ready for transfer. + @retval EFI_SUCCESS The non data transfer executes successfully. + +**/ +EFI_STATUS +EFIAPI +AhciNonDataTransfer ( + IN EFI_PCI_IO_PROTOCOL *PciIo, + IN EFI_AHCI_REGISTERS *AhciRegisters, + IN UINT8 Port, + IN UINT8 PortMultiplier, + IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL, + IN UINT8 AtapiCommandLength, + IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, + IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, + IN UINT64 Timeout, + IN ATA_NONBLOCK_TASK *Task + ); + +/** + Start a DMA data transfer on specific port + + @param[in] Instance The ATA_ATAPI_PASS_THRU_INSTANCE protocol instance. + @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS. + @param[in] Port The number of port. + @param[in] PortMultiplier The timeout value of stop. + @param[in] AtapiCommand The atapi command will be used for the + transfer. + @param[in] AtapiCommandLength The length of the atapi command. + @param[in] Read The transfer direction. + @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data. + @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data. + @param[in, out] MemoryAddr The pointer to the data buffer. + @param[in] DataCount The data count to be transferred. + @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit. + @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK + used by non-blocking mode. + + @retval EFI_DEVICE_ERROR The DMA data transfer abort with error occurs. + @retval EFI_TIMEOUT The operation is time out. + @retval EFI_UNSUPPORTED The device is not ready for transfer. + @retval EFI_SUCCESS The DMA data transfer executes successfully. + +**/ +EFI_STATUS +EFIAPI +AhciDmaTransfer ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, + IN EFI_AHCI_REGISTERS *AhciRegisters, + IN UINT8 Port, + IN UINT8 PortMultiplier, + IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL, + IN UINT8 AtapiCommandLength, + IN BOOLEAN Read, + IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, + IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, + IN OUT VOID *MemoryAddr, + IN UINT32 DataCount, + IN UINT64 Timeout, + IN ATA_NONBLOCK_TASK *Task + ); + +/** + Start a PIO data transfer on specific port. + + @param[in] PciIo The PCI IO protocol instance. + @param[in] AhciRegisters The pointer to the EFI_AHCI_REGISTERS. + @param[in] Port The number of port. + @param[in] PortMultiplier The timeout value of stop. + @param[in] AtapiCommand The atapi command will be used for the + transfer. + @param[in] AtapiCommandLength The length of the atapi command. + @param[in] Read The transfer direction. + @param[in] AtaCommandBlock The EFI_ATA_COMMAND_BLOCK data. + @param[in, out] AtaStatusBlock The EFI_ATA_STATUS_BLOCK data. + @param[in, out] MemoryAddr The pointer to the data buffer. + @param[in] DataCount The data count to be transferred. + @param[in] Timeout The timeout value of non data transfer, uses 100ns as a unit. + @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK + used by non-blocking mode. + + @retval EFI_DEVICE_ERROR The PIO data transfer abort with error occurs. + @retval EFI_TIMEOUT The operation is time out. + @retval EFI_UNSUPPORTED The device is not ready for transfer. + @retval EFI_SUCCESS The PIO data transfer executes successfully. + +**/ +EFI_STATUS +EFIAPI +AhciPioTransfer ( + IN EFI_PCI_IO_PROTOCOL *PciIo, + IN EFI_AHCI_REGISTERS *AhciRegisters, + IN UINT8 Port, + IN UINT8 PortMultiplier, + IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand OPTIONAL, + IN UINT8 AtapiCommandLength, + IN BOOLEAN Read, + IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, + IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, + IN OUT VOID *MemoryAddr, + IN UINT32 DataCount, + IN UINT64 Timeout, + IN ATA_NONBLOCK_TASK *Task + ); + +/** + Send ATA command into device with NON_DATA protocol + + @param[in] PciIo A pointer to ATA_ATAPI_PASS_THRU_INSTANCE + data structure. + @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure. + @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data + structure. + @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure. + @param[in] Timeout The time to complete the command, uses 100ns as a unit. + @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK + used by non-blocking mode. + + @retval EFI_SUCCESS Reading succeed + @retval EFI_ABORTED Command failed + @retval EFI_DEVICE_ERROR Device status error. + +**/ +EFI_STATUS +EFIAPI +AtaNonDataCommandIn ( + IN EFI_PCI_IO_PROTOCOL *PciIo, + IN EFI_IDE_REGISTERS *IdeRegisters, + IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, + IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, + IN UINT64 Timeout, + IN ATA_NONBLOCK_TASK *Task + ); + +/** + Perform an ATA Udma operation (Read, ReadExt, Write, WriteExt). + + @param[in] Instance A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data + structure. + @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure. + @param[in] Read Flag used to determine the data transfer + direction. Read equals 1, means data transferred + from device to host;Read equals 0, means data + transferred from host to device. + @param[in] DataBuffer A pointer to the source buffer for the data. + @param[in] DataLength The length of the data. + @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure. + @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure. + @param[in] Timeout The time to complete the command, uses 100ns as a unit. + @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK + used by non-blocking mode. + + @retval EFI_SUCCESS the operation is successful. + @retval EFI_OUT_OF_RESOURCES Build PRD table failed + @retval EFI_UNSUPPORTED Unknown channel or operations command + @retval EFI_DEVICE_ERROR Ata command execute failed + +**/ +EFI_STATUS +EFIAPI +AtaUdmaInOut ( + IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, + IN EFI_IDE_REGISTERS *IdeRegisters, + IN BOOLEAN Read, + IN VOID *DataBuffer, + IN UINT64 DataLength, + IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, + IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, + IN UINT64 Timeout, + IN ATA_NONBLOCK_TASK *Task + ); + +/** + This function is used to send out ATA commands conforms to the PIO Data In Protocol. + + @param[in] PciIo A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data + structure. + @param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure. + @param[in, out] Buffer A pointer to the source buffer for the data. + @param[in] ByteCount The length of the data. + @param[in] Read Flag used to determine the data transfer direction. + Read equals 1, means data transferred from device + to host;Read equals 0, means data transferred + from host to device. + @param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure. + @param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure. + @param[in] Timeout The time to complete the command, uses 100ns as a unit. + @param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK + used by non-blocking mode. + + @retval EFI_SUCCESS send out the ATA command and device send required data successfully. + @retval EFI_DEVICE_ERROR command sent failed. + +**/ +EFI_STATUS +EFIAPI +AtaPioDataInOut ( + IN EFI_PCI_IO_PROTOCOL *PciIo, + IN EFI_IDE_REGISTERS *IdeRegisters, + IN OUT VOID *Buffer, + IN UINT64 ByteCount, + IN BOOLEAN Read, + IN EFI_ATA_COMMAND_BLOCK *AtaCommandBlock, + IN OUT EFI_ATA_STATUS_BLOCK *AtaStatusBlock, + IN UINT64 Timeout, + IN ATA_NONBLOCK_TASK *Task + ); + +#endif + diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.c b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.c index 66af1906ce..ea108a851d 100644 --- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.c +++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.c @@ -1,162 +1,162 @@ -/** @file - This file is used to implement the EFI_DISK_INFO_PROTOCOL interface.. - - Copyright (c) 2013, Intel Corporation. All rights reserved.
- 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 "NvmExpress.h" - -EFI_DISK_INFO_PROTOCOL gNvmExpressDiskInfoProtocolTemplate = { - EFI_DISK_INFO_NVME_INTERFACE_GUID, - NvmExpressDiskInfoInquiry, - NvmExpressDiskInfoIdentify, - NvmExpressDiskInfoSenseData, - NvmExpressDiskInfoWhichIde -}; - -/** - Initialize the installation of DiskInfo protocol. - - This function prepares for the installation of DiskInfo protocol on the child handle. - By default, it installs DiskInfo protocol with NVME interface GUID. - - @param[in] Device The pointer of NVME_DEVICE_PRIVATE_DATA. - -**/ -VOID -InitializeDiskInfo ( - IN NVME_DEVICE_PRIVATE_DATA *Device - ) -{ - CopyMem (&Device->DiskInfo, &gNvmExpressDiskInfoProtocolTemplate, sizeof (EFI_DISK_INFO_PROTOCOL)); -} - - -/** - Provides inquiry information for the controller type. - - This function is used to get inquiry data. Data format - of Identify data is defined by the Interface GUID. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. - @param[in, out] InquiryData Pointer to a buffer for the inquiry data. - @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size. - - @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class - @retval EFI_DEVICE_ERROR Error reading InquiryData from device - @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoInquiry ( - IN EFI_DISK_INFO_PROTOCOL *This, - IN OUT VOID *InquiryData, - IN OUT UINT32 *InquiryDataSize - ) -{ - return EFI_NOT_FOUND; -} - - -/** - Provides identify information for the controller type. - - This function is used to get identify data. Data format - of Identify data is defined by the Interface GUID. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL - instance. - @param[in, out] IdentifyData Pointer to a buffer for the identify data. - @param[in, out] IdentifyDataSize Pointer to the value for the identify data - size. - - @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class - @retval EFI_DEVICE_ERROR Error reading IdentifyData from device - @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoIdentify ( - IN EFI_DISK_INFO_PROTOCOL *This, - IN OUT VOID *IdentifyData, - IN OUT UINT32 *IdentifyDataSize - ) -{ - EFI_STATUS Status; - NVME_DEVICE_PRIVATE_DATA *Device; - - Device = NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO (This); - - Status = EFI_BUFFER_TOO_SMALL; - if (*IdentifyDataSize >= sizeof (Device->NamespaceData)) { - Status = EFI_SUCCESS; - CopyMem (IdentifyData, &Device->NamespaceData, sizeof (Device->NamespaceData)); - } - *IdentifyDataSize = sizeof (Device->NamespaceData); - return Status; -} - -/** - Provides sense data information for the controller type. - - This function is used to get sense data. - Data format of Sense data is defined by the Interface GUID. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. - @param[in, out] SenseData Pointer to the SenseData. - @param[in, out] SenseDataSize Size of SenseData in bytes. - @param[out] SenseDataNumber Pointer to the value for the sense data size. - - @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class. - @retval EFI_DEVICE_ERROR Error reading SenseData from device. - @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough. - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoSenseData ( - IN EFI_DISK_INFO_PROTOCOL *This, - IN OUT VOID *SenseData, - IN OUT UINT32 *SenseDataSize, - OUT UINT8 *SenseDataNumber - ) -{ - return EFI_NOT_FOUND; -} - - -/** - This function is used to get controller information. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. - @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. - @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. - - @retval EFI_SUCCESS IdeChannel and IdeDevice are valid. - @retval EFI_UNSUPPORTED This is not an IDE device. - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoWhichIde ( - IN EFI_DISK_INFO_PROTOCOL *This, - OUT UINT32 *IdeChannel, - OUT UINT32 *IdeDevice - ) -{ - return EFI_UNSUPPORTED; -} - +/** @file + This file is used to implement the EFI_DISK_INFO_PROTOCOL interface.. + + Copyright (c) 2013, Intel Corporation. All rights reserved.
+ 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 "NvmExpress.h" + +EFI_DISK_INFO_PROTOCOL gNvmExpressDiskInfoProtocolTemplate = { + EFI_DISK_INFO_NVME_INTERFACE_GUID, + NvmExpressDiskInfoInquiry, + NvmExpressDiskInfoIdentify, + NvmExpressDiskInfoSenseData, + NvmExpressDiskInfoWhichIde +}; + +/** + Initialize the installation of DiskInfo protocol. + + This function prepares for the installation of DiskInfo protocol on the child handle. + By default, it installs DiskInfo protocol with NVME interface GUID. + + @param[in] Device The pointer of NVME_DEVICE_PRIVATE_DATA. + +**/ +VOID +InitializeDiskInfo ( + IN NVME_DEVICE_PRIVATE_DATA *Device + ) +{ + CopyMem (&Device->DiskInfo, &gNvmExpressDiskInfoProtocolTemplate, sizeof (EFI_DISK_INFO_PROTOCOL)); +} + + +/** + Provides inquiry information for the controller type. + + This function is used to get inquiry data. Data format + of Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in, out] InquiryData Pointer to a buffer for the inquiry data. + @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class + @retval EFI_DEVICE_ERROR Error reading InquiryData from device + @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoInquiry ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *InquiryData, + IN OUT UINT32 *InquiryDataSize + ) +{ + return EFI_NOT_FOUND; +} + + +/** + Provides identify information for the controller type. + + This function is used to get identify data. Data format + of Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL + instance. + @param[in, out] IdentifyData Pointer to a buffer for the identify data. + @param[in, out] IdentifyDataSize Pointer to the value for the identify data + size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class + @retval EFI_DEVICE_ERROR Error reading IdentifyData from device + @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoIdentify ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *IdentifyData, + IN OUT UINT32 *IdentifyDataSize + ) +{ + EFI_STATUS Status; + NVME_DEVICE_PRIVATE_DATA *Device; + + Device = NVME_DEVICE_PRIVATE_DATA_FROM_DISK_INFO (This); + + Status = EFI_BUFFER_TOO_SMALL; + if (*IdentifyDataSize >= sizeof (Device->NamespaceData)) { + Status = EFI_SUCCESS; + CopyMem (IdentifyData, &Device->NamespaceData, sizeof (Device->NamespaceData)); + } + *IdentifyDataSize = sizeof (Device->NamespaceData); + return Status; +} + +/** + Provides sense data information for the controller type. + + This function is used to get sense data. + Data format of Sense data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in, out] SenseData Pointer to the SenseData. + @param[in, out] SenseDataSize Size of SenseData in bytes. + @param[out] SenseDataNumber Pointer to the value for the sense data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading SenseData from device. + @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoSenseData ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *SenseData, + IN OUT UINT32 *SenseDataSize, + OUT UINT8 *SenseDataNumber + ) +{ + return EFI_NOT_FOUND; +} + + +/** + This function is used to get controller information. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. + @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. + + @retval EFI_SUCCESS IdeChannel and IdeDevice are valid. + @retval EFI_UNSUPPORTED This is not an IDE device. + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoWhichIde ( + IN EFI_DISK_INFO_PROTOCOL *This, + OUT UINT32 *IdeChannel, + OUT UINT32 *IdeDevice + ) +{ + return EFI_UNSUPPORTED; +} + diff --git a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.h b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.h index 7db3dff47a..f07cfe3474 100644 --- a/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.h +++ b/MdeModulePkg/Bus/Pci/NvmExpressDxe/NvmExpressDiskInfo.h @@ -1,129 +1,129 @@ -/** @file - Header file for EFI_DISK_INFO_PROTOCOL interface. - -Copyright (c) 2013, Intel Corporation. All rights reserved.
-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. - -**/ - -#ifndef _NVME_DISKINFO_H_ -#define _NVME_DISKINFO_H_ - -/** - Initialize the installation of DiskInfo protocol. - - This function prepares for the installation of DiskInfo protocol on the child handle. - By default, it installs DiskInfo protocol with NVME interface GUID. - - @param[in] Device The pointer of NVME_DEVICE_PRIVATE_DATA. - -**/ -VOID -InitializeDiskInfo ( - IN NVME_DEVICE_PRIVATE_DATA *Device - ); - - -/** - Provides inquiry information for the controller type. - - This function is used to get inquiry data. Data format - of Identify data is defined by the Interface GUID. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. - @param[in, out] InquiryData Pointer to a buffer for the inquiry data. - @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size. - - @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class - @retval EFI_DEVICE_ERROR Error reading InquiryData from device - @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoInquiry ( - IN EFI_DISK_INFO_PROTOCOL *This, - IN OUT VOID *InquiryData, - IN OUT UINT32 *InquiryDataSize - ); - -/** - Provides identify information for the controller type. - - This function is used to get identify data. Data format - of Identify data is defined by the Interface GUID. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL - instance. - @param[in, out] IdentifyData Pointer to a buffer for the identify data. - @param[in, out] IdentifyDataSize Pointer to the value for the identify data - size. - - @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class - @retval EFI_DEVICE_ERROR Error reading IdentifyData from device - @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoIdentify ( - IN EFI_DISK_INFO_PROTOCOL *This, - IN OUT VOID *IdentifyData, - IN OUT UINT32 *IdentifyDataSize - ); - -/** - Provides sense data information for the controller type. - - This function is used to get sense data. - Data format of Sense data is defined by the Interface GUID. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. - @param[in, out] SenseData Pointer to the SenseData. - @param[in, out] SenseDataSize Size of SenseData in bytes. - @param[out] SenseDataNumber Pointer to the value for the sense data size. - - @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class. - @retval EFI_DEVICE_ERROR Error reading SenseData from device. - @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough. - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoSenseData ( - IN EFI_DISK_INFO_PROTOCOL *This, - IN OUT VOID *SenseData, - IN OUT UINT32 *SenseDataSize, - OUT UINT8 *SenseDataNumber - ); - - -/** - This function is used to get controller information. - - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. - @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. - @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. - - @retval EFI_SUCCESS IdeChannel and IdeDevice are valid. - @retval EFI_UNSUPPORTED This is not an IDE device. - -**/ -EFI_STATUS -EFIAPI -NvmExpressDiskInfoWhichIde ( - IN EFI_DISK_INFO_PROTOCOL *This, - OUT UINT32 *IdeChannel, - OUT UINT32 *IdeDevice - ); - -#endif +/** @file + Header file for EFI_DISK_INFO_PROTOCOL interface. + +Copyright (c) 2013, Intel Corporation. All rights reserved.
+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. + +**/ + +#ifndef _NVME_DISKINFO_H_ +#define _NVME_DISKINFO_H_ + +/** + Initialize the installation of DiskInfo protocol. + + This function prepares for the installation of DiskInfo protocol on the child handle. + By default, it installs DiskInfo protocol with NVME interface GUID. + + @param[in] Device The pointer of NVME_DEVICE_PRIVATE_DATA. + +**/ +VOID +InitializeDiskInfo ( + IN NVME_DEVICE_PRIVATE_DATA *Device + ); + + +/** + Provides inquiry information for the controller type. + + This function is used to get inquiry data. Data format + of Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in, out] InquiryData Pointer to a buffer for the inquiry data. + @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class + @retval EFI_DEVICE_ERROR Error reading InquiryData from device + @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoInquiry ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *InquiryData, + IN OUT UINT32 *InquiryDataSize + ); + +/** + Provides identify information for the controller type. + + This function is used to get identify data. Data format + of Identify data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL + instance. + @param[in, out] IdentifyData Pointer to a buffer for the identify data. + @param[in, out] IdentifyDataSize Pointer to the value for the identify data + size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class + @retval EFI_DEVICE_ERROR Error reading IdentifyData from device + @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoIdentify ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *IdentifyData, + IN OUT UINT32 *IdentifyDataSize + ); + +/** + Provides sense data information for the controller type. + + This function is used to get sense data. + Data format of Sense data is defined by the Interface GUID. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in, out] SenseData Pointer to the SenseData. + @param[in, out] SenseDataSize Size of SenseData in bytes. + @param[out] SenseDataNumber Pointer to the value for the sense data size. + + @retval EFI_SUCCESS The command was accepted without any errors. + @retval EFI_NOT_FOUND Device does not support this data class. + @retval EFI_DEVICE_ERROR Error reading SenseData from device. + @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough. + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoSenseData ( + IN EFI_DISK_INFO_PROTOCOL *This, + IN OUT VOID *SenseData, + IN OUT UINT32 *SenseDataSize, + OUT UINT8 *SenseDataNumber + ); + + +/** + This function is used to get controller information. + + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. + @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. + + @retval EFI_SUCCESS IdeChannel and IdeDevice are valid. + @retval EFI_UNSUPPORTED This is not an IDE device. + +**/ +EFI_STATUS +EFIAPI +NvmExpressDiskInfoWhichIde ( + IN EFI_DISK_INFO_PROTOCOL *This, + OUT UINT32 *IdeChannel, + OUT UINT32 *IdeDevice + ); + +#endif diff --git a/MdeModulePkg/Bus/Pci/XhciDxe/Xhci.c b/MdeModulePkg/Bus/Pci/XhciDxe/Xhci.c index a831abe772..bd308613f6 100644 --- a/MdeModulePkg/Bus/Pci/XhciDxe/Xhci.c +++ b/MdeModulePkg/Bus/Pci/XhciDxe/Xhci.c @@ -1,2205 +1,2205 @@ -/** @file - The XHCI controller driver. - -Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.
-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 "Xhci.h" - -// -// Two arrays used to translate the XHCI port state (change) -// to the UEFI protocol's port state (change). -// -USB_PORT_STATE_MAP mUsbPortStateMap[] = { - {XHC_PORTSC_CCS, USB_PORT_STAT_CONNECTION}, - {XHC_PORTSC_PED, USB_PORT_STAT_ENABLE}, - {XHC_PORTSC_OCA, USB_PORT_STAT_OVERCURRENT}, - {XHC_PORTSC_RESET, USB_PORT_STAT_RESET} -}; - -USB_PORT_STATE_MAP mUsbPortChangeMap[] = { - {XHC_PORTSC_CSC, USB_PORT_STAT_C_CONNECTION}, - {XHC_PORTSC_PEC, USB_PORT_STAT_C_ENABLE}, - {XHC_PORTSC_OCC, USB_PORT_STAT_C_OVERCURRENT}, - {XHC_PORTSC_PRC, USB_PORT_STAT_C_RESET} -}; - -USB_CLEAR_PORT_MAP mUsbClearPortChangeMap[] = { - {XHC_PORTSC_CSC, EfiUsbPortConnectChange}, - {XHC_PORTSC_PEC, EfiUsbPortEnableChange}, - {XHC_PORTSC_OCC, EfiUsbPortOverCurrentChange}, - {XHC_PORTSC_PRC, EfiUsbPortResetChange} -}; - -USB_PORT_STATE_MAP mUsbHubPortStateMap[] = { - {XHC_HUB_PORTSC_CCS, USB_PORT_STAT_CONNECTION}, - {XHC_HUB_PORTSC_PED, USB_PORT_STAT_ENABLE}, - {XHC_HUB_PORTSC_OCA, USB_PORT_STAT_OVERCURRENT}, - {XHC_HUB_PORTSC_RESET, USB_PORT_STAT_RESET} -}; - -USB_PORT_STATE_MAP mUsbHubPortChangeMap[] = { - {XHC_HUB_PORTSC_CSC, USB_PORT_STAT_C_CONNECTION}, - {XHC_HUB_PORTSC_PEC, USB_PORT_STAT_C_ENABLE}, - {XHC_HUB_PORTSC_OCC, USB_PORT_STAT_C_OVERCURRENT}, - {XHC_HUB_PORTSC_PRC, USB_PORT_STAT_C_RESET} -}; - -USB_CLEAR_PORT_MAP mUsbHubClearPortChangeMap[] = { - {XHC_HUB_PORTSC_CSC, EfiUsbPortConnectChange}, - {XHC_HUB_PORTSC_PEC, EfiUsbPortEnableChange}, - {XHC_HUB_PORTSC_OCC, EfiUsbPortOverCurrentChange}, - {XHC_HUB_PORTSC_PRC, EfiUsbPortResetChange}, - {XHC_HUB_PORTSC_BHRC, Usb3PortBHPortResetChange} -}; - -EFI_DRIVER_BINDING_PROTOCOL gXhciDriverBinding = { - XhcDriverBindingSupported, - XhcDriverBindingStart, - XhcDriverBindingStop, - 0x30, - NULL, - NULL -}; - -// -// Template for Xhci's Usb2 Host Controller Protocol Instance. -// -EFI_USB2_HC_PROTOCOL gXhciUsb2HcTemplate = { - XhcGetCapability, - XhcReset, - XhcGetState, - XhcSetState, - XhcControlTransfer, - XhcBulkTransfer, - XhcAsyncInterruptTransfer, - XhcSyncInterruptTransfer, - XhcIsochronousTransfer, - XhcAsyncIsochronousTransfer, - XhcGetRootHubPortStatus, - XhcSetRootHubPortFeature, - XhcClearRootHubPortFeature, - 0x3, - 0x0 -}; - -/** - Retrieves the capability of root hub ports. - - @param This The EFI_USB2_HC_PROTOCOL instance. - @param MaxSpeed Max speed supported by the controller. - @param PortNumber Number of the root hub ports. - @param Is64BitCapable Whether the controller supports 64-bit memory - addressing. - - @retval EFI_SUCCESS Host controller capability were retrieved successfully. - @retval EFI_INVALID_PARAMETER Either of the three capability pointer is NULL. - -**/ -EFI_STATUS -EFIAPI -XhcGetCapability ( - IN EFI_USB2_HC_PROTOCOL *This, - OUT UINT8 *MaxSpeed, - OUT UINT8 *PortNumber, - OUT UINT8 *Is64BitCapable - ) -{ - USB_XHCI_INSTANCE *Xhc; - EFI_TPL OldTpl; - - if ((MaxSpeed == NULL) || (PortNumber == NULL) || (Is64BitCapable == NULL)) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - *MaxSpeed = EFI_USB_SPEED_SUPER; - *PortNumber = (UINT8) (Xhc->HcSParams1.Data.MaxPorts); - *Is64BitCapable = (UINT8) (Xhc->HcCParams.Data.Ac64); - DEBUG ((EFI_D_INFO, "XhcGetCapability: %d ports, 64 bit %d\n", *PortNumber, *Is64BitCapable)); - - gBS->RestoreTPL (OldTpl); - - return EFI_SUCCESS; -} - - -/** - Provides software reset for the USB host controller. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param Attributes A bit mask of the reset operation to perform. - - @retval EFI_SUCCESS The reset operation succeeded. - @retval EFI_INVALID_PARAMETER Attributes is not valid. - @retval EFI_UNSUPPOURTED The type of reset specified by Attributes is - not currently supported by the host controller. - @retval EFI_DEVICE_ERROR Host controller isn't halted to reset. - -**/ -EFI_STATUS -EFIAPI -XhcReset ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT16 Attributes - ) -{ - USB_XHCI_INSTANCE *Xhc; - EFI_STATUS Status; - EFI_TPL OldTpl; - - Xhc = XHC_FROM_THIS (This); - - if (Xhc->DevicePath != NULL) { - // - // Report Status Code to indicate reset happens - // - REPORT_STATUS_CODE_WITH_DEVICE_PATH ( - EFI_PROGRESS_CODE, - (EFI_IO_BUS_USB | EFI_IOB_PC_RESET), - Xhc->DevicePath - ); - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - switch (Attributes) { - case EFI_USB_HC_RESET_GLOBAL: - // - // Flow through, same behavior as Host Controller Reset - // - case EFI_USB_HC_RESET_HOST_CONTROLLER: - if ((Xhc->DebugCapSupOffset != 0xFFFFFFFF) && ((XhcReadExtCapReg (Xhc, Xhc->DebugCapSupOffset) & 0xFF) == XHC_CAP_USB_DEBUG) && - ((XhcReadExtCapReg (Xhc, Xhc->DebugCapSupOffset + XHC_DC_DCCTRL) & BIT0) != 0)) { - Status = EFI_SUCCESS; - goto ON_EXIT; - } - // - // Host Controller must be Halt when Reset it - // - if (!XhcIsHalt (Xhc)) { - Status = XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); - - if (EFI_ERROR (Status)) { - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - } - - Status = XhcResetHC (Xhc, XHC_RESET_TIMEOUT); - ASSERT (!(XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_CNR))); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - // - // Clean up the asynchronous transfers, currently only - // interrupt supports asynchronous operation. - // - XhciDelAllAsyncIntTransfers (Xhc); - XhcFreeSched (Xhc); - - XhcInitSched (Xhc); - break; - - case EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG: - case EFI_USB_HC_RESET_HOST_WITH_DEBUG: - Status = EFI_UNSUPPORTED; - break; - - default: - Status = EFI_INVALID_PARAMETER; - } - -ON_EXIT: - DEBUG ((EFI_D_INFO, "XhcReset: status %r\n", Status)); - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Retrieve the current state of the USB host controller. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param State Variable to return the current host controller - state. - - @retval EFI_SUCCESS Host controller state was returned in State. - @retval EFI_INVALID_PARAMETER State is NULL. - @retval EFI_DEVICE_ERROR An error was encountered while attempting to - retrieve the host controller's current state. - -**/ -EFI_STATUS -EFIAPI -XhcGetState ( - IN EFI_USB2_HC_PROTOCOL *This, - OUT EFI_USB_HC_STATE *State - ) -{ - USB_XHCI_INSTANCE *Xhc; - EFI_TPL OldTpl; - - if (State == NULL) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - - if (XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_HALT)) { - *State = EfiUsbHcStateHalt; - } else { - *State = EfiUsbHcStateOperational; - } - - DEBUG ((EFI_D_INFO, "XhcGetState: current state %d\n", *State)); - gBS->RestoreTPL (OldTpl); - - return EFI_SUCCESS; -} - -/** - Sets the USB host controller to a specific state. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param State The state of the host controller that will be set. - - @retval EFI_SUCCESS The USB host controller was successfully placed - in the state specified by State. - @retval EFI_INVALID_PARAMETER State is invalid. - @retval EFI_DEVICE_ERROR Failed to set the state due to device error. - -**/ -EFI_STATUS -EFIAPI -XhcSetState ( - IN EFI_USB2_HC_PROTOCOL *This, - IN EFI_USB_HC_STATE State - ) -{ - USB_XHCI_INSTANCE *Xhc; - EFI_STATUS Status; - EFI_USB_HC_STATE CurState; - EFI_TPL OldTpl; - - Status = XhcGetState (This, &CurState); - - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - if (CurState == State) { - return EFI_SUCCESS; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - - switch (State) { - case EfiUsbHcStateHalt: - Status = XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); - break; - - case EfiUsbHcStateOperational: - if (XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_HSE)) { - Status = EFI_DEVICE_ERROR; - break; - } - - // - // Software must not write a one to this field unless the host controller - // is in the Halted state. Doing so will yield undefined results. - // refers to Spec[XHCI1.0-2.3.1] - // - if (!XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_HALT)) { - Status = EFI_DEVICE_ERROR; - break; - } - - Status = XhcRunHC (Xhc, XHC_GENERIC_TIMEOUT); - break; - - case EfiUsbHcStateSuspend: - Status = EFI_UNSUPPORTED; - break; - - default: - Status = EFI_INVALID_PARAMETER; - } - - DEBUG ((EFI_D_INFO, "XhcSetState: status %r\n", Status)); - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Retrieves the current status of a USB root hub port. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param PortNumber The root hub port to retrieve the state from. - This value is zero-based. - @param PortStatus Variable to receive the port state. - - @retval EFI_SUCCESS The status of the USB root hub port specified. - by PortNumber was returned in PortStatus. - @retval EFI_INVALID_PARAMETER PortNumber is invalid. - @retval EFI_DEVICE_ERROR Can't read register. - -**/ -EFI_STATUS -EFIAPI -XhcGetRootHubPortStatus ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 PortNumber, - OUT EFI_USB_PORT_STATUS *PortStatus - ) -{ - USB_XHCI_INSTANCE *Xhc; - UINT32 Offset; - UINT32 State; - UINT32 TotalPort; - UINTN Index; - UINTN MapSize; - EFI_STATUS Status; - USB_DEV_ROUTE ParentRouteChart; - EFI_TPL OldTpl; - - if (PortStatus == NULL) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - Status = EFI_SUCCESS; - - TotalPort = Xhc->HcSParams1.Data.MaxPorts; - - if (PortNumber >= TotalPort) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - Offset = (UINT32) (XHC_PORTSC_OFFSET + (0x10 * PortNumber)); - PortStatus->PortStatus = 0; - PortStatus->PortChangeStatus = 0; - - State = XhcReadOpReg (Xhc, Offset); - - // - // According to XHCI 1.0 spec, bit 10~13 of the root port status register identifies the speed of the attached device. - // - switch ((State & XHC_PORTSC_PS) >> 10) { - case 2: - PortStatus->PortStatus |= USB_PORT_STAT_LOW_SPEED; - break; - - case 3: - PortStatus->PortStatus |= USB_PORT_STAT_HIGH_SPEED; - break; - - case 4: - PortStatus->PortStatus |= USB_PORT_STAT_SUPER_SPEED; - break; - - default: - break; - } - - // - // Convert the XHCI port/port change state to UEFI status - // - MapSize = sizeof (mUsbPortStateMap) / sizeof (USB_PORT_STATE_MAP); - - for (Index = 0; Index < MapSize; Index++) { - if (XHC_BIT_IS_SET (State, mUsbPortStateMap[Index].HwState)) { - PortStatus->PortStatus = (UINT16) (PortStatus->PortStatus | mUsbPortStateMap[Index].UefiState); - } - } - // - // Bit5~8 reflects its current link state. - // - if ((State & XHC_PORTSC_PLS) >> 5 == 3) { - PortStatus->PortStatus |= USB_PORT_STAT_SUSPEND; - } - - MapSize = sizeof (mUsbPortChangeMap) / sizeof (USB_PORT_STATE_MAP); - - for (Index = 0; Index < MapSize; Index++) { - if (XHC_BIT_IS_SET (State, mUsbPortChangeMap[Index].HwState)) { - PortStatus->PortChangeStatus = (UINT16) (PortStatus->PortChangeStatus | mUsbPortChangeMap[Index].UefiState); - } - } - - MapSize = sizeof (mUsbClearPortChangeMap) / sizeof (USB_CLEAR_PORT_MAP); - - for (Index = 0; Index < MapSize; Index++) { - if (XHC_BIT_IS_SET (State, mUsbClearPortChangeMap[Index].HwState)) { - XhcClearRootHubPortFeature (This, PortNumber, (EFI_USB_PORT_FEATURE)mUsbClearPortChangeMap[Index].Selector); - } - } - - // - // Poll the root port status register to enable/disable corresponding device slot if there is a device attached/detached. - // For those devices behind hub, we get its attach/detach event by hooking Get_Port_Status request at control transfer for those hub. - // - ParentRouteChart.Dword = 0; - XhcPollPortStatusChange (Xhc, ParentRouteChart, PortNumber, PortStatus); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Sets a feature for the specified root hub port. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param PortNumber Root hub port to set. - @param PortFeature Feature to set. - - @retval EFI_SUCCESS The feature specified by PortFeature was set. - @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid. - @retval EFI_DEVICE_ERROR Can't read register. - -**/ -EFI_STATUS -EFIAPI -XhcSetRootHubPortFeature ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 PortNumber, - IN EFI_USB_PORT_FEATURE PortFeature - ) -{ - USB_XHCI_INSTANCE *Xhc; - UINT32 Offset; - UINT32 State; - UINT32 TotalPort; - EFI_STATUS Status; - EFI_TPL OldTpl; - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - Status = EFI_SUCCESS; - - TotalPort = (Xhc->HcSParams1.Data.MaxPorts); - - if (PortNumber >= TotalPort) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - Offset = (UINT32) (XHC_PORTSC_OFFSET + (0x10 * PortNumber)); - State = XhcReadOpReg (Xhc, Offset); - - // - // Mask off the port status change bits, these bits are - // write clean bit - // - State &= ~ (BIT1 | BIT17 | BIT18 | BIT19 | BIT20 | BIT21 | BIT22 | BIT23); - - switch (PortFeature) { - case EfiUsbPortEnable: - // - // Ports may only be enabled by the xHC. Software cannot enable a port by writing a '1' to this flag. - // A port may be disabled by software writing a '1' to this flag. - // - Status = EFI_SUCCESS; - break; - - case EfiUsbPortSuspend: - State |= XHC_PORTSC_LWS; - XhcWriteOpReg (Xhc, Offset, State); - State &= ~XHC_PORTSC_PLS; - State |= (3 << 5) ; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortReset: - DEBUG ((EFI_D_INFO, "XhcUsbPortReset!\n")); - // - // Make sure Host Controller not halt before reset it - // - if (XhcIsHalt (Xhc)) { - Status = XhcRunHC (Xhc, XHC_GENERIC_TIMEOUT); - - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_INFO, "XhcSetRootHubPortFeature :failed to start HC - %r\n", Status)); - break; - } - } - - // - // 4.3.1 Resetting a Root Hub Port - // 1) Write the PORTSC register with the Port Reset (PR) bit set to '1'. - // - State |= XHC_PORTSC_RESET; - XhcWriteOpReg (Xhc, Offset, State); - XhcWaitOpRegBit(Xhc, Offset, XHC_PORTSC_PRC, TRUE, XHC_GENERIC_TIMEOUT); - break; - - case EfiUsbPortPower: - // - // Not supported, ignore the operation - // - Status = EFI_SUCCESS; - break; - - case EfiUsbPortOwner: - // - // XHCI root hub port don't has the owner bit, ignore the operation - // - Status = EFI_SUCCESS; - break; - - default: - Status = EFI_INVALID_PARAMETER; - } - -ON_EXIT: - DEBUG ((EFI_D_INFO, "XhcSetRootHubPortFeature: status %r\n", Status)); - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Clears a feature for the specified root hub port. - - @param This A pointer to the EFI_USB2_HC_PROTOCOL instance. - @param PortNumber Specifies the root hub port whose feature is - requested to be cleared. - @param PortFeature Indicates the feature selector associated with the - feature clear request. - - @retval EFI_SUCCESS The feature specified by PortFeature was cleared - for the USB root hub port specified by PortNumber. - @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid. - @retval EFI_DEVICE_ERROR Can't read register. - -**/ -EFI_STATUS -EFIAPI -XhcClearRootHubPortFeature ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 PortNumber, - IN EFI_USB_PORT_FEATURE PortFeature - ) -{ - USB_XHCI_INSTANCE *Xhc; - UINT32 Offset; - UINT32 State; - UINT32 TotalPort; - EFI_STATUS Status; - EFI_TPL OldTpl; - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - Status = EFI_SUCCESS; - - TotalPort = (Xhc->HcSParams1.Data.MaxPorts); - - if (PortNumber >= TotalPort) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - Offset = XHC_PORTSC_OFFSET + (0x10 * PortNumber); - - // - // Mask off the port status change bits, these bits are - // write clean bit - // - State = XhcReadOpReg (Xhc, Offset); - State &= ~ (BIT1 | BIT17 | BIT18 | BIT19 | BIT20 | BIT21 | BIT22 | BIT23); - - switch (PortFeature) { - case EfiUsbPortEnable: - // - // Ports may only be enabled by the xHC. Software cannot enable a port by writing a '1' to this flag. - // A port may be disabled by software writing a '1' to this flag. - // - State |= XHC_PORTSC_PED; - State &= ~XHC_PORTSC_RESET; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortSuspend: - State |= XHC_PORTSC_LWS; - XhcWriteOpReg (Xhc, Offset, State); - State &= ~XHC_PORTSC_PLS; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortReset: - // - // PORTSC_RESET BIT(4) bit is RW1S attribute, which means Write-1-to-set status: - // Register bits indicate status when read, a clear bit may be set by - // writing a '1'. Writing a '0' to RW1S bits has no effect. - // - break; - - case EfiUsbPortOwner: - // - // XHCI root hub port don't has the owner bit, ignore the operation - // - break; - - case EfiUsbPortConnectChange: - // - // Clear connect status change - // - State |= XHC_PORTSC_CSC; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortEnableChange: - // - // Clear enable status change - // - State |= XHC_PORTSC_PEC; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortOverCurrentChange: - // - // Clear PortOverCurrent change - // - State |= XHC_PORTSC_OCC; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortResetChange: - // - // Clear Port Reset change - // - State |= XHC_PORTSC_PRC; - XhcWriteOpReg (Xhc, Offset, State); - break; - - case EfiUsbPortPower: - case EfiUsbPortSuspendChange: - // - // Not supported or not related operation - // - break; - - default: - Status = EFI_INVALID_PARAMETER; - break; - } - -ON_EXIT: - DEBUG ((EFI_D_INFO, "XhcClearRootHubPortFeature: status %r\n", Status)); - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Submits control transfer to a target USB device. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress The target device address. - @param DeviceSpeed Target device speed. - @param MaximumPacketLength Maximum packet size the default control transfer - endpoint is capable of sending or receiving. - @param Request USB device request to send. - @param TransferDirection Specifies the data direction for the data stage - @param Data Data buffer to be transmitted or received from USB - device. - @param DataLength The size (in bytes) of the data buffer. - @param Timeout Indicates the maximum timeout, in millisecond. - @param Translator Transaction translator to be used by this device. - @param TransferResult Return the result of this control transfer. - - @retval EFI_SUCCESS Transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resources. - @retval EFI_INVALID_PARAMETER Some parameters are invalid. - @retval EFI_TIMEOUT Transfer failed due to timeout. - @retval EFI_DEVICE_ERROR Transfer failed due to host controller or device error. - -**/ -EFI_STATUS -EFIAPI -XhcControlTransfer ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 DeviceAddress, - IN UINT8 DeviceSpeed, - IN UINTN MaximumPacketLength, - IN EFI_USB_DEVICE_REQUEST *Request, - IN EFI_USB_DATA_DIRECTION TransferDirection, - IN OUT VOID *Data, - IN OUT UINTN *DataLength, - IN UINTN Timeout, - IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, - OUT UINT32 *TransferResult - ) -{ - USB_XHCI_INSTANCE *Xhc; - URB *Urb; - UINT8 Endpoint; - UINT8 Index; - UINT8 DescriptorType; - UINT8 SlotId; - UINT8 TTT; - UINT8 MTT; - UINT32 MaxPacket0; - EFI_USB_HUB_DESCRIPTOR *HubDesc; - EFI_TPL OldTpl; - EFI_STATUS Status; - EFI_STATUS RecoveryStatus; - UINTN MapSize; - EFI_USB_PORT_STATUS PortStatus; - UINT32 State; - EFI_USB_DEVICE_REQUEST ClearPortRequest; - UINTN Len; - - // - // Validate parameters - // - if ((Request == NULL) || (TransferResult == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((TransferDirection != EfiUsbDataIn) && - (TransferDirection != EfiUsbDataOut) && - (TransferDirection != EfiUsbNoData)) { - return EFI_INVALID_PARAMETER; - } - - if ((TransferDirection == EfiUsbNoData) && - ((Data != NULL) || (*DataLength != 0))) { - return EFI_INVALID_PARAMETER; - } - - if ((TransferDirection != EfiUsbNoData) && - ((Data == NULL) || (*DataLength == 0))) { - return EFI_INVALID_PARAMETER; - } - - if ((MaximumPacketLength != 8) && (MaximumPacketLength != 16) && - (MaximumPacketLength != 32) && (MaximumPacketLength != 64) && - (MaximumPacketLength != 512) - ) { - return EFI_INVALID_PARAMETER; - } - - if ((DeviceSpeed == EFI_USB_SPEED_LOW) && (MaximumPacketLength != 8)) { - return EFI_INVALID_PARAMETER; - } - - if ((DeviceSpeed == EFI_USB_SPEED_SUPER) && (MaximumPacketLength != 512)) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - - Status = EFI_DEVICE_ERROR; - *TransferResult = EFI_USB_ERR_SYSTEM; - Len = 0; - - if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { - DEBUG ((EFI_D_ERROR, "XhcControlTransfer: HC halted at entrance\n")); - goto ON_EXIT; - } - - // - // Check if the device is still enabled before every transaction. - // - SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); - if (SlotId == 0) { - goto ON_EXIT; - } - - // - // Hook the Set_Address request from UsbBus. - // According to XHCI 1.0 spec, the Set_Address request is replaced by XHCI's Address_Device cmd. - // - if ((Request->Request == USB_REQ_SET_ADDRESS) && - (Request->RequestType == USB_REQUEST_TYPE (EfiUsbNoData, USB_REQ_TYPE_STANDARD, USB_TARGET_DEVICE))) { - // - // Reset the BusDevAddr field of all disabled entries in UsbDevContext array firstly. - // This way is used to clean the history to avoid using wrong device address by XhcAsyncInterruptTransfer(). - // - for (Index = 0; Index < 255; Index++) { - if (!Xhc->UsbDevContext[Index + 1].Enabled && - (Xhc->UsbDevContext[Index + 1].SlotId == 0) && - (Xhc->UsbDevContext[Index + 1].BusDevAddr == (UINT8)Request->Value)) { - Xhc->UsbDevContext[Index + 1].BusDevAddr = 0; - } - } - - if (Xhc->UsbDevContext[SlotId].XhciDevAddr == 0) { - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - // - // The actual device address has been assigned by XHCI during initializing the device slot. - // So we just need establish the mapping relationship between the device address requested from UsbBus - // and the actual device address assigned by XHCI. The the following invocations through EFI_USB2_HC_PROTOCOL interface - // can find out the actual device address by it. - // - Xhc->UsbDevContext[SlotId].BusDevAddr = (UINT8)Request->Value; - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // Create a new URB, insert it into the asynchronous - // schedule list, then poll the execution status. - // Note that we encode the direction in address although default control - // endpoint is bidirectional. XhcCreateUrb expects this - // combination of Ep addr and its direction. - // - Endpoint = (UINT8) (0 | ((TransferDirection == EfiUsbDataIn) ? 0x80 : 0)); - Urb = XhcCreateUrb ( - Xhc, - DeviceAddress, - Endpoint, - DeviceSpeed, - MaximumPacketLength, - XHC_CTRL_TRANSFER, - Request, - Data, - *DataLength, - NULL, - NULL - ); - - if (Urb == NULL) { - DEBUG ((EFI_D_ERROR, "XhcControlTransfer: failed to create URB")); - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - Status = XhcExecTransfer (Xhc, FALSE, Urb, Timeout); - - // - // Get the status from URB. The result is updated in XhcCheckUrbResult - // which is called by XhcExecTransfer - // - *TransferResult = Urb->Result; - *DataLength = Urb->Completed; - - if (*TransferResult == EFI_USB_NOERROR) { - Status = EFI_SUCCESS; - } else if (*TransferResult == EFI_USB_ERR_STALL) { - RecoveryStatus = XhcRecoverHaltedEndpoint(Xhc, Urb); - if (EFI_ERROR (RecoveryStatus)) { - DEBUG ((EFI_D_ERROR, "XhcControlTransfer: XhcRecoverHaltedEndpoint failed\n")); - } - Status = EFI_DEVICE_ERROR; - goto FREE_URB; - } else { - goto FREE_URB; - } - - Xhc->PciIo->Flush (Xhc->PciIo); - - if (Urb->DataMap != NULL) { - Status = Xhc->PciIo->Unmap (Xhc->PciIo, Urb->DataMap); - ASSERT_EFI_ERROR (Status); - if (EFI_ERROR (Status)) { - Status = EFI_DEVICE_ERROR; - goto FREE_URB; - } - } - - // - // Hook Get_Descriptor request from UsbBus as we need evaluate context and configure endpoint. - // Hook Get_Status request form UsbBus as we need trace device attach/detach event happened at hub. - // Hook Set_Config request from UsbBus as we need configure device endpoint. - // - if ((Request->Request == USB_REQ_GET_DESCRIPTOR) && - ((Request->RequestType == USB_REQUEST_TYPE (EfiUsbDataIn, USB_REQ_TYPE_STANDARD, USB_TARGET_DEVICE)) || - ((Request->RequestType == USB_REQUEST_TYPE (EfiUsbDataIn, USB_REQ_TYPE_CLASS, USB_TARGET_DEVICE))))) { - DescriptorType = (UINT8)(Request->Value >> 8); - if ((DescriptorType == USB_DESC_TYPE_DEVICE) && ((*DataLength == sizeof (EFI_USB_DEVICE_DESCRIPTOR)) || ((DeviceSpeed == EFI_USB_SPEED_FULL) && (*DataLength == 8)))) { - ASSERT (Data != NULL); - // - // Store a copy of device scriptor as hub device need this info to configure endpoint. - // - CopyMem (&Xhc->UsbDevContext[SlotId].DevDesc, Data, *DataLength); - if (Xhc->UsbDevContext[SlotId].DevDesc.BcdUSB == 0x0300) { - // - // If it's a usb3.0 device, then its max packet size is a 2^n. - // - MaxPacket0 = 1 << Xhc->UsbDevContext[SlotId].DevDesc.MaxPacketSize0; - } else { - MaxPacket0 = Xhc->UsbDevContext[SlotId].DevDesc.MaxPacketSize0; - } - Xhc->UsbDevContext[SlotId].ConfDesc = AllocateZeroPool (Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations * sizeof (EFI_USB_CONFIG_DESCRIPTOR *)); - if (Xhc->HcCParams.Data.Csz == 0) { - Status = XhcEvaluateContext (Xhc, SlotId, MaxPacket0); - } else { - Status = XhcEvaluateContext64 (Xhc, SlotId, MaxPacket0); - } - } else if (DescriptorType == USB_DESC_TYPE_CONFIG) { - ASSERT (Data != NULL); - if (*DataLength == ((UINT16 *)Data)[1]) { - // - // Get configuration value from request, Store the configuration descriptor for Configure_Endpoint cmd. - // - Index = (UINT8)Request->Value; - ASSERT (Index < Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations); - Xhc->UsbDevContext[SlotId].ConfDesc[Index] = AllocateZeroPool(*DataLength); - CopyMem (Xhc->UsbDevContext[SlotId].ConfDesc[Index], Data, *DataLength); - } - } else if (((DescriptorType == USB_DESC_TYPE_HUB) || - (DescriptorType == USB_DESC_TYPE_HUB_SUPER_SPEED)) && (*DataLength > 2)) { - ASSERT (Data != NULL); - HubDesc = (EFI_USB_HUB_DESCRIPTOR *)Data; - ASSERT (HubDesc->NumPorts <= 15); - // - // The bit 5,6 of HubCharacter field of Hub Descriptor is TTT. - // - TTT = (UINT8)((HubDesc->HubCharacter & (BIT5 | BIT6)) >> 5); - if (Xhc->UsbDevContext[SlotId].DevDesc.DeviceProtocol == 2) { - // - // Don't support multi-TT feature for super speed hub now. - // - MTT = 0; - DEBUG ((EFI_D_ERROR, "XHCI: Don't support multi-TT feature for Hub now. (force to disable MTT)\n")); - } else { - MTT = 0; - } - - if (Xhc->HcCParams.Data.Csz == 0) { - Status = XhcConfigHubContext (Xhc, SlotId, HubDesc->NumPorts, TTT, MTT); - } else { - Status = XhcConfigHubContext64 (Xhc, SlotId, HubDesc->NumPorts, TTT, MTT); - } - } - } else if ((Request->Request == USB_REQ_SET_CONFIG) && - (Request->RequestType == USB_REQUEST_TYPE (EfiUsbNoData, USB_REQ_TYPE_STANDARD, USB_TARGET_DEVICE))) { - // - // Hook Set_Config request from UsbBus as we need configure device endpoint. - // - for (Index = 0; Index < Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations; Index++) { - if (Xhc->UsbDevContext[SlotId].ConfDesc[Index]->ConfigurationValue == (UINT8)Request->Value) { - if (Xhc->HcCParams.Data.Csz == 0) { - Status = XhcSetConfigCmd (Xhc, SlotId, DeviceSpeed, Xhc->UsbDevContext[SlotId].ConfDesc[Index]); - } else { - Status = XhcSetConfigCmd64 (Xhc, SlotId, DeviceSpeed, Xhc->UsbDevContext[SlotId].ConfDesc[Index]); - } - break; - } - } - } else if ((Request->Request == USB_REQ_GET_STATUS) && - (Request->RequestType == USB_REQUEST_TYPE (EfiUsbDataIn, USB_REQ_TYPE_CLASS, USB_TARGET_OTHER))) { - ASSERT (Data != NULL); - // - // Hook Get_Status request from UsbBus to keep track of the port status change. - // - State = *(UINT32 *)Data; - PortStatus.PortStatus = 0; - PortStatus.PortChangeStatus = 0; - - if (DeviceSpeed == EFI_USB_SPEED_SUPER) { - // - // For super speed hub, its bit10~12 presents the attached device speed. - // - if ((State & XHC_PORTSC_PS) >> 10 == 0) { - PortStatus.PortStatus |= USB_PORT_STAT_SUPER_SPEED; - } - } else { - // - // For high or full/low speed hub, its bit9~10 presents the attached device speed. - // - if (XHC_BIT_IS_SET (State, BIT9)) { - PortStatus.PortStatus |= USB_PORT_STAT_LOW_SPEED; - } else if (XHC_BIT_IS_SET (State, BIT10)) { - PortStatus.PortStatus |= USB_PORT_STAT_HIGH_SPEED; - } - } - - // - // Convert the XHCI port/port change state to UEFI status - // - MapSize = sizeof (mUsbHubPortStateMap) / sizeof (USB_PORT_STATE_MAP); - for (Index = 0; Index < MapSize; Index++) { - if (XHC_BIT_IS_SET (State, mUsbHubPortStateMap[Index].HwState)) { - PortStatus.PortStatus = (UINT16) (PortStatus.PortStatus | mUsbHubPortStateMap[Index].UefiState); - } - } - - MapSize = sizeof (mUsbHubPortChangeMap) / sizeof (USB_PORT_STATE_MAP); - for (Index = 0; Index < MapSize; Index++) { - if (XHC_BIT_IS_SET (State, mUsbHubPortChangeMap[Index].HwState)) { - PortStatus.PortChangeStatus = (UINT16) (PortStatus.PortChangeStatus | mUsbHubPortChangeMap[Index].UefiState); - } - } - - MapSize = sizeof (mUsbHubClearPortChangeMap) / sizeof (USB_CLEAR_PORT_MAP); - - for (Index = 0; Index < MapSize; Index++) { - if (XHC_BIT_IS_SET (State, mUsbHubClearPortChangeMap[Index].HwState)) { - ZeroMem (&ClearPortRequest, sizeof (EFI_USB_DEVICE_REQUEST)); - ClearPortRequest.RequestType = USB_REQUEST_TYPE (EfiUsbNoData, USB_REQ_TYPE_CLASS, USB_TARGET_OTHER); - ClearPortRequest.Request = (UINT8) USB_REQ_CLEAR_FEATURE; - ClearPortRequest.Value = mUsbHubClearPortChangeMap[Index].Selector; - ClearPortRequest.Index = Request->Index; - ClearPortRequest.Length = 0; - - XhcControlTransfer ( - This, - DeviceAddress, - DeviceSpeed, - MaximumPacketLength, - &ClearPortRequest, - EfiUsbNoData, - NULL, - &Len, - Timeout, - Translator, - TransferResult - ); - } - } - - XhcPollPortStatusChange (Xhc, Xhc->UsbDevContext[SlotId].RouteString, (UINT8)Request->Index, &PortStatus); - - *(UINT32 *)Data = *(UINT32*)&PortStatus; - } - -FREE_URB: - FreePool (Urb); - -ON_EXIT: - - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "XhcControlTransfer: error - %r, transfer - %x\n", Status, *TransferResult)); - } - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Submits bulk transfer to a bulk endpoint of a USB device. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address. - @param EndPointAddress Endpoint number and its direction in bit 7. - @param DeviceSpeed Device speed, Low speed device doesn't support bulk - transfer. - @param MaximumPacketLength Maximum packet size the endpoint is capable of - sending or receiving. - @param DataBuffersNumber Number of data buffers prepared for the transfer. - @param Data Array of pointers to the buffers of data to transmit - from or receive into. - @param DataLength The lenght of the data buffer. - @param DataToggle On input, the initial data toggle for the transfer; - On output, it is updated to to next data toggle to - use of the subsequent bulk transfer. - @param Timeout Indicates the maximum time, in millisecond, which - the transfer is allowed to complete. - @param Translator A pointr to the transaction translator data. - @param TransferResult A pointer to the detailed result information of the - bulk transfer. - - @retval EFI_SUCCESS The transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource. - @retval EFI_INVALID_PARAMETER Some parameters are invalid. - @retval EFI_TIMEOUT The transfer failed due to timeout. - @retval EFI_DEVICE_ERROR The transfer failed due to host controller error. - -**/ -EFI_STATUS -EFIAPI -XhcBulkTransfer ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 DeviceAddress, - IN UINT8 EndPointAddress, - IN UINT8 DeviceSpeed, - IN UINTN MaximumPacketLength, - IN UINT8 DataBuffersNumber, - IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM], - IN OUT UINTN *DataLength, - IN OUT UINT8 *DataToggle, - IN UINTN Timeout, - IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, - OUT UINT32 *TransferResult - ) -{ - USB_XHCI_INSTANCE *Xhc; - URB *Urb; - UINT8 SlotId; - EFI_STATUS Status; - EFI_STATUS RecoveryStatus; - EFI_TPL OldTpl; - - // - // Validate the parameters - // - if ((DataLength == NULL) || (*DataLength == 0) || - (Data == NULL) || (Data[0] == NULL) || (TransferResult == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((*DataToggle != 0) && (*DataToggle != 1)) { - return EFI_INVALID_PARAMETER; - } - - if ((DeviceSpeed == EFI_USB_SPEED_LOW) || - ((DeviceSpeed == EFI_USB_SPEED_FULL) && (MaximumPacketLength > 64)) || - ((EFI_USB_SPEED_HIGH == DeviceSpeed) && (MaximumPacketLength > 512)) || - ((EFI_USB_SPEED_SUPER == DeviceSpeed) && (MaximumPacketLength > 1024))) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - - *TransferResult = EFI_USB_ERR_SYSTEM; - Status = EFI_DEVICE_ERROR; - - if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { - DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: HC is halted\n")); - goto ON_EXIT; - } - - // - // Check if the device is still enabled before every transaction. - // - SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); - if (SlotId == 0) { - goto ON_EXIT; - } - - // - // Create a new URB, insert it into the asynchronous - // schedule list, then poll the execution status. - // - Urb = XhcCreateUrb ( - Xhc, - DeviceAddress, - EndPointAddress, - DeviceSpeed, - MaximumPacketLength, - XHC_BULK_TRANSFER, - NULL, - Data[0], - *DataLength, - NULL, - NULL - ); - - if (Urb == NULL) { - DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: failed to create URB\n")); - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - Status = XhcExecTransfer (Xhc, FALSE, Urb, Timeout); - - *TransferResult = Urb->Result; - *DataLength = Urb->Completed; - - if (*TransferResult == EFI_USB_NOERROR) { - Status = EFI_SUCCESS; - } else if (*TransferResult == EFI_USB_ERR_STALL) { - RecoveryStatus = XhcRecoverHaltedEndpoint(Xhc, Urb); - if (EFI_ERROR (RecoveryStatus)) { - DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: XhcRecoverHaltedEndpoint failed\n")); - } - Status = EFI_DEVICE_ERROR; - } - - Xhc->PciIo->Flush (Xhc->PciIo); - XhcFreeUrb (Xhc, Urb); - -ON_EXIT: - - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: error - %r, transfer - %x\n", Status, *TransferResult)); - } - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Submits an asynchronous interrupt transfer to an - interrupt endpoint of a USB device. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address. - @param EndPointAddress Endpoint number and its direction encoded in bit 7 - @param DeviceSpeed Indicates device speed. - @param MaximumPacketLength Maximum packet size the target endpoint is capable - @param IsNewTransfer If TRUE, to submit an new asynchronous interrupt - transfer If FALSE, to remove the specified - asynchronous interrupt. - @param DataToggle On input, the initial data toggle to use; on output, - it is updated to indicate the next data toggle. - @param PollingInterval The he interval, in milliseconds, that the transfer - is polled. - @param DataLength The length of data to receive at the rate specified - by PollingInterval. - @param Translator Transaction translator to use. - @param CallBackFunction Function to call at the rate specified by - PollingInterval. - @param Context Context to CallBackFunction. - - @retval EFI_SUCCESS The request has been successfully submitted or canceled. - @retval EFI_INVALID_PARAMETER Some parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The request failed due to a lack of resources. - @retval EFI_DEVICE_ERROR The transfer failed due to host controller error. - -**/ -EFI_STATUS -EFIAPI -XhcAsyncInterruptTransfer ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 DeviceAddress, - IN UINT8 EndPointAddress, - IN UINT8 DeviceSpeed, - IN UINTN MaximumPacketLength, - IN BOOLEAN IsNewTransfer, - IN OUT UINT8 *DataToggle, - IN UINTN PollingInterval, - IN UINTN DataLength, - IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, - IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction, - IN VOID *Context OPTIONAL - ) -{ - USB_XHCI_INSTANCE *Xhc; - URB *Urb; - EFI_STATUS Status; - UINT8 SlotId; - UINT8 Index; - UINT8 *Data; - EFI_TPL OldTpl; - - // - // Validate parameters - // - if (!XHCI_IS_DATAIN (EndPointAddress)) { - return EFI_INVALID_PARAMETER; - } - - if (IsNewTransfer) { - if (DataLength == 0) { - return EFI_INVALID_PARAMETER; - } - - if ((*DataToggle != 1) && (*DataToggle != 0)) { - return EFI_INVALID_PARAMETER; - } - - if ((PollingInterval > 255) || (PollingInterval < 1)) { - return EFI_INVALID_PARAMETER; - } - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - - // - // Delete Async interrupt transfer request. - // - if (!IsNewTransfer) { - // - // The delete request may happen after device is detached. - // - for (Index = 0; Index < 255; Index++) { - if (Xhc->UsbDevContext[Index + 1].BusDevAddr == DeviceAddress) { - break; - } - } - - if (Index == 255) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - Status = XhciDelAsyncIntTransfer (Xhc, DeviceAddress, EndPointAddress); - DEBUG ((EFI_D_INFO, "XhcAsyncInterruptTransfer: remove old transfer for addr %d, Status = %r\n", DeviceAddress, Status)); - goto ON_EXIT; - } - - Status = EFI_SUCCESS; - - if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { - DEBUG ((EFI_D_ERROR, "XhcAsyncInterruptTransfer: HC is halt\n")); - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - // - // Check if the device is still enabled before every transaction. - // - SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); - if (SlotId == 0) { - goto ON_EXIT; - } - - Data = AllocateZeroPool (DataLength); - - if (Data == NULL) { - DEBUG ((EFI_D_ERROR, "XhcAsyncInterruptTransfer: failed to allocate buffer\n")); - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - Urb = XhcCreateUrb ( - Xhc, - DeviceAddress, - EndPointAddress, - DeviceSpeed, - MaximumPacketLength, - XHC_INT_TRANSFER_ASYNC, - NULL, - Data, - DataLength, - CallBackFunction, - Context - ); - - if (Urb == NULL) { - DEBUG ((EFI_D_ERROR, "XhcAsyncInterruptTransfer: failed to create URB\n")); - FreePool (Data); - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - InsertHeadList (&Xhc->AsyncIntTransfers, &Urb->UrbList); - // - // Ring the doorbell - // - Status = RingIntTransferDoorBell (Xhc, Urb); - -ON_EXIT: - Xhc->PciIo->Flush (Xhc->PciIo); - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Submits synchronous interrupt transfer to an interrupt endpoint - of a USB device. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address. - @param EndPointAddress Endpoint number and its direction encoded in bit 7 - @param DeviceSpeed Indicates device speed. - @param MaximumPacketLength Maximum packet size the target endpoint is capable - of sending or receiving. - @param Data Buffer of data that will be transmitted to USB - device or received from USB device. - @param DataLength On input, the size, in bytes, of the data buffer; On - output, the number of bytes transferred. - @param DataToggle On input, the initial data toggle to use; on output, - it is updated to indicate the next data toggle. - @param Timeout Maximum time, in second, to complete. - @param Translator Transaction translator to use. - @param TransferResult Variable to receive the transfer result. - - @return EFI_SUCCESS The transfer was completed successfully. - @return EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource. - @return EFI_INVALID_PARAMETER Some parameters are invalid. - @return EFI_TIMEOUT The transfer failed due to timeout. - @return EFI_DEVICE_ERROR The failed due to host controller or device error - -**/ -EFI_STATUS -EFIAPI -XhcSyncInterruptTransfer ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 DeviceAddress, - IN UINT8 EndPointAddress, - IN UINT8 DeviceSpeed, - IN UINTN MaximumPacketLength, - IN OUT VOID *Data, - IN OUT UINTN *DataLength, - IN OUT UINT8 *DataToggle, - IN UINTN Timeout, - IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, - OUT UINT32 *TransferResult - ) -{ - USB_XHCI_INSTANCE *Xhc; - URB *Urb; - UINT8 SlotId; - EFI_STATUS Status; - EFI_STATUS RecoveryStatus; - EFI_TPL OldTpl; - - // - // Validates parameters - // - if ((DataLength == NULL) || (*DataLength == 0) || - (Data == NULL) || (TransferResult == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (!XHCI_IS_DATAIN (EndPointAddress)) { - return EFI_INVALID_PARAMETER; - } - - if ((*DataToggle != 1) && (*DataToggle != 0)) { - return EFI_INVALID_PARAMETER; - } - - if (((DeviceSpeed == EFI_USB_SPEED_LOW) && (MaximumPacketLength != 8)) || - ((DeviceSpeed == EFI_USB_SPEED_FULL) && (MaximumPacketLength > 64)) || - ((DeviceSpeed == EFI_USB_SPEED_HIGH) && (MaximumPacketLength > 3072))) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (XHC_TPL); - - Xhc = XHC_FROM_THIS (This); - - *TransferResult = EFI_USB_ERR_SYSTEM; - Status = EFI_DEVICE_ERROR; - - if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { - DEBUG ((EFI_D_ERROR, "EhcSyncInterruptTransfer: HC is halt\n")); - goto ON_EXIT; - } - - // - // Check if the device is still enabled before every transaction. - // - SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); - if (SlotId == 0) { - goto ON_EXIT; - } - - Urb = XhcCreateUrb ( - Xhc, - DeviceAddress, - EndPointAddress, - DeviceSpeed, - MaximumPacketLength, - XHC_INT_TRANSFER_SYNC, - NULL, - Data, - *DataLength, - NULL, - NULL - ); - - if (Urb == NULL) { - DEBUG ((EFI_D_ERROR, "XhcSyncInterruptTransfer: failed to create URB\n")); - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - Status = XhcExecTransfer (Xhc, FALSE, Urb, Timeout); - - *TransferResult = Urb->Result; - *DataLength = Urb->Completed; - - if (*TransferResult == EFI_USB_NOERROR) { - Status = EFI_SUCCESS; - } else if (*TransferResult == EFI_USB_ERR_STALL) { - RecoveryStatus = XhcRecoverHaltedEndpoint(Xhc, Urb); - if (EFI_ERROR (RecoveryStatus)) { - DEBUG ((EFI_D_ERROR, "XhcSyncInterruptTransfer: XhcRecoverHaltedEndpoint failed\n")); - } - Status = EFI_DEVICE_ERROR; - } - - Xhc->PciIo->Flush (Xhc->PciIo); - XhcFreeUrb (Xhc, Urb); - -ON_EXIT: - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "XhcSyncInterruptTransfer: error - %r, transfer - %x\n", Status, *TransferResult)); - } - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Submits isochronous transfer to a target USB device. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address. - @param EndPointAddress End point address with its direction. - @param DeviceSpeed Device speed, Low speed device doesn't support this - type. - @param MaximumPacketLength Maximum packet size that the endpoint is capable of - sending or receiving. - @param DataBuffersNumber Number of data buffers prepared for the transfer. - @param Data Array of pointers to the buffers of data that will - be transmitted to USB device or received from USB - device. - @param DataLength The size, in bytes, of the data buffer. - @param Translator Transaction translator to use. - @param TransferResult Variable to receive the transfer result. - - @return EFI_UNSUPPORTED Isochronous transfer is unsupported. - -**/ -EFI_STATUS -EFIAPI -XhcIsochronousTransfer ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 DeviceAddress, - IN UINT8 EndPointAddress, - IN UINT8 DeviceSpeed, - IN UINTN MaximumPacketLength, - IN UINT8 DataBuffersNumber, - IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], - IN UINTN DataLength, - IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, - OUT UINT32 *TransferResult - ) -{ - return EFI_UNSUPPORTED; -} - - -/** - Submits Async isochronous transfer to a target USB device. - - @param This This EFI_USB2_HC_PROTOCOL instance. - @param DeviceAddress Target device address. - @param EndPointAddress End point address with its direction. - @param DeviceSpeed Device speed, Low speed device doesn't support this - type. - @param MaximumPacketLength Maximum packet size that the endpoint is capable of - sending or receiving. - @param DataBuffersNumber Number of data buffers prepared for the transfer. - @param Data Array of pointers to the buffers of data that will - be transmitted to USB device or received from USB - device. - @param DataLength The size, in bytes, of the data buffer. - @param Translator Transaction translator to use. - @param IsochronousCallBack Function to be called when the transfer complete. - @param Context Context passed to the call back function as - parameter. - - @return EFI_UNSUPPORTED Isochronous transfer isn't supported. - -**/ -EFI_STATUS -EFIAPI -XhcAsyncIsochronousTransfer ( - IN EFI_USB2_HC_PROTOCOL *This, - IN UINT8 DeviceAddress, - IN UINT8 EndPointAddress, - IN UINT8 DeviceSpeed, - IN UINTN MaximumPacketLength, - IN UINT8 DataBuffersNumber, - IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], - IN UINTN DataLength, - IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, - IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, - IN VOID *Context - ) -{ - return EFI_UNSUPPORTED; -} - -/** - Entry point for EFI drivers. - - @param ImageHandle EFI_HANDLE. - @param SystemTable EFI_SYSTEM_TABLE. - - @retval EFI_SUCCESS Success. - @retval Others Fail. - -**/ -EFI_STATUS -EFIAPI -XhcDriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gXhciDriverBinding, - ImageHandle, - &gXhciComponentName, - &gXhciComponentName2 - ); -} - - -/** - Test to see if this driver supports ControllerHandle. Any - ControllerHandle that has Usb2HcProtocol installed will - be supported. - - @param This Protocol instance pointer. - @param Controller Handle of device to test. - @param RemainingDevicePath Not used. - - @return EFI_SUCCESS This driver supports this device. - @return EFI_UNSUPPORTED This driver does not support this device. - -**/ -EFI_STATUS -EFIAPI -XhcDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -{ - EFI_STATUS Status; - EFI_PCI_IO_PROTOCOL *PciIo; - USB_CLASSC UsbClassCReg; - - // - // Test whether there is PCI IO Protocol attached on the controller handle. - // - Status = gBS->OpenProtocol ( - Controller, - &gEfiPciIoProtocolGuid, - (VOID **) &PciIo, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Status = PciIo->Pci.Read ( - PciIo, - EfiPciIoWidthUint8, - PCI_CLASSCODE_OFFSET, - sizeof (USB_CLASSC) / sizeof (UINT8), - &UsbClassCReg - ); - - if (EFI_ERROR (Status)) { - Status = EFI_UNSUPPORTED; - goto ON_EXIT; - } - - // - // Test whether the controller belongs to Xhci type - // - if ((UsbClassCReg.BaseCode != PCI_CLASS_SERIAL) || - (UsbClassCReg.SubClassCode != PCI_CLASS_SERIAL_USB) || - (UsbClassCReg.ProgInterface != PCI_IF_XHCI)) { - Status = EFI_UNSUPPORTED; - } - -ON_EXIT: - gBS->CloseProtocol ( - Controller, - &gEfiPciIoProtocolGuid, - This->DriverBindingHandle, - Controller - ); - - return Status; -} - -/** - Create and initialize a USB_XHCI_INSTANCE structure. - - @param PciIo The PciIo on this device. - @param DevicePath The device path of host controller. - @param OriginalPciAttributes Original PCI attributes. - - @return The allocated and initialized USB_XHCI_INSTANCE structure if created, - otherwise NULL. - -**/ -USB_XHCI_INSTANCE* -XhcCreateUsbHc ( - IN EFI_PCI_IO_PROTOCOL *PciIo, - IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, - IN UINT64 OriginalPciAttributes - ) -{ - USB_XHCI_INSTANCE *Xhc; - EFI_STATUS Status; - UINT32 PageSize; - UINT16 ExtCapReg; - - Xhc = AllocateZeroPool (sizeof (USB_XHCI_INSTANCE)); - - if (Xhc == NULL) { - return NULL; - } - - // - // Initialize private data structure - // - Xhc->Signature = XHCI_INSTANCE_SIG; - Xhc->PciIo = PciIo; - Xhc->DevicePath = DevicePath; - Xhc->OriginalPciAttributes = OriginalPciAttributes; - CopyMem (&Xhc->Usb2Hc, &gXhciUsb2HcTemplate, sizeof (EFI_USB2_HC_PROTOCOL)); - - InitializeListHead (&Xhc->AsyncIntTransfers); - - // - // Be caution that the Offset passed to XhcReadCapReg() should be Dword align - // - Xhc->CapLength = XhcReadCapReg8 (Xhc, XHC_CAPLENGTH_OFFSET); - Xhc->HcSParams1.Dword = XhcReadCapReg (Xhc, XHC_HCSPARAMS1_OFFSET); - Xhc->HcSParams2.Dword = XhcReadCapReg (Xhc, XHC_HCSPARAMS2_OFFSET); - Xhc->HcCParams.Dword = XhcReadCapReg (Xhc, XHC_HCCPARAMS_OFFSET); - Xhc->DBOff = XhcReadCapReg (Xhc, XHC_DBOFF_OFFSET); - Xhc->RTSOff = XhcReadCapReg (Xhc, XHC_RTSOFF_OFFSET); - - // - // This PageSize field defines the page size supported by the xHC implementation. - // This xHC supports a page size of 2^(n+12) if bit n is Set. For example, - // if bit 0 is Set, the xHC supports 4k byte page sizes. - // - PageSize = XhcReadOpReg(Xhc, XHC_PAGESIZE_OFFSET) & XHC_PAGESIZE_MASK; - Xhc->PageSize = 1 << (HighBitSet32(PageSize) + 12); - - ExtCapReg = (UINT16) (Xhc->HcCParams.Data.ExtCapReg); - Xhc->ExtCapRegBase = ExtCapReg << 2; - Xhc->UsbLegSupOffset = XhcGetCapabilityAddr (Xhc, XHC_CAP_USB_LEGACY); - Xhc->DebugCapSupOffset = XhcGetCapabilityAddr (Xhc, XHC_CAP_USB_DEBUG); - - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: Capability length 0x%x\n", Xhc->CapLength)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: HcSParams1 0x%x\n", Xhc->HcSParams1)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: HcSParams2 0x%x\n", Xhc->HcSParams2)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: HcCParams 0x%x\n", Xhc->HcCParams)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: DBOff 0x%x\n", Xhc->DBOff)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: RTSOff 0x%x\n", Xhc->RTSOff)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: UsbLegSupOffset 0x%x\n", Xhc->UsbLegSupOffset)); - DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: DebugCapSupOffset 0x%x\n", Xhc->DebugCapSupOffset)); - - // - // Create AsyncRequest Polling Timer - // - Status = gBS->CreateEvent ( - EVT_TIMER | EVT_NOTIFY_SIGNAL, - TPL_CALLBACK, - XhcMonitorAsyncRequests, - Xhc, - &Xhc->PollTimer - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - return Xhc; - -ON_ERROR: - FreePool (Xhc); - return NULL; -} - -/** - One notified function to stop the Host Controller when gBS->ExitBootServices() called. - - @param Event Pointer to this event - @param Context Event hanlder private data - -**/ -VOID -EFIAPI -XhcExitBootService ( - EFI_EVENT Event, - VOID *Context - ) - -{ - USB_XHCI_INSTANCE *Xhc; - EFI_PCI_IO_PROTOCOL *PciIo; - - Xhc = (USB_XHCI_INSTANCE*) Context; - PciIo = Xhc->PciIo; - - // - // Stop AsyncRequest Polling timer then stop the XHCI driver - // and uninstall the XHCI protocl. - // - gBS->SetTimer (Xhc->PollTimer, TimerCancel, 0); - XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); - - if (Xhc->PollTimer != NULL) { - gBS->CloseEvent (Xhc->PollTimer); - } - - XhcClearBiosOwnership (Xhc); - - // - // Restore original PCI attributes - // - PciIo->Attributes ( - PciIo, - EfiPciIoAttributeOperationSet, - Xhc->OriginalPciAttributes, - NULL - ); -} - -/** - Starting the Usb XHCI Driver. - - @param This Protocol instance pointer. - @param Controller Handle of device to test. - @param RemainingDevicePath Not used. - - @return EFI_SUCCESS supports this device. - @return EFI_UNSUPPORTED do not support this device. - @return EFI_DEVICE_ERROR cannot be started due to device Error. - @return EFI_OUT_OF_RESOURCES cannot allocate resources. - -**/ -EFI_STATUS -EFIAPI -XhcDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -{ - EFI_STATUS Status; - EFI_PCI_IO_PROTOCOL *PciIo; - UINT64 Supports; - UINT64 OriginalPciAttributes; - BOOLEAN PciAttributesSaved; - USB_XHCI_INSTANCE *Xhc; - EFI_DEVICE_PATH_PROTOCOL *HcDevicePath; - - // - // Open the PciIo Protocol, then enable the USB host controller - // - Status = gBS->OpenProtocol ( - Controller, - &gEfiPciIoProtocolGuid, - (VOID **) &PciIo, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Open Device Path Protocol for on USB host controller - // - HcDevicePath = NULL; - Status = gBS->OpenProtocol ( - Controller, - &gEfiDevicePathProtocolGuid, - (VOID **) &HcDevicePath, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - PciAttributesSaved = FALSE; - // - // Save original PCI attributes - // - Status = PciIo->Attributes ( - PciIo, - EfiPciIoAttributeOperationGet, - 0, - &OriginalPciAttributes - ); - - if (EFI_ERROR (Status)) { - goto CLOSE_PCIIO; - } - PciAttributesSaved = TRUE; - - Status = PciIo->Attributes ( - PciIo, - EfiPciIoAttributeOperationSupported, - 0, - &Supports - ); - if (!EFI_ERROR (Status)) { - Supports &= EFI_PCI_DEVICE_ENABLE; - Status = PciIo->Attributes ( - PciIo, - EfiPciIoAttributeOperationEnable, - Supports, - NULL - ); - } - - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to enable controller\n")); - goto CLOSE_PCIIO; - } - - // - // Create then install USB2_HC_PROTOCOL - // - Xhc = XhcCreateUsbHc (PciIo, HcDevicePath, OriginalPciAttributes); - - if (Xhc == NULL) { - DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to create USB2_HC\n")); - return EFI_OUT_OF_RESOURCES; - } - - XhcSetBiosOwnership (Xhc); - - XhcResetHC (Xhc, XHC_RESET_TIMEOUT); - ASSERT (XhcIsHalt (Xhc)); - - // - // After Chip Hardware Reset wait until the Controller Not Ready (CNR) flag - // in the USBSTS is '0' before writing any xHC Operational or Runtime registers. - // - ASSERT (!(XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_CNR))); - - // - // Initialize the schedule - // - XhcInitSched (Xhc); - - // - // Start the Host Controller - // - XhcRunHC(Xhc, XHC_GENERIC_TIMEOUT); - - // - // Start the asynchronous interrupt monitor - // - Status = gBS->SetTimer (Xhc->PollTimer, TimerPeriodic, XHC_ASYNC_TIMER_INTERVAL); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to start async interrupt monitor\n")); - XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); - goto FREE_POOL; - } - - // - // Create event to stop the HC when exit boot service. - // - Status = gBS->CreateEventEx ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - XhcExitBootService, - Xhc, - &gEfiEventExitBootServicesGuid, - &Xhc->ExitBootServiceEvent - ); - if (EFI_ERROR (Status)) { - goto FREE_POOL; - } - - // - // Install the component name protocol, don't fail the start - // because of something for display. - // - AddUnicodeString2 ( - "eng", - gXhciComponentName.SupportedLanguages, - &Xhc->ControllerNameTable, - L"eXtensible Host Controller (USB 3.0)", - TRUE - ); - AddUnicodeString2 ( - "en", - gXhciComponentName2.SupportedLanguages, - &Xhc->ControllerNameTable, - L"eXtensible Host Controller (USB 3.0)", - FALSE - ); - - Status = gBS->InstallProtocolInterface ( - &Controller, - &gEfiUsb2HcProtocolGuid, - EFI_NATIVE_INTERFACE, - &Xhc->Usb2Hc - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to install USB2_HC Protocol\n")); - goto FREE_POOL; - } - - DEBUG ((EFI_D_INFO, "XhcDriverBindingStart: XHCI started for controller @ %x\n", Controller)); - return EFI_SUCCESS; - -FREE_POOL: - gBS->CloseEvent (Xhc->PollTimer); - XhcFreeSched (Xhc); - FreePool (Xhc); - -CLOSE_PCIIO: - if (PciAttributesSaved) { - // - // Restore original PCI attributes - // - PciIo->Attributes ( - PciIo, - EfiPciIoAttributeOperationSet, - OriginalPciAttributes, - NULL - ); - } - - gBS->CloseProtocol ( - Controller, - &gEfiPciIoProtocolGuid, - This->DriverBindingHandle, - Controller - ); - - return Status; -} - - -/** - Stop this driver on ControllerHandle. Support stoping any child handles - created by this driver. - - @param This Protocol instance pointer. - @param Controller Handle of device to stop driver on. - @param NumberOfChildren Number of Children in the ChildHandleBuffer. - @param ChildHandleBuffer List of handles for the children we need to stop. - - @return EFI_SUCCESS Success. - @return EFI_DEVICE_ERROR Fail. - -**/ -EFI_STATUS -EFIAPI -XhcDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_STATUS Status; - EFI_USB2_HC_PROTOCOL *Usb2Hc; - EFI_PCI_IO_PROTOCOL *PciIo; - USB_XHCI_INSTANCE *Xhc; - UINT8 Index; - - // - // Test whether the Controller handler passed in is a valid - // Usb controller handle that should be supported, if not, - // return the error status directly - // - Status = gBS->OpenProtocol ( - Controller, - &gEfiUsb2HcProtocolGuid, - (VOID **) &Usb2Hc, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->UninstallProtocolInterface ( - Controller, - &gEfiUsb2HcProtocolGuid, - Usb2Hc - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - Xhc = XHC_FROM_THIS (Usb2Hc); - PciIo = Xhc->PciIo; - - // - // Stop AsyncRequest Polling timer then stop the XHCI driver - // and uninstall the XHCI protocl. - // - gBS->SetTimer (Xhc->PollTimer, TimerCancel, 0); - - // - // Disable the device slots occupied by these devices on its downstream ports. - // Entry 0 is reserved. - // - for (Index = 0; Index < 255; Index++) { - if (!Xhc->UsbDevContext[Index + 1].Enabled || - (Xhc->UsbDevContext[Index + 1].SlotId == 0)) { - continue; - } - if (Xhc->HcCParams.Data.Csz == 0) { - XhcDisableSlotCmd (Xhc, Xhc->UsbDevContext[Index + 1].SlotId); - } else { - XhcDisableSlotCmd64 (Xhc, Xhc->UsbDevContext[Index + 1].SlotId); - } - } - - if (Xhc->PollTimer != NULL) { - gBS->CloseEvent (Xhc->PollTimer); - } - - if (Xhc->ExitBootServiceEvent != NULL) { - gBS->CloseEvent (Xhc->ExitBootServiceEvent); - } - - XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); - XhcClearBiosOwnership (Xhc); - XhciDelAllAsyncIntTransfers (Xhc); - XhcFreeSched (Xhc); - - if (Xhc->ControllerNameTable) { - FreeUnicodeStringTable (Xhc->ControllerNameTable); - } - - // - // Restore original PCI attributes - // - PciIo->Attributes ( - PciIo, - EfiPciIoAttributeOperationSet, - Xhc->OriginalPciAttributes, - NULL - ); - - gBS->CloseProtocol ( - Controller, - &gEfiPciIoProtocolGuid, - This->DriverBindingHandle, - Controller - ); - - FreePool (Xhc); - - return EFI_SUCCESS; -} - +/** @file + The XHCI controller driver. + +Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.
+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 "Xhci.h" + +// +// Two arrays used to translate the XHCI port state (change) +// to the UEFI protocol's port state (change). +// +USB_PORT_STATE_MAP mUsbPortStateMap[] = { + {XHC_PORTSC_CCS, USB_PORT_STAT_CONNECTION}, + {XHC_PORTSC_PED, USB_PORT_STAT_ENABLE}, + {XHC_PORTSC_OCA, USB_PORT_STAT_OVERCURRENT}, + {XHC_PORTSC_RESET, USB_PORT_STAT_RESET} +}; + +USB_PORT_STATE_MAP mUsbPortChangeMap[] = { + {XHC_PORTSC_CSC, USB_PORT_STAT_C_CONNECTION}, + {XHC_PORTSC_PEC, USB_PORT_STAT_C_ENABLE}, + {XHC_PORTSC_OCC, USB_PORT_STAT_C_OVERCURRENT}, + {XHC_PORTSC_PRC, USB_PORT_STAT_C_RESET} +}; + +USB_CLEAR_PORT_MAP mUsbClearPortChangeMap[] = { + {XHC_PORTSC_CSC, EfiUsbPortConnectChange}, + {XHC_PORTSC_PEC, EfiUsbPortEnableChange}, + {XHC_PORTSC_OCC, EfiUsbPortOverCurrentChange}, + {XHC_PORTSC_PRC, EfiUsbPortResetChange} +}; + +USB_PORT_STATE_MAP mUsbHubPortStateMap[] = { + {XHC_HUB_PORTSC_CCS, USB_PORT_STAT_CONNECTION}, + {XHC_HUB_PORTSC_PED, USB_PORT_STAT_ENABLE}, + {XHC_HUB_PORTSC_OCA, USB_PORT_STAT_OVERCURRENT}, + {XHC_HUB_PORTSC_RESET, USB_PORT_STAT_RESET} +}; + +USB_PORT_STATE_MAP mUsbHubPortChangeMap[] = { + {XHC_HUB_PORTSC_CSC, USB_PORT_STAT_C_CONNECTION}, + {XHC_HUB_PORTSC_PEC, USB_PORT_STAT_C_ENABLE}, + {XHC_HUB_PORTSC_OCC, USB_PORT_STAT_C_OVERCURRENT}, + {XHC_HUB_PORTSC_PRC, USB_PORT_STAT_C_RESET} +}; + +USB_CLEAR_PORT_MAP mUsbHubClearPortChangeMap[] = { + {XHC_HUB_PORTSC_CSC, EfiUsbPortConnectChange}, + {XHC_HUB_PORTSC_PEC, EfiUsbPortEnableChange}, + {XHC_HUB_PORTSC_OCC, EfiUsbPortOverCurrentChange}, + {XHC_HUB_PORTSC_PRC, EfiUsbPortResetChange}, + {XHC_HUB_PORTSC_BHRC, Usb3PortBHPortResetChange} +}; + +EFI_DRIVER_BINDING_PROTOCOL gXhciDriverBinding = { + XhcDriverBindingSupported, + XhcDriverBindingStart, + XhcDriverBindingStop, + 0x30, + NULL, + NULL +}; + +// +// Template for Xhci's Usb2 Host Controller Protocol Instance. +// +EFI_USB2_HC_PROTOCOL gXhciUsb2HcTemplate = { + XhcGetCapability, + XhcReset, + XhcGetState, + XhcSetState, + XhcControlTransfer, + XhcBulkTransfer, + XhcAsyncInterruptTransfer, + XhcSyncInterruptTransfer, + XhcIsochronousTransfer, + XhcAsyncIsochronousTransfer, + XhcGetRootHubPortStatus, + XhcSetRootHubPortFeature, + XhcClearRootHubPortFeature, + 0x3, + 0x0 +}; + +/** + Retrieves the capability of root hub ports. + + @param This The EFI_USB2_HC_PROTOCOL instance. + @param MaxSpeed Max speed supported by the controller. + @param PortNumber Number of the root hub ports. + @param Is64BitCapable Whether the controller supports 64-bit memory + addressing. + + @retval EFI_SUCCESS Host controller capability were retrieved successfully. + @retval EFI_INVALID_PARAMETER Either of the three capability pointer is NULL. + +**/ +EFI_STATUS +EFIAPI +XhcGetCapability ( + IN EFI_USB2_HC_PROTOCOL *This, + OUT UINT8 *MaxSpeed, + OUT UINT8 *PortNumber, + OUT UINT8 *Is64BitCapable + ) +{ + USB_XHCI_INSTANCE *Xhc; + EFI_TPL OldTpl; + + if ((MaxSpeed == NULL) || (PortNumber == NULL) || (Is64BitCapable == NULL)) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + *MaxSpeed = EFI_USB_SPEED_SUPER; + *PortNumber = (UINT8) (Xhc->HcSParams1.Data.MaxPorts); + *Is64BitCapable = (UINT8) (Xhc->HcCParams.Data.Ac64); + DEBUG ((EFI_D_INFO, "XhcGetCapability: %d ports, 64 bit %d\n", *PortNumber, *Is64BitCapable)); + + gBS->RestoreTPL (OldTpl); + + return EFI_SUCCESS; +} + + +/** + Provides software reset for the USB host controller. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param Attributes A bit mask of the reset operation to perform. + + @retval EFI_SUCCESS The reset operation succeeded. + @retval EFI_INVALID_PARAMETER Attributes is not valid. + @retval EFI_UNSUPPOURTED The type of reset specified by Attributes is + not currently supported by the host controller. + @retval EFI_DEVICE_ERROR Host controller isn't halted to reset. + +**/ +EFI_STATUS +EFIAPI +XhcReset ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT16 Attributes + ) +{ + USB_XHCI_INSTANCE *Xhc; + EFI_STATUS Status; + EFI_TPL OldTpl; + + Xhc = XHC_FROM_THIS (This); + + if (Xhc->DevicePath != NULL) { + // + // Report Status Code to indicate reset happens + // + REPORT_STATUS_CODE_WITH_DEVICE_PATH ( + EFI_PROGRESS_CODE, + (EFI_IO_BUS_USB | EFI_IOB_PC_RESET), + Xhc->DevicePath + ); + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + switch (Attributes) { + case EFI_USB_HC_RESET_GLOBAL: + // + // Flow through, same behavior as Host Controller Reset + // + case EFI_USB_HC_RESET_HOST_CONTROLLER: + if ((Xhc->DebugCapSupOffset != 0xFFFFFFFF) && ((XhcReadExtCapReg (Xhc, Xhc->DebugCapSupOffset) & 0xFF) == XHC_CAP_USB_DEBUG) && + ((XhcReadExtCapReg (Xhc, Xhc->DebugCapSupOffset + XHC_DC_DCCTRL) & BIT0) != 0)) { + Status = EFI_SUCCESS; + goto ON_EXIT; + } + // + // Host Controller must be Halt when Reset it + // + if (!XhcIsHalt (Xhc)) { + Status = XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); + + if (EFI_ERROR (Status)) { + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + } + + Status = XhcResetHC (Xhc, XHC_RESET_TIMEOUT); + ASSERT (!(XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_CNR))); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + // + // Clean up the asynchronous transfers, currently only + // interrupt supports asynchronous operation. + // + XhciDelAllAsyncIntTransfers (Xhc); + XhcFreeSched (Xhc); + + XhcInitSched (Xhc); + break; + + case EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG: + case EFI_USB_HC_RESET_HOST_WITH_DEBUG: + Status = EFI_UNSUPPORTED; + break; + + default: + Status = EFI_INVALID_PARAMETER; + } + +ON_EXIT: + DEBUG ((EFI_D_INFO, "XhcReset: status %r\n", Status)); + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Retrieve the current state of the USB host controller. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param State Variable to return the current host controller + state. + + @retval EFI_SUCCESS Host controller state was returned in State. + @retval EFI_INVALID_PARAMETER State is NULL. + @retval EFI_DEVICE_ERROR An error was encountered while attempting to + retrieve the host controller's current state. + +**/ +EFI_STATUS +EFIAPI +XhcGetState ( + IN EFI_USB2_HC_PROTOCOL *This, + OUT EFI_USB_HC_STATE *State + ) +{ + USB_XHCI_INSTANCE *Xhc; + EFI_TPL OldTpl; + + if (State == NULL) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + + if (XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_HALT)) { + *State = EfiUsbHcStateHalt; + } else { + *State = EfiUsbHcStateOperational; + } + + DEBUG ((EFI_D_INFO, "XhcGetState: current state %d\n", *State)); + gBS->RestoreTPL (OldTpl); + + return EFI_SUCCESS; +} + +/** + Sets the USB host controller to a specific state. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param State The state of the host controller that will be set. + + @retval EFI_SUCCESS The USB host controller was successfully placed + in the state specified by State. + @retval EFI_INVALID_PARAMETER State is invalid. + @retval EFI_DEVICE_ERROR Failed to set the state due to device error. + +**/ +EFI_STATUS +EFIAPI +XhcSetState ( + IN EFI_USB2_HC_PROTOCOL *This, + IN EFI_USB_HC_STATE State + ) +{ + USB_XHCI_INSTANCE *Xhc; + EFI_STATUS Status; + EFI_USB_HC_STATE CurState; + EFI_TPL OldTpl; + + Status = XhcGetState (This, &CurState); + + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + if (CurState == State) { + return EFI_SUCCESS; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + + switch (State) { + case EfiUsbHcStateHalt: + Status = XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); + break; + + case EfiUsbHcStateOperational: + if (XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_HSE)) { + Status = EFI_DEVICE_ERROR; + break; + } + + // + // Software must not write a one to this field unless the host controller + // is in the Halted state. Doing so will yield undefined results. + // refers to Spec[XHCI1.0-2.3.1] + // + if (!XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_HALT)) { + Status = EFI_DEVICE_ERROR; + break; + } + + Status = XhcRunHC (Xhc, XHC_GENERIC_TIMEOUT); + break; + + case EfiUsbHcStateSuspend: + Status = EFI_UNSUPPORTED; + break; + + default: + Status = EFI_INVALID_PARAMETER; + } + + DEBUG ((EFI_D_INFO, "XhcSetState: status %r\n", Status)); + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Retrieves the current status of a USB root hub port. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param PortNumber The root hub port to retrieve the state from. + This value is zero-based. + @param PortStatus Variable to receive the port state. + + @retval EFI_SUCCESS The status of the USB root hub port specified. + by PortNumber was returned in PortStatus. + @retval EFI_INVALID_PARAMETER PortNumber is invalid. + @retval EFI_DEVICE_ERROR Can't read register. + +**/ +EFI_STATUS +EFIAPI +XhcGetRootHubPortStatus ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 PortNumber, + OUT EFI_USB_PORT_STATUS *PortStatus + ) +{ + USB_XHCI_INSTANCE *Xhc; + UINT32 Offset; + UINT32 State; + UINT32 TotalPort; + UINTN Index; + UINTN MapSize; + EFI_STATUS Status; + USB_DEV_ROUTE ParentRouteChart; + EFI_TPL OldTpl; + + if (PortStatus == NULL) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + Status = EFI_SUCCESS; + + TotalPort = Xhc->HcSParams1.Data.MaxPorts; + + if (PortNumber >= TotalPort) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + Offset = (UINT32) (XHC_PORTSC_OFFSET + (0x10 * PortNumber)); + PortStatus->PortStatus = 0; + PortStatus->PortChangeStatus = 0; + + State = XhcReadOpReg (Xhc, Offset); + + // + // According to XHCI 1.0 spec, bit 10~13 of the root port status register identifies the speed of the attached device. + // + switch ((State & XHC_PORTSC_PS) >> 10) { + case 2: + PortStatus->PortStatus |= USB_PORT_STAT_LOW_SPEED; + break; + + case 3: + PortStatus->PortStatus |= USB_PORT_STAT_HIGH_SPEED; + break; + + case 4: + PortStatus->PortStatus |= USB_PORT_STAT_SUPER_SPEED; + break; + + default: + break; + } + + // + // Convert the XHCI port/port change state to UEFI status + // + MapSize = sizeof (mUsbPortStateMap) / sizeof (USB_PORT_STATE_MAP); + + for (Index = 0; Index < MapSize; Index++) { + if (XHC_BIT_IS_SET (State, mUsbPortStateMap[Index].HwState)) { + PortStatus->PortStatus = (UINT16) (PortStatus->PortStatus | mUsbPortStateMap[Index].UefiState); + } + } + // + // Bit5~8 reflects its current link state. + // + if ((State & XHC_PORTSC_PLS) >> 5 == 3) { + PortStatus->PortStatus |= USB_PORT_STAT_SUSPEND; + } + + MapSize = sizeof (mUsbPortChangeMap) / sizeof (USB_PORT_STATE_MAP); + + for (Index = 0; Index < MapSize; Index++) { + if (XHC_BIT_IS_SET (State, mUsbPortChangeMap[Index].HwState)) { + PortStatus->PortChangeStatus = (UINT16) (PortStatus->PortChangeStatus | mUsbPortChangeMap[Index].UefiState); + } + } + + MapSize = sizeof (mUsbClearPortChangeMap) / sizeof (USB_CLEAR_PORT_MAP); + + for (Index = 0; Index < MapSize; Index++) { + if (XHC_BIT_IS_SET (State, mUsbClearPortChangeMap[Index].HwState)) { + XhcClearRootHubPortFeature (This, PortNumber, (EFI_USB_PORT_FEATURE)mUsbClearPortChangeMap[Index].Selector); + } + } + + // + // Poll the root port status register to enable/disable corresponding device slot if there is a device attached/detached. + // For those devices behind hub, we get its attach/detach event by hooking Get_Port_Status request at control transfer for those hub. + // + ParentRouteChart.Dword = 0; + XhcPollPortStatusChange (Xhc, ParentRouteChart, PortNumber, PortStatus); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Sets a feature for the specified root hub port. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param PortNumber Root hub port to set. + @param PortFeature Feature to set. + + @retval EFI_SUCCESS The feature specified by PortFeature was set. + @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid. + @retval EFI_DEVICE_ERROR Can't read register. + +**/ +EFI_STATUS +EFIAPI +XhcSetRootHubPortFeature ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 PortNumber, + IN EFI_USB_PORT_FEATURE PortFeature + ) +{ + USB_XHCI_INSTANCE *Xhc; + UINT32 Offset; + UINT32 State; + UINT32 TotalPort; + EFI_STATUS Status; + EFI_TPL OldTpl; + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + Status = EFI_SUCCESS; + + TotalPort = (Xhc->HcSParams1.Data.MaxPorts); + + if (PortNumber >= TotalPort) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + Offset = (UINT32) (XHC_PORTSC_OFFSET + (0x10 * PortNumber)); + State = XhcReadOpReg (Xhc, Offset); + + // + // Mask off the port status change bits, these bits are + // write clean bit + // + State &= ~ (BIT1 | BIT17 | BIT18 | BIT19 | BIT20 | BIT21 | BIT22 | BIT23); + + switch (PortFeature) { + case EfiUsbPortEnable: + // + // Ports may only be enabled by the xHC. Software cannot enable a port by writing a '1' to this flag. + // A port may be disabled by software writing a '1' to this flag. + // + Status = EFI_SUCCESS; + break; + + case EfiUsbPortSuspend: + State |= XHC_PORTSC_LWS; + XhcWriteOpReg (Xhc, Offset, State); + State &= ~XHC_PORTSC_PLS; + State |= (3 << 5) ; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortReset: + DEBUG ((EFI_D_INFO, "XhcUsbPortReset!\n")); + // + // Make sure Host Controller not halt before reset it + // + if (XhcIsHalt (Xhc)) { + Status = XhcRunHC (Xhc, XHC_GENERIC_TIMEOUT); + + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_INFO, "XhcSetRootHubPortFeature :failed to start HC - %r\n", Status)); + break; + } + } + + // + // 4.3.1 Resetting a Root Hub Port + // 1) Write the PORTSC register with the Port Reset (PR) bit set to '1'. + // + State |= XHC_PORTSC_RESET; + XhcWriteOpReg (Xhc, Offset, State); + XhcWaitOpRegBit(Xhc, Offset, XHC_PORTSC_PRC, TRUE, XHC_GENERIC_TIMEOUT); + break; + + case EfiUsbPortPower: + // + // Not supported, ignore the operation + // + Status = EFI_SUCCESS; + break; + + case EfiUsbPortOwner: + // + // XHCI root hub port don't has the owner bit, ignore the operation + // + Status = EFI_SUCCESS; + break; + + default: + Status = EFI_INVALID_PARAMETER; + } + +ON_EXIT: + DEBUG ((EFI_D_INFO, "XhcSetRootHubPortFeature: status %r\n", Status)); + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Clears a feature for the specified root hub port. + + @param This A pointer to the EFI_USB2_HC_PROTOCOL instance. + @param PortNumber Specifies the root hub port whose feature is + requested to be cleared. + @param PortFeature Indicates the feature selector associated with the + feature clear request. + + @retval EFI_SUCCESS The feature specified by PortFeature was cleared + for the USB root hub port specified by PortNumber. + @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid. + @retval EFI_DEVICE_ERROR Can't read register. + +**/ +EFI_STATUS +EFIAPI +XhcClearRootHubPortFeature ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 PortNumber, + IN EFI_USB_PORT_FEATURE PortFeature + ) +{ + USB_XHCI_INSTANCE *Xhc; + UINT32 Offset; + UINT32 State; + UINT32 TotalPort; + EFI_STATUS Status; + EFI_TPL OldTpl; + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + Status = EFI_SUCCESS; + + TotalPort = (Xhc->HcSParams1.Data.MaxPorts); + + if (PortNumber >= TotalPort) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + Offset = XHC_PORTSC_OFFSET + (0x10 * PortNumber); + + // + // Mask off the port status change bits, these bits are + // write clean bit + // + State = XhcReadOpReg (Xhc, Offset); + State &= ~ (BIT1 | BIT17 | BIT18 | BIT19 | BIT20 | BIT21 | BIT22 | BIT23); + + switch (PortFeature) { + case EfiUsbPortEnable: + // + // Ports may only be enabled by the xHC. Software cannot enable a port by writing a '1' to this flag. + // A port may be disabled by software writing a '1' to this flag. + // + State |= XHC_PORTSC_PED; + State &= ~XHC_PORTSC_RESET; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortSuspend: + State |= XHC_PORTSC_LWS; + XhcWriteOpReg (Xhc, Offset, State); + State &= ~XHC_PORTSC_PLS; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortReset: + // + // PORTSC_RESET BIT(4) bit is RW1S attribute, which means Write-1-to-set status: + // Register bits indicate status when read, a clear bit may be set by + // writing a '1'. Writing a '0' to RW1S bits has no effect. + // + break; + + case EfiUsbPortOwner: + // + // XHCI root hub port don't has the owner bit, ignore the operation + // + break; + + case EfiUsbPortConnectChange: + // + // Clear connect status change + // + State |= XHC_PORTSC_CSC; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortEnableChange: + // + // Clear enable status change + // + State |= XHC_PORTSC_PEC; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortOverCurrentChange: + // + // Clear PortOverCurrent change + // + State |= XHC_PORTSC_OCC; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortResetChange: + // + // Clear Port Reset change + // + State |= XHC_PORTSC_PRC; + XhcWriteOpReg (Xhc, Offset, State); + break; + + case EfiUsbPortPower: + case EfiUsbPortSuspendChange: + // + // Not supported or not related operation + // + break; + + default: + Status = EFI_INVALID_PARAMETER; + break; + } + +ON_EXIT: + DEBUG ((EFI_D_INFO, "XhcClearRootHubPortFeature: status %r\n", Status)); + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Submits control transfer to a target USB device. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress The target device address. + @param DeviceSpeed Target device speed. + @param MaximumPacketLength Maximum packet size the default control transfer + endpoint is capable of sending or receiving. + @param Request USB device request to send. + @param TransferDirection Specifies the data direction for the data stage + @param Data Data buffer to be transmitted or received from USB + device. + @param DataLength The size (in bytes) of the data buffer. + @param Timeout Indicates the maximum timeout, in millisecond. + @param Translator Transaction translator to be used by this device. + @param TransferResult Return the result of this control transfer. + + @retval EFI_SUCCESS Transfer was completed successfully. + @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resources. + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_TIMEOUT Transfer failed due to timeout. + @retval EFI_DEVICE_ERROR Transfer failed due to host controller or device error. + +**/ +EFI_STATUS +EFIAPI +XhcControlTransfer ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 DeviceAddress, + IN UINT8 DeviceSpeed, + IN UINTN MaximumPacketLength, + IN EFI_USB_DEVICE_REQUEST *Request, + IN EFI_USB_DATA_DIRECTION TransferDirection, + IN OUT VOID *Data, + IN OUT UINTN *DataLength, + IN UINTN Timeout, + IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, + OUT UINT32 *TransferResult + ) +{ + USB_XHCI_INSTANCE *Xhc; + URB *Urb; + UINT8 Endpoint; + UINT8 Index; + UINT8 DescriptorType; + UINT8 SlotId; + UINT8 TTT; + UINT8 MTT; + UINT32 MaxPacket0; + EFI_USB_HUB_DESCRIPTOR *HubDesc; + EFI_TPL OldTpl; + EFI_STATUS Status; + EFI_STATUS RecoveryStatus; + UINTN MapSize; + EFI_USB_PORT_STATUS PortStatus; + UINT32 State; + EFI_USB_DEVICE_REQUEST ClearPortRequest; + UINTN Len; + + // + // Validate parameters + // + if ((Request == NULL) || (TransferResult == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((TransferDirection != EfiUsbDataIn) && + (TransferDirection != EfiUsbDataOut) && + (TransferDirection != EfiUsbNoData)) { + return EFI_INVALID_PARAMETER; + } + + if ((TransferDirection == EfiUsbNoData) && + ((Data != NULL) || (*DataLength != 0))) { + return EFI_INVALID_PARAMETER; + } + + if ((TransferDirection != EfiUsbNoData) && + ((Data == NULL) || (*DataLength == 0))) { + return EFI_INVALID_PARAMETER; + } + + if ((MaximumPacketLength != 8) && (MaximumPacketLength != 16) && + (MaximumPacketLength != 32) && (MaximumPacketLength != 64) && + (MaximumPacketLength != 512) + ) { + return EFI_INVALID_PARAMETER; + } + + if ((DeviceSpeed == EFI_USB_SPEED_LOW) && (MaximumPacketLength != 8)) { + return EFI_INVALID_PARAMETER; + } + + if ((DeviceSpeed == EFI_USB_SPEED_SUPER) && (MaximumPacketLength != 512)) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + + Status = EFI_DEVICE_ERROR; + *TransferResult = EFI_USB_ERR_SYSTEM; + Len = 0; + + if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { + DEBUG ((EFI_D_ERROR, "XhcControlTransfer: HC halted at entrance\n")); + goto ON_EXIT; + } + + // + // Check if the device is still enabled before every transaction. + // + SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); + if (SlotId == 0) { + goto ON_EXIT; + } + + // + // Hook the Set_Address request from UsbBus. + // According to XHCI 1.0 spec, the Set_Address request is replaced by XHCI's Address_Device cmd. + // + if ((Request->Request == USB_REQ_SET_ADDRESS) && + (Request->RequestType == USB_REQUEST_TYPE (EfiUsbNoData, USB_REQ_TYPE_STANDARD, USB_TARGET_DEVICE))) { + // + // Reset the BusDevAddr field of all disabled entries in UsbDevContext array firstly. + // This way is used to clean the history to avoid using wrong device address by XhcAsyncInterruptTransfer(). + // + for (Index = 0; Index < 255; Index++) { + if (!Xhc->UsbDevContext[Index + 1].Enabled && + (Xhc->UsbDevContext[Index + 1].SlotId == 0) && + (Xhc->UsbDevContext[Index + 1].BusDevAddr == (UINT8)Request->Value)) { + Xhc->UsbDevContext[Index + 1].BusDevAddr = 0; + } + } + + if (Xhc->UsbDevContext[SlotId].XhciDevAddr == 0) { + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + // + // The actual device address has been assigned by XHCI during initializing the device slot. + // So we just need establish the mapping relationship between the device address requested from UsbBus + // and the actual device address assigned by XHCI. The the following invocations through EFI_USB2_HC_PROTOCOL interface + // can find out the actual device address by it. + // + Xhc->UsbDevContext[SlotId].BusDevAddr = (UINT8)Request->Value; + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // Create a new URB, insert it into the asynchronous + // schedule list, then poll the execution status. + // Note that we encode the direction in address although default control + // endpoint is bidirectional. XhcCreateUrb expects this + // combination of Ep addr and its direction. + // + Endpoint = (UINT8) (0 | ((TransferDirection == EfiUsbDataIn) ? 0x80 : 0)); + Urb = XhcCreateUrb ( + Xhc, + DeviceAddress, + Endpoint, + DeviceSpeed, + MaximumPacketLength, + XHC_CTRL_TRANSFER, + Request, + Data, + *DataLength, + NULL, + NULL + ); + + if (Urb == NULL) { + DEBUG ((EFI_D_ERROR, "XhcControlTransfer: failed to create URB")); + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + Status = XhcExecTransfer (Xhc, FALSE, Urb, Timeout); + + // + // Get the status from URB. The result is updated in XhcCheckUrbResult + // which is called by XhcExecTransfer + // + *TransferResult = Urb->Result; + *DataLength = Urb->Completed; + + if (*TransferResult == EFI_USB_NOERROR) { + Status = EFI_SUCCESS; + } else if (*TransferResult == EFI_USB_ERR_STALL) { + RecoveryStatus = XhcRecoverHaltedEndpoint(Xhc, Urb); + if (EFI_ERROR (RecoveryStatus)) { + DEBUG ((EFI_D_ERROR, "XhcControlTransfer: XhcRecoverHaltedEndpoint failed\n")); + } + Status = EFI_DEVICE_ERROR; + goto FREE_URB; + } else { + goto FREE_URB; + } + + Xhc->PciIo->Flush (Xhc->PciIo); + + if (Urb->DataMap != NULL) { + Status = Xhc->PciIo->Unmap (Xhc->PciIo, Urb->DataMap); + ASSERT_EFI_ERROR (Status); + if (EFI_ERROR (Status)) { + Status = EFI_DEVICE_ERROR; + goto FREE_URB; + } + } + + // + // Hook Get_Descriptor request from UsbBus as we need evaluate context and configure endpoint. + // Hook Get_Status request form UsbBus as we need trace device attach/detach event happened at hub. + // Hook Set_Config request from UsbBus as we need configure device endpoint. + // + if ((Request->Request == USB_REQ_GET_DESCRIPTOR) && + ((Request->RequestType == USB_REQUEST_TYPE (EfiUsbDataIn, USB_REQ_TYPE_STANDARD, USB_TARGET_DEVICE)) || + ((Request->RequestType == USB_REQUEST_TYPE (EfiUsbDataIn, USB_REQ_TYPE_CLASS, USB_TARGET_DEVICE))))) { + DescriptorType = (UINT8)(Request->Value >> 8); + if ((DescriptorType == USB_DESC_TYPE_DEVICE) && ((*DataLength == sizeof (EFI_USB_DEVICE_DESCRIPTOR)) || ((DeviceSpeed == EFI_USB_SPEED_FULL) && (*DataLength == 8)))) { + ASSERT (Data != NULL); + // + // Store a copy of device scriptor as hub device need this info to configure endpoint. + // + CopyMem (&Xhc->UsbDevContext[SlotId].DevDesc, Data, *DataLength); + if (Xhc->UsbDevContext[SlotId].DevDesc.BcdUSB == 0x0300) { + // + // If it's a usb3.0 device, then its max packet size is a 2^n. + // + MaxPacket0 = 1 << Xhc->UsbDevContext[SlotId].DevDesc.MaxPacketSize0; + } else { + MaxPacket0 = Xhc->UsbDevContext[SlotId].DevDesc.MaxPacketSize0; + } + Xhc->UsbDevContext[SlotId].ConfDesc = AllocateZeroPool (Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations * sizeof (EFI_USB_CONFIG_DESCRIPTOR *)); + if (Xhc->HcCParams.Data.Csz == 0) { + Status = XhcEvaluateContext (Xhc, SlotId, MaxPacket0); + } else { + Status = XhcEvaluateContext64 (Xhc, SlotId, MaxPacket0); + } + } else if (DescriptorType == USB_DESC_TYPE_CONFIG) { + ASSERT (Data != NULL); + if (*DataLength == ((UINT16 *)Data)[1]) { + // + // Get configuration value from request, Store the configuration descriptor for Configure_Endpoint cmd. + // + Index = (UINT8)Request->Value; + ASSERT (Index < Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations); + Xhc->UsbDevContext[SlotId].ConfDesc[Index] = AllocateZeroPool(*DataLength); + CopyMem (Xhc->UsbDevContext[SlotId].ConfDesc[Index], Data, *DataLength); + } + } else if (((DescriptorType == USB_DESC_TYPE_HUB) || + (DescriptorType == USB_DESC_TYPE_HUB_SUPER_SPEED)) && (*DataLength > 2)) { + ASSERT (Data != NULL); + HubDesc = (EFI_USB_HUB_DESCRIPTOR *)Data; + ASSERT (HubDesc->NumPorts <= 15); + // + // The bit 5,6 of HubCharacter field of Hub Descriptor is TTT. + // + TTT = (UINT8)((HubDesc->HubCharacter & (BIT5 | BIT6)) >> 5); + if (Xhc->UsbDevContext[SlotId].DevDesc.DeviceProtocol == 2) { + // + // Don't support multi-TT feature for super speed hub now. + // + MTT = 0; + DEBUG ((EFI_D_ERROR, "XHCI: Don't support multi-TT feature for Hub now. (force to disable MTT)\n")); + } else { + MTT = 0; + } + + if (Xhc->HcCParams.Data.Csz == 0) { + Status = XhcConfigHubContext (Xhc, SlotId, HubDesc->NumPorts, TTT, MTT); + } else { + Status = XhcConfigHubContext64 (Xhc, SlotId, HubDesc->NumPorts, TTT, MTT); + } + } + } else if ((Request->Request == USB_REQ_SET_CONFIG) && + (Request->RequestType == USB_REQUEST_TYPE (EfiUsbNoData, USB_REQ_TYPE_STANDARD, USB_TARGET_DEVICE))) { + // + // Hook Set_Config request from UsbBus as we need configure device endpoint. + // + for (Index = 0; Index < Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations; Index++) { + if (Xhc->UsbDevContext[SlotId].ConfDesc[Index]->ConfigurationValue == (UINT8)Request->Value) { + if (Xhc->HcCParams.Data.Csz == 0) { + Status = XhcSetConfigCmd (Xhc, SlotId, DeviceSpeed, Xhc->UsbDevContext[SlotId].ConfDesc[Index]); + } else { + Status = XhcSetConfigCmd64 (Xhc, SlotId, DeviceSpeed, Xhc->UsbDevContext[SlotId].ConfDesc[Index]); + } + break; + } + } + } else if ((Request->Request == USB_REQ_GET_STATUS) && + (Request->RequestType == USB_REQUEST_TYPE (EfiUsbDataIn, USB_REQ_TYPE_CLASS, USB_TARGET_OTHER))) { + ASSERT (Data != NULL); + // + // Hook Get_Status request from UsbBus to keep track of the port status change. + // + State = *(UINT32 *)Data; + PortStatus.PortStatus = 0; + PortStatus.PortChangeStatus = 0; + + if (DeviceSpeed == EFI_USB_SPEED_SUPER) { + // + // For super speed hub, its bit10~12 presents the attached device speed. + // + if ((State & XHC_PORTSC_PS) >> 10 == 0) { + PortStatus.PortStatus |= USB_PORT_STAT_SUPER_SPEED; + } + } else { + // + // For high or full/low speed hub, its bit9~10 presents the attached device speed. + // + if (XHC_BIT_IS_SET (State, BIT9)) { + PortStatus.PortStatus |= USB_PORT_STAT_LOW_SPEED; + } else if (XHC_BIT_IS_SET (State, BIT10)) { + PortStatus.PortStatus |= USB_PORT_STAT_HIGH_SPEED; + } + } + + // + // Convert the XHCI port/port change state to UEFI status + // + MapSize = sizeof (mUsbHubPortStateMap) / sizeof (USB_PORT_STATE_MAP); + for (Index = 0; Index < MapSize; Index++) { + if (XHC_BIT_IS_SET (State, mUsbHubPortStateMap[Index].HwState)) { + PortStatus.PortStatus = (UINT16) (PortStatus.PortStatus | mUsbHubPortStateMap[Index].UefiState); + } + } + + MapSize = sizeof (mUsbHubPortChangeMap) / sizeof (USB_PORT_STATE_MAP); + for (Index = 0; Index < MapSize; Index++) { + if (XHC_BIT_IS_SET (State, mUsbHubPortChangeMap[Index].HwState)) { + PortStatus.PortChangeStatus = (UINT16) (PortStatus.PortChangeStatus | mUsbHubPortChangeMap[Index].UefiState); + } + } + + MapSize = sizeof (mUsbHubClearPortChangeMap) / sizeof (USB_CLEAR_PORT_MAP); + + for (Index = 0; Index < MapSize; Index++) { + if (XHC_BIT_IS_SET (State, mUsbHubClearPortChangeMap[Index].HwState)) { + ZeroMem (&ClearPortRequest, sizeof (EFI_USB_DEVICE_REQUEST)); + ClearPortRequest.RequestType = USB_REQUEST_TYPE (EfiUsbNoData, USB_REQ_TYPE_CLASS, USB_TARGET_OTHER); + ClearPortRequest.Request = (UINT8) USB_REQ_CLEAR_FEATURE; + ClearPortRequest.Value = mUsbHubClearPortChangeMap[Index].Selector; + ClearPortRequest.Index = Request->Index; + ClearPortRequest.Length = 0; + + XhcControlTransfer ( + This, + DeviceAddress, + DeviceSpeed, + MaximumPacketLength, + &ClearPortRequest, + EfiUsbNoData, + NULL, + &Len, + Timeout, + Translator, + TransferResult + ); + } + } + + XhcPollPortStatusChange (Xhc, Xhc->UsbDevContext[SlotId].RouteString, (UINT8)Request->Index, &PortStatus); + + *(UINT32 *)Data = *(UINT32*)&PortStatus; + } + +FREE_URB: + FreePool (Urb); + +ON_EXIT: + + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "XhcControlTransfer: error - %r, transfer - %x\n", Status, *TransferResult)); + } + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Submits bulk transfer to a bulk endpoint of a USB device. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress Endpoint number and its direction in bit 7. + @param DeviceSpeed Device speed, Low speed device doesn't support bulk + transfer. + @param MaximumPacketLength Maximum packet size the endpoint is capable of + sending or receiving. + @param DataBuffersNumber Number of data buffers prepared for the transfer. + @param Data Array of pointers to the buffers of data to transmit + from or receive into. + @param DataLength The lenght of the data buffer. + @param DataToggle On input, the initial data toggle for the transfer; + On output, it is updated to to next data toggle to + use of the subsequent bulk transfer. + @param Timeout Indicates the maximum time, in millisecond, which + the transfer is allowed to complete. + @param Translator A pointr to the transaction translator data. + @param TransferResult A pointer to the detailed result information of the + bulk transfer. + + @retval EFI_SUCCESS The transfer was completed successfully. + @retval EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource. + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_TIMEOUT The transfer failed due to timeout. + @retval EFI_DEVICE_ERROR The transfer failed due to host controller error. + +**/ +EFI_STATUS +EFIAPI +XhcBulkTransfer ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 DeviceAddress, + IN UINT8 EndPointAddress, + IN UINT8 DeviceSpeed, + IN UINTN MaximumPacketLength, + IN UINT8 DataBuffersNumber, + IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM], + IN OUT UINTN *DataLength, + IN OUT UINT8 *DataToggle, + IN UINTN Timeout, + IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, + OUT UINT32 *TransferResult + ) +{ + USB_XHCI_INSTANCE *Xhc; + URB *Urb; + UINT8 SlotId; + EFI_STATUS Status; + EFI_STATUS RecoveryStatus; + EFI_TPL OldTpl; + + // + // Validate the parameters + // + if ((DataLength == NULL) || (*DataLength == 0) || + (Data == NULL) || (Data[0] == NULL) || (TransferResult == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((*DataToggle != 0) && (*DataToggle != 1)) { + return EFI_INVALID_PARAMETER; + } + + if ((DeviceSpeed == EFI_USB_SPEED_LOW) || + ((DeviceSpeed == EFI_USB_SPEED_FULL) && (MaximumPacketLength > 64)) || + ((EFI_USB_SPEED_HIGH == DeviceSpeed) && (MaximumPacketLength > 512)) || + ((EFI_USB_SPEED_SUPER == DeviceSpeed) && (MaximumPacketLength > 1024))) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + + *TransferResult = EFI_USB_ERR_SYSTEM; + Status = EFI_DEVICE_ERROR; + + if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { + DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: HC is halted\n")); + goto ON_EXIT; + } + + // + // Check if the device is still enabled before every transaction. + // + SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); + if (SlotId == 0) { + goto ON_EXIT; + } + + // + // Create a new URB, insert it into the asynchronous + // schedule list, then poll the execution status. + // + Urb = XhcCreateUrb ( + Xhc, + DeviceAddress, + EndPointAddress, + DeviceSpeed, + MaximumPacketLength, + XHC_BULK_TRANSFER, + NULL, + Data[0], + *DataLength, + NULL, + NULL + ); + + if (Urb == NULL) { + DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: failed to create URB\n")); + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + Status = XhcExecTransfer (Xhc, FALSE, Urb, Timeout); + + *TransferResult = Urb->Result; + *DataLength = Urb->Completed; + + if (*TransferResult == EFI_USB_NOERROR) { + Status = EFI_SUCCESS; + } else if (*TransferResult == EFI_USB_ERR_STALL) { + RecoveryStatus = XhcRecoverHaltedEndpoint(Xhc, Urb); + if (EFI_ERROR (RecoveryStatus)) { + DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: XhcRecoverHaltedEndpoint failed\n")); + } + Status = EFI_DEVICE_ERROR; + } + + Xhc->PciIo->Flush (Xhc->PciIo); + XhcFreeUrb (Xhc, Urb); + +ON_EXIT: + + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "XhcBulkTransfer: error - %r, transfer - %x\n", Status, *TransferResult)); + } + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Submits an asynchronous interrupt transfer to an + interrupt endpoint of a USB device. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress Endpoint number and its direction encoded in bit 7 + @param DeviceSpeed Indicates device speed. + @param MaximumPacketLength Maximum packet size the target endpoint is capable + @param IsNewTransfer If TRUE, to submit an new asynchronous interrupt + transfer If FALSE, to remove the specified + asynchronous interrupt. + @param DataToggle On input, the initial data toggle to use; on output, + it is updated to indicate the next data toggle. + @param PollingInterval The he interval, in milliseconds, that the transfer + is polled. + @param DataLength The length of data to receive at the rate specified + by PollingInterval. + @param Translator Transaction translator to use. + @param CallBackFunction Function to call at the rate specified by + PollingInterval. + @param Context Context to CallBackFunction. + + @retval EFI_SUCCESS The request has been successfully submitted or canceled. + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_OUT_OF_RESOURCES The request failed due to a lack of resources. + @retval EFI_DEVICE_ERROR The transfer failed due to host controller error. + +**/ +EFI_STATUS +EFIAPI +XhcAsyncInterruptTransfer ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 DeviceAddress, + IN UINT8 EndPointAddress, + IN UINT8 DeviceSpeed, + IN UINTN MaximumPacketLength, + IN BOOLEAN IsNewTransfer, + IN OUT UINT8 *DataToggle, + IN UINTN PollingInterval, + IN UINTN DataLength, + IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, + IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction, + IN VOID *Context OPTIONAL + ) +{ + USB_XHCI_INSTANCE *Xhc; + URB *Urb; + EFI_STATUS Status; + UINT8 SlotId; + UINT8 Index; + UINT8 *Data; + EFI_TPL OldTpl; + + // + // Validate parameters + // + if (!XHCI_IS_DATAIN (EndPointAddress)) { + return EFI_INVALID_PARAMETER; + } + + if (IsNewTransfer) { + if (DataLength == 0) { + return EFI_INVALID_PARAMETER; + } + + if ((*DataToggle != 1) && (*DataToggle != 0)) { + return EFI_INVALID_PARAMETER; + } + + if ((PollingInterval > 255) || (PollingInterval < 1)) { + return EFI_INVALID_PARAMETER; + } + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + + // + // Delete Async interrupt transfer request. + // + if (!IsNewTransfer) { + // + // The delete request may happen after device is detached. + // + for (Index = 0; Index < 255; Index++) { + if (Xhc->UsbDevContext[Index + 1].BusDevAddr == DeviceAddress) { + break; + } + } + + if (Index == 255) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + Status = XhciDelAsyncIntTransfer (Xhc, DeviceAddress, EndPointAddress); + DEBUG ((EFI_D_INFO, "XhcAsyncInterruptTransfer: remove old transfer for addr %d, Status = %r\n", DeviceAddress, Status)); + goto ON_EXIT; + } + + Status = EFI_SUCCESS; + + if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { + DEBUG ((EFI_D_ERROR, "XhcAsyncInterruptTransfer: HC is halt\n")); + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + // + // Check if the device is still enabled before every transaction. + // + SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); + if (SlotId == 0) { + goto ON_EXIT; + } + + Data = AllocateZeroPool (DataLength); + + if (Data == NULL) { + DEBUG ((EFI_D_ERROR, "XhcAsyncInterruptTransfer: failed to allocate buffer\n")); + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + Urb = XhcCreateUrb ( + Xhc, + DeviceAddress, + EndPointAddress, + DeviceSpeed, + MaximumPacketLength, + XHC_INT_TRANSFER_ASYNC, + NULL, + Data, + DataLength, + CallBackFunction, + Context + ); + + if (Urb == NULL) { + DEBUG ((EFI_D_ERROR, "XhcAsyncInterruptTransfer: failed to create URB\n")); + FreePool (Data); + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + InsertHeadList (&Xhc->AsyncIntTransfers, &Urb->UrbList); + // + // Ring the doorbell + // + Status = RingIntTransferDoorBell (Xhc, Urb); + +ON_EXIT: + Xhc->PciIo->Flush (Xhc->PciIo); + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Submits synchronous interrupt transfer to an interrupt endpoint + of a USB device. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress Endpoint number and its direction encoded in bit 7 + @param DeviceSpeed Indicates device speed. + @param MaximumPacketLength Maximum packet size the target endpoint is capable + of sending or receiving. + @param Data Buffer of data that will be transmitted to USB + device or received from USB device. + @param DataLength On input, the size, in bytes, of the data buffer; On + output, the number of bytes transferred. + @param DataToggle On input, the initial data toggle to use; on output, + it is updated to indicate the next data toggle. + @param Timeout Maximum time, in second, to complete. + @param Translator Transaction translator to use. + @param TransferResult Variable to receive the transfer result. + + @return EFI_SUCCESS The transfer was completed successfully. + @return EFI_OUT_OF_RESOURCES The transfer failed due to lack of resource. + @return EFI_INVALID_PARAMETER Some parameters are invalid. + @return EFI_TIMEOUT The transfer failed due to timeout. + @return EFI_DEVICE_ERROR The failed due to host controller or device error + +**/ +EFI_STATUS +EFIAPI +XhcSyncInterruptTransfer ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 DeviceAddress, + IN UINT8 EndPointAddress, + IN UINT8 DeviceSpeed, + IN UINTN MaximumPacketLength, + IN OUT VOID *Data, + IN OUT UINTN *DataLength, + IN OUT UINT8 *DataToggle, + IN UINTN Timeout, + IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, + OUT UINT32 *TransferResult + ) +{ + USB_XHCI_INSTANCE *Xhc; + URB *Urb; + UINT8 SlotId; + EFI_STATUS Status; + EFI_STATUS RecoveryStatus; + EFI_TPL OldTpl; + + // + // Validates parameters + // + if ((DataLength == NULL) || (*DataLength == 0) || + (Data == NULL) || (TransferResult == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (!XHCI_IS_DATAIN (EndPointAddress)) { + return EFI_INVALID_PARAMETER; + } + + if ((*DataToggle != 1) && (*DataToggle != 0)) { + return EFI_INVALID_PARAMETER; + } + + if (((DeviceSpeed == EFI_USB_SPEED_LOW) && (MaximumPacketLength != 8)) || + ((DeviceSpeed == EFI_USB_SPEED_FULL) && (MaximumPacketLength > 64)) || + ((DeviceSpeed == EFI_USB_SPEED_HIGH) && (MaximumPacketLength > 3072))) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (XHC_TPL); + + Xhc = XHC_FROM_THIS (This); + + *TransferResult = EFI_USB_ERR_SYSTEM; + Status = EFI_DEVICE_ERROR; + + if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) { + DEBUG ((EFI_D_ERROR, "EhcSyncInterruptTransfer: HC is halt\n")); + goto ON_EXIT; + } + + // + // Check if the device is still enabled before every transaction. + // + SlotId = XhcBusDevAddrToSlotId (Xhc, DeviceAddress); + if (SlotId == 0) { + goto ON_EXIT; + } + + Urb = XhcCreateUrb ( + Xhc, + DeviceAddress, + EndPointAddress, + DeviceSpeed, + MaximumPacketLength, + XHC_INT_TRANSFER_SYNC, + NULL, + Data, + *DataLength, + NULL, + NULL + ); + + if (Urb == NULL) { + DEBUG ((EFI_D_ERROR, "XhcSyncInterruptTransfer: failed to create URB\n")); + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + Status = XhcExecTransfer (Xhc, FALSE, Urb, Timeout); + + *TransferResult = Urb->Result; + *DataLength = Urb->Completed; + + if (*TransferResult == EFI_USB_NOERROR) { + Status = EFI_SUCCESS; + } else if (*TransferResult == EFI_USB_ERR_STALL) { + RecoveryStatus = XhcRecoverHaltedEndpoint(Xhc, Urb); + if (EFI_ERROR (RecoveryStatus)) { + DEBUG ((EFI_D_ERROR, "XhcSyncInterruptTransfer: XhcRecoverHaltedEndpoint failed\n")); + } + Status = EFI_DEVICE_ERROR; + } + + Xhc->PciIo->Flush (Xhc->PciIo); + XhcFreeUrb (Xhc, Urb); + +ON_EXIT: + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "XhcSyncInterruptTransfer: error - %r, transfer - %x\n", Status, *TransferResult)); + } + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Submits isochronous transfer to a target USB device. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress End point address with its direction. + @param DeviceSpeed Device speed, Low speed device doesn't support this + type. + @param MaximumPacketLength Maximum packet size that the endpoint is capable of + sending or receiving. + @param DataBuffersNumber Number of data buffers prepared for the transfer. + @param Data Array of pointers to the buffers of data that will + be transmitted to USB device or received from USB + device. + @param DataLength The size, in bytes, of the data buffer. + @param Translator Transaction translator to use. + @param TransferResult Variable to receive the transfer result. + + @return EFI_UNSUPPORTED Isochronous transfer is unsupported. + +**/ +EFI_STATUS +EFIAPI +XhcIsochronousTransfer ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 DeviceAddress, + IN UINT8 EndPointAddress, + IN UINT8 DeviceSpeed, + IN UINTN MaximumPacketLength, + IN UINT8 DataBuffersNumber, + IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], + IN UINTN DataLength, + IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, + OUT UINT32 *TransferResult + ) +{ + return EFI_UNSUPPORTED; +} + + +/** + Submits Async isochronous transfer to a target USB device. + + @param This This EFI_USB2_HC_PROTOCOL instance. + @param DeviceAddress Target device address. + @param EndPointAddress End point address with its direction. + @param DeviceSpeed Device speed, Low speed device doesn't support this + type. + @param MaximumPacketLength Maximum packet size that the endpoint is capable of + sending or receiving. + @param DataBuffersNumber Number of data buffers prepared for the transfer. + @param Data Array of pointers to the buffers of data that will + be transmitted to USB device or received from USB + device. + @param DataLength The size, in bytes, of the data buffer. + @param Translator Transaction translator to use. + @param IsochronousCallBack Function to be called when the transfer complete. + @param Context Context passed to the call back function as + parameter. + + @return EFI_UNSUPPORTED Isochronous transfer isn't supported. + +**/ +EFI_STATUS +EFIAPI +XhcAsyncIsochronousTransfer ( + IN EFI_USB2_HC_PROTOCOL *This, + IN UINT8 DeviceAddress, + IN UINT8 EndPointAddress, + IN UINT8 DeviceSpeed, + IN UINTN MaximumPacketLength, + IN UINT8 DataBuffersNumber, + IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM], + IN UINTN DataLength, + IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator, + IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, + IN VOID *Context + ) +{ + return EFI_UNSUPPORTED; +} + +/** + Entry point for EFI drivers. + + @param ImageHandle EFI_HANDLE. + @param SystemTable EFI_SYSTEM_TABLE. + + @retval EFI_SUCCESS Success. + @retval Others Fail. + +**/ +EFI_STATUS +EFIAPI +XhcDriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gXhciDriverBinding, + ImageHandle, + &gXhciComponentName, + &gXhciComponentName2 + ); +} + + +/** + Test to see if this driver supports ControllerHandle. Any + ControllerHandle that has Usb2HcProtocol installed will + be supported. + + @param This Protocol instance pointer. + @param Controller Handle of device to test. + @param RemainingDevicePath Not used. + + @return EFI_SUCCESS This driver supports this device. + @return EFI_UNSUPPORTED This driver does not support this device. + +**/ +EFI_STATUS +EFIAPI +XhcDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + EFI_STATUS Status; + EFI_PCI_IO_PROTOCOL *PciIo; + USB_CLASSC UsbClassCReg; + + // + // Test whether there is PCI IO Protocol attached on the controller handle. + // + Status = gBS->OpenProtocol ( + Controller, + &gEfiPciIoProtocolGuid, + (VOID **) &PciIo, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Status = PciIo->Pci.Read ( + PciIo, + EfiPciIoWidthUint8, + PCI_CLASSCODE_OFFSET, + sizeof (USB_CLASSC) / sizeof (UINT8), + &UsbClassCReg + ); + + if (EFI_ERROR (Status)) { + Status = EFI_UNSUPPORTED; + goto ON_EXIT; + } + + // + // Test whether the controller belongs to Xhci type + // + if ((UsbClassCReg.BaseCode != PCI_CLASS_SERIAL) || + (UsbClassCReg.SubClassCode != PCI_CLASS_SERIAL_USB) || + (UsbClassCReg.ProgInterface != PCI_IF_XHCI)) { + Status = EFI_UNSUPPORTED; + } + +ON_EXIT: + gBS->CloseProtocol ( + Controller, + &gEfiPciIoProtocolGuid, + This->DriverBindingHandle, + Controller + ); + + return Status; +} + +/** + Create and initialize a USB_XHCI_INSTANCE structure. + + @param PciIo The PciIo on this device. + @param DevicePath The device path of host controller. + @param OriginalPciAttributes Original PCI attributes. + + @return The allocated and initialized USB_XHCI_INSTANCE structure if created, + otherwise NULL. + +**/ +USB_XHCI_INSTANCE* +XhcCreateUsbHc ( + IN EFI_PCI_IO_PROTOCOL *PciIo, + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, + IN UINT64 OriginalPciAttributes + ) +{ + USB_XHCI_INSTANCE *Xhc; + EFI_STATUS Status; + UINT32 PageSize; + UINT16 ExtCapReg; + + Xhc = AllocateZeroPool (sizeof (USB_XHCI_INSTANCE)); + + if (Xhc == NULL) { + return NULL; + } + + // + // Initialize private data structure + // + Xhc->Signature = XHCI_INSTANCE_SIG; + Xhc->PciIo = PciIo; + Xhc->DevicePath = DevicePath; + Xhc->OriginalPciAttributes = OriginalPciAttributes; + CopyMem (&Xhc->Usb2Hc, &gXhciUsb2HcTemplate, sizeof (EFI_USB2_HC_PROTOCOL)); + + InitializeListHead (&Xhc->AsyncIntTransfers); + + // + // Be caution that the Offset passed to XhcReadCapReg() should be Dword align + // + Xhc->CapLength = XhcReadCapReg8 (Xhc, XHC_CAPLENGTH_OFFSET); + Xhc->HcSParams1.Dword = XhcReadCapReg (Xhc, XHC_HCSPARAMS1_OFFSET); + Xhc->HcSParams2.Dword = XhcReadCapReg (Xhc, XHC_HCSPARAMS2_OFFSET); + Xhc->HcCParams.Dword = XhcReadCapReg (Xhc, XHC_HCCPARAMS_OFFSET); + Xhc->DBOff = XhcReadCapReg (Xhc, XHC_DBOFF_OFFSET); + Xhc->RTSOff = XhcReadCapReg (Xhc, XHC_RTSOFF_OFFSET); + + // + // This PageSize field defines the page size supported by the xHC implementation. + // This xHC supports a page size of 2^(n+12) if bit n is Set. For example, + // if bit 0 is Set, the xHC supports 4k byte page sizes. + // + PageSize = XhcReadOpReg(Xhc, XHC_PAGESIZE_OFFSET) & XHC_PAGESIZE_MASK; + Xhc->PageSize = 1 << (HighBitSet32(PageSize) + 12); + + ExtCapReg = (UINT16) (Xhc->HcCParams.Data.ExtCapReg); + Xhc->ExtCapRegBase = ExtCapReg << 2; + Xhc->UsbLegSupOffset = XhcGetCapabilityAddr (Xhc, XHC_CAP_USB_LEGACY); + Xhc->DebugCapSupOffset = XhcGetCapabilityAddr (Xhc, XHC_CAP_USB_DEBUG); + + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: Capability length 0x%x\n", Xhc->CapLength)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: HcSParams1 0x%x\n", Xhc->HcSParams1)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: HcSParams2 0x%x\n", Xhc->HcSParams2)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: HcCParams 0x%x\n", Xhc->HcCParams)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: DBOff 0x%x\n", Xhc->DBOff)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: RTSOff 0x%x\n", Xhc->RTSOff)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: UsbLegSupOffset 0x%x\n", Xhc->UsbLegSupOffset)); + DEBUG ((EFI_D_INFO, "XhcCreateUsb3Hc: DebugCapSupOffset 0x%x\n", Xhc->DebugCapSupOffset)); + + // + // Create AsyncRequest Polling Timer + // + Status = gBS->CreateEvent ( + EVT_TIMER | EVT_NOTIFY_SIGNAL, + TPL_CALLBACK, + XhcMonitorAsyncRequests, + Xhc, + &Xhc->PollTimer + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + return Xhc; + +ON_ERROR: + FreePool (Xhc); + return NULL; +} + +/** + One notified function to stop the Host Controller when gBS->ExitBootServices() called. + + @param Event Pointer to this event + @param Context Event hanlder private data + +**/ +VOID +EFIAPI +XhcExitBootService ( + EFI_EVENT Event, + VOID *Context + ) + +{ + USB_XHCI_INSTANCE *Xhc; + EFI_PCI_IO_PROTOCOL *PciIo; + + Xhc = (USB_XHCI_INSTANCE*) Context; + PciIo = Xhc->PciIo; + + // + // Stop AsyncRequest Polling timer then stop the XHCI driver + // and uninstall the XHCI protocl. + // + gBS->SetTimer (Xhc->PollTimer, TimerCancel, 0); + XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); + + if (Xhc->PollTimer != NULL) { + gBS->CloseEvent (Xhc->PollTimer); + } + + XhcClearBiosOwnership (Xhc); + + // + // Restore original PCI attributes + // + PciIo->Attributes ( + PciIo, + EfiPciIoAttributeOperationSet, + Xhc->OriginalPciAttributes, + NULL + ); +} + +/** + Starting the Usb XHCI Driver. + + @param This Protocol instance pointer. + @param Controller Handle of device to test. + @param RemainingDevicePath Not used. + + @return EFI_SUCCESS supports this device. + @return EFI_UNSUPPORTED do not support this device. + @return EFI_DEVICE_ERROR cannot be started due to device Error. + @return EFI_OUT_OF_RESOURCES cannot allocate resources. + +**/ +EFI_STATUS +EFIAPI +XhcDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + EFI_STATUS Status; + EFI_PCI_IO_PROTOCOL *PciIo; + UINT64 Supports; + UINT64 OriginalPciAttributes; + BOOLEAN PciAttributesSaved; + USB_XHCI_INSTANCE *Xhc; + EFI_DEVICE_PATH_PROTOCOL *HcDevicePath; + + // + // Open the PciIo Protocol, then enable the USB host controller + // + Status = gBS->OpenProtocol ( + Controller, + &gEfiPciIoProtocolGuid, + (VOID **) &PciIo, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Open Device Path Protocol for on USB host controller + // + HcDevicePath = NULL; + Status = gBS->OpenProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + (VOID **) &HcDevicePath, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + PciAttributesSaved = FALSE; + // + // Save original PCI attributes + // + Status = PciIo->Attributes ( + PciIo, + EfiPciIoAttributeOperationGet, + 0, + &OriginalPciAttributes + ); + + if (EFI_ERROR (Status)) { + goto CLOSE_PCIIO; + } + PciAttributesSaved = TRUE; + + Status = PciIo->Attributes ( + PciIo, + EfiPciIoAttributeOperationSupported, + 0, + &Supports + ); + if (!EFI_ERROR (Status)) { + Supports &= EFI_PCI_DEVICE_ENABLE; + Status = PciIo->Attributes ( + PciIo, + EfiPciIoAttributeOperationEnable, + Supports, + NULL + ); + } + + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to enable controller\n")); + goto CLOSE_PCIIO; + } + + // + // Create then install USB2_HC_PROTOCOL + // + Xhc = XhcCreateUsbHc (PciIo, HcDevicePath, OriginalPciAttributes); + + if (Xhc == NULL) { + DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to create USB2_HC\n")); + return EFI_OUT_OF_RESOURCES; + } + + XhcSetBiosOwnership (Xhc); + + XhcResetHC (Xhc, XHC_RESET_TIMEOUT); + ASSERT (XhcIsHalt (Xhc)); + + // + // After Chip Hardware Reset wait until the Controller Not Ready (CNR) flag + // in the USBSTS is '0' before writing any xHC Operational or Runtime registers. + // + ASSERT (!(XHC_REG_BIT_IS_SET (Xhc, XHC_USBSTS_OFFSET, XHC_USBSTS_CNR))); + + // + // Initialize the schedule + // + XhcInitSched (Xhc); + + // + // Start the Host Controller + // + XhcRunHC(Xhc, XHC_GENERIC_TIMEOUT); + + // + // Start the asynchronous interrupt monitor + // + Status = gBS->SetTimer (Xhc->PollTimer, TimerPeriodic, XHC_ASYNC_TIMER_INTERVAL); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to start async interrupt monitor\n")); + XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); + goto FREE_POOL; + } + + // + // Create event to stop the HC when exit boot service. + // + Status = gBS->CreateEventEx ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + XhcExitBootService, + Xhc, + &gEfiEventExitBootServicesGuid, + &Xhc->ExitBootServiceEvent + ); + if (EFI_ERROR (Status)) { + goto FREE_POOL; + } + + // + // Install the component name protocol, don't fail the start + // because of something for display. + // + AddUnicodeString2 ( + "eng", + gXhciComponentName.SupportedLanguages, + &Xhc->ControllerNameTable, + L"eXtensible Host Controller (USB 3.0)", + TRUE + ); + AddUnicodeString2 ( + "en", + gXhciComponentName2.SupportedLanguages, + &Xhc->ControllerNameTable, + L"eXtensible Host Controller (USB 3.0)", + FALSE + ); + + Status = gBS->InstallProtocolInterface ( + &Controller, + &gEfiUsb2HcProtocolGuid, + EFI_NATIVE_INTERFACE, + &Xhc->Usb2Hc + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "XhcDriverBindingStart: failed to install USB2_HC Protocol\n")); + goto FREE_POOL; + } + + DEBUG ((EFI_D_INFO, "XhcDriverBindingStart: XHCI started for controller @ %x\n", Controller)); + return EFI_SUCCESS; + +FREE_POOL: + gBS->CloseEvent (Xhc->PollTimer); + XhcFreeSched (Xhc); + FreePool (Xhc); + +CLOSE_PCIIO: + if (PciAttributesSaved) { + // + // Restore original PCI attributes + // + PciIo->Attributes ( + PciIo, + EfiPciIoAttributeOperationSet, + OriginalPciAttributes, + NULL + ); + } + + gBS->CloseProtocol ( + Controller, + &gEfiPciIoProtocolGuid, + This->DriverBindingHandle, + Controller + ); + + return Status; +} + + +/** + Stop this driver on ControllerHandle. Support stoping any child handles + created by this driver. + + @param This Protocol instance pointer. + @param Controller Handle of device to stop driver on. + @param NumberOfChildren Number of Children in the ChildHandleBuffer. + @param ChildHandleBuffer List of handles for the children we need to stop. + + @return EFI_SUCCESS Success. + @return EFI_DEVICE_ERROR Fail. + +**/ +EFI_STATUS +EFIAPI +XhcDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_STATUS Status; + EFI_USB2_HC_PROTOCOL *Usb2Hc; + EFI_PCI_IO_PROTOCOL *PciIo; + USB_XHCI_INSTANCE *Xhc; + UINT8 Index; + + // + // Test whether the Controller handler passed in is a valid + // Usb controller handle that should be supported, if not, + // return the error status directly + // + Status = gBS->OpenProtocol ( + Controller, + &gEfiUsb2HcProtocolGuid, + (VOID **) &Usb2Hc, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->UninstallProtocolInterface ( + Controller, + &gEfiUsb2HcProtocolGuid, + Usb2Hc + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Xhc = XHC_FROM_THIS (Usb2Hc); + PciIo = Xhc->PciIo; + + // + // Stop AsyncRequest Polling timer then stop the XHCI driver + // and uninstall the XHCI protocl. + // + gBS->SetTimer (Xhc->PollTimer, TimerCancel, 0); + + // + // Disable the device slots occupied by these devices on its downstream ports. + // Entry 0 is reserved. + // + for (Index = 0; Index < 255; Index++) { + if (!Xhc->UsbDevContext[Index + 1].Enabled || + (Xhc->UsbDevContext[Index + 1].SlotId == 0)) { + continue; + } + if (Xhc->HcCParams.Data.Csz == 0) { + XhcDisableSlotCmd (Xhc, Xhc->UsbDevContext[Index + 1].SlotId); + } else { + XhcDisableSlotCmd64 (Xhc, Xhc->UsbDevContext[Index + 1].SlotId); + } + } + + if (Xhc->PollTimer != NULL) { + gBS->CloseEvent (Xhc->PollTimer); + } + + if (Xhc->ExitBootServiceEvent != NULL) { + gBS->CloseEvent (Xhc->ExitBootServiceEvent); + } + + XhcHaltHC (Xhc, XHC_GENERIC_TIMEOUT); + XhcClearBiosOwnership (Xhc); + XhciDelAllAsyncIntTransfers (Xhc); + XhcFreeSched (Xhc); + + if (Xhc->ControllerNameTable) { + FreeUnicodeStringTable (Xhc->ControllerNameTable); + } + + // + // Restore original PCI attributes + // + PciIo->Attributes ( + PciIo, + EfiPciIoAttributeOperationSet, + Xhc->OriginalPciAttributes, + NULL + ); + + gBS->CloseProtocol ( + Controller, + &gEfiPciIoProtocolGuid, + This->DriverBindingHandle, + Controller + ); + + FreePool (Xhc); + + return EFI_SUCCESS; +} + diff --git a/MdeModulePkg/Include/Library/TcpIoLib.h b/MdeModulePkg/Include/Library/TcpIoLib.h index 49008bdefc..2871f6747e 100644 --- a/MdeModulePkg/Include/Library/TcpIoLib.h +++ b/MdeModulePkg/Include/Library/TcpIoLib.h @@ -11,23 +11,23 @@ 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. -**/ - -#ifndef _TCP_IO_H_ +**/ + +#ifndef _TCP_IO_H_ #define _TCP_IO_H_ #include #include -#include +#include #define TCP_VERSION_4 IP_VERSION_4 #define TCP_VERSION_6 IP_VERSION_6 -/// -/// 10 seconds -/// +/// +/// 10 seconds +/// #define TCP_GET_MAPPING_TIMEOUT 100000000U @@ -40,12 +40,12 @@ typedef struct { EFI_IPv4_ADDRESS RemoteIp; UINT16 RemotePort; BOOLEAN ActiveFlag; -} TCP4_IO_CONFIG_DATA; +} TCP4_IO_CONFIG_DATA; -typedef struct { +typedef struct { UINT16 StationPort; EFI_IPv6_ADDRESS RemoteIp; - UINT16 RemotePort; + UINT16 RemotePort; BOOLEAN ActiveFlag; } TCP6_IO_CONFIG_DATA; @@ -112,7 +112,7 @@ typedef struct { @retval EFI_SUCCESS The TCP socket is created and configured. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED One or more of the control options are not + @retval EFI_UNSUPPORTED One or more of the control options are not supported in the implementation. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval Others Failed to create the TCP socket or configure it. @@ -120,26 +120,26 @@ typedef struct { **/ EFI_STATUS EFIAPI -TcpIoCreateSocket ( - IN EFI_HANDLE Image, +TcpIoCreateSocket ( + IN EFI_HANDLE Image, IN EFI_HANDLE Controller, - IN UINT8 TcpVersion, - IN TCP_IO_CONFIG_DATA *ConfigData, - OUT TCP_IO *TcpIo - ); - -/** - Destroy the socket. - - @param[in] TcpIo The TcpIo which wraps the socket to be destroyed. - -**/ -VOID + IN UINT8 TcpVersion, + IN TCP_IO_CONFIG_DATA *ConfigData, + OUT TCP_IO *TcpIo + ); + +/** + Destroy the socket. + + @param[in] TcpIo The TcpIo which wraps the socket to be destroyed. + +**/ +VOID EFIAPI -TcpIoDestroySocket ( - IN TCP_IO *TcpIo - ); - +TcpIoDestroySocket ( + IN TCP_IO *TcpIo + ); + /** Connect to the other endpoint of the TCP socket. @@ -156,12 +156,12 @@ TcpIoDestroySocket ( @retval Others Other errors as indicated. **/ -EFI_STATUS +EFI_STATUS EFIAPI -TcpIoConnect ( - IN OUT TCP_IO *TcpIo, - IN EFI_EVENT Timeout - ); +TcpIoConnect ( + IN OUT TCP_IO *TcpIo, + IN EFI_EVENT Timeout + ); /** Accept the incomding request from the other endpoint of the TCP socket. @@ -187,19 +187,19 @@ TcpIoAccept ( IN OUT TCP_IO *TcpIo, IN EFI_EVENT Timeout ); - -/** - Reset the socket. - - @param[in, out] TcpIo The TcpIo wrapping the TCP socket. - -**/ -VOID + +/** + Reset the socket. + + @param[in, out] TcpIo The TcpIo wrapping the TCP socket. + +**/ +VOID EFIAPI -TcpIoReset ( - IN OUT TCP_IO *TcpIo - ); - +TcpIoReset ( + IN OUT TCP_IO *TcpIo + ); + /** Transmit the Packet to the other endpoint of the socket. @@ -215,13 +215,13 @@ TcpIoReset ( @retval Others Other errors as indicated. **/ -EFI_STATUS +EFI_STATUS EFIAPI -TcpIoTransmit ( - IN TCP_IO *TcpIo, - IN NET_BUF *Packet - ); - +TcpIoTransmit ( + IN TCP_IO *TcpIo, + IN NET_BUF *Packet + ); + /** Receive data from the socket. @@ -240,14 +240,14 @@ TcpIoTransmit ( @retval Others Other errors as indicated. **/ -EFI_STATUS +EFI_STATUS EFIAPI -TcpIoReceive ( - IN OUT TCP_IO *TcpIo, - IN NET_BUF *Packet, - IN BOOLEAN AsyncMode, - IN EFI_EVENT Timeout - ); +TcpIoReceive ( + IN OUT TCP_IO *TcpIo, + IN NET_BUF *Packet, + IN BOOLEAN AsyncMode, + IN EFI_EVENT Timeout + ); #endif diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c index 730ccb2caf..17183e1a6c 100644 --- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c +++ b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c @@ -22,92 +22,92 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include #include -/** +/** The common notify function associated with various TcpIo events. - - @param[in] Event The event signaled. - @param[in] Context The context. - -**/ -VOID -EFIAPI + + @param[in] Event The event signaled. + @param[in] Context The context. + +**/ +VOID +EFIAPI TcpIoCommonNotify ( - IN EFI_EVENT Event, - IN VOID *Context - ) + IN EFI_EVENT Event, + IN VOID *Context + ) { if ((Event == NULL) || (Context == NULL)) { return ; } - *((BOOLEAN *) Context) = TRUE; + *((BOOLEAN *) Context) = TRUE; } -/** +/** The internal function for delay configuring TCP6 when IP6 driver is still in DAD. - - @param[in] Tcp6 The EFI_TCP6_PROTOCOL protocol instance. - @param[in] Tcp6ConfigData The Tcp6 configuration data. - - @retval EFI_SUCCESS The operational settings successfully - completed. + + @param[in] Tcp6 The EFI_TCP6_PROTOCOL protocol instance. + @param[in] Tcp6ConfigData The Tcp6 configuration data. + + @retval EFI_SUCCESS The operational settings successfully + completed. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. @retval Others Failed to finish the operation. -**/ -EFI_STATUS +**/ +EFI_STATUS TcpIoGetMapping ( - IN EFI_TCP6_PROTOCOL *Tcp6, - IN EFI_TCP6_CONFIG_DATA *Tcp6ConfigData - ) -{ - EFI_STATUS Status; - EFI_EVENT Event; + IN EFI_TCP6_PROTOCOL *Tcp6, + IN EFI_TCP6_CONFIG_DATA *Tcp6ConfigData + ) +{ + EFI_STATUS Status; + EFI_EVENT Event; if ((Tcp6 == NULL) || (Tcp6ConfigData == NULL)) { return EFI_INVALID_PARAMETER; } - Event = NULL; - Status = gBS->CreateEvent ( - EVT_TIMER, - TPL_CALLBACK, - NULL, - NULL, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - Status = gBS->SetTimer ( - Event, - TimerRelative, + Event = NULL; + Status = gBS->CreateEvent ( + EVT_TIMER, + TPL_CALLBACK, + NULL, + NULL, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + Status = gBS->SetTimer ( + Event, + TimerRelative, TCP_GET_MAPPING_TIMEOUT - ); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - while (EFI_ERROR (gBS->CheckEvent (Event))) { - - Tcp6->Poll (Tcp6); - - Status = Tcp6->Configure (Tcp6, Tcp6ConfigData); - - if (!EFI_ERROR (Status)) { - break; - } - } - -ON_EXIT: - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - return Status; + ); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + while (EFI_ERROR (gBS->CheckEvent (Event))) { + + Tcp6->Poll (Tcp6); + + Status = Tcp6->Configure (Tcp6, Tcp6ConfigData); + + if (!EFI_ERROR (Status)) { + break; + } + } + +ON_EXIT: + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + return Status; } /** @@ -121,7 +121,7 @@ ON_EXIT: @retval EFI_SUCCESS The TCP socket is created and configured. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED One or more of the control options are not + @retval EFI_UNSUPPORTED One or more of the control options are not supported in the implementation. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval Others Failed to create the TCP socket or configure it. @@ -177,26 +177,26 @@ TcpIoCreateSocket ( // // Create the TCP child instance and get the TCP protocol. // - Status = NetLibCreateServiceChild ( - Controller, - Image, + Status = NetLibCreateServiceChild ( + Controller, + Image, ServiceBindingGuid, &TcpIo->Handle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->OpenProtocol ( + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->OpenProtocol ( TcpIo->Handle, ProtocolGuid, Interface, - Image, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); + Image, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); if (EFI_ERROR (Status) || (*Interface == NULL)) { - goto ON_ERROR; + goto ON_ERROR; } if (TcpVersion == TCP_VERSION_4) { @@ -204,28 +204,28 @@ TcpIoCreateSocket ( } else { Tcp6 = TcpIo->Tcp.Tcp6; } - + TcpIo->Image = Image; TcpIo->Controller = Controller; - - // - // Set the configuration parameters. - // - ControlOption.ReceiveBufferSize = 0x200000; - ControlOption.SendBufferSize = 0x200000; - ControlOption.MaxSynBackLog = 0; - ControlOption.ConnectionTimeout = 0; - ControlOption.DataRetries = 6; - ControlOption.FinTimeout = 0; - ControlOption.TimeWaitTimeout = 0; - ControlOption.KeepAliveProbes = 4; - ControlOption.KeepAliveTime = 0; - ControlOption.KeepAliveInterval = 0; - ControlOption.EnableNagle = FALSE; - ControlOption.EnableTimeStamp = FALSE; - ControlOption.EnableWindowScaling = TRUE; - ControlOption.EnableSelectiveAck = FALSE; - ControlOption.EnablePathMtuDiscovery = FALSE; + + // + // Set the configuration parameters. + // + ControlOption.ReceiveBufferSize = 0x200000; + ControlOption.SendBufferSize = 0x200000; + ControlOption.MaxSynBackLog = 0; + ControlOption.ConnectionTimeout = 0; + ControlOption.DataRetries = 6; + ControlOption.FinTimeout = 0; + ControlOption.TimeWaitTimeout = 0; + ControlOption.KeepAliveProbes = 4; + ControlOption.KeepAliveTime = 0; + ControlOption.KeepAliveInterval = 0; + ControlOption.EnableNagle = FALSE; + ControlOption.EnableTimeStamp = FALSE; + ControlOption.EnableWindowScaling = TRUE; + ControlOption.EnableSelectiveAck = FALSE; + ControlOption.EnablePathMtuDiscovery = FALSE; if (TcpVersion == TCP_VERSION_4) { Tcp4ConfigData.TypeOfService = 8; @@ -309,59 +309,59 @@ TcpIoCreateSocket ( } } - // - // Create events for variuos asynchronous operations. + // + // Create events for variuos asynchronous operations. // Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, TcpIoCommonNotify, &TcpIo->IsConnDone, &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; } TcpIo->ConnToken.Tcp4Token.CompletionToken.Event = Event; - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, TcpIoCommonNotify, &TcpIo->IsListenDone, &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; } TcpIo->ListenToken.Tcp4Token.CompletionToken.Event = Event; - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, TcpIoCommonNotify, &TcpIo->IsTxDone, &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } TcpIo->TxToken.Tcp4Token.CompletionToken.Event = Event; - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, TcpIoCommonNotify, &TcpIo->IsRxDone, &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } TcpIo->RxToken.Tcp4Token.CompletionToken.Event = Event; @@ -373,26 +373,26 @@ TcpIoCreateSocket ( TcpIo->RxToken.Tcp4Token.Packet.RxData = RxData; - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, TcpIoCommonNotify, &TcpIo->IsCloseDone, &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } TcpIo->CloseToken.Tcp4Token.CompletionToken.Event = Event; return EFI_SUCCESS; - -ON_ERROR: + +ON_ERROR: TcpIoDestroySocket (TcpIo); - + return Status; } @@ -482,7 +482,7 @@ TcpIoDestroySocket ( if ((Tcp4 != NULL) || (Tcp6 != NULL)) { - gBS->CloseProtocol ( + gBS->CloseProtocol ( TcpIo->Handle, ProtocolGuid, TcpIo->Image, @@ -518,7 +518,7 @@ TcpIoDestroySocket ( } } - NetLibDestroyServiceChild ( + NetLibDestroyServiceChild ( TcpIo->Controller, TcpIo->Image, ServiceBindingGuid, @@ -572,24 +572,24 @@ TcpIoConnect ( return EFI_UNSUPPORTED; } - if (EFI_ERROR (Status)) { - return Status; - } - + if (EFI_ERROR (Status)) { + return Status; + } + while (!TcpIo->IsConnDone && EFI_ERROR (gBS->CheckEvent (Timeout))) { if (TcpIo->TcpVersion == TCP_VERSION_4) { Tcp4->Poll (Tcp4); } else { Tcp6->Poll (Tcp6); } - } - + } + if (!TcpIo->IsConnDone) { - Status = EFI_TIMEOUT; + Status = EFI_TIMEOUT; } else { Status = TcpIo->ConnToken.Tcp4Token.CompletionToken.Status; } - + return Status; } @@ -642,8 +642,8 @@ TcpIoAccept ( return EFI_UNSUPPORTED; } - if (EFI_ERROR (Status)) { - return Status; + if (EFI_ERROR (Status)) { + return Status; } while (!TcpIo->IsListenDone && EFI_ERROR (gBS->CheckEvent (Timeout))) { @@ -652,18 +652,18 @@ TcpIoAccept ( } else { Tcp6->Poll (Tcp6); } - } + } if (!TcpIo->IsListenDone) { - Status = EFI_TIMEOUT; + Status = EFI_TIMEOUT; } else { Status = TcpIo->ListenToken.Tcp4Token.CompletionToken.Status; } - // - // The new TCP instance handle created for the established connection is - // in ListenToken. - // + // + // The new TCP instance handle created for the established connection is + // in ListenToken. + // if (!EFI_ERROR (Status)) { if (TcpIo->TcpVersion == TCP_VERSION_4) { ProtocolGuid = &gEfiTcp4ProtocolGuid; @@ -671,16 +671,16 @@ TcpIoAccept ( ProtocolGuid = &gEfiTcp6ProtocolGuid; } - Status = gBS->OpenProtocol ( + Status = gBS->OpenProtocol ( TcpIo->ListenToken.Tcp4Token.NewChildHandle, ProtocolGuid, (VOID **) (&TcpIo->NewTcp.Tcp4), TcpIo->Image, TcpIo->Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - } + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + } return Status; } @@ -721,10 +721,10 @@ TcpIoReset ( return ; } - if (EFI_ERROR (Status)) { - return ; - } - + if (EFI_ERROR (Status)) { + return ; + } + while (!TcpIo->IsCloseDone) { if (TcpIo->TcpVersion == TCP_VERSION_4) { Tcp4->Poll (Tcp4); @@ -780,16 +780,16 @@ TcpIoTransmit ( Data = AllocatePool (Size); if (Data == NULL) { - return EFI_OUT_OF_RESOURCES; + return EFI_OUT_OF_RESOURCES; } ((EFI_TCP4_TRANSMIT_DATA *) Data)->Push = TRUE; ((EFI_TCP4_TRANSMIT_DATA *) Data)->Urgent = FALSE; ((EFI_TCP4_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; - // - // Build the fragment table. - // + // + // Build the fragment table. + // ((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentCount = Packet->BlockOpNum; NetbufBuildExt ( @@ -802,8 +802,8 @@ TcpIoTransmit ( Tcp6 = NULL; Status = EFI_DEVICE_ERROR; - // - // Trasnmit the packet. + // + // Trasnmit the packet. // if (TcpIo->TcpVersion == TCP_VERSION_4) { TcpIo->TxToken.Tcp4Token.Packet.TxData = (EFI_TCP4_TRANSMIT_DATA *) Data; @@ -831,25 +831,25 @@ TcpIoTransmit ( Status = Tcp6->Transmit (Tcp6, &TcpIo->TxToken.Tcp6Token); } - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + while (!TcpIo->IsTxDone) { if (TcpIo->TcpVersion == TCP_VERSION_4) { Tcp4->Poll (Tcp4); } else { Tcp6->Poll (Tcp6); } - } - + } + TcpIo->IsTxDone = FALSE; Status = TcpIo->TxToken.Tcp4Token.CompletionToken.Status; -ON_EXIT: - +ON_EXIT: + FreePool (Data); - + return Status; } @@ -926,22 +926,22 @@ TcpIoReceive ( return EFI_UNSUPPORTED; } - FragmentCount = Packet->BlockOpNum; - Fragment = AllocatePool (FragmentCount * sizeof (NET_FRAGMENT)); + FragmentCount = Packet->BlockOpNum; + Fragment = AllocatePool (FragmentCount * sizeof (NET_FRAGMENT)); if (Fragment == NULL) { Status = EFI_OUT_OF_RESOURCES; goto ON_EXIT; - } - // - // Build the fragment table. - // - NetbufBuildExt (Packet, Fragment, &FragmentCount); + } + // + // Build the fragment table. + // + NetbufBuildExt (Packet, Fragment, &FragmentCount); RxData->FragmentCount = 1; CurrentFragment = 0; - Status = EFI_SUCCESS; - - while (CurrentFragment < FragmentCount) { + Status = EFI_SUCCESS; + + while (CurrentFragment < FragmentCount) { RxData->DataLength = Fragment[CurrentFragment].Len; RxData->FragmentTable[0].FragmentLength = Fragment[CurrentFragment].Len; RxData->FragmentTable[0].FragmentBuffer = Fragment[CurrentFragment].Bulk; @@ -952,9 +952,9 @@ TcpIoReceive ( Status = Tcp6->Receive (Tcp6, &TcpIo->RxToken.Tcp6Token); } - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } while (!TcpIo->IsRxDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { // @@ -966,42 +966,42 @@ TcpIoReceive ( Tcp6->Poll (Tcp6); } } - + if (!TcpIo->IsRxDone) { - // - // Timeout occurs, cancel the receive request. - // + // + // Timeout occurs, cancel the receive request. + // if (TcpIo->TcpVersion == TCP_VERSION_4) { Tcp4->Cancel (Tcp4, &TcpIo->RxToken.Tcp4Token.CompletionToken); } else { Tcp6->Cancel (Tcp6, &TcpIo->RxToken.Tcp6Token.CompletionToken); } - - Status = EFI_TIMEOUT; - goto ON_EXIT; - } else { + + Status = EFI_TIMEOUT; + goto ON_EXIT; + } else { TcpIo->IsRxDone = FALSE; } Status = TcpIo->RxToken.Tcp4Token.CompletionToken.Status; if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - + goto ON_EXIT; + } + Fragment[CurrentFragment].Len -= RxData->FragmentTable[0].FragmentLength; - if (Fragment[CurrentFragment].Len == 0) { - CurrentFragment++; - } else { + if (Fragment[CurrentFragment].Len == 0) { + CurrentFragment++; + } else { Fragment[CurrentFragment].Bulk += RxData->FragmentTable[0].FragmentLength; - } - } - -ON_EXIT: + } + } + +ON_EXIT: if (Fragment != NULL) { FreePool (Fragment); } - + return Status; } diff --git a/MdeModulePkg/Universal/DebugSupportDxe/X64/AsmFuncs.S b/MdeModulePkg/Universal/DebugSupportDxe/X64/AsmFuncs.S index e6a40e8dad..9783ec6b80 100644 --- a/MdeModulePkg/Universal/DebugSupportDxe/X64/AsmFuncs.S +++ b/MdeModulePkg/Universal/DebugSupportDxe/X64/AsmFuncs.S @@ -1,551 +1,551 @@ -///**@file -// Low leve x64 specific debug support functions. -// -// Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
-// Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
-// 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. -// -//**/ - -ASM_GLOBAL ASM_PFX(OrigVector) -ASM_GLOBAL ASM_PFX(InterruptEntryStub) -ASM_GLOBAL ASM_PFX(StubSize) -ASM_GLOBAL ASM_PFX(CommonIdtEntry) -ASM_GLOBAL ASM_PFX(FxStorSupport) - -.data - -ASM_PFX(StubSize): .long ASM_PFX(InterruptEntryStubEnd) - ASM_PFX(InterruptEntryStub) -ASM_PFX(AppRsp): .long 0x11111111 # ? - .long 0x11111111 # ? -ASM_PFX(DebugRsp): .long 0x22222222 # ? - .long 0x22222222 # ? -ASM_PFX(ExtraPush): .long 0x33333333 # ? - .long 0x33333333 # ? -ASM_PFX(ExceptData): .long 0x44444444 # ? - .long 0x44444444 # ? -ASM_PFX(Rflags): .long 0x55555555 # ? - .long 0x55555555 # ? -ASM_PFX(OrigVector): .long 0x66666666 # ? - .long 0x66666666 # ? - -// The declarations below define the memory region that will be used for the debug stack. -// The context record will be built by pushing register values onto this stack. -// It is imparitive that alignment be carefully managed, since the FXSTOR and -// FXRSTOR instructions will GP fault if their memory operand is not 16 byte aligned. -// -// The stub will switch stacks from the application stack to the debuger stack -// and pushes the exception number. -// -// Then we building the context record on the stack. Since the stack grows down, -// we push the fields of the context record from the back to the front. There -// are 336 bytes of stack used prior allocating the 512 bytes of stack to be -// used as the memory buffer for the fxstor instruction. Therefore address of -// the buffer used for the FXSTOR instruction is &Eax - 336 - 512, which -// must be 16 byte aligned. -// -// We carefully locate the stack to make this happen. -// -// For reference, the context structure looks like this: -// struct { -// UINT64 ExceptionData; -// FX_SAVE_STATE_X64 FxSaveState; // 512 bytes, must be 16 byte aligned -// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; -// UINT64 Cr0, Cr1, Cr2, Cr3, Cr4, Cr8; -// UINT64 RFlags; -// UINT64 Ldtr, Tr; -// UINT64 Gdtr[2], Idtr[2]; -// UINT64 Rip; -// UINT64 Gs, Fs, Es, Ds, Cs, Ss; -// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; -// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; -// } SYSTEM_CONTEXT_X64; // 64 bit system context record - -.p2align 4 -DebugStackEnd : .ascii "DbgStkEnd >>>>>>" # 16 byte long string - must be 16 bytes to preserve alignment - .fill 0x1ffc, 4, 0x00000000 - # 32K should be enough stack - # This allocation is coocked to insure - # that the the buffer for the FXSTORE instruction - # will be 16 byte aligned also. - # -ASM_PFX(ExceptionNumber): .long 0x77777777 # first entry will be the vector number pushed by the stub - .long 0x77777777 # ? - -DebugStackBegin : .ascii "<<<< DbgStkBegin" # initial debug ESP == DebugStackBegin, set in stub - - -.text - -//------------------------------------------------------------------------------ -// BOOLEAN -// FxStorSupport ( -// void -// ) -// -// Abstract: Returns TRUE if FxStor instructions are supported -// -ASM_GLOBAL ASM_PFX(FxStorSupport) -ASM_PFX(FxStorSupport): -// -// cpuid corrupts rbx which must be preserved per the C calling convention -// - pushq %rbx - movq $1, %rax - cpuid - movl %edx, %eax - andq $0x01000000, %rax - shrq $24, %rax - popq %rbx - ret -//------------------------------------------------------------------------------ -// void -// Vect2Desc ( -// IA32_IDT_GATE_DESCRIPTOR * DestDesc, // rcx -// void (*Vector) (void) // rdx -// ) -// -// Abstract: Encodes an IDT descriptor with the given physical address -// -ASM_GLOBAL ASM_PFX(Vect2Desc) -ASM_PFX(Vect2Desc): - movq %rdx, %rax - movw %ax, (%rcx) # write bits 15..0 of offset - movw %cs, %dx - movw %dx, 2(%rcx) # SYS_CODE_SEL from GDT - movw $(0x0e00 | 0x8000), 4(%rcx) # type = 386 interrupt gate, present - shrq $16, %rax - movw %ax, 6(%rcx) # write bits 31..16 of offset - shrq $16, %rax - movl %eax, 8(%rcx) # write bits 63..32 of offset - - ret - -//------------------------------------------------------------------------------ -// InterruptEntryStub -// -// Abstract: This code is not a function, but is a small piece of code that is -// copied and fixed up once for each IDT entry that is hooked. -// -ASM_GLOBAL ASM_PFX(InterruptEntryStub) -ASM_PFX(InterruptEntryStub): - - pushq $0 # push vector number - will be modified before installed - jmp ASM_PFX(CommonIdtEntry) - -ASM_GLOBAL ASM_PFX(InterruptEntryStubEnd) -ASM_PFX(InterruptEntryStubEnd): - -//------------------------------------------------------------------------------ -// CommonIdtEntry -// -// Abstract: This code is not a function, but is the common part for all IDT -// vectors. -// -ASM_GLOBAL ASM_PFX(CommonIdtEntry) -// -// At this point, the stub has saved the current application stack esp into AppRsp -// and switched stacks to the debug stack, where it pushed the vector number -// -// The application stack looks like this: -// -// ... -// (last application stack entry) -// [16 bytes alignment, do not care it] -// SS from interrupted task -// RSP from interrupted task -// rflags from interrupted task -// CS from interrupted task -// RIP from interrupted task -// Error code <-------------------- Only present for some exeption types -// -// Vector Number <----------------- pushed in our IDT Entry -// - - -// The stub switched us to the debug stack and pushed the interrupt number. -// -// Next, construct the context record. It will be build on the debug stack by -// pushing the registers in the correct order so as to create the context structure -// on the debug stack. The context record must be built from the end back to the -// beginning because the stack grows down... -// -// For reference, the context record looks like this: -// -// typedef -// struct { -// UINT64 ExceptionData; -// FX_SAVE_STATE_X64 FxSaveState; -// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; -// UINT64 Cr0, Cr2, Cr3, Cr4, Cr8; -// UINT64 RFlags; -// UINT64 Ldtr, Tr; -// UINT64 Gdtr[2], Idtr[2]; -// UINT64 Rip; -// UINT64 Gs, Fs, Es, Ds, Cs, Ss; -// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; -// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; -// } SYSTEM_CONTEXT_X64; // 64 -ASM_PFX(CommonIdtEntry): -// NOTE: we save rsp here to prevent compiler put rip reference cause error AppRsp - pushq %rax - movq (8)(%rsp), %rax # save vector number - movq %rax, ASM_PFX(ExceptionNumber)(%rip) # save vector number - popq %rax - addq $8, %rsp # pop vector number - movq %rsp, ASM_PFX(AppRsp)(%rip) # save stack top - movq DebugStackBegin(%rip), %rsp # switch to debugger stack - subq $8, %rsp # leave space for vector number -// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; -// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; - pushq %r15 - pushq %r14 - pushq %r13 - pushq %r12 - pushq %r11 - pushq %r10 - pushq %r9 - pushq %r8 - pushq %rax - pushq %rcx - pushq %rdx - pushq %rbx - pushq %rsp - pushq %rbp - pushq %rsi - pushq %rdi -// Save interrupt state rflags register... - pushfq - popq %rax - movq %rax, ASM_PFX(Rflags)(%rip) -// We need to determine if any extra data was pushed by the exception, and if so, save it -// To do this, we check the exception number pushed by the stub, and cache the -// result in a variable since we'll need this again. - cmpl $0, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - cmpl $10, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - cmpl $11, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - cmpl $12, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - cmpl $13, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - cmpl $14, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - cmpl $17, ASM_PFX(ExceptionNumber)(%rip) - jz ExtraPushOne - movl $0, ASM_PFX(ExtraPush)(%rip) - movl $0, ASM_PFX(ExceptData)(%rip) - jmp ExtraPushDone -ExtraPushOne: - movl $1, ASM_PFX(ExtraPush)(%rip) - -// If there's some extra data, save it also, and modify the saved AppRsp to effectively -// pop this value off the application's stack. - movq ASM_PFX(AppRsp)(%rip), %rax - movq (%rax), %rbx - movq %rbx, ASM_PFX(ExceptData)(%rip) - addq $8, %rax - movq %rax, ASM_PFX(AppRsp)(%rip) - -ExtraPushDone: - -// The "push" above pushed the debug stack rsp. Since what we're actually doing -// is building the context record on the debug stack, we need to save the pushed -// debug RSP, and replace it with the application's last stack entry... - movq 24(%rsp), %rax - movq %rax, ASM_PFX(DebugRsp)(%rip) - movq ASM_PFX(AppRsp)(%rip), %rax - movq 24(%rax), %rax - # application stack has ss, rsp, rflags, cs, & rip, so - # last actual application stack entry is saved at offset - # 24 bytes from stack top. - movq %rax, 24(%rsp) - -// continue building context record -// UINT64 Gs, Fs, Es, Ds, Cs, Ss; insure high 16 bits of each is zero - mov %ss, %rax - pushq %rax - # CS from application is one entry back in application stack - movq ASM_PFX(AppRsp)(%rip), %rax - movzxw 8(%rax), %rax - pushq %rax - - mov %ds, %rax - pushq %rax - movw %es, %rax - pushq %rax - mov %fs, %rax - pushq %rax - mov %gs, %rax - pushq %rax -// UINT64 Rip; - # Rip from application is on top of application stack - movq ASM_PFX(AppRsp)(%rip), %rax - pushq (%rax) -// UINT64 Gdtr[2], Idtr[2]; - push $0 - push $0 - sidtq (%rsp) - push $0 - push $0 - sgdtq (%rsp) - -// UINT64 Ldtr, Tr; - xorq %rax, %rax - str %ax - pushq %rax - sldt %ax - pushq %rax - -// UINT64 RFlags; -// Rflags from application is two entries back in application stack - movq ASM_PFX(AppRsp)(%rip), %rax - pushq 16(%rax) -// UINT64 Cr0, Cr1, Cr2, Cr3, Cr4, Cr8; -// insure FXSAVE/FXRSTOR is enabled in CR4... -// ... while we're at it, make sure DE is also enabled... - movq %cr8, %rax - pushq %rax - movq %cr4, %rax - orq $0x208, %rax - movq %rax, %cr4 - pushq %rax - movq %cr3, %rax - pushq %rax - movq %cr2, %rax - pushq %rax - push $0 - movq %cr0, %rax - pushq %rax -// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; - movq %dr7, %rax - pushq %rax -// clear Dr7 while executing debugger itself - xorq %rax, %rax - movq %rax, %dr7 - - movq %dr6, %rax - pushq %rax -// insure all status bits in dr6 are clear... - xorq %rax, %rax - movq %rax, %dr6 - - movq %dr3, %rax - pushq %rax - movq %dr2, %rax - pushq %rax - movq %dr1, %rax - pushq %rax - movq %dr0, %rax - pushq %rax - -// FX_SAVE_STATE_X64 FxSaveState; - subq $512, %rsp - movq %rsp, %rdi - # IMPORTANT!! The debug stack has been carefully constructed to - # insure that rsp and rdi are 16 byte aligned when we get here. - # They MUST be. If they are not, a GP fault will occur. - - # FXSTOR_RDI - fxsave (%rdi) - -// UEFI calling convention for x64 requires that Direction flag in EFLAGs is clear - cld - -// UINT64 ExceptionData; - movq ASM_PFX(ExceptData)(%rip), %rax - pushq %rax - -// call to C code which will in turn call registered handler -// pass in the vector number - movq %rsp, %rdx - movq ASM_PFX(ExceptionNumber)(%rip), %rcx - subq $40, %rsp - call ASM_PFX(InterruptDistrubutionHub) - addq $40, %rsp -// restore context... -// UINT64 ExceptionData; - addq $8, %rsp - -// FX_SAVE_STATE_X64 FxSaveState; - movq %rsp, %rsi - - # FXRSTOR_RSI - fxrstor (%rsi) - - addq $512, %rsp - -// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; - popq %rax - movq %rax, %dr0 - popq %rax - movq %rax, %dr1 - popq %rax - movq %rax, %dr2 - popq %rax - movq %rax, %dr3 - -// skip restore of dr6. We cleared dr6 during the context save. - addq $8, %rsp - popq %rax - movq %rax, %dr7 - -// UINT64 Cr0, Cr1, Cr2, Cr3, Cr4, Cr8; - popq %rax - movq %rax, %cr0 - addq $8, %rsp - popq %rax - movq %rax, %cr2 - popq %rax - movq %rax, %cr3 - popq %rax - movq %rax, %cr4 - popq %rax - movq %rax, %cr8 -// UINT64 RFlags; - movq ASM_PFX(AppRsp)(%rip), %rax - popq 16(%rax) -// UINT64 Ldtr, Tr; -// UINT64 Gdtr[2], Idtr[2]; -// Best not let anyone mess with these particular registers... - addq $48, %rsp -// UINT64 Rip; - popq (%rax) - -// UINT64 Gs, Fs, Es, Ds, Cs, Ss; -// NOTE - modified segment registers could hang the debugger... We -// could attempt to insulate ourselves against this possibility, -// but that poses risks as well. -// - - popq %rax - # mov %rax, %gs - popq %rax - # mov %rax, %fs - popq %rax - mov %rax, %es - popq %rax - mov %rax, %ds - movq ASM_PFX(AppRsp)(%rip), %rax - popq 8(%rax) - popq %rax - mov %rax, %ss -## The next stuff to restore is the general purpose registers that were pushed -## using the "push" instruction. -## -## The value of RSP as stored in the context record is the application RSP -## including the 5 entries on the application stack caused by the exception -## itself. It may have been modified by the debug agent, so we need to -## determine if we need to relocate the application stack. - - movq 24(%rsp), %rbx # move the potentially modified AppRsp into rbx - movq ASM_PFX(AppRsp)(%rip), %rax - movq 24(%rax), %rax - cmpq %rax, %rbx - je NoAppStackMove - - movq ASM_PFX(AppRsp)(%rip), %rax - movq (%rax), %rcx # RIP - movq %rcx, (%rbx) - - movq 8(%rax), %rcx # CS - movq %rcx, 8(%rbx) - - movq 16(%rax), %rcx # RFLAGS - movq %rcx, 16(%rbx) - - movq 24(%rax), %rcx # RSP - movq %rcx, 24(%rbx) - - movq 32(%rax), %rcx # SS - movq %rcx, 32(%rbx) - - movq %rbx, %rax # modify the saved AppRsp to the new AppRsp - movq %rax, ASM_PFX(AppRsp)(%rip) -NoAppStackMove: - movq ASM_PFX(DebugRsp)(%rip), %rax # restore the DebugRsp on the debug stack - # so our "pop" will not cause a stack switch - movq %rax, 24(%rsp) - - cmpl $0x068, ASM_PFX(ExceptionNumber)(%rip) - jne NoChain - -Chain: - -// Restore rflags so when we chain, the flags will be exactly as if we were never here. -// We gin up the stack to do an iretq so we can get ALL the flags. - movq ASM_PFX(AppRsp)(%rip), %rax - movq 40(%rax), %rbx - pushq %rbx - mov %ss, %rax - pushq %rax - movq %rsp, %rax - addq $16, %rax - pushq %rax - movq ASM_PFX(AppRsp)(%rip), %rax - movq 16(%rax), %rbx - andq $0xfffffffffffffcff, %rbx # special handling for IF and TF - pushq %rbx - mov %cs, %rax - pushq %rax - movq PhonyIretq(%rip), %rax - pushq %rax - iretq -PhonyIretq: - -// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; -// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; - popq %rdi - popq %rsi - popq %rbp - popq %rsp - popq %rbx - popq %rdx - popq %rcx - popq %rax - popq %r8 - popq %r9 - popq %r10 - popq %r11 - popq %r12 - popq %r13 - popq %r14 - popq %r15 - -// Switch back to application stack - movq ASM_PFX(AppRsp)(%rip), %rsp -// Jump to original handler - jmp ASM_PFX(OrigVector) -NoChain: -// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; -// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; - popq %rdi - popq %rsi - popq %rbp - popq %rsp - popq %rbx - popq %rdx - popq %rcx - popq %rax - popq %r8 - popq %r9 - popq %r10 - popq %r11 - popq %r12 - popq %r13 - popq %r14 - popq %r15 - -// Switch back to application stack - movq ASM_PFX(AppRsp)(%rip), %rsp - -// We're outa here... - iret +///**@file +// Low leve x64 specific debug support functions. +// +// Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
+// Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
+// 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. +// +//**/ + +ASM_GLOBAL ASM_PFX(OrigVector) +ASM_GLOBAL ASM_PFX(InterruptEntryStub) +ASM_GLOBAL ASM_PFX(StubSize) +ASM_GLOBAL ASM_PFX(CommonIdtEntry) +ASM_GLOBAL ASM_PFX(FxStorSupport) + +.data + +ASM_PFX(StubSize): .long ASM_PFX(InterruptEntryStubEnd) - ASM_PFX(InterruptEntryStub) +ASM_PFX(AppRsp): .long 0x11111111 # ? + .long 0x11111111 # ? +ASM_PFX(DebugRsp): .long 0x22222222 # ? + .long 0x22222222 # ? +ASM_PFX(ExtraPush): .long 0x33333333 # ? + .long 0x33333333 # ? +ASM_PFX(ExceptData): .long 0x44444444 # ? + .long 0x44444444 # ? +ASM_PFX(Rflags): .long 0x55555555 # ? + .long 0x55555555 # ? +ASM_PFX(OrigVector): .long 0x66666666 # ? + .long 0x66666666 # ? + +// The declarations below define the memory region that will be used for the debug stack. +// The context record will be built by pushing register values onto this stack. +// It is imparitive that alignment be carefully managed, since the FXSTOR and +// FXRSTOR instructions will GP fault if their memory operand is not 16 byte aligned. +// +// The stub will switch stacks from the application stack to the debuger stack +// and pushes the exception number. +// +// Then we building the context record on the stack. Since the stack grows down, +// we push the fields of the context record from the back to the front. There +// are 336 bytes of stack used prior allocating the 512 bytes of stack to be +// used as the memory buffer for the fxstor instruction. Therefore address of +// the buffer used for the FXSTOR instruction is &Eax - 336 - 512, which +// must be 16 byte aligned. +// +// We carefully locate the stack to make this happen. +// +// For reference, the context structure looks like this: +// struct { +// UINT64 ExceptionData; +// FX_SAVE_STATE_X64 FxSaveState; // 512 bytes, must be 16 byte aligned +// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; +// UINT64 Cr0, Cr1, Cr2, Cr3, Cr4, Cr8; +// UINT64 RFlags; +// UINT64 Ldtr, Tr; +// UINT64 Gdtr[2], Idtr[2]; +// UINT64 Rip; +// UINT64 Gs, Fs, Es, Ds, Cs, Ss; +// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; +// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; +// } SYSTEM_CONTEXT_X64; // 64 bit system context record + +.p2align 4 +DebugStackEnd : .ascii "DbgStkEnd >>>>>>" # 16 byte long string - must be 16 bytes to preserve alignment + .fill 0x1ffc, 4, 0x00000000 + # 32K should be enough stack + # This allocation is coocked to insure + # that the the buffer for the FXSTORE instruction + # will be 16 byte aligned also. + # +ASM_PFX(ExceptionNumber): .long 0x77777777 # first entry will be the vector number pushed by the stub + .long 0x77777777 # ? + +DebugStackBegin : .ascii "<<<< DbgStkBegin" # initial debug ESP == DebugStackBegin, set in stub + + +.text + +//------------------------------------------------------------------------------ +// BOOLEAN +// FxStorSupport ( +// void +// ) +// +// Abstract: Returns TRUE if FxStor instructions are supported +// +ASM_GLOBAL ASM_PFX(FxStorSupport) +ASM_PFX(FxStorSupport): +// +// cpuid corrupts rbx which must be preserved per the C calling convention +// + pushq %rbx + movq $1, %rax + cpuid + movl %edx, %eax + andq $0x01000000, %rax + shrq $24, %rax + popq %rbx + ret +//------------------------------------------------------------------------------ +// void +// Vect2Desc ( +// IA32_IDT_GATE_DESCRIPTOR * DestDesc, // rcx +// void (*Vector) (void) // rdx +// ) +// +// Abstract: Encodes an IDT descriptor with the given physical address +// +ASM_GLOBAL ASM_PFX(Vect2Desc) +ASM_PFX(Vect2Desc): + movq %rdx, %rax + movw %ax, (%rcx) # write bits 15..0 of offset + movw %cs, %dx + movw %dx, 2(%rcx) # SYS_CODE_SEL from GDT + movw $(0x0e00 | 0x8000), 4(%rcx) # type = 386 interrupt gate, present + shrq $16, %rax + movw %ax, 6(%rcx) # write bits 31..16 of offset + shrq $16, %rax + movl %eax, 8(%rcx) # write bits 63..32 of offset + + ret + +//------------------------------------------------------------------------------ +// InterruptEntryStub +// +// Abstract: This code is not a function, but is a small piece of code that is +// copied and fixed up once for each IDT entry that is hooked. +// +ASM_GLOBAL ASM_PFX(InterruptEntryStub) +ASM_PFX(InterruptEntryStub): + + pushq $0 # push vector number - will be modified before installed + jmp ASM_PFX(CommonIdtEntry) + +ASM_GLOBAL ASM_PFX(InterruptEntryStubEnd) +ASM_PFX(InterruptEntryStubEnd): + +//------------------------------------------------------------------------------ +// CommonIdtEntry +// +// Abstract: This code is not a function, but is the common part for all IDT +// vectors. +// +ASM_GLOBAL ASM_PFX(CommonIdtEntry) +// +// At this point, the stub has saved the current application stack esp into AppRsp +// and switched stacks to the debug stack, where it pushed the vector number +// +// The application stack looks like this: +// +// ... +// (last application stack entry) +// [16 bytes alignment, do not care it] +// SS from interrupted task +// RSP from interrupted task +// rflags from interrupted task +// CS from interrupted task +// RIP from interrupted task +// Error code <-------------------- Only present for some exeption types +// +// Vector Number <----------------- pushed in our IDT Entry +// + + +// The stub switched us to the debug stack and pushed the interrupt number. +// +// Next, construct the context record. It will be build on the debug stack by +// pushing the registers in the correct order so as to create the context structure +// on the debug stack. The context record must be built from the end back to the +// beginning because the stack grows down... +// +// For reference, the context record looks like this: +// +// typedef +// struct { +// UINT64 ExceptionData; +// FX_SAVE_STATE_X64 FxSaveState; +// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; +// UINT64 Cr0, Cr2, Cr3, Cr4, Cr8; +// UINT64 RFlags; +// UINT64 Ldtr, Tr; +// UINT64 Gdtr[2], Idtr[2]; +// UINT64 Rip; +// UINT64 Gs, Fs, Es, Ds, Cs, Ss; +// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; +// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; +// } SYSTEM_CONTEXT_X64; // 64 +ASM_PFX(CommonIdtEntry): +// NOTE: we save rsp here to prevent compiler put rip reference cause error AppRsp + pushq %rax + movq (8)(%rsp), %rax # save vector number + movq %rax, ASM_PFX(ExceptionNumber)(%rip) # save vector number + popq %rax + addq $8, %rsp # pop vector number + movq %rsp, ASM_PFX(AppRsp)(%rip) # save stack top + movq DebugStackBegin(%rip), %rsp # switch to debugger stack + subq $8, %rsp # leave space for vector number +// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; +// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; + pushq %r15 + pushq %r14 + pushq %r13 + pushq %r12 + pushq %r11 + pushq %r10 + pushq %r9 + pushq %r8 + pushq %rax + pushq %rcx + pushq %rdx + pushq %rbx + pushq %rsp + pushq %rbp + pushq %rsi + pushq %rdi +// Save interrupt state rflags register... + pushfq + popq %rax + movq %rax, ASM_PFX(Rflags)(%rip) +// We need to determine if any extra data was pushed by the exception, and if so, save it +// To do this, we check the exception number pushed by the stub, and cache the +// result in a variable since we'll need this again. + cmpl $0, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + cmpl $10, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + cmpl $11, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + cmpl $12, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + cmpl $13, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + cmpl $14, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + cmpl $17, ASM_PFX(ExceptionNumber)(%rip) + jz ExtraPushOne + movl $0, ASM_PFX(ExtraPush)(%rip) + movl $0, ASM_PFX(ExceptData)(%rip) + jmp ExtraPushDone +ExtraPushOne: + movl $1, ASM_PFX(ExtraPush)(%rip) + +// If there's some extra data, save it also, and modify the saved AppRsp to effectively +// pop this value off the application's stack. + movq ASM_PFX(AppRsp)(%rip), %rax + movq (%rax), %rbx + movq %rbx, ASM_PFX(ExceptData)(%rip) + addq $8, %rax + movq %rax, ASM_PFX(AppRsp)(%rip) + +ExtraPushDone: + +// The "push" above pushed the debug stack rsp. Since what we're actually doing +// is building the context record on the debug stack, we need to save the pushed +// debug RSP, and replace it with the application's last stack entry... + movq 24(%rsp), %rax + movq %rax, ASM_PFX(DebugRsp)(%rip) + movq ASM_PFX(AppRsp)(%rip), %rax + movq 24(%rax), %rax + # application stack has ss, rsp, rflags, cs, & rip, so + # last actual application stack entry is saved at offset + # 24 bytes from stack top. + movq %rax, 24(%rsp) + +// continue building context record +// UINT64 Gs, Fs, Es, Ds, Cs, Ss; insure high 16 bits of each is zero + mov %ss, %rax + pushq %rax + # CS from application is one entry back in application stack + movq ASM_PFX(AppRsp)(%rip), %rax + movzxw 8(%rax), %rax + pushq %rax + + mov %ds, %rax + pushq %rax + movw %es, %rax + pushq %rax + mov %fs, %rax + pushq %rax + mov %gs, %rax + pushq %rax +// UINT64 Rip; + # Rip from application is on top of application stack + movq ASM_PFX(AppRsp)(%rip), %rax + pushq (%rax) +// UINT64 Gdtr[2], Idtr[2]; + push $0 + push $0 + sidtq (%rsp) + push $0 + push $0 + sgdtq (%rsp) + +// UINT64 Ldtr, Tr; + xorq %rax, %rax + str %ax + pushq %rax + sldt %ax + pushq %rax + +// UINT64 RFlags; +// Rflags from application is two entries back in application stack + movq ASM_PFX(AppRsp)(%rip), %rax + pushq 16(%rax) +// UINT64 Cr0, Cr1, Cr2, Cr3, Cr4, Cr8; +// insure FXSAVE/FXRSTOR is enabled in CR4... +// ... while we're at it, make sure DE is also enabled... + movq %cr8, %rax + pushq %rax + movq %cr4, %rax + orq $0x208, %rax + movq %rax, %cr4 + pushq %rax + movq %cr3, %rax + pushq %rax + movq %cr2, %rax + pushq %rax + push $0 + movq %cr0, %rax + pushq %rax +// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; + movq %dr7, %rax + pushq %rax +// clear Dr7 while executing debugger itself + xorq %rax, %rax + movq %rax, %dr7 + + movq %dr6, %rax + pushq %rax +// insure all status bits in dr6 are clear... + xorq %rax, %rax + movq %rax, %dr6 + + movq %dr3, %rax + pushq %rax + movq %dr2, %rax + pushq %rax + movq %dr1, %rax + pushq %rax + movq %dr0, %rax + pushq %rax + +// FX_SAVE_STATE_X64 FxSaveState; + subq $512, %rsp + movq %rsp, %rdi + # IMPORTANT!! The debug stack has been carefully constructed to + # insure that rsp and rdi are 16 byte aligned when we get here. + # They MUST be. If they are not, a GP fault will occur. + + # FXSTOR_RDI + fxsave (%rdi) + +// UEFI calling convention for x64 requires that Direction flag in EFLAGs is clear + cld + +// UINT64 ExceptionData; + movq ASM_PFX(ExceptData)(%rip), %rax + pushq %rax + +// call to C code which will in turn call registered handler +// pass in the vector number + movq %rsp, %rdx + movq ASM_PFX(ExceptionNumber)(%rip), %rcx + subq $40, %rsp + call ASM_PFX(InterruptDistrubutionHub) + addq $40, %rsp +// restore context... +// UINT64 ExceptionData; + addq $8, %rsp + +// FX_SAVE_STATE_X64 FxSaveState; + movq %rsp, %rsi + + # FXRSTOR_RSI + fxrstor (%rsi) + + addq $512, %rsp + +// UINT64 Dr0, Dr1, Dr2, Dr3, Dr6, Dr7; + popq %rax + movq %rax, %dr0 + popq %rax + movq %rax, %dr1 + popq %rax + movq %rax, %dr2 + popq %rax + movq %rax, %dr3 + +// skip restore of dr6. We cleared dr6 during the context save. + addq $8, %rsp + popq %rax + movq %rax, %dr7 + +// UINT64 Cr0, Cr1, Cr2, Cr3, Cr4, Cr8; + popq %rax + movq %rax, %cr0 + addq $8, %rsp + popq %rax + movq %rax, %cr2 + popq %rax + movq %rax, %cr3 + popq %rax + movq %rax, %cr4 + popq %rax + movq %rax, %cr8 +// UINT64 RFlags; + movq ASM_PFX(AppRsp)(%rip), %rax + popq 16(%rax) +// UINT64 Ldtr, Tr; +// UINT64 Gdtr[2], Idtr[2]; +// Best not let anyone mess with these particular registers... + addq $48, %rsp +// UINT64 Rip; + popq (%rax) + +// UINT64 Gs, Fs, Es, Ds, Cs, Ss; +// NOTE - modified segment registers could hang the debugger... We +// could attempt to insulate ourselves against this possibility, +// but that poses risks as well. +// + + popq %rax + # mov %rax, %gs + popq %rax + # mov %rax, %fs + popq %rax + mov %rax, %es + popq %rax + mov %rax, %ds + movq ASM_PFX(AppRsp)(%rip), %rax + popq 8(%rax) + popq %rax + mov %rax, %ss +## The next stuff to restore is the general purpose registers that were pushed +## using the "push" instruction. +## +## The value of RSP as stored in the context record is the application RSP +## including the 5 entries on the application stack caused by the exception +## itself. It may have been modified by the debug agent, so we need to +## determine if we need to relocate the application stack. + + movq 24(%rsp), %rbx # move the potentially modified AppRsp into rbx + movq ASM_PFX(AppRsp)(%rip), %rax + movq 24(%rax), %rax + cmpq %rax, %rbx + je NoAppStackMove + + movq ASM_PFX(AppRsp)(%rip), %rax + movq (%rax), %rcx # RIP + movq %rcx, (%rbx) + + movq 8(%rax), %rcx # CS + movq %rcx, 8(%rbx) + + movq 16(%rax), %rcx # RFLAGS + movq %rcx, 16(%rbx) + + movq 24(%rax), %rcx # RSP + movq %rcx, 24(%rbx) + + movq 32(%rax), %rcx # SS + movq %rcx, 32(%rbx) + + movq %rbx, %rax # modify the saved AppRsp to the new AppRsp + movq %rax, ASM_PFX(AppRsp)(%rip) +NoAppStackMove: + movq ASM_PFX(DebugRsp)(%rip), %rax # restore the DebugRsp on the debug stack + # so our "pop" will not cause a stack switch + movq %rax, 24(%rsp) + + cmpl $0x068, ASM_PFX(ExceptionNumber)(%rip) + jne NoChain + +Chain: + +// Restore rflags so when we chain, the flags will be exactly as if we were never here. +// We gin up the stack to do an iretq so we can get ALL the flags. + movq ASM_PFX(AppRsp)(%rip), %rax + movq 40(%rax), %rbx + pushq %rbx + mov %ss, %rax + pushq %rax + movq %rsp, %rax + addq $16, %rax + pushq %rax + movq ASM_PFX(AppRsp)(%rip), %rax + movq 16(%rax), %rbx + andq $0xfffffffffffffcff, %rbx # special handling for IF and TF + pushq %rbx + mov %cs, %rax + pushq %rax + movq PhonyIretq(%rip), %rax + pushq %rax + iretq +PhonyIretq: + +// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; +// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; + popq %rdi + popq %rsi + popq %rbp + popq %rsp + popq %rbx + popq %rdx + popq %rcx + popq %rax + popq %r8 + popq %r9 + popq %r10 + popq %r11 + popq %r12 + popq %r13 + popq %r14 + popq %r15 + +// Switch back to application stack + movq ASM_PFX(AppRsp)(%rip), %rsp +// Jump to original handler + jmp ASM_PFX(OrigVector) +NoChain: +// UINT64 Rdi, Rsi, Rbp, Rsp, Rbx, Rdx, Rcx, Rax; +// UINT64 R8, R9, R10, R11, R12, R13, R14, R15; + popq %rdi + popq %rsi + popq %rbp + popq %rsp + popq %rbx + popq %rdx + popq %rcx + popq %rax + popq %r8 + popq %r9 + popq %r10 + popq %r11 + popq %r12 + popq %r13 + popq %r14 + popq %r15 + +// Switch back to application stack + movq ASM_PFX(AppRsp)(%rip), %rsp + +// We're outa here... + iret diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.c b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.c index 2287863e3e..3c2437ef5c 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.c +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.c @@ -254,15 +254,15 @@ PxeBcDriverBindingStart ( if (EFI_ERROR (Status)) { goto ON_ERROR; } - - // + + // // Get max packet size from Ip4 to calculate block size for Tftp later. - // - Status = Private->Ip4->GetModeData (Private->Ip4, &Ip4ModeData, NULL, NULL); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - + // + Status = Private->Ip4->GetModeData (Private->Ip4, &Ip4ModeData, NULL, NULL); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + Private->Ip4MaxPacketSize = Ip4ModeData.MaxPacketSize; Status = NetLibCreateServiceChild ( diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h index cc771bc5d4..97703cb5f9 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h @@ -50,7 +50,7 @@ typedef struct _PXEBC_PRIVATE_DATA PXEBC_PRIVATE_DATA; #define PXEBC_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'X', 'E', 'P') #define PXEBC_MTFTP_TIMEOUT 4 #define PXEBC_MTFTP_RETRIES 6 -#define PXEBC_DEFAULT_UDP_OVERHEAD_SIZE 8 +#define PXEBC_DEFAULT_UDP_OVERHEAD_SIZE 8 #define PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE 4 #define PXEBC_DEFAULT_PACKET_SIZE 1480 #define PXEBC_DEFAULT_LIFETIME 50000 // 50ms, unit is microsecond diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf index 89ec686ca1..36436b6db8 100644 --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf @@ -1,97 +1,97 @@ -## @file -# Component description file for SMM Variable module. -# -# This module installs SMM variable protocol into SMM protocol database, -# which can be used by SMM driver, and installs SMM variable protocol -# into BS protocol database, which can be used to notify the SMM Runtime -# Dxe driver that the SMM variable service is ready. -# This module should be used with SMM Runtime DXE module together. The -# SMM Runtime DXE module would install variable arch protocol and variable -# write arch protocol based on SMM variable module. -# -# Caution: This module requires additional review when modified. -# This driver will have external input - variable data and communicate buffer in SMM mode. -# This external input must be validated carefully to avoid security issue like -# buffer overflow, integer overflow. -# -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
-# 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. -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = VariableSmm - FILE_GUID = 23A089B3-EED5-4ac5-B2AB-43E3298C2343 - MODULE_TYPE = DXE_SMM_DRIVER - VERSION_STRING = 1.0 - PI_SPECIFICATION_VERSION = 0x0001000A - ENTRY_POINT = VariableServiceInitialize - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 -# - - -[Sources] - Reclaim.c - Variable.c - VariableSmm.c - Variable.h - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - UefiDriverEntryPoint - MemoryAllocationLib - BaseLib - SynchronizationLib - UefiLib - SmmServicesTableLib - BaseMemoryLib - DebugLib - DxeServicesTableLib - HobLib - PcdLib - -[Protocols] - gEfiSmmFirmwareVolumeBlockProtocolGuid ## SOMETIMES_CONSUMES - gEfiSmmVariableProtocolGuid ## ALWAYS_PRODUCES - gEfiSmmFaultTolerantWriteProtocolGuid ## SOMETIMES_CONSUMES - gEfiSmmAccess2ProtocolGuid ## ALWAYS_CONSUMES - gEfiSmmEndOfDxeProtocolGuid ## ALWAYS_CONSUMES - -[Guids] - gEfiVariableGuid ## PRODUCES ## Configuration Table Guid - gEfiGlobalVariableGuid ## PRODUCES ## Variable Guid - gSmmVariableWriteGuid ## PRODUCES ## SMM Variable Write Guid - gEfiSystemNvDataFvGuid ## CONSUMES - gEfiHardwareErrorVariableGuid ## SOMETIMES_CONSUMES - gEdkiiFaultTolerantWriteGuid ## CONSUMES - -[Pcd] - gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize - gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase - gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64 - gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize - gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize - gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize - gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize - -[FeaturePcd] - gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics ## SOMETIME_CONSUMES (statistic the information of variable.) - -[Depex] - TRUE - - +## @file +# Component description file for SMM Variable module. +# +# This module installs SMM variable protocol into SMM protocol database, +# which can be used by SMM driver, and installs SMM variable protocol +# into BS protocol database, which can be used to notify the SMM Runtime +# Dxe driver that the SMM variable service is ready. +# This module should be used with SMM Runtime DXE module together. The +# SMM Runtime DXE module would install variable arch protocol and variable +# write arch protocol based on SMM variable module. +# +# Caution: This module requires additional review when modified. +# This driver will have external input - variable data and communicate buffer in SMM mode. +# This external input must be validated carefully to avoid security issue like +# buffer overflow, integer overflow. +# +# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# 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. +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = VariableSmm + FILE_GUID = 23A089B3-EED5-4ac5-B2AB-43E3298C2343 + MODULE_TYPE = DXE_SMM_DRIVER + VERSION_STRING = 1.0 + PI_SPECIFICATION_VERSION = 0x0001000A + ENTRY_POINT = VariableServiceInitialize + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 +# + + +[Sources] + Reclaim.c + Variable.c + VariableSmm.c + Variable.h + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + UefiDriverEntryPoint + MemoryAllocationLib + BaseLib + SynchronizationLib + UefiLib + SmmServicesTableLib + BaseMemoryLib + DebugLib + DxeServicesTableLib + HobLib + PcdLib + +[Protocols] + gEfiSmmFirmwareVolumeBlockProtocolGuid ## SOMETIMES_CONSUMES + gEfiSmmVariableProtocolGuid ## ALWAYS_PRODUCES + gEfiSmmFaultTolerantWriteProtocolGuid ## SOMETIMES_CONSUMES + gEfiSmmAccess2ProtocolGuid ## ALWAYS_CONSUMES + gEfiSmmEndOfDxeProtocolGuid ## ALWAYS_CONSUMES + +[Guids] + gEfiVariableGuid ## PRODUCES ## Configuration Table Guid + gEfiGlobalVariableGuid ## PRODUCES ## Variable Guid + gSmmVariableWriteGuid ## PRODUCES ## SMM Variable Write Guid + gEfiSystemNvDataFvGuid ## CONSUMES + gEfiHardwareErrorVariableGuid ## SOMETIMES_CONSUMES + gEdkiiFaultTolerantWriteGuid ## CONSUMES + +[Pcd] + gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize + gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase + gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64 + gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize + gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize + gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize + gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize + +[FeaturePcd] + gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics ## SOMETIME_CONSUMES (statistic the information of variable.) + +[Depex] + TRUE + +