/** @file\r
- This file declares PlatfromOpRom protocols which provides the interface between \r
+ This file declares PlatfromOpRom protocols that provide the interface between \r
the PCI bus driver/PCI Host Bridge Resource Allocation driver and a platform-specific \r
driver to describe the unique features of a platform. \r
This protocol is optional.\r
\r
- Copyright (c) 2007 - 2009, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\r
This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
\r
///\r
/// This file must be included because the EFI_PCI_PLATFORM_PROTOCOL uses\r
-/// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE\r
+/// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE.\r
///\r
#include <Protocol/PciHostBridgeResourceAllocation.h>\r
\r
///\r
-/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL\r
+/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL.\r
///\r
#define EFI_PCI_PLATFORM_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL\r
+/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL.\r
///\r
typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;\r
\r
/// - EFI_RESERVE_ISA_IO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS:<BR>\r
/// Sets aside the ISA I/O range and all the aliases during PCI\r
/// enumeration. VGA I/O ranges and aliases are included in ISA alias\r
-/// ranges. In this scheme, 75 percent of the I/O space remains unused.\r
+/// ranges. In this scheme, seventy-five percent of the I/O space remains unused.\r
/// By using this selection, the platform indicates that it wants to support\r
/// PCI devices that require the following, at the cost of wasted I/O space:\r
/// ISA range and its aliases\r
/// The first device that requests the legacy VGA range will get all the\r
/// legacy VGA range plus its aliased addresses forwarded to it. The first\r
/// device that requests the legacy ISA range will get all the legacy ISA\r
-/// range plus its aliased addresses forwarded to it.\r
+/// range, plus its aliased addresses, forwarded to it.\r
/// - EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS:<BR>\r
/// Sets aside the ISA I/O range (0x100 - 0x3FF) during PCI enumeration\r
/// and the aliases of the VGA I/O ranges. By using this selection, the\r
#define EFI_RESERVE_NONE_IO_ALIAS 0x0000\r
\r
///\r
-/// Sets aside ISA I/O range and all aliases\r
+/// Sets aside ISA I/O range and all aliases:\r
/// - n100..n3FF\r
/// - n500..n7FF\r
/// - n900..nBFF\r
-/// - nD00..nFFF\r
+/// - nD00..nFFF.\r
///\r
#define EFI_RESERVE_ISA_IO_ALIAS 0x0001\r
\r
///\r
-/// Sets aside ISA I/O range 0x100-0x3FF\r
+/// Sets aside ISA I/O range 0x100-0x3FF.\r
///\r
#define EFI_RESERVE_ISA_IO_NO_ALIAS 0x0002\r
\r
///\r
-/// Sets aside VGA I/O ranges and all aliases\r
+/// Sets aside VGA I/O ranges and all aliases.\r
///\r
#define EFI_RESERVE_VGA_IO_ALIAS 0x0004\r
\r
///\r
-/// Sets aside VGA I/O rangess\r
+/// Sets aside VGA I/O ranges\r
///\r
#define EFI_RESERVE_VGA_IO_NO_ALIAS 0x0008\r
\r
it needs to handle those errors on its own because there is no way to surface any\r
errors to the caller.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[in] HostBridge The handle of the host bridge controller.\r
@param[in] Phase The phase of the PCI bus enumeration.\r
@param[in] ExecPhase Defines the execution phase of the PCI chipset driver.\r
needs to handle those errors on its own because there is no way to surface any errors to\r
the caller.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[in] HostBridge The associated PCI host bridge handle.\r
@param[in] RootBridge The associated PCI root bridge handle.\r
@param[in] PciAddress The address of the PCI device on the PCI bus.\r
enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol\r
driver can call this member function to retrieve the policy.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[out] PciPolicy The platform policy with respect to VGA and ISA aliasing.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
scanning the ROM that is attached to any controller, which allows a platform to specify a ROM\r
image that is different from the ROM image on a PCI card.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[in] PciHandle The handle of the PCI device.\r
@param[out] RomImage If the call succeeds, the pointer to the pointer to the option ROM image.\r
Otherwise, this field is undefined. The memory for RomImage is allocated\r
@retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.\r
@retval EFI_NOT_FOUND No option ROM was available for this device.\r
@retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.\r
- @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.\r
+ @retval EFI_DEVICE_ERROR An error occurred in obtaining the option ROM.\r
\r
**/\r
typedef\r
projects / mirror_edk2.git / blobdiff