]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Synchronize function comment in h file
authorgikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 26 Nov 2008 06:57:44 +0000 (06:57 +0000)
committergikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 26 Nov 2008 06:57:44 +0000 (06:57 +0000)
with  c file instance of  this functions in MdePkg.

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

20 files changed:
MdePkg/Include/Library/IoLib.h
MdePkg/Include/Library/PalLib.h
MdePkg/Include/Library/PcdLib.h
MdePkg/Include/Library/PciCf8Lib.h
MdePkg/Include/Library/PciExpressLib.h
MdePkg/Include/Library/PciLib.h
MdePkg/Include/Library/UefiScsiLib.h
MdePkg/Include/Library/UefiUsbLib.h
MdePkg/Library/BasePalLibNull/PalCall.c
MdePkg/Library/BasePcdLibNull/PcdLib.c
MdePkg/Library/BasePciCf8Lib/PciCf8Lib.c
MdePkg/Library/BasePciExpressLib/PciExpressLib.c
MdePkg/Library/BasePciLibCf8/PciLib.c
MdePkg/Library/BasePciLibPciExpress/PciLib.c
MdePkg/Library/DxePcdLib/DxePcdLib.c
MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
MdePkg/Library/PeiPalLib/PeiPalLib.c
MdePkg/Library/PeiPcdLib/PeiPcdLib.c
MdePkg/Library/PeiPciLibPciCfg2/PciLib.c
MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c

index 5f544d04fba2538360017c2d5660207b61a666f6..7c415f79b40bd78f7575d505772ae3647a97fa19 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provide services to access I/O Ports and MMIO registers.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
index 30c13668def38049f99321693d0dfe3b3fb0ca83..a113659b0d45517f56ecdc2c939ccb3475c470a0 100644 (file)
@@ -9,15 +9,14 @@
   can contain a constructor to look up the PAL Entry Point from a HOB.  This library class \r
   is only available on IPF.\r
   \r
-Copyright (c) 2006 -2008, Intel Corporation All rights\r
-reserved. This program and the accompanying materials are\r
-licensed and made available under the terms and conditions of\r
-the BSD License which accompanies this distribution.  The full\r
-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) 2006 - 2008, Intel Corporation<BR>\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
 \r
 **/\r
 \r
index 63a6e36c531ea86b866046aa1b94f29acd2c51da..4e2399a565c5f8ac5e159410d4db1ed23ec891ef 100644 (file)
@@ -1504,7 +1504,7 @@ LibPcdGetNextTokenSpace (
   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.\r
   @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
   \r
-  @return Return the pinter to the buffer been set.\r
+  @return Return the pointer to the buffer been set.\r
 \r
 **/\r
 VOID *\r
index e2415ff93608efaf29f67493056c108be57a8703..3683590eff29f9ba31376cb1c252c525a0789aa9 100644 (file)
@@ -5,7 +5,7 @@
   configuration cycles must be though I/O ports 0xCF8 and 0xCFC.  This library only allows \r
   access to PCI Segment #0.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
index 098f815510e331f581c1d57c5a91d498eabccc26..1a1356e3d8998fadd743438a85bf085fdf7f5554 100644 (file)
@@ -5,7 +5,7 @@
   configuration cycles must be though the 256 MB PCI Express MMIO window whose base address\r
   is defined by PcdPciExpressBaseAddress.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
index 184b9f6d7d55b6a12cf6bcf9787c849f2234049b..7bf164445b9729137ea1554f8d69f916af21ce6a 100644 (file)
@@ -10,7 +10,7 @@
   these three libraries is identical.  The PCI CF8 Library and PCI Express Library simply use \r
   explicit access methods.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
index 97f97c793b4a2cbbcf101a7976b900a18f8a2a1d..4eb9fa36f3499b11baaad6e691d714aad1ade5aa 100644 (file)
@@ -48,7 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                                     If SenseDataLength is 0, then this parameter is\r
                                     optional and may be NULL.\r
   @param[in, out] SenseDataLength   On input, a pointer to the length in bytes of\r
-                                    the SenseData buffer. On output, a poiinter to\r
+                                    the SenseData buffer. On output, a pointer to\r
                                     the number of bytes written to the SenseData buffer. \r
   @param[out]     HostAdapterStatus The status of the SCSI Host Controller that produces\r
                                     the SCSI bus containing the SCSI target specified by\r
@@ -56,7 +56,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                                     See the EFI SCSI I/O Protocol in the UEFI Specification\r
                                     for details on the possible return values.\r
   @param[out]     TargetStatus      The status returned by the SCSI target specified\r
-                                    by ScsiIo when the SCSI Request Packat was executed\r
+                                    by ScsiIo when the SCSI Request Packet was executed\r
                                     on the SCSI Host Controller. See the EFI SCSI I/O\r
                                     Protocol in the UEFI Specification for details on\r
                                     the possible return values. \r
@@ -135,7 +135,7 @@ ScsiTestUnitReadyCommand (
                                          SCSI I/O Protocol in the UEFI Specification\r
                                          for details on the possible return values.\r
   @param[out]     TargetStatus           The status returned by the SCSI target specified\r
-                                         by ScsiIo when the SCSI Request Packat was\r
+                                         by ScsiIo when the SCSI Request Packet was\r
                                          executed on the SCSI Host Controller.\r
                                          See the EFI SCSI I/O Protocol in the UEFI\r
                                          Specification for details on the possible\r
@@ -231,7 +231,7 @@ ScsiInquiryCommand (
                                      UEFI Specification for details on the possible\r
                                      return values.\r
   @param[out]     TargetStatus       The status returned by the SCSI target specified\r
-                                     by ScsiIo when the SCSI Request Packat was executed\r
+                                     by ScsiIo when the SCSI Request Packet was executed\r
                                      on the SCSI Host Controller.  See the EFI SCSI\r
                                      I/O Protocol in the UEFI Specification for details\r
                                      on the possible return values.\r
index c52dd89cc733cf6c33d1f463aadced3356441935..ff2c70c96b291875107f6c1e83386d707c1df7d8 100644 (file)
@@ -68,7 +68,7 @@ UsbGetHidDescriptor (
 \r
   @retval  EFI_SUCCESS           The request executed successfully.\r
   @retval  EFI_OUT_OF_RESOURCES  The request could not be completed because the\r
-                                 buffer specifed by DescriptorLength and DescriptorBuffer\r
+                                 buffer specified by DescriptorLength and DescriptorBuffer\r
                                  is not large enough to hold the result of the request.\r
   @retval  EFI_TIMEOUT           A timeout occurred executing the request.\r
   @retval  EFI_DEVICE_ERROR      The request failed due to a device error.\r
@@ -542,7 +542,7 @@ UsbGetStatus (
 \r
   Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.\r
   If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.\r
-  If the endpoint descriptor is found, then clear the halt fature of this USB endpoint.\r
+  If the endpoint descriptor is found, then clear the halt feature of this USB endpoint.\r
   The status of the transfer is returned in Status.\r
   If UsbIo is NULL, then ASSERT().\r
   If Status is NULL, then ASSERT().\r
index e13711abdfe29fa01087c6d3abfe7ad849d48e2e..82db43cf65f7a3b8de11a1c68a0015c817b6214d 100644 (file)
@@ -2,16 +2,17 @@
   \r
   Template and Sample instance of PalCallLib.\r
   \r
-  Copyright (c) 2006 - 2008, 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
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
+  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
+     \r
 **/\r
+\r
 #include <Base.h>\r
 #include <Library/PalLib.h>\r
 #include <Library/DebugLib.h>\r
index 37a151d25cff7edcc1aec048f97eaad5749ac390..168803426358d34bdcf97e8df41c0f5ee3c60d5c 100644 (file)
@@ -778,8 +778,6 @@ LibPcdGetNextToken (
   then NULL is returned. \r
 \r
   If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
-\r
   \r
   @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
                     to start the search.\r
@@ -799,25 +797,27 @@ LibPcdGetNextTokenSpace (
 }\r
 \r
 \r
-\r
 /**\r
+  Sets a value of a patchable PCD entry that is type pointer.\r
+  \r
   Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
-  and SizeOfValue.  Buffer is returned.  If SizeOfValue is greater than \r
-  MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return \r
+  and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than \r
+  MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
   NULL to indicate that the set operation was not actually performed.  \r
-  If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to \r
+  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to \r
   MaximumDatumSize and NULL must be returned.\r
   \r
   If PatchVariable is NULL, then ASSERT().\r
-  If SizeOfValue is NULL, then ASSERT().\r
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+  If SizeOfBuffer is NULL, then ASSERT().\r
+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
 \r
   @param[in] PatchVariable      A pointer to the global variable in a module that is \r
                                 the target of the set operation.\r
   @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.\r
   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.\r
   @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
-  @return Return the pinter to the buffer been set.\r
+  \r
+  @return Return the pointer to the buffer been set.\r
 \r
 **/\r
 VOID *\r
index d6bc180b8b2e216f093577e7333bf09500fcc128..40ef57391e5b6a71f590ad4e5a8dd0f35a69d5d1 100644 (file)
@@ -1316,7 +1316,7 @@ PciCf8BitFieldAndThenOr32(
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer receiving the data read.\r
 \r
-  @return Size\r
+  @return Size read from StartAddress.\r
 \r
 **/\r
 UINTN\r
@@ -1416,7 +1416,7 @@ PciCf8ReadBuffer (
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
-  @return Size\r
+  @return Size written to StartAddress.\r
 \r
 **/\r
 UINTN\r
index 6d76e846fa5a8dafcf4b60ec76c1844de5c9219b..4d1dfb12a9722f9f486f598c39f87ef73323328d 100644 (file)
@@ -1221,7 +1221,7 @@ PciExpressBitFieldAndThenOr32 (
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer receiving the data read.\r
 \r
-  @return Size\r
+  @return Size read data from StartAddress.\r
 \r
 **/\r
 UINTN\r
@@ -1321,7 +1321,7 @@ PciExpressReadBuffer (
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
-  @return Size\r
+  @return Size written to StartAddress.\r
 \r
 **/\r
 UINTN\r
index d4a3ef06f636896194b137decaaca6ca9410fd3a..e8416c846bc9367a4301611d202e4bc9669de22b 100644 (file)
@@ -382,6 +382,7 @@ PciBitFieldAndThenOr8 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -406,6 +407,7 @@ PciRead16 (
   that all PCI read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -436,6 +438,7 @@ PciWrite16 (
   are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -466,6 +469,7 @@ PciOr16 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -497,6 +501,7 @@ PciAnd16 (
   read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -525,6 +530,7 @@ PciAndThenOr16 (
   returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -558,6 +564,7 @@ PciBitFieldRead16 (
   16-bit register is returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -596,6 +603,7 @@ PciBitFieldWrite16 (
   are serialized. Extra left bits in OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -634,6 +642,7 @@ PciBitFieldOr16 (
   serialized. Extra left bits in AndData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -674,6 +683,7 @@ PciBitFieldAnd16 (
   OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -710,6 +720,7 @@ PciBitFieldAndThenOr16 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -734,6 +745,7 @@ PciRead32 (
   that all PCI read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -764,6 +776,7 @@ PciWrite32 (
   are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -794,6 +807,7 @@ PciOr32 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -825,6 +839,7 @@ PciAnd32 (
   read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -853,6 +868,7 @@ PciAndThenOr32 (
   returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -886,6 +902,7 @@ PciBitFieldRead32 (
   32-bit register is returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -924,6 +941,7 @@ PciBitFieldWrite32 (
   are serialized. Extra left bits in OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -962,6 +980,7 @@ PciBitFieldOr32 (
   serialized. Extra left bits in AndData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1002,6 +1021,7 @@ PciBitFieldAnd32 (
   OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
index 48fe66f1801e7af4a22017ec332a72f3221dedea..4bdf0be8ff039303976ee8da88492f947579cab1 100644 (file)
@@ -382,6 +382,7 @@ PciBitFieldAndThenOr8 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -406,10 +407,11 @@ PciRead16 (
   that all PCI read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value  The value to write.\r
+  @param  Value   The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -436,6 +438,7 @@ PciWrite16 (
   are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -466,6 +469,7 @@ PciOr16 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -497,6 +501,7 @@ PciAnd16 (
   read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -525,6 +530,7 @@ PciAndThenOr16 (
   returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -558,6 +564,7 @@ PciBitFieldRead16 (
   16-bit register is returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -596,6 +603,7 @@ PciBitFieldWrite16 (
   are serialized. Extra left bits in OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -634,6 +642,7 @@ PciBitFieldOr16 (
   serialized. Extra left bits in AndData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -674,6 +683,7 @@ PciBitFieldAnd16 (
   OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -710,6 +720,7 @@ PciBitFieldAndThenOr16 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -734,6 +745,7 @@ PciRead32 (
   that all PCI read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -764,6 +776,7 @@ PciWrite32 (
   are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -794,6 +807,7 @@ PciOr32 (
   serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -825,6 +839,7 @@ PciAnd32 (
   read and write operations are serialized.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
@@ -853,6 +868,7 @@ PciAndThenOr32 (
   returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -886,6 +902,7 @@ PciBitFieldRead32 (
   32-bit register is returned.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -924,6 +941,7 @@ PciBitFieldWrite32 (
   are serialized. Extra left bits in OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -962,6 +980,7 @@ PciBitFieldOr32 (
   serialized. Extra left bits in AndData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1002,6 +1021,7 @@ PciBitFieldAnd32 (
   OrData are stripped.\r
 \r
   If Address > 0x0FFFFFFF, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
index 4f552ebb0b219f32b418e7cca92b867f75303aef..e5d05fbe8c4d3b7cc053781fb8851b3878452d65 100644 (file)
@@ -957,7 +957,7 @@ LibPcdGetNextTokenSpace (
                                 In out, returns actual size of buffer is set.\r
   @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
 \r
-  @return Return the pinter to the buffer been set.\r
+  @return Return the pointer to the buffer been set.\r
   @retval NULL   If SizeOfBuffer is set to MAX_ADDRESS or larger than MaximumDatumSize, \r
                  then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned.\r
 **/\r
index 6ce460a8c2752d46d3c033c1f06ee5d77b1d8537..040e26a292d619b96d67f582ca249602d47119ae 100644 (file)
@@ -129,6 +129,7 @@ AllocateReservedPages (
   Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer.  Buffer\r
   must have been allocated on a previous call to the page allocation services of the Memory\r
   Allocation Library.\r
+  \r
   If Buffer was not allocated with a page allocation function in the Memory Allocation Library,\r
   then ASSERT().\r
   If Pages is zero, then ASSERT().\r
@@ -207,6 +208,7 @@ InternalAllocateAlignedPages (
   alignment specified by Alignment.  The allocated buffer is returned.  If Pages is 0, then NULL is\r
   returned.  If there is not enough memory at the specified alignment remaining to satisfy the\r
   request, then NULL is returned.\r
+  \r
   If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
 \r
   @param  Pages                 The number of 4 KB pages to allocate.\r
@@ -233,6 +235,7 @@ AllocateAlignedPages (
   alignment specified by Alignment.  The allocated buffer is returned.  If Pages is 0, then NULL is\r
   returned.  If there is not enough memory at the specified alignment remaining to satisfy the\r
   request, then NULL is returned.\r
+  \r
   If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
 \r
   @param  Pages                 The number of 4 KB pages to allocate.\r
@@ -259,6 +262,7 @@ AllocateAlignedRuntimePages (
   alignment specified by Alignment.  The allocated buffer is returned.  If Pages is 0, then NULL is\r
   returned.  If there is not enough memory at the specified alignment remaining to satisfy the\r
   request, then NULL is returned.\r
+  \r
   If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
 \r
   @param  Pages                 The number of 4 KB pages to allocate.\r
@@ -285,6 +289,7 @@ AllocateAlignedReservedPages (
   Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer.  Buffer\r
   must have been allocated on a previous call to the aligned page allocation services of the Memory\r
   Allocation Library.\r
+  \r
   If Buffer was not allocated with an aligned page allocation function in the Memory Allocation\r
   Library, then ASSERT().\r
   If Pages is zero, then ASSERT().\r
@@ -546,6 +551,7 @@ InternalAllocateCopyPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
@@ -581,6 +587,7 @@ AllocateCopyPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
@@ -607,6 +614,7 @@ AllocateRuntimeCopyPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
@@ -773,6 +781,7 @@ ReallocateReservedPool (
 \r
   Frees the buffer specified by Buffer.  Buffer must have been allocated on a previous call to the\r
   pool allocation services of the Memory Allocation Library.\r
+  \r
   If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r
   then ASSERT().\r
 \r
index 34faae61d8c24b27168b9f7aa83ebb20c70394d3..d0d9b3ddd3b212921803008ab2ba0e7e0c73bf81 100644 (file)
@@ -1,16 +1,15 @@
 /** @file\r
   PAL Call Services Function.\r
 \r
-  Copyright (c) 2006 -2008, Intel Corporation All rights\r
-  reserved. This program and the accompanying materials are\r
-  licensed and made available under the terms and conditions of\r
-  the BSD License which accompanies this distribution.  The full\r
-  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
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
+    \r
 **/\r
 \r
 \r
index 2766817b4307cdd0a611fca19d146d864b336387..8f9b7fa64e1f87bb73ac863a0ca742e2b7f00418 100644 (file)
@@ -926,6 +926,8 @@ LibPcdGetNextTokenSpace (
 \r
 \r
 /**\r
+  Sets a value of a patchable PCD entry that is type pointer.\r
+  \r
   Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
   and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than \r
   MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
@@ -941,10 +943,9 @@ LibPcdGetNextTokenSpace (
                                 the target of the set operation.\r
   @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.\r
   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.\r
-                                In out, returns actual size of buffer is set.\r
   @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
   \r
-  @return Return the pinter to the buffer been set.\r
+  @return Return the pointer to the buffer been set.\r
 \r
 **/\r
 VOID *\r
index 71b149639fdabc67f815b58fe34fed6870d894cb..ddae8dbfc34426a1a0ffa7cd96092893bc676b37 100644 (file)
@@ -512,7 +512,7 @@ PciBitFieldAndThenOr8 (
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
 \r
-  @return The value read from the PCI configuration register.\r
+  @return The read value from the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -538,7 +538,7 @@ PciRead16 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Data    The value to write.\r
+  @param  Value   The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -866,7 +866,7 @@ PciBitFieldAndThenOr16 (
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
 \r
-  @return The value read from the PCI configuration register.\r
+  @return The read value from the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -892,7 +892,7 @@ PciRead32 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Data    The value to write.\r
+  @param  Value   The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
index c4d744c0aee85991ec6680e024defea371cfe5b6..d89393999213b2f25ce375227d69b69ef10f5ee2 100644 (file)
@@ -577,6 +577,7 @@ InternalAllocateCopyPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r