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

[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
This commit is contained in:
yshang1 2008-04-03 04:56:34 +00:00
parent a69a84d3cb
commit c311f86b23
22 changed files with 93 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MdePkg/Include/Guid/HiiKeyBoardLayout.h
View File

@ -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

24
MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h
View File

@ -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_

1
MdePkg/Include/Library/PeiServicesTablePointerLib.h
View File

@ -50,6 +50,7 @@ SetPeiServicesTablePointer (
@param PeiServices The address of PeiServices pointer.
**/
VOID
EFIAPI
MigrateIdtTable (
IN EFI_PEI_SERVICES **PeiServices
);

2
MdePkg/Include/Pi/PiHob.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
HOB related definitions in PI.
Copyright (c) 2006 - 2007, Intel Corporation

2
MdePkg/Include/Ppi/Decompress.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
Provides decompression services to the PEI Foundatoin.
Copyright (c) 2006, Intel Corporation

2
MdePkg/Include/Ppi/FirmwareVolume.h
View File

@ -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

2
MdePkg/Include/Ppi/FirmwareVolumeInfo.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
This file provides location and format of a firmware volume.
Copyright (c) 2006 - 2007, Intel Corporation

2
MdePkg/Include/Ppi/GuidedSectionExtraction.h
View File

@ -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

2
MdePkg/Include/Ppi/LoadImage.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
The file descript the PPI which notifies other drivers
of the PEIM being initialized by the PEI Dispatcher.

2
MdePkg/Include/Ppi/Pcd.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
Platform Configuration Database (PCD) PPI
Copyright (c) 2006 - 2007, Intel Corporation

2
MdePkg/Include/Ppi/TemporaryRamSupport.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
This file declares Temporary RAM Support PPI.
Copyright (c) 2006 - 2007, Intel Corporation

11
MdePkg/Include/Protocol/Arp.h
View File

@ -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

5
MdePkg/Include/Protocol/DebugPort.h
View File

@ -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

12
MdePkg/Include/Protocol/Ip4.h
View File

@ -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

5
MdePkg/Include/Protocol/Ip4Config.h
View File

@ -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__

5
MdePkg/Include/Protocol/ServiceBinding.h
View File

@ -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

19
MdePkg/Include/Uefi/UefiBaseType.h
View File

@ -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.
**/

2
MdePkg/Include/Uefi/UefiGpt.h
View File

@ -1,4 +1,4 @@
/* @file
/** @file
EFI Guid Partition Table Format Definition.
Copyright (c) 2006 - 2007, Intel Corporation

3
MdePkg/Include/Uefi/UefiTcgPlatform.h
View File

@ -1,4 +1,5 @@
/* @file
/** @file
TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final
Copyright (c) 2006 - 2007, Intel Corporation

1
MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
View File

@ -73,6 +73,7 @@ SetPeiServicesTablePointer (
@param PeiServices The address of PeiServices pointer.
**/
VOID
EFIAPI
MigrateIdtTable (
IN EFI_PEI_SERVICES **PeiServices
)

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

@ -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.
**/

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

@ -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.
**/