Refine include file for PCI Platform Protocol, and update C source code accordingly.
authorxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 19 Jun 2009 09:35:07 +0000 (09:35 +0000)
committerxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 19 Jun 2009 09:35:07 +0000 (09:35 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8614 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumerator.c
IntelFrameworkPkg/Include/Protocol/PciPlatform.h

index c8cd57a5142b854eb388be59b9a87b05c9f3e4b7..b14a018994f0a943be36ee4564305151ed91accd 100644 (file)
@@ -1727,9 +1727,9 @@ NotifyPhase (
     HostBridgeHandle = PciRootBridgeIo->ParentHandle;\r
 \r
     //\r
-    // Call PlatformPci::PhaseNotify() if the protocol is present.\r
+    // Call PlatformPci::PlatformNotify() if the protocol is present.\r
     //\r
-    gPciPlatformProtocol->PhaseNotify (\r
+    gPciPlatformProtocol->PlatformNotify (\r
                             gPciPlatformProtocol,\r
                             HostBridgeHandle,\r
                             Phase,\r
@@ -1744,9 +1744,9 @@ NotifyPhase (
 \r
   if (gPciPlatformProtocol != NULL) {\r
     //\r
-    // Call PlatformPci::PhaseNotify() if the protocol is present.\r
+    // Call PlatformPci::PlatformNotify() if the protocol is present.\r
     //\r
-    gPciPlatformProtocol->PhaseNotify (\r
+    gPciPlatformProtocol->PlatformNotify (\r
                             gPciPlatformProtocol,\r
                             HostBridgeHandle,\r
                             Phase,\r
index 32f5742cc6180ad3c853b331e4427eb89c97ab86..97d9af99c1dfdae004f3e024e0d9d323000859c8 100644 (file)
@@ -4,7 +4,7 @@
   driver to describe the unique features of a platform. This\r
   protocol is optional.\r
   \r
-  Copyright (c) 2007, Intel Corporation\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
@@ -36,22 +36,45 @@ typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;
 \r
 typedef    UINT32   EFI_PCI_PLATFORM_POLICY;\r
 \r
-\r
+//\r
+// There are 4 legal combinations of following bit values:\r
+// EFI_RESERVE_NONE_IO_ALIAS,\r
+// EFI_RESERVE_ISA_IO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS,\r
+// EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS,\r
+// EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_NO_ALIAS\r
+//\r
 #define     EFI_RESERVE_NONE_IO_ALIAS        0x0000\r
 #define     EFI_RESERVE_ISA_IO_ALIAS         0x0001\r
 #define     EFI_RESERVE_ISA_IO_NO_ALIAS      0x0002\r
 #define     EFI_RESERVE_VGA_IO_ALIAS         0x0004\r
 #define     EFI_RESERVE_VGA_IO_NO_ALIAS      0x0008\r
 \r
-\r
+///\r
+/// EFI_PCI_CHIPSET_EXECUTION_PHASE is used to call a platform protocol and execute\r
+/// platform-specific code.\r
+///\r
 typedef enum {\r
+  ///\r
+  /// The phase that indicates the entry point to the PCI Bus Notify phase. This\r
+  /// platform hook is called before the PCI bus driver calls the\r
+  /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL driver.\r
+  ///\r
   ChipsetEntry,\r
+  ///\r
+  /// The phase that indicates the exit point to the Chipset Notify phase before\r
+  /// returning to the PCI Bus Driver Notify phase. This platform hook is called after\r
+  /// the PCI bus driver calls the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+  /// driver.\r
+  ///\r
   ChipsetExit,\r
   MaximumChipsetPhase\r
 } EFI_PCI_CHIPSET_EXECUTION_PHASE;\r
 \r
 \r
 /**\r
+  The notification from the PCI bus enumerator to the platform that it is\r
+  about to enter a certain phase during the enumeration process.\r
+\r
   The PlatformNotify() function can be used to notify the platform driver so that\r
   it can perform platform-specific actions. No specific actions are required.\r
   Eight notification points are defined at this time. More synchronization points\r
@@ -83,6 +106,9 @@ EFI_STATUS
 \r
 \r
 /**\r
+  The notification from the PCI bus enumerator to the platform for each PCI\r
+  controller at several predefined points during PCI controller initialization.\r
+\r
   The PlatformPrepController() function can be used to notify the platform driver so that\r
   it can perform platform-specific actions. No specific actions are required.\r
   Several notification points are defined at this time. More synchronization points may be\r
@@ -118,6 +144,8 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Retrieves the platform policy regarding enumeration.\r
+\r
   The GetPlatformPolicy() function retrieves the platform policy regarding PCI\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
@@ -138,6 +166,8 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Gets the PCI device's option ROM from a platform-specific location.\r
+\r
   The GetPciRom() function gets the PCI device's option ROM from a platform-specific location.\r
   The option ROM will be loaded into memory. This member function is used to return an image\r
   that is packaged as a PCI 2.2 option ROM. The image may contain both legacy and EFI option\r
@@ -173,29 +203,13 @@ EFI_STATUS
   OUT  UINTN                        *RomSize\r
 );\r
 \r
-/**\r
-  @par Protocol Description:\r
-  This protocol provides the interface between the PCI bus driver/PCI Host\r
-  Bridge Resource Allocation driver and a platform-specific driver to describe\r
-  the unique features of a platform.\r
-\r
-  @param PlatformNotify\r
-  The notification from the PCI bus enumerator to the platform that it is\r
-  about to enter a certain phase during the enumeration process.\r
-\r
-  @param PlatformPrepController\r
-  The notification from the PCI bus enumerator to the platform for each PCI\r
-  controller at several predefined points during PCI controller initialization.\r
-\r
-  @param GetPlatformPolicy\r
-  Retrieves the platform policy regarding enumeration.\r
-\r
-  @param GetPciRom\r
-  Gets the PCI device's option ROM from a platform-specific location.\r
-\r
-**/\r
+///\r
+/// This protocol provides the interface between the PCI bus driver/PCI Host\r
+/// Bridge Resource Allocation driver and a platform-specific driver to describe\r
+/// the unique features of a platform.\r
+///\r
 struct _EFI_PCI_PLATFORM_PROTOCOL {\r
-  EFI_PCI_PLATFORM_PHASE_NOTIFY          PhaseNotify;\r
+  EFI_PCI_PLATFORM_PHASE_NOTIFY          PlatformNotify;\r
   EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER PlatformPrepController;\r
   EFI_PCI_PLATFORM_GET_PLATFORM_POLICY   GetPlatformPolicy;\r
   EFI_PCI_PLATFORM_GET_PCI_ROM           GetPciRom;\r