diff options
author | myronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524> | 2010-06-25 21:56:02 +0000 |
---|---|---|
committer | myronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524> | 2010-06-25 21:56:02 +0000 |
commit | 2fc59a003ed9104f9feebe0e418f2a04a50f3284 (patch) | |
tree | 6db3e57a6dc3e203bcc9cbc509ea734379fc9e29 /MdePkg/Library/PeiPciLibPciCfg2 | |
parent | 22f6824925d63a113d1323120c6468114581b67a (diff) | |
download | edk2-2fc59a003ed9104f9feebe0e418f2a04a50f3284.tar.gz edk2-2fc59a003ed9104f9feebe0e418f2a04a50f3284.tar.bz2 edk2-2fc59a003ed9104f9feebe0e418f2a04a50f3284.zip |
Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10604 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/PeiPciLibPciCfg2')
-rw-r--r-- | MdePkg/Library/PeiPciLibPciCfg2/PciLib.c | 88 | ||||
-rw-r--r-- | MdePkg/Library/PeiPciLibPciCfg2/PeiPciLibPciCfg2.inf | 2 |
2 files changed, 45 insertions, 45 deletions
diff --git a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c index 047ede2fa5..98ac205933 100644 --- a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c +++ b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c @@ -6,7 +6,7 @@ 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
+ 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.
@@ -37,7 +37,7 @@ /**
Translate PCI Lib address into format of PCI CFG2 PPI.
- @param A Address that encodes the PCI Bus, Device, Function and
+ @param A The address that encodes the PCI Bus, Device, Function and
Register.
**/
@@ -51,7 +51,7 @@ It reads and returns the PCI configuration register specified by Address,
the width of data is specified by Width.
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param Width Width of data to read
@@ -93,7 +93,7 @@ PeiPciLibPciCfg2ReadWorker ( value specified by Data. The width of data is specifed by Width.
Data is returned.
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param Width Width of data to write
@param Data The value to write.
@@ -137,7 +137,7 @@ PeiPciLibPciCfg2WriteWorker ( If Address > 0x0FFFFFFF, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@retval RETURN_SUCCESS The PCI device was registered for runtime access.
@@ -168,7 +168,7 @@ PciRegisterForRuntimeAccess ( If Address > 0x0FFFFFFF, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@return The read value from the PCI configuration register.
@@ -194,7 +194,7 @@ PciRead8 ( If Address > 0x0FFFFFFF, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param Value The value to write.
@@ -226,7 +226,7 @@ PciWrite8 ( If Address > 0x0FFFFFFF, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param OrData The value to OR with the PCI configuration register.
@@ -256,7 +256,7 @@ PciOr8 ( If Address > 0x0FFFFFFF, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param AndData The value to AND with the PCI configuration register.
@@ -287,7 +287,7 @@ PciAnd8 ( If Address > 0x0FFFFFFF, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the result of the AND operation.
@@ -318,7 +318,7 @@ PciAndThenOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to read.
+ @param Address The PCI configuration register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -351,12 +351,12 @@ PciBitFieldRead8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..7.
- @param Value New value of the bit field.
+ @param Value The new value of the bit field.
@return The value written back to the PCI configuration register.
@@ -392,7 +392,7 @@ PciBitFieldWrite8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -433,7 +433,7 @@ PciBitFieldOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -476,7 +476,7 @@ PciBitFieldAnd8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -513,7 +513,7 @@ PciBitFieldAndThenOr8 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@return The read value from the PCI configuration register.
@@ -540,7 +540,7 @@ PciRead16 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param Value The value to write.
@@ -573,7 +573,7 @@ PciWrite16 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param OrData The value to OR with the PCI configuration register.
@@ -604,7 +604,7 @@ PciOr16 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param AndData The value to AND with the PCI configuration register.
@@ -636,7 +636,7 @@ PciAnd16 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the result of the AND operation.
@@ -668,7 +668,7 @@ PciAndThenOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to read.
+ @param Address The PCI configuration register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -702,12 +702,12 @@ PciBitFieldRead16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..15.
- @param Value New value of the bit field.
+ @param Value The new value of the bit field.
@return The value written back to the PCI configuration register.
@@ -744,7 +744,7 @@ PciBitFieldWrite16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -786,7 +786,7 @@ PciBitFieldOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -830,7 +830,7 @@ PciBitFieldAnd16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -867,7 +867,7 @@ PciBitFieldAndThenOr16 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@return The read value from the PCI configuration register.
@@ -894,7 +894,7 @@ PciRead32 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param Value The value to write.
@@ -927,7 +927,7 @@ PciWrite32 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param OrData The value to OR with the PCI configuration register.
@@ -958,7 +958,7 @@ PciOr32 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param AndData The value to AND with the PCI configuration register.
@@ -990,7 +990,7 @@ PciAnd32 ( If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address Address that encodes the PCI Bus, Device, Function and
+ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
@param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the result of the AND operation.
@@ -1022,7 +1022,7 @@ PciAndThenOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to read.
+ @param Address The PCI configuration register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1056,12 +1056,12 @@ PciBitFieldRead32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
- @param Value New value of the bit field.
+ @param Value The new value of the bit field.
@return The value written back to the PCI configuration register.
@@ -1098,7 +1098,7 @@ PciBitFieldWrite32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1140,7 +1140,7 @@ PciBitFieldOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1184,7 +1184,7 @@ PciBitFieldAnd32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address PCI configuration register to write.
+ @param Address The PCI configuration register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1226,10 +1226,10 @@ PciBitFieldAndThenOr32 ( If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, then ASSERT().
- @param StartAddress Starting address that encodes the PCI Bus, Device,
+ @param StartAddress The starting address that encodes the PCI Bus, Device,
Function and Register.
- @param Size Size in bytes of the transfer.
- @param Buffer Pointer to a buffer receiving the data read.
+ @param Size The size in bytes of the transfer.
+ @param Buffer The pointer to a buffer receiving the data read.
@return Size
@@ -1324,10 +1324,10 @@ PciReadBuffer ( If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, then ASSERT().
- @param StartAddress Starting address that encodes the PCI Bus, Device,
+ @param StartAddress The starting address that encodes the PCI Bus, Device,
Function and Register.
- @param Size Size in bytes of the transfer.
- @param Buffer Pointer to a buffer containing the data to write.
+ @param Size The size in bytes of the transfer.
+ @param Buffer The pointer to a buffer containing the data to write.
@return Size written to StartAddress.
diff --git a/MdePkg/Library/PeiPciLibPciCfg2/PeiPciLibPciCfg2.inf b/MdePkg/Library/PeiPciLibPciCfg2/PeiPciLibPciCfg2.inf index 5debb1d1da..de1a0ef630 100644 --- a/MdePkg/Library/PeiPciLibPciCfg2/PeiPciLibPciCfg2.inf +++ b/MdePkg/Library/PeiPciLibPciCfg2/PeiPciLibPciCfg2.inf @@ -12,7 +12,7 @@ # 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
+# 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.
#
|