tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Synchronize interface function comment from declaration in library class header file to implementation in library instance. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6957 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-12-10 03:28:54 +00:00
parent 530e25f536
commit 070a76b193
12 changed files with 386 additions and 393 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c
View File

@ -68,7 +68,7 @@ SmbusLibConstructor (
@param Status Return status for the executed command. @param Status Return status for the executed command.
This is an optional parameter and may be NULL. This is an optional parameter and may be NULL.
@return The actual number of bytes that are executed for this operation.. @return The actual number of bytes that are executed for this operation.
**/ **/
UINTN UINTN

3
MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
View File

@ -79,7 +79,8 @@ _DriverUnloadHandler (
@param ImageHandle ImageHandle of the loaded driver. @param ImageHandle ImageHandle of the loaded driver.
@param SystemTable Pointer to the EFI System Table. @param SystemTable Pointer to the EFI System Table.
@retval EFI_SUCCESS One or more of the drivers returned a success code. @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
or UEFI Driver exited normally.
@retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision. @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
@retval Other Return value from ProcessModuleEntryPointList(). @retval Other Return value from ProcessModuleEntryPointList().

1
MdePkg/Library/UefiLib/UefiLib.c
View File

@ -689,7 +689,6 @@ LookupUnicodeString (
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
LookupUnicodeString2 ( LookupUnicodeString2 (
IN CONST CHAR8 *Language, IN CONST CHAR8 *Language,

34
MdePkg/Library/UefiLib/UefiNotTiano.c
View File

@ -75,8 +75,8 @@ EfiCreateEventLegacyBoot (
/** /**
Create an EFI event in the Legacy Boot Event Group and allows Create an EFI event in the Legacy Boot Event Group and allows
the caller to specify a notification function. the caller to specify a notification function.
This function abstracts the creation of the Legacy Boot Event. This function abstracts the creation of the Legacy Boot Event.
The Framework moved from a proprietary to UEFI 2.0 based mechanism. The Framework moved from a proprietary to UEFI 2.0 based mechanism.
This library abstracts the caller from how this event is created to prevent This library abstracts the caller from how this event is created to prevent
@ -160,8 +160,8 @@ EfiCreateEventReadyToBoot (
/** /**
Create an EFI event in the Ready To Boot Event Group and allows Create an EFI event in the Ready To Boot Event Group and allows
the caller to specify a notification function. the caller to specify a notification function.
This function abstracts the creation of the Ready to Boot Event. This function abstracts the creation of the Ready to Boot Event.
The Framework moved from a proprietary to UEFI 2.0 based mechanism. The Framework moved from a proprietary to UEFI 2.0 based mechanism.
This library abstracts the caller from how this event is created to prevent This library abstracts the caller from how this event is created to prevent
@ -282,17 +282,17 @@ EfiSignalEventLegacyBoot (
@retval Other FvDevicePathNode is valid and pointer to NameGuid was returned. @retval Other FvDevicePathNode is valid and pointer to NameGuid was returned.
**/ **/
EFI_GUID* EFI_GUID *
EFIAPI EFIAPI
EfiGetNameGuidFromFwVolDevicePathNode ( EfiGetNameGuidFromFwVolDevicePathNode (
IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvFileDevicePathNode IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode
) )
{ {
ASSERT (FvFileDevicePathNode != NULL); ASSERT (FvDevicePathNode != NULL);
if (DevicePathType (&FvFileDevicePathNode->Header) == MEDIA_DEVICE_PATH && if (DevicePathType (&FvDevicePathNode->Header) == MEDIA_DEVICE_PATH &&
DevicePathSubType (&FvFileDevicePathNode->Header) == MEDIA_PIWG_FW_FILE_DP) { DevicePathSubType (&FvDevicePathNode->Header) == MEDIA_PIWG_FW_FILE_DP) {
return (EFI_GUID *) &FvFileDevicePathNode->FvFileName; return (EFI_GUID *) &FvDevicePathNode->FvFileName;
} }
return NULL; return NULL;
@ -318,20 +318,20 @@ EfiGetNameGuidFromFwVolDevicePathNode (
VOID VOID
EFIAPI EFIAPI
EfiInitializeFwVolDevicepathNode ( EfiInitializeFwVolDevicepathNode (
IN OUT MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvFileDevicePathNode, IN OUT MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode,
IN CONST EFI_GUID *NameGuid IN CONST EFI_GUID *NameGuid
) )
{ {
ASSERT (FvFileDevicePathNode != NULL); ASSERT (FvDevicePathNode != NULL);
ASSERT (NameGuid != NULL); ASSERT (NameGuid != NULL);
// //
// Use the new Device path that does not conflict with the UEFI // Use the new Device path that does not conflict with the UEFI
// //
FvFileDevicePathNode->Header.Type = MEDIA_DEVICE_PATH; FvDevicePathNode->Header.Type = MEDIA_DEVICE_PATH;
FvFileDevicePathNode->Header.SubType = MEDIA_PIWG_FW_FILE_DP; FvDevicePathNode->Header.SubType = MEDIA_PIWG_FW_FILE_DP;
SetDevicePathNodeLength (&FvFileDevicePathNode->Header, sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH)); SetDevicePathNodeLength (&FvDevicePathNode->Header, sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH));
CopyGuid (&FvFileDevicePathNode->FvFileName, NameGuid); CopyGuid (&FvDevicePathNode->FvFileName, NameGuid);
} }

4
MdePkg/Library/UefiMemoryLib/CompareMemWrapper.c
View File

@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer. mismatched byte in DestinationBuffer.
If Length > 0 and DestinationBuffer is NULL, then ASSERT(). If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT(). If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@return 0 All Length bytes of the two buffers are identical. @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first @retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer. mismatched byte in DestinationBuffer.
**/ **/
INTN INTN
EFIAPI EFIAPI

30
MdePkg/Library/UefiMemoryLib/MemLibInternals.h
View File

@ -36,38 +36,42 @@
#include <Library/BaseLib.h> #include <Library/BaseLib.h>
/** /**
Copy Length bytes from Source to Destination. Copies a source buffer to a destination buffer, and returns the destination buffer.
@param DestinationBuffer Target of copy This function wraps the gBS->CopyMem().
@param SourceBuffer Place to copy from
@param Length Number of bytes to copy
@return Destination @param DestinationBuffer Pointer to the destination buffer of the memory copy.
@param SourceBuffer Pointer to the source buffer of the memory copy.
@param Length Number of bytes to copy from SourceBuffer to DestinationBuffer.
@return DestinationBuffer.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
InternalMemCopyMem ( InternalMemCopyMem (
OUT VOID *DestinationBuffer, OUT VOID *Destination,
IN CONST VOID *SourceBuffer, IN CONST VOID *Source,
IN UINTN Length IN UINTN Length
); );
/** /**
Set Buffer to Value for Size bytes. Fills a target buffer with a byte value, and returns the target buffer.
@param Buffer Memory to set. This function wraps the gBS->SetMem().
@param Length Number of bytes to set
@param Value Value of the set operation.
@return Buffer @param Buffer Memory to set.
@param Size Number of bytes to set.
@param Value Value of the set operation.
@return Buffer.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
InternalMemSetMem ( InternalMemSetMem (
OUT VOID *Buffer, OUT VOID *Buffer,
IN UINTN Length, IN UINTN Size,
IN UINT8 Value IN UINT8 Value
); );

31
MdePkg/Library/UefiPciLibPciRootBridgeIo/PciLib.c
View File

@ -143,9 +143,12 @@ DxePciLibPciRootBridgeIoWriteWorker (
} }
/** /**
Register a PCI device so PCI configuration registers may be accessed after Registers a PCI device so PCI configuration registers may be accessed after
SetVirtualAddressMap(). SetVirtualAddressMap().
Registers the PCI device specified by Address so all the PCI configuration registers
associated with that PCI device may be accessed after SetVirtualAddressMap() is called.
If Address > 0x0FFFFFFF, then ASSERT(). If Address > 0x0FFFFFFF, then ASSERT().
@param Address Address that encodes the PCI Bus, Device, Function and @param Address Address that encodes the PCI Bus, Device, Function and
@ -181,7 +184,7 @@ PciRegisterForRuntimeAccess (
@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.
**/ **/
UINT8 UINT8
@ -206,7 +209,7 @@ PciRead8 (
@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.
@ -215,12 +218,12 @@ UINT8
EFIAPI EFIAPI
PciWrite8 ( PciWrite8 (
IN UINTN Address, IN UINTN Address,
IN UINT8 Data IN UINT8 Value
) )
{ {
ASSERT_INVALID_PCI_ADDRESS (Address, 0); ASSERT_INVALID_PCI_ADDRESS (Address, 0);
return (UINT8) DxePciLibPciRootBridgeIoWriteWorker (Address, EfiPciWidthUint8, Data); return (UINT8) DxePciLibPciRootBridgeIoWriteWorker (Address, EfiPciWidthUint8, Value);
} }
/** /**
@ -526,7 +529,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
@ -552,7 +555,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.
@ -561,12 +564,12 @@ UINT16
EFIAPI EFIAPI
PciWrite16 ( PciWrite16 (
IN UINTN Address, IN UINTN Address,
IN UINT16 Data IN UINT16 Value
) )
{ {
ASSERT_INVALID_PCI_ADDRESS (Address, 1); ASSERT_INVALID_PCI_ADDRESS (Address, 1);
return (UINT16) DxePciLibPciRootBridgeIoWriteWorker (Address, EfiPciWidthUint16, Data); return (UINT16) DxePciLibPciRootBridgeIoWriteWorker (Address, EfiPciWidthUint16, Value);
} }
/** /**
@ -880,7 +883,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
@ -906,7 +909,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.
@ -915,12 +918,12 @@ UINT32
EFIAPI EFIAPI
PciWrite32 ( PciWrite32 (
IN UINTN Address, IN UINTN Address,
IN UINT32 Data IN UINT32 Value
) )
{ {
ASSERT_INVALID_PCI_ADDRESS (Address, 3); ASSERT_INVALID_PCI_ADDRESS (Address, 3);
return DxePciLibPciRootBridgeIoWriteWorker (Address, EfiPciWidthUint32, Data); return DxePciLibPciRootBridgeIoWriteWorker (Address, EfiPciWidthUint32, Value);
} }
/** /**
@ -1339,7 +1342,7 @@ PciReadBuffer (
@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

626
MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.c
View File

File diff suppressed because it is too large Load Diff

36
MdePkg/Library/UefiRuntimeLib/RuntimeService.c
View File

@ -87,7 +87,7 @@ EFI_STATUS
EFIAPI EFIAPI
EfiGetTime ( EfiGetTime (
OUT EFI_TIME *Time, OUT EFI_TIME *Time,
OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL
) )
{ {
return mRT->GetTime (Time, Capabilities); return mRT->GetTime (Time, Capabilities);
@ -186,7 +186,7 @@ EFI_STATUS
EFIAPI EFIAPI
EfiSetWakeupTime ( EfiSetWakeupTime (
IN BOOLEAN Enable, IN BOOLEAN Enable,
IN EFI_TIME *Time OPTIONAL IN EFI_TIME *Time OPTIONAL
) )
{ {
return mRT->SetWakeupTime (Enable, Time); return mRT->SetWakeupTime (Enable, Time);
@ -226,11 +226,11 @@ EfiSetWakeupTime (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiGetVariable ( EfiGetVariable (
IN CHAR16 *VariableName, IN CHAR16 *VariableName,
IN EFI_GUID * VendorGuid, IN EFI_GUID *VendorGuid,
OUT UINT32 *Attributes OPTIONAL, OUT UINT32 *Attributes OPTIONAL,
IN OUT UINTN *DataSize, IN OUT UINTN *DataSize,
OUT VOID *Data OUT VOID *Data
) )
{ {
return mRT->GetVariable (VariableName, VendorGuid, Attributes, DataSize, Data); return mRT->GetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);
@ -545,9 +545,9 @@ EfiSetVirtualAddressMap (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiUpdateCapsule ( EfiUpdateCapsule (
IN EFI_CAPSULE_HEADER **CapsuleHeaderArray, IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
IN UINTN CapsuleCount, IN UINTN CapsuleCount,
IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
) )
{ {
return mRT->UpdateCapsule ( return mRT->UpdateCapsule (
@ -595,10 +595,10 @@ EfiUpdateCapsule (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiQueryCapsuleCapabilities ( EfiQueryCapsuleCapabilities (
IN EFI_CAPSULE_HEADER **CapsuleHeaderArray, IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
IN UINTN CapsuleCount, IN UINTN CapsuleCount,
OUT UINT64 *MaximumCapsuleSize, OUT UINT64 *MaximumCapsuleSize,
OUT EFI_RESET_TYPE *ResetType OUT EFI_RESET_TYPE *ResetType
) )
{ {
return mRT->QueryCapsuleCapabilities ( return mRT->QueryCapsuleCapabilities (
@ -647,10 +647,10 @@ EfiQueryCapsuleCapabilities (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiQueryVariableInfo ( EfiQueryVariableInfo (
IN UINT32 Attributes, IN UINT32 Attributes,
OUT UINT64 *MaximumVariableStorageSize, OUT UINT64 *MaximumVariableStorageSize,
OUT UINT64 *RemainingVariableStorageSize, OUT UINT64 *RemainingVariableStorageSize,
OUT UINT64 *MaximumVariableSize OUT UINT64 *MaximumVariableSize
) )
{ {
return mRT->QueryVariableInfo ( return mRT->QueryVariableInfo (

4
MdePkg/Library/UefiScsiLib/UefiScsiLib.c
View File

@ -192,7 +192,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
@ -338,7 +338,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.

6
MdePkg/Library/UefiUsbLib/Hid.c
View File

@ -98,7 +98,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.
@ -389,7 +389,7 @@ UsbSetReportRequest (
IN UINT8 Interface, IN UINT8 Interface,
IN UINT8 ReportId, IN UINT8 ReportId,
IN UINT8 ReportType, IN UINT8 ReportType,
IN UINT16 ReportLength, IN UINT16 ReportLen,
IN UINT8 *Report IN UINT8 *Report
) )
{ {
@ -415,7 +415,7 @@ UsbSetReportRequest (
EfiUsbDataOut, EfiUsbDataOut,
TIMEOUT_VALUE, TIMEOUT_VALUE,
Report, Report,
ReportLength, ReportLen,
&Status &Status
); );

2
MdePkg/Library/UefiUsbLib/UsbDxeLib.c
View File

@ -590,7 +590,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().