Synchronize function comment in h file

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
This commit is contained in:
gikidy
2008-11-26 06:57:44 +00:00
parent 122e219151
commit 9638ba6d3f
20 changed files with 106 additions and 56 deletions

View File

@ -1,7 +1,7 @@
/** @file /** @file
Provide services to access I/O Ports and MMIO registers. Provide services to access I/O Ports and MMIO registers.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

View File

@ -9,15 +9,14 @@
can contain a constructor to look up the PAL Entry Point from a HOB. This library class can contain a constructor to look up the PAL Entry Point from a HOB. This library class
is only available on IPF. is only available on IPF.
Copyright (c) 2006 -2008, Intel Corporation All rights Copyright (c) 2006 - 2008, Intel Corporation<BR>
reserved. This program and the accompanying materials are All rights reserved. This program and the accompanying materials
licensed and made available under the terms and conditions of are licensed and made available under the terms and conditions of the BSD License
the BSD License which accompanies this distribution. The full which accompanies this distribution. The full text of the license may be found at
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, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/

View File

@ -1504,7 +1504,7 @@ LibPcdGetNextTokenSpace (
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to used to set the target variable. @param[in] Buffer A pointer to the buffer to used to set the target variable.
@return Return the pinter to the buffer been set. @return Return the pointer to the buffer been set.
**/ **/
VOID * VOID *

View File

@ -5,7 +5,7 @@
configuration cycles must be though I/O ports 0xCF8 and 0xCFC. This library only allows configuration cycles must be though I/O ports 0xCF8 and 0xCFC. This library only allows
access to PCI Segment #0. access to PCI Segment #0.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

View File

@ -5,7 +5,7 @@
configuration cycles must be though the 256 MB PCI Express MMIO window whose base address configuration cycles must be though the 256 MB PCI Express MMIO window whose base address
is defined by PcdPciExpressBaseAddress. is defined by PcdPciExpressBaseAddress.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

View File

@ -10,7 +10,7 @@
these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use
explicit access methods. explicit access methods.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

View File

@ -48,7 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
If SenseDataLength is 0, then this parameter is If SenseDataLength is 0, then this parameter is
optional and may be NULL. optional and may be NULL.
@param[in, out] SenseDataLength On input, a pointer to the length in bytes of @param[in, out] SenseDataLength On input, a pointer to the length in bytes of
the SenseData buffer. On output, a poiinter to the SenseData buffer. On output, a pointer to
the number of bytes written to the SenseData buffer. the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that produces @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces
the SCSI bus containing the SCSI target specified by the SCSI bus containing the SCSI target specified by
@ -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 See the EFI SCSI I/O Protocol in the UEFI Specification
for details on the possible return values. for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified @param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was executed by ScsiIo when the SCSI Request Packet was executed
on the SCSI Host Controller. See the EFI SCSI I/O on the SCSI Host Controller. See the EFI SCSI I/O
Protocol in the UEFI Specification for details on Protocol in the UEFI Specification for details on
the possible return values. the possible return values.
@ -135,7 +135,7 @@ ScsiTestUnitReadyCommand (
SCSI I/O Protocol in the UEFI Specification SCSI I/O Protocol in the UEFI Specification
for details on the possible return values. for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified @param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was by ScsiIo when the SCSI Request Packet was
executed on the SCSI Host Controller. executed on the SCSI Host Controller.
See the EFI SCSI I/O Protocol in the UEFI See the EFI SCSI I/O Protocol in the UEFI
Specification for details on the possible Specification for details on the possible
@ -231,7 +231,7 @@ ScsiInquiryCommand (
UEFI Specification for details on the possible UEFI Specification for details on the possible
return values. return values.
@param[out] TargetStatus The status returned by the SCSI target specified @param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was executed by ScsiIo when the SCSI Request Packet was executed
on the SCSI Host Controller. See the EFI SCSI on the SCSI Host Controller. See the EFI SCSI
I/O Protocol in the UEFI Specification for details I/O Protocol in the UEFI Specification for details
on the possible return values. on the possible return values.

View File

@ -68,7 +68,7 @@ UsbGetHidDescriptor (
@retval EFI_SUCCESS The request executed successfully. @retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the @retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and DescriptorBuffer buffer specified by DescriptorLength and DescriptorBuffer
is not large enough to hold the result of the request. is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request. @retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. @retval EFI_DEVICE_ERROR The request failed due to a device error.
@ -542,7 +542,7 @@ UsbGetStatus (
Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint. Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.
If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND. If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.
If the endpoint descriptor is found, then clear the halt fature of this USB endpoint. If the endpoint descriptor is found, then clear the halt feature of this USB endpoint.
The status of the transfer is returned in Status. The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT(). If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT(). If Status is NULL, then ASSERT().

View File

@ -2,16 +2,17 @@
Template and Sample instance of PalCallLib. Template and Sample instance of PalCallLib.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 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, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
#include <Base.h> #include <Base.h>
#include <Library/PalLib.h> #include <Library/PalLib.h>
#include <Library/DebugLib.h> #include <Library/DebugLib.h>

View File

@ -778,8 +778,6 @@ LibPcdGetNextToken (
then NULL is returned. then NULL is returned.
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT(). If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace @param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
to start the search. to start the search.
@ -799,25 +797,27 @@ LibPcdGetNextTokenSpace (
} }
/** /**
Sets a value of a patchable PCD entry that is type pointer.
Sets the PCD entry specified by PatchVariable to the value specified by Buffer Sets the PCD entry specified by PatchVariable to the value specified by Buffer
and SizeOfValue. Buffer is returned. If SizeOfValue is greater than and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than
MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return
NULL to indicate that the set operation was not actually performed. NULL to indicate that the set operation was not actually performed.
If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to
MaximumDatumSize and NULL must be returned. MaximumDatumSize and NULL must be returned.
If PatchVariable is NULL, then ASSERT(). If PatchVariable is NULL, then ASSERT().
If SizeOfValue is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT().
If SizeOfValue > 0 and Buffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
@param[in] PatchVariable A pointer to the global variable in a module that is @param[in] PatchVariable A pointer to the global variable in a module that is
the target of the set operation. the target of the set operation.
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to used to set the target variable. @param[in] Buffer A pointer to the buffer to used to set the target variable.
@return Return the pinter to the buffer been set.
@return Return the pointer to the buffer been set.
**/ **/
VOID * VOID *

View File

@ -1316,7 +1316,7 @@ PciCf8BitFieldAndThenOr32(
@param Size Size in bytes of the transfer. @param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer receiving the data read. @param Buffer Pointer to a buffer receiving the data read.
@return Size @return Size read from StartAddress.
**/ **/
UINTN UINTN
@ -1416,7 +1416,7 @@ PciCf8ReadBuffer (
@param Size Size in bytes of the transfer. @param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write. @param Buffer Pointer to a buffer containing the data to write.
@return Size @return Size written to StartAddress.
**/ **/
UINTN UINTN

View File

@ -1221,7 +1221,7 @@ PciExpressBitFieldAndThenOr32 (
@param Size Size in bytes of the transfer. @param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer receiving the data read. @param Buffer Pointer to a buffer receiving the data read.
@return Size @return Size read data from StartAddress.
**/ **/
UINTN UINTN
@ -1321,7 +1321,7 @@ PciExpressReadBuffer (
@param Size Size in bytes of the transfer. @param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write. @param Buffer Pointer to a buffer containing the data to write.
@return Size @return Size written to StartAddress.
**/ **/
UINTN UINTN

View File

@ -382,6 +382,7 @@ PciBitFieldAndThenOr8 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -406,6 +407,7 @@ PciRead16 (
that all PCI read and write operations are serialized. that all PCI read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -436,6 +438,7 @@ PciWrite16 (
are serialized. are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -466,6 +469,7 @@ PciOr16 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -497,6 +501,7 @@ PciAnd16 (
read and write operations are serialized. read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -525,6 +530,7 @@ PciAndThenOr16 (
returned. returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -558,6 +564,7 @@ PciBitFieldRead16 (
16-bit register is returned. 16-bit register is returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -596,6 +603,7 @@ PciBitFieldWrite16 (
are serialized. Extra left bits in OrData are stripped. are serialized. Extra left bits in OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -634,6 +642,7 @@ PciBitFieldOr16 (
serialized. Extra left bits in AndData are stripped. serialized. Extra left bits in AndData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -674,6 +683,7 @@ PciBitFieldAnd16 (
OrData are stripped. OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -710,6 +720,7 @@ PciBitFieldAndThenOr16 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -734,6 +745,7 @@ PciRead32 (
that all PCI read and write operations are serialized. that all PCI read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -764,6 +776,7 @@ PciWrite32 (
are serialized. are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -794,6 +807,7 @@ PciOr32 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -825,6 +839,7 @@ PciAnd32 (
read and write operations are serialized. read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -853,6 +868,7 @@ PciAndThenOr32 (
returned. returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -886,6 +902,7 @@ PciBitFieldRead32 (
32-bit register is returned. 32-bit register is returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -924,6 +941,7 @@ PciBitFieldWrite32 (
are serialized. Extra left bits in OrData are stripped. are serialized. Extra left bits in OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -962,6 +980,7 @@ PciBitFieldOr32 (
serialized. Extra left bits in AndData are stripped. serialized. Extra left bits in AndData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -1002,6 +1021,7 @@ PciBitFieldAnd32 (
OrData are stripped. OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

View File

@ -382,6 +382,7 @@ PciBitFieldAndThenOr8 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -406,10 +407,11 @@ PciRead16 (
that all PCI read and write operations are serialized. that all PCI read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@param Value The value to write. @param Value The value to write.
@return The value written to the PCI configuration register. @return The value written to the PCI configuration register.
@ -436,6 +438,7 @@ PciWrite16 (
are serialized. are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -466,6 +469,7 @@ PciOr16 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -497,6 +501,7 @@ PciAnd16 (
read and write operations are serialized. read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -525,6 +530,7 @@ PciAndThenOr16 (
returned. returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -558,6 +564,7 @@ PciBitFieldRead16 (
16-bit register is returned. 16-bit register is returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -596,6 +603,7 @@ PciBitFieldWrite16 (
are serialized. Extra left bits in OrData are stripped. are serialized. Extra left bits in OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -634,6 +642,7 @@ PciBitFieldOr16 (
serialized. Extra left bits in AndData are stripped. serialized. Extra left bits in AndData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -674,6 +683,7 @@ PciBitFieldAnd16 (
OrData are stripped. OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT(). If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -710,6 +720,7 @@ PciBitFieldAndThenOr16 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -734,6 +745,7 @@ PciRead32 (
that all PCI read and write operations are serialized. that all PCI read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -764,6 +776,7 @@ PciWrite32 (
are serialized. are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -794,6 +807,7 @@ PciOr32 (
serialized. serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -825,6 +839,7 @@ PciAnd32 (
read and write operations are serialized. read and write operations are serialized.
If Address > 0x0FFFFFFF, then ASSERT(). 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 Address that encodes the PCI Bus, Device, Function and
Register. Register.
@ -853,6 +868,7 @@ PciAndThenOr32 (
returned. returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -886,6 +902,7 @@ PciBitFieldRead32 (
32-bit register is returned. 32-bit register is returned.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -924,6 +941,7 @@ PciBitFieldWrite32 (
are serialized. Extra left bits in OrData are stripped. are serialized. Extra left bits in OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -962,6 +980,7 @@ PciBitFieldOr32 (
serialized. Extra left bits in AndData are stripped. serialized. Extra left bits in AndData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().
@ -1002,6 +1021,7 @@ PciBitFieldAnd32 (
OrData are stripped. OrData are stripped.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT(). If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

View File

@ -957,7 +957,7 @@ LibPcdGetNextTokenSpace (
In out, returns actual size of buffer is set. In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to used to set the target variable. @param[in] Buffer A pointer to the buffer to used to set the target variable.
@return Return the pinter to the buffer been set. @return Return the pointer to the buffer been set.
@retval NULL If SizeOfBuffer is set to MAX_ADDRESS or larger than MaximumDatumSize, @retval NULL If SizeOfBuffer is set to MAX_ADDRESS or larger than MaximumDatumSize,
then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned. then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned.
**/ **/

View File

@ -129,6 +129,7 @@ AllocateReservedPages (
Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
must have been allocated on a previous call to the page allocation services of the Memory must have been allocated on a previous call to the page allocation services of the Memory
Allocation Library. Allocation Library.
If Buffer was not allocated with a page allocation function in the Memory Allocation Library, If Buffer was not allocated with a page allocation function in the Memory Allocation Library,
then ASSERT(). then ASSERT().
If Pages is zero, then ASSERT(). If Pages is zero, then ASSERT().
@ -207,6 +208,7 @@ InternalAllocateAlignedPages (
alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
returned. If there is not enough memory at the specified alignment remaining to satisfy the returned. If there is not enough memory at the specified alignment remaining to satisfy the
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@ -233,6 +235,7 @@ AllocateAlignedPages (
alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
returned. If there is not enough memory at the specified alignment remaining to satisfy the returned. If there is not enough memory at the specified alignment remaining to satisfy the
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@ -259,6 +262,7 @@ AllocateAlignedRuntimePages (
alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
returned. If there is not enough memory at the specified alignment remaining to satisfy the returned. If there is not enough memory at the specified alignment remaining to satisfy the
request, then NULL is returned. request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate. @param Pages The number of 4 KB pages to allocate.
@ -285,6 +289,7 @@ AllocateAlignedReservedPages (
Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
must have been allocated on a previous call to the aligned page allocation services of the Memory must have been allocated on a previous call to the aligned page allocation services of the Memory
Allocation Library. Allocation Library.
If Buffer was not allocated with an aligned page allocation function in the Memory Allocation If Buffer was not allocated with an aligned page allocation function in the Memory Allocation
Library, then ASSERT(). Library, then ASSERT().
If Pages is zero, then ASSERT(). If Pages is zero, then ASSERT().
@ -546,6 +551,7 @@ InternalAllocateCopyPool (
AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned. is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@ -581,6 +587,7 @@ AllocateCopyPool (
AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned. is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@ -607,6 +614,7 @@ AllocateRuntimeCopyPool (
AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned. is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@ -773,6 +781,7 @@ ReallocateReservedPool (
Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
pool allocation services of the Memory Allocation Library. pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library, If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
then ASSERT(). then ASSERT().

View File

@ -1,16 +1,15 @@
/** @file /** @file
PAL Call Services Function. PAL Call Services Function.
Copyright (c) 2006 -2008, Intel Corporation All rights Copyright (c) 2006 - 2008, Intel Corporation<BR>
reserved. This program and the accompanying materials are All rights reserved. This program and the accompanying materials
licensed and made available under the terms and conditions of are licensed and made available under the terms and conditions of the BSD License
the BSD License which accompanies this distribution. The full which accompanies this distribution. The full text of the license may be found at
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.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/

View File

@ -926,6 +926,8 @@ LibPcdGetNextTokenSpace (
/** /**
Sets a value of a patchable PCD entry that is type pointer.
Sets the PCD entry specified by PatchVariable to the value specified by Buffer Sets the PCD entry specified by PatchVariable to the value specified by Buffer
and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than
MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return
@ -941,10 +943,9 @@ LibPcdGetNextTokenSpace (
the target of the set operation. the target of the set operation.
@param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to used to set the target variable. @param[in] Buffer A pointer to the buffer to used to set the target variable.
@return Return the pinter to the buffer been set. @return Return the pointer to the buffer been set.
**/ **/
VOID * VOID *

View File

@ -512,7 +512,7 @@ PciBitFieldAndThenOr8 (
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
Register. Register.
@return The value read from the PCI configuration register. @return The read value from the PCI configuration register.
**/ **/
UINT16 UINT16
@ -538,7 +538,7 @@ PciRead16 (
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
Register. Register.
@param Data The value to write. @param Value The value to write.
@return The value written to the PCI configuration register. @return The value written to the PCI configuration register.
@ -866,7 +866,7 @@ PciBitFieldAndThenOr16 (
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
Register. Register.
@return The value read from the PCI configuration register. @return The read value from the PCI configuration register.
**/ **/
UINT32 UINT32
@ -892,7 +892,7 @@ PciRead32 (
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
Register. Register.
@param Data The value to write. @param Value The value to write.
@return The value written to the PCI configuration register. @return The value written to the PCI configuration register.

View File

@ -577,6 +577,7 @@ InternalAllocateCopyPool (
AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned. is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().