Update the comment for RegisterForRunimeAccess() functions to match the Spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6862 6f19259b-4bc3-4df7-8a09-765794883524

8 files changed, 34 insertions, 8 deletions

diff --git a/MdePkg/Include/Library/PciCf8Lib.h b/MdePkg/Include/Library/PciCf8Lib.h
index 3683590eff..ddc7c27fc0 100644
--- a/MdePkg/Include/Library/PciCf8Lib.h
+++ b/MdePkg/Include/Library/PciCf8Lib.h
@@ -40,9 +40,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   (((Offset) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20))

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration registers 

+  associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Include/Library/PciExpressLib.h b/MdePkg/Include/Library/PciExpressLib.h
index 1a1356e3d8..286a8e53a0 100644
--- a/MdePkg/Include/Library/PciExpressLib.h
+++ b/MdePkg/Include/Library/PciExpressLib.h
@@ -39,9 +39,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   (((Offset) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20))

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration 

+  registers associated with that PCI device may be accessed after SetVirtualAddressMap() 

+  is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Include/Library/PciLib.h b/MdePkg/Include/Library/PciLib.h
index 7bf164445b..766bb0b759 100644
--- a/MdePkg/Include/Library/PciLib.h
+++ b/MdePkg/Include/Library/PciLib.h
@@ -41,9 +41,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   (((Offset) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20))

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration registers 

+  associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Library/BasePciCf8Lib/PciCf8Lib.c b/MdePkg/Library/BasePciCf8Lib/PciCf8Lib.c
index 40ef57391e..8173c11814 100644
--- a/MdePkg/Library/BasePciCf8Lib/PciCf8Lib.c
+++ b/MdePkg/Library/BasePciCf8Lib/PciCf8Lib.c
@@ -61,9 +61,12 @@
   ASSERT (((A) & (~0xffff0ff | (M))) == 0)

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration registers 

+  associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Library/BasePciExpressLib/PciExpressLib.c b/MdePkg/Library/BasePciExpressLib/PciExpressLib.c
index 4d1dfb12a9..94fb0b2bee 100644
--- a/MdePkg/Library/BasePciExpressLib/PciExpressLib.c
+++ b/MdePkg/Library/BasePciExpressLib/PciExpressLib.c
@@ -37,9 +37,13 @@
   ASSERT (((A) & ~0xfffffff) == 0)

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration 

+  registers associated with that PCI device may be accessed after SetVirtualAddressMap() 

+  is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Library/BasePciLibCf8/PciLib.c b/MdePkg/Library/BasePciLibCf8/PciLib.c
index e8416c846b..6072898d81 100644
--- a/MdePkg/Library/BasePciLibCf8/PciLib.c
+++ b/MdePkg/Library/BasePciLibCf8/PciLib.c
@@ -20,9 +20,12 @@
 #include <Library/PciCf8Lib.h>

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration registers 

+  associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Library/BasePciLibPciExpress/PciLib.c b/MdePkg/Library/BasePciLibPciExpress/PciLib.c
index 4bdf0be8ff..b89306bb00 100644
--- a/MdePkg/Library/BasePciLibPciExpress/PciLib.c
+++ b/MdePkg/Library/BasePciLibPciExpress/PciLib.c
@@ -20,9 +20,12 @@
 #include <Library/PciExpressLib.h>

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration registers 

+  associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and

diff --git a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c
index ddae8dbfc3..bd2c17ccdf 100644
--- a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c
+++ b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c
@@ -129,9 +129,12 @@ PeiPciLibPciCfg2WriteWorker (
 }

 

 /**

-  Register a PCI device so PCI configuration registers may be accessed after 

+  Registers a PCI device so PCI configuration registers may be accessed after 

   SetVirtualAddressMap().

   

+  Registers the PCI device specified by Address so all the PCI configuration registers 

+  associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

+  

   If Address > 0x0FFFFFFF, then ASSERT().

 

   @param  Address Address that encodes the PCI Bus, Device, Function and