From c311f86b23f334412fa0b57ede8b4daec7ec66fe Mon Sep 17 00:00:00 2001 From: yshang1 Date: Thu, 3 Apr 2008 04:56:34 +0000 Subject: [PATCH] [Description] Scrub MdePkg: - Add file description with doxygen format. - Add calling convention of library class in MdePkg. - Add function descriptions of public protocol/library class. [Impaction] It should be backward-compatible. [Ref Info] N/A git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4985 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Guid/HiiKeyBoardLayout.h | 2 ++ .../IndustryStandard/IScsiBootFirmwareTable.h | 24 +++++++------------ .../Library/PeiServicesTablePointerLib.h | 1 + MdePkg/Include/Pi/PiHob.h | 2 +- MdePkg/Include/Ppi/Decompress.h | 2 +- MdePkg/Include/Ppi/FirmwareVolume.h | 2 +- MdePkg/Include/Ppi/FirmwareVolumeInfo.h | 2 +- MdePkg/Include/Ppi/GuidedSectionExtraction.h | 2 +- MdePkg/Include/Ppi/LoadImage.h | 2 +- MdePkg/Include/Ppi/Pcd.h | 2 +- MdePkg/Include/Ppi/TemporaryRamSupport.h | 2 +- MdePkg/Include/Protocol/Arp.h | 11 +++++++++ MdePkg/Include/Protocol/DebugPort.h | 5 ++++ MdePkg/Include/Protocol/Ip4.h | 12 ++++++++++ MdePkg/Include/Protocol/Ip4Config.h | 5 +++- MdePkg/Include/Protocol/ServiceBinding.h | 5 ++++ MdePkg/Include/Uefi/UefiBaseType.h | 19 +++++++-------- MdePkg/Include/Uefi/UefiGpt.h | 2 +- MdePkg/Include/Uefi/UefiTcgPlatform.h | 3 ++- .../PeiServicesTablePointer.c | 1 + MdePkg/Library/UefiUsbLib/Hid.c | 19 ++++++++------- MdePkg/Library/UefiUsbLib/UsbDxeLib.c | 23 ++++++++++-------- 22 files changed, 93 insertions(+), 55 deletions(-) diff --git a/MdePkg/Include/Guid/HiiKeyBoardLayout.h b/MdePkg/Include/Guid/HiiKeyBoardLayout.h index 3c29bd725e..cb76307c55 100644 --- a/MdePkg/Include/Guid/HiiKeyBoardLayout.h +++ b/MdePkg/Include/Guid/HiiKeyBoardLayout.h @@ -1,5 +1,7 @@ /** @file + HII keyboard layout GUID as defined in UEFI2.1 specification + Copyright (c) 2006 - 2007, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License diff --git a/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h b/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h index 3d249d3d63..d47430b82f 100644 --- a/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h +++ b/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h @@ -1,23 +1,17 @@ /** @file -Copyright (c) 2005 - 2007, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -Module Name: - - IScsiBootFirmwareTable.h - -Abstract: - The definition for iSCSI Boot Firmware Table, it's defined in Microsoft iBFT document. + Copyright (c) 2006 - 2007, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + **/ #ifndef _ISCSI_BOOT_FIRMWARE_TABLE_H_ diff --git a/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/MdePkg/Include/Library/PeiServicesTablePointerLib.h index f6ced47265..8c133dd108 100644 --- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h +++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h @@ -50,6 +50,7 @@ SetPeiServicesTablePointer ( @param PeiServices The address of PeiServices pointer. **/ VOID +EFIAPI MigrateIdtTable ( IN EFI_PEI_SERVICES **PeiServices ); diff --git a/MdePkg/Include/Pi/PiHob.h b/MdePkg/Include/Pi/PiHob.h index b415f1cdad..95de43f02f 100644 --- a/MdePkg/Include/Pi/PiHob.h +++ b/MdePkg/Include/Pi/PiHob.h @@ -1,4 +1,4 @@ -/* @file +/** @file HOB related definitions in PI. Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h index e64661b9c2..1c013bea2d 100644 --- a/MdePkg/Include/Ppi/Decompress.h +++ b/MdePkg/Include/Ppi/Decompress.h @@ -1,4 +1,4 @@ -/* @file +/** @file Provides decompression services to the PEI Foundatoin. Copyright (c) 2006, Intel Corporation diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h index f88beee6ce..33b5ebb70e 100644 --- a/MdePkg/Include/Ppi/FirmwareVolume.h +++ b/MdePkg/Include/Ppi/FirmwareVolume.h @@ -1,4 +1,4 @@ -/* @file +/** @file This file provides functions for accessing a memory-mapped firmware volume of a specific format. Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h index 8d44a31d4a..e66bfed51b 100644 --- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h +++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h @@ -1,4 +1,4 @@ -/* @file +/** @file This file provides location and format of a firmware volume. Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h index 80b1ee1210..d4753f9ac4 100644 --- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h +++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h @@ -1,4 +1,4 @@ -/* @file +/** @file If a GUID-defined section is encountered when doing section extraction, the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance calls the appropriate instance of the GUIDed Section Extraction PPI diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h index 5b2ce9acd2..7e0679bd1d 100644 --- a/MdePkg/Include/Ppi/LoadImage.h +++ b/MdePkg/Include/Ppi/LoadImage.h @@ -1,4 +1,4 @@ -/* @file +/** @file The file descript the PPI which notifies other drivers of the PEIM being initialized by the PEI Dispatcher. diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h index 92ffbb8b07..4d62de64eb 100644 --- a/MdePkg/Include/Ppi/Pcd.h +++ b/MdePkg/Include/Ppi/Pcd.h @@ -1,4 +1,4 @@ -/* @file +/** @file Platform Configuration Database (PCD) PPI Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h index b8d2e7fda5..447c66da56 100644 --- a/MdePkg/Include/Ppi/TemporaryRamSupport.h +++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h @@ -1,4 +1,4 @@ -/* @file +/** @file This file declares Temporary RAM Support PPI. Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h index c9000c7062..662fd9de25 100644 --- a/MdePkg/Include/Protocol/Arp.h +++ b/MdePkg/Include/Protocol/Arp.h @@ -1,4 +1,15 @@ /** @file + + EFI ARP Protocol Definition + + The EFI ARP Service Binding Protocol is used to locate EFI + ARP Protocol drivers to create and destroy child of the + driver to communicate with other host using ARP protocol. + + The EFI ARP Protocol provides services to map IP network + address to hardware address used by a data link protocol. + + Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License diff --git a/MdePkg/Include/Protocol/DebugPort.h b/MdePkg/Include/Protocol/DebugPort.h index d560554ce9..afe656ded5 100644 --- a/MdePkg/Include/Protocol/DebugPort.h +++ b/MdePkg/Include/Protocol/DebugPort.h @@ -1,4 +1,9 @@ /** @file + + The file defines the EFI Debugport protocol. + This protocol is used by debug agent to communicate with the + remote debug host. + Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h index 9988549645..a72244e2c8 100644 --- a/MdePkg/Include/Protocol/Ip4.h +++ b/MdePkg/Include/Protocol/Ip4.h @@ -1,4 +1,16 @@ /** @file + + This file defines the EFI IPv4 (Internet Protocol version 4) + Protocol interface. It is split into the following three main + sections: + - EFI IPv4 Service Binding Protocol + - EFI IPv4 Variable + - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic + network IPv4 packet I/O services, which includes support for + a subset of the Internet Control Message Protocol (ICMP) and + may include support for the Internet Group Management + Protocol (IGMP). + Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h index e744ce42c9..23a6f7d2d3 100644 --- a/MdePkg/Include/Protocol/Ip4Config.h +++ b/MdePkg/Include/Protocol/Ip4Config.h @@ -1,4 +1,8 @@ /** @file + + This file provides a definition of the EFI IPv4 Configuration + Protocol. + Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License @@ -9,7 +13,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ - #ifndef __EFI_IP4CONFIG_PROTOCOL_H__ #define __EFI_IP4CONFIG_PROTOCOL_H__ diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h index 2fd0805f46..42cd9978c4 100644 --- a/MdePkg/Include/Protocol/ServiceBinding.h +++ b/MdePkg/Include/Protocol/ServiceBinding.h @@ -1,4 +1,9 @@ /** @file + + The file defines the generic Service Binding Protocol + functions. + + Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License diff --git a/MdePkg/Include/Uefi/UefiBaseType.h b/MdePkg/Include/Uefi/UefiBaseType.h index f4119c1c7e..b75c72d3e2 100644 --- a/MdePkg/Include/Uefi/UefiBaseType.h +++ b/MdePkg/Include/Uefi/UefiBaseType.h @@ -1,16 +1,15 @@ - -/* @file +/** @file Defines data types and constants introduced in UEFI. -Copyright (c) 2006 - 2007, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + Copyright (c) 2006 - 2007, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/MdePkg/Include/Uefi/UefiGpt.h b/MdePkg/Include/Uefi/UefiGpt.h index 202397b80f..c79d80823a 100644 --- a/MdePkg/Include/Uefi/UefiGpt.h +++ b/MdePkg/Include/Uefi/UefiGpt.h @@ -1,4 +1,4 @@ -/* @file +/** @file EFI Guid Partition Table Format Definition. Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Include/Uefi/UefiTcgPlatform.h b/MdePkg/Include/Uefi/UefiTcgPlatform.h index 12f53b6a25..f577d75e33 100644 --- a/MdePkg/Include/Uefi/UefiTcgPlatform.h +++ b/MdePkg/Include/Uefi/UefiTcgPlatform.h @@ -1,4 +1,5 @@ -/* @file +/** @file + TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final Copyright (c) 2006 - 2007, Intel Corporation diff --git a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c index 2536d6a861..42f4e1b637 100644 --- a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c +++ b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c @@ -73,6 +73,7 @@ SetPeiServicesTablePointer ( @param PeiServices The address of PeiServices pointer. **/ VOID +EFIAPI MigrateIdtTable ( IN EFI_PEI_SERVICES **PeiServices ) diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c index 9391574fe0..bf40656ae9 100644 --- a/MdePkg/Library/UefiUsbLib/Hid.c +++ b/MdePkg/Library/UefiUsbLib/Hid.c @@ -1,14 +1,15 @@ /** @file -Copyright (c) 2004, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -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 library provides USB descriptor, protocol operations. + + Copyright (c) 2004, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c index a1d61d52bf..a3ac0e6140 100644 --- a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c +++ b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c @@ -1,15 +1,18 @@ /** @file -Copyright (c) 2004 - 2007, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - Common Dxe Libarary for USB + The library provides the USB descritor, interface and protocol + operations. + + Copyright (c) 2004 - 2007, Intel Corporation All rights + reserved. This program and the accompanying materials are + licensed and made available under the terms and conditions of + the BSD License which accompanies this distribution. The full + text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + **/ -- 2.39.2