From 2fc59a003ed9104f9feebe0e418f2a04a50f3284 Mon Sep 17 00:00:00 2001 From: myronporter Date: Fri, 25 Jun 2010 21:56:02 +0000 Subject: 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 --- .../PciSegmentLib.c | 88 +++++++++++----------- .../PciSegmentLib.h | 4 +- .../UefiPciSegmentLibPciRootBridgeIo.inf | 2 +- 3 files changed, 47 insertions(+), 47 deletions(-) (limited to 'MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo') diff --git a/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.c b/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.c index bffb52708e..ccd9df34d0 100644 --- a/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.c +++ b/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.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. @@ -131,7 +131,7 @@ PciSegmentLibDestructor ( This internal function extracts segment number and bus number data from address, and retrieves the corresponding PCI Root Bridge I/O Protocol instance. - @param Address Address that encodes the Segment, PCI Bus, Device, Function and + @param Address The address that encodes the Segment, PCI Bus, Device, Function and Register. @return The address for PCI Root Bridge I/O Protocol. @@ -171,7 +171,7 @@ PciSegmentLibSearchForRootBridge ( 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 @@ -209,7 +209,7 @@ DxePciSegmentLibPciRootBridgeIoReadWorker ( 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. @@ -246,7 +246,7 @@ DxePciSegmentLibPciRootBridgeIoWriteWorker ( If any reserved bits in Address are set, 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. @@ -276,7 +276,7 @@ PciSegmentRegisterForRuntimeAccess ( If any reserved bits in Address are set, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @return The 8-bit PCI configuration register specified by Address. @@ -300,7 +300,7 @@ PciSegmentRead8 ( If any reserved bits in Address are set, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Value The value to write. @return The value written to the PCI configuration register. @@ -329,7 +329,7 @@ PciSegmentWrite8 ( If any reserved bits in Address are set, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param OrData The value to OR with the PCI configuration register. @return The value written to the PCI configuration register. @@ -355,7 +355,7 @@ PciSegmentOr8 ( This function must guarantee that all PCI read and write operations are serialized. If any reserved bits in Address are set, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param AndData The value to AND with the PCI configuration register. @return The value written to the PCI configuration register. @@ -384,7 +384,7 @@ PciSegmentAnd8 ( If any reserved bits in Address are set, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param AndData The value to AND with the PCI configuration register. @param OrData The value to OR with the PCI configuration register. @@ -414,7 +414,7 @@ PciSegmentAndThenOr8 ( 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. @@ -447,12 +447,12 @@ PciSegmentBitFieldRead8 ( 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. @@ -488,7 +488,7 @@ PciSegmentBitFieldWrite8 ( 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. @@ -529,7 +529,7 @@ PciSegmentBitFieldOr8 ( 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. @@ -572,7 +572,7 @@ PciSegmentBitFieldAnd8 ( 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. @@ -608,7 +608,7 @@ PciSegmentBitFieldAndThenOr8 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @return The 16-bit PCI configuration register specified by Address. @@ -633,7 +633,7 @@ PciSegmentRead16 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Value The value to write. @return The parameter of Value. @@ -665,7 +665,7 @@ PciSegmentWrite16 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function and + @param Address The address that encodes the PCI Segment, Bus, Device, Function and Register. @param OrData The value to OR with the PCI configuration register. @@ -694,7 +694,7 @@ PciSegmentOr16 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param AndData The value to AND with the PCI configuration register. @return The value written to the PCI configuration register. @@ -724,7 +724,7 @@ PciSegmentAnd16 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param AndData The value to AND with the PCI configuration register. @param OrData The value to OR with the PCI configuration register. @@ -755,7 +755,7 @@ PciSegmentAndThenOr16 ( 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. @@ -789,12 +789,12 @@ PciSegmentBitFieldRead16 ( 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. @@ -825,7 +825,7 @@ PciSegmentBitFieldWrite16 ( 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 @@ PciSegmentBitFieldOr16 ( If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param StartBit The ordinal of the least significant bit in the bit field. The ordinal of the least significant bit in a byte is bit 0. @param EndBit The ordinal of the most significant bit in the bit field. @@ -910,7 +910,7 @@ PciSegmentBitFieldAnd16 ( 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. @@ -946,7 +946,7 @@ PciSegmentBitFieldAndThenOr16 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @return The 32-bit PCI configuration register specified by Address. @@ -971,7 +971,7 @@ PciSegmentRead32 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param Value The value to write. @return The parameter of Value. @@ -1001,7 +1001,7 @@ PciSegmentWrite32 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param OrData The value to OR with the PCI configuration register. @return The value written to the PCI configuration register. @@ -1029,7 +1029,7 @@ PciSegmentOr32 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param AndData The value to AND with the PCI configuration register. @return The value written to the PCI configuration register. @@ -1059,7 +1059,7 @@ PciSegmentAnd32 ( If any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). - @param Address Address that encodes the PCI Segment, Bus, Device, Function, and Register. + @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register. @param AndData The value to AND with the PCI configuration register. @param OrData The value to OR with the PCI configuration register. @@ -1090,7 +1090,7 @@ PciSegmentAndThenOr32 ( 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. @@ -1124,12 +1124,12 @@ PciSegmentBitFieldRead32 ( 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. @@ -1165,7 +1165,7 @@ PciSegmentBitFieldWrite32 ( 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. @@ -1207,7 +1207,7 @@ PciSegmentBitFieldOr32 ( 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. @@ -1250,7 +1250,7 @@ PciSegmentBitFieldAnd32 ( 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. @@ -1292,10 +1292,10 @@ PciSegmentBitFieldAndThenOr32 ( If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT(). - @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, + @param StartAddress The starting address that encodes the PCI Segment, 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 @@ -1390,10 +1390,10 @@ PciSegmentReadBuffer ( If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT(). - @param StartAddress Starting address that encodes the PCI Segment, Bus, Device, + @param StartAddress The starting address that encodes the PCI Segment, 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 The parameter of Size. diff --git a/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.h b/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.h index 035db17831..7f130feea2 100644 --- a/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.h +++ b/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.h @@ -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. @@ -49,7 +49,7 @@ typedef struct { /** Translate PCI Lib address into format of PCI Root Bridge I/O Protocol - @param A Address that encodes the PCI Bus, Device, Function and + @param A The address that encodes the PCI Bus, Device, Function and Register. **/ diff --git a/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/UefiPciSegmentLibPciRootBridgeIo.inf b/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/UefiPciSegmentLibPciRootBridgeIo.inf index 95b445daad..cd2f8194f0 100644 --- a/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/UefiPciSegmentLibPciRootBridgeIo.inf +++ b/MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/UefiPciSegmentLibPciRootBridgeIo.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. # -- cgit v1.2.3