sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MdeModulePkg: Clean up source files

Browse Source 
1. Do not use tab characters
2. No trailing white space in one line
3. All files must end with CRLF

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
This commit is contained in:
Liming Gao
2018-06-27 21:08:52 +08:00
parent ca79bab7af
commit d1102dba72
1010 changed files with 13588 additions and 13588 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
MdeModulePkg/Include/Ppi/AtaController.h
View File

@@ -1,8 +1,8 @@
/** @file
Define the PPI to abstract the functions that enable IDE and SATA channels, and to retrieve
the base I/O port address for each of the enabled IDE and SATA channels.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define _PEI_ATA_CONTROLLER_PPI_H_
///
/// Global ID for the PEI_ATA_CONTROLLER_PPI.
/// Global ID for the PEI_ATA_CONTROLLER_PPI.
///
#define PEI_ATA_CONTROLLER_PPI_GUID \
{ \
@@ -32,50 +32,50 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _PEI_ATA_CONTROLLER_PPI PEI_ATA_CONTROLLER_PPI;
///
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// disable the IDE channels.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// disable the IDE channels.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
///
#define PEI_ICH_IDE_NONE 0x00
///
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// enable the Primary IDE channel.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
///
#define PEI_ICH_IDE_PRIMARY 0x01
///
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// enable the Secondary IDE channel.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
///
#define PEI_ICH_IDE_SECONDARY 0x02
///
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// disable the SATA channel.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
///
#define PEI_ICH_SATA_NONE 0x04
///
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// enable the Primary SATA channel.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
///
#define PEI_ICH_SATA_PRIMARY 0x08
///
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// This bit is used in the ChannelMask parameter of EnableAtaChannel() to
/// enable the Secondary SATA channel.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
/// This is designed for old generation chipset with PATA/SATA controllers.
/// It may be ignored in PPI implementation for new generation chipset without PATA controller.
///
#define PEI_ICH_SATA_SECONDARY 0x010
@@ -97,15 +97,15 @@ typedef struct {
Sets IDE and SATA channels to an enabled or disabled state.
This service enables or disables the IDE and SATA channels specified by ChannelMask.
It may ignore ChannelMask setting to enable or disable IDE and SATA channels based on the platform policy.
The number of the enabled channels will be returned by GET_IDE_REGS_BASE_ADDR() function.
It may ignore ChannelMask setting to enable or disable IDE and SATA channels based on the platform policy.
The number of the enabled channels will be returned by GET_IDE_REGS_BASE_ADDR() function.
If the new state is set, then EFI_SUCCESS is returned. If the new state can
not be set, then EFI_DEVICE_ERROR is returned.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the PEI_ATA_CONTROLLER_PPI.
@param[in] ChannelMask The bitmask that identifies the IDE and SATA channels to
@param[in] ChannelMask The bitmask that identifies the IDE and SATA channels to
enable or disable. This parameter is optional.
@retval EFI_SUCCESS The IDE or SATA channels were enabled or disabled successfully.
@@ -121,18 +121,18 @@ EFI_STATUS
);
/**
Retrieves the I/O port base addresses for command and control registers of the
Retrieves the I/O port base addresses for command and control registers of the
enabled IDE/SATA channels.
This service fills in the structure poionted to by IdeRegsBaseAddr with the I/O
port base addresses for the command and control registers of the IDE and SATA
channels that were previously enabled in EnableAtaChannel(). The number of
channels that were previously enabled in EnableAtaChannel(). The number of
enabled IDE and SATA channels is returned.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the PEI_ATA_CONTROLLER_PPI.
@param[out] IdeRegsBaseAddr The pointer to caller allocated space to return the
I/O port base addresses of the IDE and SATA channels
@param[out] IdeRegsBaseAddr The pointer to caller allocated space to return the
I/O port base addresses of the IDE and SATA channels
that were previosuly enabled with EnableAtaChannel().
@return The number of enabled IDE and SATA channels in the platform.
@@ -143,7 +143,7 @@ UINT32
(EFIAPI *GET_IDE_REGS_BASE_ADDR)(
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_ATA_CONTROLLER_PPI *This,
OUT IDE_REGS_BASE_ADDR *IdeRegsBaseAddr
OUT IDE_REGS_BASE_ADDR *IdeRegsBaseAddr
);
///

6
MdeModulePkg/Include/Ppi/SerialPortPei.h
View File

@@ -1,8 +1,8 @@
/** @file
PPI that is installed after the initialization of a serial stream device
is complete.
PPI that is installed after the initialization of a serial stream device
is complete.
Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at

36
MdeModulePkg/Include/Ppi/SmmAccess.h
View File

@@ -5,13 +5,13 @@
It abstracts the location and characteristics of SMRAM. The expectation is
that the north bridge or memory controller would publish this PPI.
The principal functionality found in the memory controller includes the following:
The principal functionality found in the memory controller includes the following:
- Exposing the SMRAM to all non-SMM agents, or the "open" state
- Shrouding the SMRAM to all but the SMM agents, or the "closed" state
- Preserving the system integrity, or "locking" the SMRAM, such that the settings cannot be
perturbed by either boot service or runtime agents
- Preserving the system integrity, or "locking" the SMRAM, such that the settings cannot be
perturbed by either boot service or runtime agents
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -35,18 +35,18 @@ typedef struct _PEI_SMM_ACCESS_PPI PEI_SMM_ACCESS_PPI;
/**
Opens the SMRAM area to be accessible by a PEIM driver.
This function "opens" SMRAM so that it is visible while not inside of SMM. The function should
return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM. The function
This function "opens" SMRAM so that it is visible while not inside of SMM. The function should
return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM. The function
should return EFI_DEVICE_ERROR if the SMRAM configuration is locked.
@param PeiServices General purpose services available to every PEIM.
@param This The pointer to the SMM Access Interface.
@param DescriptorIndex The region of SMRAM to Open.
@retval EFI_SUCCESS The region was successfully opened.
@retval EFI_DEVICE_ERROR The region could not be opened because locked by chipset.
@retval EFI_INVALID_PARAMETER The descriptor index was out of bounds.
**/
typedef
EFI_STATUS
@@ -59,15 +59,15 @@ EFI_STATUS
/**
Inhibits access to the SMRAM.
This function "closes" SMRAM so that it is not visible while outside of SMM. The function should
This function "closes" SMRAM so that it is not visible while outside of SMM. The function should
return EFI_UNSUPPORTED if the hardware does not support hiding of SMRAM.
@param PeiServices General purpose services available to every PEIM.
@param This The pointer to the SMM Access Interface.
@param DescriptorIndex The region of SMRAM to Close.
@retval EFI_SUCCESS The region was successfully closed.
@retval EFI_DEVICE_ERROR The region could not be closed because locked by chipset.
@retval EFI_DEVICE_ERROR The region could not be closed because locked by chipset.
@retval EFI_INVALID_PARAMETER The descriptor index was out of bounds.
**/
@@ -82,13 +82,13 @@ EFI_STATUS
/**
Inhibits access to the SMRAM.
This function prohibits access to the SMRAM region. This function is usually implemented such
that it is a write-once operation.
This function prohibits access to the SMRAM region. This function is usually implemented such
that it is a write-once operation.
@param PeiServices General purpose services available to every PEIM.
@param This The pointer to the SMM Access Interface.
@param DescriptorIndex The region of SMRAM to Close.
@retval EFI_SUCCESS The region was successfully locked.
@retval EFI_DEVICE_ERROR The region could not be locked because at least
one range is still open.
@@ -112,7 +112,7 @@ EFI_STATUS
buffer to contain the description information.
@param SmramMap The buffer containing the data describing the Smram
region descriptors.
@retval EFI_BUFFER_TOO_SMALL The user did not provide a sufficient buffer.
@retval EFI_SUCCESS The user provided a sufficiently-sized buffer.
@@ -128,10 +128,10 @@ EFI_STATUS
///
/// EFI SMM Access PPI is used to control the visibility of the SMRAM on the platform.
/// It abstracts the location and characteristics of SMRAM. The platform should report
/// all MMRAM via PEI_SMM_ACCESS_PPI. The expectation is that the north bridge or
/// It abstracts the location and characteristics of SMRAM. The platform should report
/// all MMRAM via PEI_SMM_ACCESS_PPI. The expectation is that the north bridge or
/// memory controller would publish this PPI.
///
///
struct _PEI_SMM_ACCESS_PPI {
PEI_SMM_OPEN Open;
PEI_SMM_CLOSE Close;

6
MdeModulePkg/Include/Ppi/SmmCommunication.h
View File

@@ -1,12 +1,12 @@
/** @file
EFI SMM Communication PPI definition.
This Ppi provides a means of communicating between PEIM and SMI
This Ppi provides a means of communicating between PEIM and SMI
handlers inside of SMM.
This Ppi is produced and consumed only in S3 resume boot path.
It is NOT available in normal boot path.
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -32,7 +32,7 @@ typedef struct _EFI_PEI_SMM_COMMUNICATION_PPI EFI_PEI_SMM_COMMUNICATION_PPI;
/**
Communicates with a registered handler.
This function provides a service to send and receive messages from a registered UEFI service.
@param[in] This The EFI_PEI_SMM_COMMUNICATION_PPI instance.

6
MdeModulePkg/Include/Ppi/SmmControl.h
View File

@@ -9,7 +9,7 @@
event from a platform chipset agent is an optional capability for both IA-32 and Itanium-based
systems.
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -64,7 +64,7 @@ EFI_STATUS
@param PeiServices General purpose services available to every PEIM.
@param This The PEI_SMM_CONTROL_PPI instance.
@param Periodic Optional parameter to repeat at this period one
@param Periodic Optional parameter to repeat at this period one
time or, if the Periodic Boolean is set, periodically.
@retval EFI_SUCCESS The SMI/PMI has been engendered.
@@ -85,7 +85,7 @@ EFI_STATUS
/// - A processor driver to abstract the SMI/PMI IPI
/// - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an
/// Intel chipset
///
///
struct _PEI_SMM_CONTROL_PPI {
PEI_SMM_ACTIVATE Trigger;
PEI_SMM_DEACTIVATE Clear;

96
MdeModulePkg/Include/Ppi/Usb2HostController.h
View File

@@ -1,11 +1,11 @@
/** @file
Defines the USB Host Controller PPI that provides I/O services for a USB Host
Controller that may be used to access recovery devices. These interfaces are
Defines the USB Host Controller PPI that provides I/O services for a USB Host
Controller that may be used to access recovery devices. These interfaces are
modeled on the UEFI 2.3 specification EFI_USB2_HOST_CONTROLLER_PROTOCOL.
Refer to section 16.1 of the UEFI 2.3 Specification for more information on
Refer to section 16.1 of the UEFI 2.3 Specification for more information on
these interfaces.
Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved. <BR>
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -37,45 +37,45 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _PEI_USB2_HOST_CONTROLLER_PPI PEI_USB2_HOST_CONTROLLER_PPI;
/**
Initiate a USB control transfer using a specific USB Host controller on the USB bus.
Initiate a USB control transfer using a specific USB Host controller on the USB bus.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[in] DeviceAddress Represents the address of the target device
@param[in] DeviceAddress Represents the address of the target device
on the USB.
@param[in] DeviceSpeed Indicates device speed.
@param[in] MaximumPacketLength Indicates the maximum packet size that the
@param[in] MaximumPacketLength Indicates the maximum packet size that the
default control transfer
endpoint is capable of sending or receiving.
@param[in] Request A pointer to the USB device request that
@param[in] Request A pointer to the USB device request that
will be sent to the USB device.
@param[in] TransferDirection Specifies the data direction for the transfer.
There are three values available:
@param[in] TransferDirection Specifies the data direction for the transfer.
There are three values available:
EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
@param[in,out] Data A pointer to the buffer of data that will
@param[in,out] Data A pointer to the buffer of data that will
be transmitted to USB device or
received from USB device.
@param[in,out] DataLength On input, indicates the size, in bytes, of
@param[in,out] DataLength On input, indicates the size, in bytes, of
the data buffer specified by Data.
On output, indicates the amount of data
On output, indicates the amount of data
actually transferred.
@param[in] TimeOut Indicates the maximum time, in milliseconds,
@param[in] TimeOut Indicates the maximum time, in milliseconds,
that the transfer is allowed to complete.
If Timeout is 0, then the caller must wait for
the function to be completed until EFI_SUCCESS
or EFI_DEVICE_ERROR is returned.
@param[in] Translator A pointer to the transaction translator data.
@param[out] TransferResult A pointer to the detailed result information
@param[out] TransferResult A pointer to the detailed result information
generated by this control transfer.
@retval EFI_SUCCESS The control transfer was completed successfully.
@retval EFI_DEVICE_ERROR The control transfer failed due to host controller
@retval EFI_DEVICE_ERROR The control transfer failed due to host controller
or device error.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources.
@retval EFI_TIMEOUT The control transfer failed due to timeout.
**/
typedef
@@ -96,22 +96,22 @@ EFI_STATUS
);
/**
Initiate a USB bulk transfer using a specific USB Host controller on the USB bus.
Initiate a USB bulk transfer using a specific USB Host controller on the USB bus.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[in] DeviceAddress Represents the address of the target device
@param[in] DeviceAddress Represents the address of the target device
on the USB.
@param[in] EndPointAddress The combination of an endpoint number and
@param[in] EndPointAddress The combination of an endpoint number and
an endpoint direction of the target USB device.
@param[in] DeviceSpeed Indicates device speed.
@param[in] MaximumPacketLength Indicates the maximum packet size the target
@param[in] MaximumPacketLength Indicates the maximum packet size the target
endpoint is capable of sending or receiving.
@param[in,out] Data Array of pointers to the buffers of data
that will be transmitted to USB device or
@param[in,out] Data Array of pointers to the buffers of data
that will be transmitted to USB device or
received from USB device.
@param[in,out] DataLength When input, indicates the size, in bytes, of
@param[in,out] DataLength When input, indicates the size, in bytes, of
the data buffers specified by Data. When output,
indicates the data size actually transferred.
@param[in,out] DataToggle A pointer to the data toggle value.
@@ -121,7 +121,7 @@ EFI_STATUS
the function to be completed until EFI_SUCCESS
or EFI_DEVICE_ERROR is returned.
@param[in] Translator A pointer to the transaction translator data.
@param[out] TransferResult A pointer to the detailed result information
@param[out] TransferResult A pointer to the detailed result information
of the bulk transfer.
@retval EFI_SUCCESS The bulk transfer was completed successfully.
@@ -129,8 +129,8 @@ EFI_STATUS
Caller should check TransferResult for detailed error information.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES The bulk transfer could not be submitted due to a lack of resources.
@retval EFI_TIMEOUT The bulk transfer failed due to timeout.
@retval EFI_TIMEOUT The bulk transfer failed due to timeout.
**/
typedef
@@ -140,7 +140,7 @@ EFI_STATUS
IN PEI_USB2_HOST_CONTROLLER_PPI *This,
IN UINT8 DeviceAddress,
IN UINT8 EndPointAddress,
IN UINT8 DeviceSpeed,
IN UINT8 DeviceSpeed,
IN UINTN MaximumPacketLength,
IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM],
IN OUT UINTN *DataLength,
@@ -154,10 +154,10 @@ EFI_STATUS
Retrieves the number of root hub ports.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[out] PortNumber The pointer to the number of the root hub ports.
@param[out] PortNumber The pointer to the number of the root hub ports.
@retval EFI_SUCCESS The port number was retrieved successfully.
@retval EFI_INVALID_PARAMETER PortNumber is NULL.
@@ -174,15 +174,15 @@ EFI_STATUS
Retrieves the current status of a USB root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port from which the status is
@param[in] PortNumber Specifies the root hub port from which the status is
to be retrieved.
This value is zero based.
@param[out] PortStatus A pointer to the current port status bits and port
@param[out] PortStatus A pointer to the current port status bits and port
status change bits.
@retval EFI_SUCCESS The status of the USB root hub port specified by
@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.
@@ -200,18 +200,18 @@ EFI_STATUS
Sets a feature for the specified root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port whose feature is requested
@param[in] PortNumber Specifies the root hub port whose feature is requested
to be set. This value is zero based.
@param[in] PortFeature Indicates the feature selector associated with the feature
@param[in] PortFeature Indicates the feature selector associated with the feature
set request.
@retval EFI_SUCCESS The feature specified by PortFeature was set for
@retval EFI_SUCCESS The feature specified by PortFeature was set for
the USB root hub port specified by PortNumber.
@retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid
@retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid
for this function.
@retval EFI_TIMEOUT The time out occurred
@retval EFI_TIMEOUT The time out occurred
**/
typedef
@@ -227,7 +227,7 @@ EFI_STATUS
Clears a feature for the specified root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB2_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port whose feature is
requested to be cleared.
@@ -251,7 +251,7 @@ EFI_STATUS
///
/// This PPI contains a set of services to interact with the USB host controller.
/// These interfaces are modeled on the UEFI 2.3 specification protocol
/// EFI_USB2_HOST_CONTROLLER_PROTOCOL. Refer to section 16.1 of the UEFI 2.3
/// EFI_USB2_HOST_CONTROLLER_PROTOCOL. Refer to section 16.1 of the UEFI 2.3
/// Specification for more information on these interfaces.
///
struct _PEI_USB2_HOST_CONTROLLER_PPI {

8
MdeModulePkg/Include/Ppi/UsbController.h
View File

@@ -1,8 +1,8 @@
/** @file
Define APIs to retrieve USB Host Controller Info such as controller type and
Define APIs to retrieve USB Host Controller Info such as controller type and
I/O Port Base Address.
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -63,11 +63,11 @@ typedef struct _PEI_USB_CONTROLLER_PPI PEI_USB_CONTROLLER_PPI;
@param[in] ControllerId The ID of the USB controller.
@param[out] ControllerType On output, returns the type of the USB controller.
@param[out] BaseAddress On output, returns the base address of UHCI's I/O ports
if UHCI is enabled or the base address of EHCI's MMIO
if UHCI is enabled or the base address of EHCI's MMIO
if EHCI is enabled.
@retval EFI_SUCCESS USB controller attributes were returned successfully.
@retval EFI_INVALID_PARAMETER ControllerId is greater than the maximum number
@retval EFI_INVALID_PARAMETER ControllerId is greater than the maximum number
of USB controller supported by this platform.
**/

90
MdeModulePkg/Include/Ppi/UsbHostController.h
View File

@@ -1,11 +1,11 @@
/** @file
Defines the USB Host Controller PPI that provides I/O services for a USB Host
Controller that may be used to access recovery devices. These interfaces are
Defines the USB Host Controller PPI that provides I/O services for a USB Host
Controller that may be used to access recovery devices. These interfaces are
modeled on the UEFI 2.3 specification EFI_USB2_HOST_CONTROLLER_PROTOCOL.
Refer to section 16.1 of the UEFI 2.3 Specification for more information on
Refer to section 16.1 of the UEFI 2.3 Specification for more information on
these interfaces.
Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -37,38 +37,38 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _PEI_USB_HOST_CONTROLLER_PPI PEI_USB_HOST_CONTROLLER_PPI;
/**
Initiate a USB control transfer using a specific USB Host controller on the USB bus.
Initiate a USB control transfer using a specific USB Host controller on the USB bus.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB_HOST_CONTROLLER_PPI.
@param[in] DeviceAddress Represents the address of the target device
@param[in] DeviceAddress Represents the address of the target device
on the USB.
@param[in] DeviceSpeed Indicates device speed.
@param[in] MaximumPacketLength Indicates the maximum packet size that the
@param[in] MaximumPacketLength Indicates the maximum packet size that the
default control transfer
endpoint is capable of sending or receiving.
@param[in] Request A pointer to the USB device request that
@param[in] Request A pointer to the USB device request that
will be sent to the USB device.
@param[in] TransferDirection Specifies the data direction for the transfer.
There are three values available:
@param[in] TransferDirection Specifies the data direction for the transfer.
There are three values available:
EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
@param[in,out] Data A pointer to the buffer of data that will
@param[in,out] Data A pointer to the buffer of data that will
be transmitted to USB device or
received from USB device.
@param[in,out] DataLength On input, indicates the size, in bytes, of
@param[in,out] DataLength On input, indicates the size, in bytes, of
the data buffer specified by Data.
On output, indicates the amount of data
On output, indicates the amount of data
actually transferred.
@param[in] TimeOut Indicates the maximum time, in milliseconds,
that the transfer is allowed to complete.
@param[in] TimeOut Indicates the maximum time, in milliseconds,
that the transfer is allowed to complete.
If Timeout is 0, then the caller must wait for
the function to be completed until EFI_SUCCESS
or EFI_DEVICE_ERROR is returned.
@param[out] TransferResult A pointer to the detailed result information
@param[out] TransferResult A pointer to the detailed result information
generated by this control transfer.
@retval EFI_DEVICE_ERROR The control transfer failed due to host controller
@retval EFI_DEVICE_ERROR The control transfer failed due to host controller
or device error.
@retval EFI_SUCCESS The control transfer was completed successfully.
@@ -90,21 +90,21 @@ EFI_STATUS
);
/**
Initiate a USB bulk transfer using a specific USB Host controller on the USB bus.
Initiate a USB bulk transfer using a specific USB Host controller on the USB bus.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB_HOST_CONTROLLER_PPI.
@param[in] DeviceAddress Represents the address of the target device
@param[in] DeviceAddress Represents the address of the target device
on the USB.
@param[in] EndPointAddress The combination of an endpoint number and
@param[in] EndPointAddress The combination of an endpoint number and
an endpoint direction of the target USB device.
@param[in] MaximumPacketLength Indicates the maximum packet size the target
@param[in] MaximumPacketLength Indicates the maximum packet size the target
endpoint is capable of sending or receiving.
@param[in,out] Data Array of pointers to the buffers of data
that will be transmitted to USB device or
@param[in,out] Data Array of pointers to the buffers of data
that will be transmitted to USB device or
received from USB device.
@param[in,out] DataLength When input, indicates the size, in bytes, of
@param[in,out] DataLength When input, indicates the size, in bytes, of
the data buffers specified by Data. When output,
indicates the data size actually transferred.
@param[in,out] DataToggle A pointer to the data toggle value.
@@ -113,7 +113,7 @@ EFI_STATUS
If Timeout is 0, then the caller must wait for
the function to be completed until EFI_SUCCESS
or EFI_DEVICE_ERROR is returned.
@param[out] TransferResult A pointer to the detailed result information
@param[out] TransferResult A pointer to the detailed result information
of the bulk transfer.
@retval EFI_SUCCESS The bulk transfer was completed successfully.
@@ -140,12 +140,12 @@ EFI_STATUS
Retrieves the number of root hub ports.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB_HOST_CONTROLLER_PPI.
@param[out] PortNumber The pointer to the number of the root hub ports.
@param[out] PortNumber The pointer to the number of the root hub ports.
@retval EFI_SUCCESS The port number was retrieved successfully.
@retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve
@retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve
the port number.
@retval EFI_INVALID_PARAMETER PortNumber is NULL.
@@ -162,15 +162,15 @@ EFI_STATUS
Retrieves the current status of a USB root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port from which the status is
@param[in] PortNumber Specifies the root hub port from which the status is
to be retrieved.
This value is zero based.
@param[out] PortStatus A pointer to the current port status bits and port
@param[out] PortStatus A pointer to the current port status bits and port
status change bits.
@retval EFI_SUCCESS The status of the USB root hub port specified by
@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.
@@ -188,16 +188,16 @@ EFI_STATUS
Sets a feature for the specified root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port whose feature is requested
@param[in] PortNumber Specifies the root hub port whose feature is requested
to be set. This value is zero based.
@param[in] PortFeature Indicates the feature selector associated with the feature
@param[in] PortFeature Indicates the feature selector associated with the feature
set request.
@retval EFI_SUCCESS The feature specified by PortFeature was set for
@retval EFI_SUCCESS The feature specified by PortFeature was set for
the USB root hub port specified by PortNumber.
@retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid
@retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid
for this function.
**/
@@ -214,7 +214,7 @@ EFI_STATUS
Clears a feature for the specified root hub port.
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the
@param[in] This The pointer to this instance of the
PEI_USB_HOST_CONTROLLER_PPI.
@param[in] PortNumber Specifies the root hub port whose feature is
requested to be cleared.
@@ -239,7 +239,7 @@ EFI_STATUS
///
/// This PPI contains a set of services to interact with the USB host controller.
/// These interfaces are modeled on the UEFI 2.3 specification protocol
/// EFI_USB2_HOST_CONTROLLER_PROTOCOL. Refer to section 16.1 of the UEFI 2.3
/// EFI_USB2_HOST_CONTROLLER_PROTOCOL. Refer to section 16.1 of the UEFI 2.3
/// Specification for more information on these interfaces.
///
struct _PEI_USB_HOST_CONTROLLER_PPI {

42
MdeModulePkg/Include/Ppi/UsbIo.h
View File

@@ -1,12 +1,12 @@
/** @file
Defines the PEI_USB_IO_PPI that the USB-related PEIM can use for I/O operations
on the USB BUS. This interface enables recovery from a
USB-class storage device, such as USB CD/DVD, USB hard drive, or USB FLASH
Defines the PEI_USB_IO_PPI that the USB-related PEIM can use for I/O operations
on the USB BUS. This interface enables recovery from a
USB-class storage device, such as USB CD/DVD, USB hard drive, or USB FLASH
drive. These interfaces are modeled on the UEFI 2.3 specification EFI_USB_IO_PROTOCOL.
Refer to section 16.2.4 of the UEFI 2.3 Specification for more information on
Refer to section 16.2.4 of the UEFI 2.3 Specification for more information on
these interfaces.
Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
@@ -42,29 +42,29 @@ typedef struct _PEI_USB_IO_PPI PEI_USB_IO_PPI;
@param[in] PeiServices The pointer to the PEI Services Table.
@param[in] This The pointer to this instance of the PEI_USB_IO_PPI.
@param[in] Request A pointer to the USB device request that will be
@param[in] Request A pointer to the USB device request that will be
sent to the USB device.
@param[in] Direction Specifies the data direction for the transfer. There
are three values available:
@param[in] Direction Specifies the data direction for the transfer. There
are three values available:
EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
@param[in] Timeout Indicates the maximum time, in milliseconds, that
@param[in] Timeout Indicates the maximum time, in milliseconds, that
the transfer is allowed to complete.
If Timeout is 0, then the caller must wait for the
function to be completed until EFI_SUCCESS or
EFI_DEVICE_ERROR is returned.
@param[in,out] Data A pointer to the buffer of data that will be
@param[in,out] Data A pointer to the buffer of data that will be
transmitted to or received from the USB device.
@param[in] DataLength On input, indicates the size, in bytes, of the data
@param[in] DataLength On input, indicates the size, in bytes, of the data
buffer specified by Data.
@retval EFI_SUCCESS The control transfer was completed successfully.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due
@retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due
to a lack of resources.
@retval EFI_TIMEOUT The control transfer failed due to timeout.
@retval EFI_DEVICE_ERROR The control transfer failed due to host controller
@retval EFI_DEVICE_ERROR The control transfer failed due to host controller
or device error.
Caller should check TransferResult for detailed
Caller should check TransferResult for detailed
error information.
**/
@@ -95,12 +95,12 @@ EFI_STATUS
@retval EFI_SUCCESS The bulk transfer completed successfully.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to
@retval EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to
a lack of resources.
@retval EFI_TIMEOUT The bulk transfer failed due to timeout.
@retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller
@retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller
or device error.
Caller should check TransferResult for detailed
Caller should check TransferResult for detailed
error information.
**/
@@ -124,7 +124,7 @@ EFI_STATUS
@retval EFI_SUCCESS The interface descriptor was returned.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_DEVICE_ERROR A device error occurred, the function failed to
@retval EFI_DEVICE_ERROR A device error occurred, the function failed to
get the interface descriptor.
**/
@@ -146,7 +146,7 @@ EFI_STATUS
@retval EFI_SUCCESS The endpoint descriptor was returned.
@retval EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_DEVICE_ERROR A device error occurred, the function failed to
@retval EFI_DEVICE_ERROR A device error occurred, the function failed to
get the endpoint descriptor.
**/
@@ -180,7 +180,7 @@ EFI_STATUS
///
/// This PPI contains a set of services to interact with the USB host controller.
/// These interfaces are modeled on the UEFI 2.3 specification EFI_USB_IO_PROTOCOL.
/// Refer to section 16.2.4 of the UEFI 2.3 Specification for more information on
/// Refer to section 16.2.4 of the UEFI 2.3 Specification for more information on
/// these interfaces.
///
struct _PEI_USB_IO_PPI {