Remove BugBug in comments and adjust function header according to code style doc.
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 20 Jul 2006 09:08:37 +0000 (09:08 +0000)
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 20 Jul 2006 09:08:37 +0000 (09:08 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524

76 files changed:
MdePkg/Include/Common/BaseTypes.h
MdePkg/Include/Common/DataHubRecords.h
MdePkg/Include/Common/Dependency.h
MdePkg/Include/Common/MultiPhase.h
MdePkg/Include/Dxe/ArchProtocol/Bds.h
MdePkg/Include/Dxe/ArchProtocol/Cpu.h
MdePkg/Include/Dxe/ArchProtocol/Metronome.h
MdePkg/Include/Dxe/ArchProtocol/Runtime.h
MdePkg/Include/Dxe/ArchProtocol/Security.h
MdePkg/Include/Dxe/ArchProtocol/StatusCode.h
MdePkg/Include/Dxe/ArchProtocol/Timer.h
MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h
MdePkg/Include/Dxe/DxeCis.h
MdePkg/Include/Dxe/SmmCis.h
MdePkg/Include/Guid/Acpi.h
MdePkg/Include/Guid/EventGroup.h
MdePkg/Include/Guid/EventLegacyBios.h
MdePkg/Include/Ia32/ProcessorBind.h
MdePkg/Include/IndustryStandard/scsi.h
MdePkg/Include/Library/HobLib.h
MdePkg/Include/Peim/PeiCis.h
MdePkg/Include/Ppi/BlockIo.h
MdePkg/Include/Ppi/BootScriptExecuter.h
MdePkg/Include/Ppi/CpuIo.h
MdePkg/Include/Ppi/DeviceRecoveryModule.h
MdePkg/Include/Ppi/DxeIpl.h
MdePkg/Include/Ppi/FindFv.h
MdePkg/Include/Ppi/LoadFile.h
MdePkg/Include/Ppi/PciCfg.h
MdePkg/Include/Ppi/ReadOnlyVariable.h
MdePkg/Include/Ppi/RecoveryModule.h
MdePkg/Include/Ppi/S3Resume.h
MdePkg/Include/Ppi/SecPlatformInformation.h
MdePkg/Include/Ppi/SectionExtraction.h
MdePkg/Include/Ppi/Security.h
MdePkg/Include/Ppi/Smbus.h
MdePkg/Include/Ppi/Stall.h
MdePkg/Include/Protocol/AcpiSupport.h
MdePkg/Include/Protocol/Bis.h
MdePkg/Include/Protocol/BootScriptSave.h
MdePkg/Include/Protocol/CpuIo.h
MdePkg/Include/Protocol/DataHub.h
MdePkg/Include/Protocol/DeviceIo.h
MdePkg/Include/Protocol/FirmwareVolume.h
MdePkg/Include/Protocol/FirmwareVolumeBlock.h
MdePkg/Include/Protocol/FormBrowser.h
MdePkg/Include/Protocol/FormCallback.h
MdePkg/Include/Protocol/GuidedSectionExtraction.h
MdePkg/Include/Protocol/Hii.h
MdePkg/Include/Protocol/IdeControllerInit.h
MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h
MdePkg/Include/Protocol/Legacy8259.h
MdePkg/Include/Protocol/LegacyBios.h
MdePkg/Include/Protocol/LegacyBiosPlatform.h
MdePkg/Include/Protocol/LegacyInterrupt.h
MdePkg/Include/Protocol/LegacyRegion.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
MdePkg/Include/Protocol/PciHotPlugInit.h
MdePkg/Include/Protocol/PciPlatform.h
MdePkg/Include/Protocol/ScsiPassThruExt.h
MdePkg/Include/Protocol/SectionExtraction.h
MdePkg/Include/Protocol/Smbus.h
MdePkg/Include/Protocol/SmmAccess.h
MdePkg/Include/Protocol/SmmBase.h
MdePkg/Include/Protocol/SmmControl.h
MdePkg/Include/Protocol/SmmGpiDispatch.h
MdePkg/Include/Protocol/SmmIchnDispatch.h
MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h
MdePkg/Include/Protocol/SmmPowerButtonDispatch.h
MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h
MdePkg/Include/Protocol/SmmStatusCode.h
MdePkg/Include/Protocol/SmmSwDispatch.h
MdePkg/Include/Protocol/SmmSxDispatch.h
MdePkg/Include/Protocol/SmmUsbDispatch.h
MdePkg/Include/Protocol/UsbHostController.h

index 86c3c71..3935919 100644 (file)
@@ -62,7 +62,7 @@ typedef struct {
 //\r
 #ifndef TRUE\r
 //\r
-// BugBug: UEFI specification claims 1 and 0. We are concerned about the \r
+//  UEFI specification claims 1 and 0. We are concerned about the \r
 //  complier portability so we did it this way.\r
 //\r
 #define TRUE  ((BOOLEAN)(1==1))\r
index 0bc8f23..dc8d291 100644 (file)
@@ -1,10 +1,7 @@
 /** @file\r
-  This file defines GUIDs and associated data structures for records \r
-  posted to the Data Hub. \r
-  The producers of these records use these definitions to construct \r
-  records.\r
-  The consumers of these records use these definitions to retrieve,\r
-  filter and parse records.\r
+  This file defines GUIDs and associated data structures for records posted to the Data Hub. \r
+  The producers of these records use these definitions to construct records.\r
+  The consumers of these records use these definitions to retrieve, filter and parse records.\r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 744027d..d82cefd 100644 (file)
@@ -1,6 +1,5 @@
 /** @file\r
-  This module contains data specific to dependency expressions\r
-  and local function prototypes.\r
+  This module contains data specific to dependency expressions.\r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 93867a5..d9b72a4 100644 (file)
@@ -17,8 +17,6 @@
 #ifndef __MULTI_PHASE_H__\r
 #define __MULTI_PHASE_H__\r
 \r
-//\r
-//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
 //\r
 // Needed EFI defines for PEI\r
 //\r
index f6b72d2..d060eb9 100644 (file)
@@ -49,7 +49,7 @@ typedef struct _EFI_BDS_ARCH_PROTOCOL   EFI_BDS_ARCH_PROTOCOL;
   device connection operation fails twice in a row, then that boot device has \r
   failed, and should be skipped.  This function should never return.\r
 \r
-  @param  This The EFI_BDS_ARCH_PROTOCOL instance.\r
+  @param  This             The EFI_BDS_ARCH_PROTOCOL instance.\r
 \r
   @return None.\r
 \r
index 975a816..ac1b43b 100644 (file)
@@ -43,11 +43,10 @@ typedef enum {
 /**\r
   EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.\r
 \r
-  @param  InterruptType Defines the type of interrupt or exception that \r
-  occurred on the processor.This parameter is processor architecture specific.\r
-  \r
-  @param  SystemContext A pointer to the processor context when \r
-  the interrupt occurred on the processor.\r
+  @param  InterruptType    Defines the type of interrupt or exception that\r
+                           occurred on the processor.This parameter is processor architecture specific.\r
+  @param  SystemContext    A pointer to the processor context when\r
+                           the interrupt occurred on the processor.\r
 \r
   @return None\r
 \r
@@ -70,20 +69,20 @@ VOID
   this function can just return EFI_SUCCESS. If the processor does not support \r
   flushing a range of the data cache, then the entire data cache can be flushed.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
-  @param  Start The beginning physical address to flush from the processor's data\r
-  cache.\r
-  @param  Length The number of bytes to flush from the processor's data cache. This\r
-  function may flush more bytes than Length specifies depending upon\r
-  the granularity of the flush operation that the processor supports.\r
-  @param  FlushType Specifies the type of flush operation to perform.\r
-\r
-  @retval  EFI_SUCCESS The address range from Start to Start+Length was flushed from\r
-  the processor's data cache.\r
-  @retval  EFI_UNSUPPORTEDT The processor does not support the cache flush type specified\r
-  by FlushType.\r
-  @retval  EFI_DEVICE_ERROR The address range from Start to Start+Length could not be flushed\r
-  from the processor's data cache.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  Start            The beginning physical address to flush from the processor's data\r
+                           cache.\r
+  @param  Length           The number of bytes to flush from the processor's data cache. This\r
+                           function may flush more bytes than Length specifies depending upon\r
+                           the granularity of the flush operation that the processor supports.\r
+  @param  FlushType        Specifies the type of flush operation to perform.\r
+\r
+  @retval EFI_SUCCESS           The address range from Start to Start+Length was flushed from\r
+                                the processor's data cache.\r
+  @retval EFI_UNSUPPORTEDT      The processor does not support the cache flush type specified\r
+                                by FlushType.\r
+  @retval EFI_DEVICE_ERROR      The address range from Start to Start+Length could not be flushed\r
+                                from the processor's data cache.\r
 \r
 **/\r
 typedef\r
@@ -99,10 +98,10 @@ EFI_STATUS
 /**\r
   This function enables interrupt processing by the processor. \r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
 \r
-  @retval  EFI_SUCCESS Interrupts are enabled on the processor.\r
-  @retval  EFI_DEVICE_ERROR Interrupts could not be enabled on the processor.\r
+  @retval EFI_SUCCESS           Interrupts are enabled on the processor.\r
+  @retval EFI_DEVICE_ERROR      Interrupts could not be enabled on the processor.\r
 \r
 **/\r
 typedef\r
@@ -115,10 +114,10 @@ EFI_STATUS
 /**\r
   This function disables interrupt processing by the processor.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
 \r
-  @retval  EFI_SUCCESS Interrupts are disabled on the processor.\r
-  @retval  EFI_DEVICE_ERROR Interrupts could not be disabled on the processor.\r
+  @retval EFI_SUCCESS           Interrupts are disabled on the processor.\r
+  @retval EFI_DEVICE_ERROR      Interrupts could not be disabled on the processor.\r
 \r
 **/\r
 typedef\r
@@ -133,12 +132,12 @@ EFI_STATUS
   State. If interrupts are currently enabled, then TRUE is returned. If interrupts \r
   are currently disabled, then FALSE is returned.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
-  @param  State A pointer to the processor's current interrupt state. Set to TRUE if\r
-  interrupts are enabled and FALSE if interrupts are disabled.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  State            A pointer to the processor's current interrupt state. Set to TRUE if\r
+                           interrupts are enabled and FALSE if interrupts are disabled.\r
 \r
-  @retval  EFI_SUCCESS The processor's current interrupt state was returned in State.\r
-  @retval  EFI_INVALID_PARAMETER State is NULL.\r
+  @retval EFI_SUCCESS           The processor's current interrupt state was returned in State.\r
+  @retval EFI_INVALID_PARAMETER State is NULL.\r
 \r
 **/\r
 typedef\r
@@ -156,13 +155,13 @@ EFI_STATUS
   INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error \r
   occurs attempting to generate an INIT, then EFI_DEVICE_ERROR is returned.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
-  @param  InitType The type of processor INIT to perform.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  InitType         The type of processor INIT to perform.\r
 \r
-  @retval  EFI_SUCCESS The processor INIT was performed. This return code should never be seen.\r
-  @retval  EFI_UNSUPPORTED The processor INIT operation specified by InitType is not supported\r
-  by this processor.\r
-  @retval  EFI_DEVICE_ERROR The processor INIT failed.\r
+  @retval EFI_SUCCESS           The processor INIT was performed. This return code should never be seen.\r
+  @retval EFI_UNSUPPORTED       The processor INIT operation specified by InitType is not supported\r
+                                by this processor.\r
+  @retval EFI_DEVICE_ERROR      The processor INIT failed.\r
 \r
 **/\r
 typedef\r
@@ -179,19 +178,19 @@ EFI_STATUS
   handler for the processor interrupt or exception type specified by InterruptType is uninstalled. \r
   The installed handler is called once for each processor interrupt or exception.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
-  @param  InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts\r
-  are enabled and FALSE if interrupts are disabled.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  InterruptType    A pointer to the processor's current interrupt state. Set to TRUE if interrupts\r
+                           are enabled and FALSE if interrupts are disabled.\r
   @param  InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
-  when a processor interrupt occurs. If this parameter is NULL, then the handler\r
-  will be uninstalled.\r
+                           when a processor interrupt occurs. If this parameter is NULL, then the handler\r
+                           will be uninstalled.\r
 \r
-  @retval  EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r
-  @retval  EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r
-  previously installed.\r
-  @retval  EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
-  previously installed.\r
-  @retval  EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.\r
+  @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.\r
+  @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was\r
+                                previously installed.\r
+  @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
+                                previously installed.\r
+  @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported.\r
 \r
 **/\r
 typedef\r
@@ -206,17 +205,17 @@ EFI_STATUS
 /**\r
   This function reads the processor timer specified by TimerIndex and returns it in TimerValue.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
-  @param  TimerIndex Specifies which processor timer is to be returned in TimerValue. This parameter\r
-  must be between 0 and NumberOfTimers-1.\r
-  @param  TimerValue Pointer to the returned timer value.\r
-  @param  TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment\r
-  of TimerValue.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  TimerIndex       Specifies which processor timer is to be returned in TimerValue. This parameter\r
+                           must be between 0 and NumberOfTimers-1.\r
+  @param  TimerValue       Pointer to the returned timer value.\r
+  @param  TimerPeriod      A pointer to the amount of time that passes in femtoseconds for each increment\r
+                           of TimerValue.\r
 \r
-  @retval  EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.\r
-  @retval  EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.\r
-  @retval  EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.\r
-  @retval  EFI_UNSUPPORTED The processor does not have any readable timers.\r
+  @retval EFI_SUCCESS           The processor timer value specified by TimerIndex was returned in TimerValue.\r
+  @retval EFI_DEVICE_ERROR      An error occurred attempting to read one of the processor's timers.\r
+  @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.\r
+  @retval EFI_UNSUPPORTED       The processor does not have any readable timers.\r
 \r
 **/\r
 typedef\r
@@ -233,21 +232,21 @@ EFI_STATUS
   This function modifies the attributes for the memory region specified by BaseAddress and\r
   Length from their current attributes to the attributes specified by Attributes.\r
 \r
-  @param  This The EFI_CPU_ARCH_PROTOCOL instance.\r
-  @param  BaseAddress The physical address that is the start address of a memory region.\r
-  @param  Length The size in bytes of the memory region.\r
-  @param  Attributes The bit mask of attributes to set for the memory region.\r
-\r
-  @retval  EFI_SUCCESS The attributes were set for the memory region.\r
-  @retval  EFI_ACCESS_DENIED The attributes for the memory resource range specified by\r
-  BaseAddress and Length cannot be modified.\r
-  @retval  EFI_INVALID_PARAMETER Length is zero.\r
-  @retval  EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of\r
-  the memory resource range.\r
-  @retval  EFI_UNSUPPORTED The processor does not support one or more bytes of the memory\r
-  resource range specified by BaseAddress and Length.\r
-  The bit mask of attributes is not support for the memory resource\r
-  range specified by BaseAddress and Length.\r
+  @param  This             The EFI_CPU_ARCH_PROTOCOL instance.\r
+  @param  BaseAddress      The physical address that is the start address of a memory region.\r
+  @param  Length           The size in bytes of the memory region.\r
+  @param  Attributes       The bit mask of attributes to set for the memory region.\r
+\r
+  @retval EFI_SUCCESS           The attributes were set for the memory region.\r
+  @retval EFI_ACCESS_DENIED     The attributes for the memory resource range specified by\r
+                                BaseAddress and Length cannot be modified.\r
+  @retval EFI_INVALID_PARAMETER Length is zero.\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough system resources to modify the attributes of\r
+                                the memory resource range.\r
+  @retval EFI_UNSUPPORTED       The processor does not support one or more bytes of the memory\r
+                                resource range specified by BaseAddress and Length.\r
+                                The bit mask of attributes is not support for the memory resource\r
+                                range specified by BaseAddress and Length.\r
 \r
 **/\r
 typedef\r
@@ -274,11 +273,14 @@ EFI_STATUS
   flushing a range of addresses from the data cache, then the entire data \r
   cache must be flushed. \r
 \r
-  @param EnableInterrupt    Enables interrupt processing by the processor. \r
+  @param EnableInterrupt   \r
+  Enables interrupt processing by the processor.\r
 \r
-  @param DisableInterrupt    Disables interrupt processing by the processor.\r
+  @param DisableInterrupt  \r
+  Disables interrupt processing by the processor.\r
 \r
-  @param GetInterruptState  Retrieves the processor's current interrupt state.\r
+  @param GetInterruptState \r
+  Retrieves the processor's current interrupt state.\r
 \r
   @param Init\r
   Generates an INIT on the processor. If a processor cannot programmatically \r
@@ -291,9 +293,11 @@ EFI_STATUS
   hook the timer interrupt in a system. It can also be used by the debugger to \r
   hook exception vectors.\r
 \r
-  @param GetTimerValue    Returns the value of one of the processor's internal timers.\r
+  @param GetTimerValue       \r
+  Returns the value of one of the processor's internal timers.\r
 \r
-  @param SetMemoryAttributes  Attempts to set the attributes of a memory region.\r
+  @param SetMemoryAttributes \r
+  Attempts to set the attributes of a memory region.\r
 \r
   @param NumberOfTimers\r
   The number of timers that are available in a processor. The value in this \r
index a07003e..c4a1f71 100644 (file)
@@ -47,14 +47,12 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;
   ticks will not be missed.  If a timeout occurs waiting for the specified \r
   number of ticks, then EFI_TIMEOUT is returned.\r
 \r
-  @param  This The EFI_METRONOME_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TickNumber Number of ticks to wait.\r
-\r
-  @retval  EFI_SUCCESS The wait for the number of ticks specified by TickNumber\r
-  succeeded.\r
-  \r
-  @retval  EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.\r
+  @param  This             The EFI_METRONOME_ARCH_PROTOCOL instance.\r
+  @param  TickNumber       Number of ticks to wait.\r
+\r
+  @retval EFI_SUCCESS           The wait for the number of ticks specified by TickNumber\r
+                                succeeded.\r
+  @retval EFI_TIMEOUT           A timeout occurred waiting for the specified number of ticks.\r
 \r
 **/\r
 typedef \r
index bbd4c1a..feb2d8f 100644 (file)
@@ -50,23 +50,19 @@ typedef struct _EFI_RUNTIME_ARCH_PROTOCOL   EFI_RUNTIME_ARCH_PROTOCOL;
   loaded into memory with the Boot Service LoadImage().  As a result, no \r
   parameter checking needs to be performed.\r
 \r
-  @param  This The EFI_RUNTIME_ARCH_PROTOCOL instance.\r
-  \r
-  @param  ImageBase Start of image that has been loaded in memory. It is either\r
-  a pointer to the DOS or PE header of the image.\r
-  \r
-  @param  ImageSize Size of the image in bytes.\r
-  \r
-  @param  RelocationData Information about the fixups that were performed on ImageBase\r
-  when it was loaded into memory. This information is needed\r
-  when the virtual mode fix-ups are reapplied so that data that\r
-  has been programmatically updated will not be fixed up. If\r
-  code updates a global variable the code is responsible for\r
-  fixing up the variable for virtual mode.\r
-\r
-  @retval  EFI_SUCCESS The ImageBase has been registered.\r
-  \r
-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources to register ImageBase.\r
+  @param  This             The EFI_RUNTIME_ARCH_PROTOCOL instance.\r
+  @param  ImageBase        Start of image that has been loaded in memory. It is either\r
+                           a pointer to the DOS or PE header of the image.\r
+  @param  ImageSize        Size of the image in bytes.\r
+  @param  RelocationData   Information about the fixups that were performed on ImageBase\r
+                           when it was loaded into memory. This information is needed\r
+                           when the virtual mode fix-ups are reapplied so that data that\r
+                           has been programmatically updated will not be fixed up. If\r
+                           code updates a global variable the code is responsible for\r
+                           fixing up the variable for virtual mode.\r
+\r
+  @retval EFI_SUCCESS           The ImageBase has been registered.\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to register ImageBase.\r
 \r
 **/\r
 typedef\r
@@ -88,22 +84,16 @@ EFI_STATUS
   with the Boot Service CreateEvent().  As a result, no parameter checking needs \r
   to be performed.\r
 \r
-  @param  This The EFI_RUNTIME_ARCH_PROTOCOL instance.\r
-  \r
-  @param  Type The same as Type passed into CreateEvent().\r
-  \r
-  @param  NotifyTpl The same as NotifyTpl passed into CreateEvent().\r
-  \r
-  @param  NotifyFunction The same as NotifyFunction passed into CreateEvent().\r
-  \r
-  @param  NotifyContext The same as NotifyContext passed into CreateEvent().\r
-  \r
-  @param  Event The EFI_EVENT returned by CreateEvent().  Event must be in\r
-  runtime memory.\r
-\r
-  @retval  EFI_SUCCESS The Event has been registered.\r
-  \r
-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources to register Event.\r
+  @param  This             The EFI_RUNTIME_ARCH_PROTOCOL instance.\r
+  @param  Type             The same as Type passed into CreateEvent().\r
+  @param  NotifyTpl        The same as NotifyTpl passed into CreateEvent().\r
+  @param  NotifyFunction   The same as NotifyFunction passed into CreateEvent().\r
+  @param  NotifyContext    The same as NotifyContext passed into CreateEvent().\r
+  @param  Event            The EFI_EVENT returned by CreateEvent(). Event must be in\r
+                           runtime memory.\r
+\r
+  @retval EFI_SUCCESS           The Event has been registered.\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to register Event.\r
 \r
 **/\r
 typedef\r
index 3598199..ec981b4 100644 (file)
@@ -65,29 +65,25 @@ typedef struct _EFI_SECURITY_ARCH_PROTOCOL    EFI_SECURITY_ARCH_PROTOCOL;
   might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is \r
   returned.\r
 \r
-  @param  This The EFI_SECURITY_ARCH_PROTOCOL instance.\r
-  \r
-  @param  AuthenticationStatus This is the authentication type returned from the Section\r
-  Extraction protocol.  See the Section Extraction Protocol\r
-  Specification for details on this type.\r
-  \r
-  @param  File This is a pointer to the device path of the file that is\r
-  being dispatched.  This will optionally be used for logging.\r
-\r
-  @retval  EFI_SUCCESS The file specified by File did authenticate, and the\r
-  platform policy dictates that the DXE Core may use File.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER Driver is NULL.\r
-  \r
-  @retval  EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
-  the platform policy dictates that File should be placed\r
-  in the untrusted state.   A file may be promoted from\r
-  the untrusted to the trusted state at a future time\r
-  with a call to the Trust() DXE Service.\r
-  \r
-  @retval  EFI_ACCESS_DENIED The file specified by File did not authenticate, and\r
-  the platform policy dictates that File should not be\r
-  used for any purpose.\r
+  @param  This             The EFI_SECURITY_ARCH_PROTOCOL instance.\r
+  @param  AuthenticationStatus \r
+                           This is the authentication type returned from the Section\r
+                           Extraction protocol. See the Section Extraction Protocol\r
+                           Specification for details on this type.\r
+  @param  File             This is a pointer to the device path of the file that is\r
+                           being dispatched. This will optionally be used for logging.\r
+\r
+  @retval EFI_SUCCESS           The file specified by File did authenticate, and the\r
+                                platform policy dictates that the DXE Core may use File.\r
+  @retval EFI_INVALID_PARAMETER Driver is NULL.\r
+  @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
+                                the platform policy dictates that File should be placed\r
+                                in the untrusted state. A file may be promoted from\r
+                                the untrusted to the trusted state at a future time\r
+                                with a call to the Trust() DXE Service.\r
+  @retval EFI_ACCESS_DENIED     The file specified by File did not authenticate, and\r
+                                the platform policy dictates that File should not be\r
+                                used for any purpose.\r
 \r
 **/\r
 typedef \r
index 6440dc3..6bfaeae 100644 (file)
 /**\r
   Provides an interface that a software module can call to report a status code.\r
 \r
-  @param  Type Indicates the type of status code being reported.\r
-  \r
-  @param  Value Describes the current status of a hardware or software entity.\r
-  This included information about the class and subclass that is used to \r
-  classify the entity as well as an operation.\r
-  \r
-  @param  Instance The enumeration of a hardware or software entity within \r
-  the system. Valid instance numbers start with 1.\r
-  \r
-  @param  CallerId This optional parameter may be used to identify the caller.\r
-  This parameter allows the status code driver to apply different rules to \r
-  different callers.\r
-  \r
-  @param  Data This optional parameter may be used to pass additional data.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully\r
-  \r
-  @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r
+  @param  Type             Indicates the type of status code being reported.\r
+  @param  Value            Describes the current status of a hardware or software entity.\r
+                           This included information about the class and subclass that is used to\r
+                           classify the entity as well as an operation.\r
+  @param  Instance         The enumeration of a hardware or software entity within\r
+                           the system. Valid instance numbers start with 1.\r
+  @param  CallerId         This optional parameter may be used to identify the caller.\r
+                           This parameter allows the status code driver to apply different rules to\r
+                           different callers.\r
+  @param  Data             This optional parameter may be used to pass additional data.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully\r
+  @retval EFI_DEVICE_ERROR      The function should not be completed due to a device error.\r
 \r
 **/\r
 typedef\r
@@ -70,7 +65,7 @@ EFI_STATUS
   This protocol must be produced by a runtime DXE driver and may be consumed \r
   only by the DXE Foundation.\r
 \r
-  @param ReportStatusCode Emit a status code.\r
+  @param  ReportStatusCode Emit a status code.\r
 \r
 **/\r
 typedef struct _EFI_STATUS_CODE_PROTOCOL {\r
index 330f4cf..302ae14 100644 (file)
@@ -39,10 +39,10 @@ typedef struct _EFI_TIMER_ARCH_PROTOCOL   EFI_TIMER_ARCH_PROTOCOL;
   of tyis type to be called for the timer interrupt, so it can know how much \r
   time has passed.  This information is used to signal timer based events.  \r
 \r
-  @param  Time Time since the last timer interrupt in 100 ns units.  This will\r
-  typically be TimerPeriod, but if a timer interrupt is missed, and the\r
-  EFI_TIMER_ARCH_PROTOCOL driver can detect missed interrupts, then Time\r
-  will contain the actual amount of time since the last interrupt.\r
+  @param  Time             Time since the last timer interrupt in 100 ns units. This will\r
+                           typically be TimerPeriod, but if a timer interrupt is missed, and the\r
+                           EFI_TIMER_ARCH_PROTOCOL driver can detect missed interrupts, then Time\r
+                           will contain the actual amount of time since the last interrupt.\r
 \r
   None.\r
 \r
@@ -66,25 +66,20 @@ VOID
   register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR \r
   is returned.\r
 \r
-  @param  This The EFI_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  NotifyFunction The function to call when a timer interrupt fires.  This\r
-  function executes at TPL_HIGH_LEVEL.  The DXE Core will\r
-  register a handler for the timer interrupt, so it can know\r
-  how much time has passed.  This information is used to\r
-  signal timer based events.  NULL will unregister the handler.\r
-\r
-  @retval  EFI_SUCCESS The timer handler was registered.\r
-  \r
-  @retval  EFI_UNSUPPORTED The platform does not support timer interrupts.\r
-  \r
-  @retval  EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already\r
-  registered.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
-  previously registered.\r
-  \r
-  @retval  EFI_DEVICE_ERROR The timer handler could not be registered.\r
+  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.\r
+  @param  NotifyFunction   The function to call when a timer interrupt fires. This\r
+                           function executes at TPL_HIGH_LEVEL. The DXE Core will\r
+                           register a handler for the timer interrupt, so it can know\r
+                           how much time has passed. This information is used to\r
+                           signal timer based events. NULL will unregister the handler.\r
+\r
+  @retval EFI_SUCCESS           The timer handler was registered.\r
+  @retval EFI_UNSUPPORTED       The platform does not support timer interrupts.\r
+  @retval EFI_ALREADY_STARTED   NotifyFunction is not NULL, and a handler is already\r
+                                registered.\r
+  @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
+                                previously registered.\r
+  @retval EFI_DEVICE_ERROR      The timer handler could not be registered.\r
 \r
 **/\r
 typedef \r
@@ -107,20 +102,17 @@ EFI_STATUS
   interrupt controller so that a CPU interrupt is not generated when the timer \r
   interrupt fires. \r
 \r
-  @param  This The EFI_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TimerPeriod The rate to program the timer interrupt in 100 nS units.  If\r
-  the timer hardware is not programmable, then EFI_UNSUPPORTED is\r
-  returned.  If the timer is programmable, then the timer period\r
-  will be rounded up to the nearest timer period that is supported\r
-  by the timer hardware.  If TimerPeriod is set to 0, then the\r
-  timer interrupts will be disabled.\r
-\r
-  @retval  EFI_SUCCESS The timer period was changed.\r
-  \r
-  @retval  EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.\r
-  \r
-  @retval  EFI_DEVICE_ERROR The timer period could not be changed due to a device error.\r
+  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      The rate to program the timer interrupt in 100 nS units. If\r
+                           the timer hardware is not programmable, then EFI_UNSUPPORTED is\r
+                           returned. If the timer is programmable, then the timer period\r
+                           will be rounded up to the nearest timer period that is supported\r
+                           by the timer hardware. If TimerPeriod is set to 0, then the\r
+                           timer interrupts will be disabled.\r
+\r
+  @retval EFI_SUCCESS           The timer period was changed.\r
+  @retval EFI_UNSUPPORTED       The platform cannot change the period of the timer interrupt.\r
+  @retval EFI_DEVICE_ERROR      The timer period could not be changed due to a device error.\r
 \r
 **/\r
 typedef \r
@@ -136,14 +128,12 @@ EFI_STATUS
   is NULL, then EFI_INVALID_PARAMETER is returned.  If a TimerPeriod of 0 is \r
   returned, then the timer is currently disabled.\r
 \r
-  @param  This The EFI_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TimerPeriod A pointer to the timer period to retrieve in 100 ns units.  If\r
-  0 is returned, then the timer is currently disabled.\r
+  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      A pointer to the timer period to retrieve in 100 ns units. If\r
+                           0 is returned, then the timer is currently disabled.\r
 \r
-  @retval  EFI_SUCCESS The timer period was returned in TimerPeriod.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
+  @retval EFI_SUCCESS           The timer period was returned in TimerPeriod.\r
+  @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
 \r
 **/\r
 typedef \r
@@ -162,11 +152,10 @@ EFI_STATUS
   registered handler should not be able to distinguish a hardware-generated timer \r
   interrupt from a software-generated timer interrupt.\r
 \r
-  @param  This The EFI_TIMER_ARCH_PROTOCOL instance.\r
+  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.\r
 \r
-  @retval  EFI_SUCCESS The soft timer interrupt was generated.\r
-  \r
-  @retval  EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.\r
+  @retval EFI_SUCCESS           The soft timer interrupt was generated.\r
+  @retval EFI_UNSUPPORTEDT      The platform does not support the generation of soft timer interrupts.\r
 \r
 **/\r
 typedef \r
index a8d84b1..8e31a36 100644 (file)
@@ -37,9 +37,9 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOC
   A function of this type is called when the watchdog timer fires if a \r
   handler has been registered.\r
 \r
-  @param  Time The time in 100 ns units that has passed since the watchdog\r
-  timer was armed.  For the notify function to be called, this\r
-  must be greater than TimerPeriod.\r
+  @param  Time             The time in 100 ns units that has passed since the watchdog\r
+                           timer was armed. For the notify function to be called, this\r
+                           must be greater than TimerPeriod.\r
 \r
   @return None.\r
 \r
@@ -62,19 +62,16 @@ VOID
   If an attempt is made to uninstall a handler when a handler is not installed, \r
   then return EFI_INVALID_PARAMETER.\r
 \r
-  @param  This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  NotifyFunction The function to call when the watchdog timer fires.  If this\r
-  is NULL, then the handler will be unregistered.\r
+  @param  This             The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
+  @param  NotifyFunction   The function to call when the watchdog timer fires. If this\r
+                           is NULL, then the handler will be unregistered.\r
 \r
-  @retval  EFI_SUCCESS The watchdog timer handler was registered or\r
-  unregistered.\r
-  \r
-  @retval  EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already\r
-  registered.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
-  previously registered.\r
+  @retval EFI_SUCCESS           The watchdog timer handler was registered or\r
+                                unregistered.\r
+  @retval EFI_ALREADY_STARTED   NotifyFunction is not NULL, and a handler is already\r
+                                registered.\r
+  @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
+                                previously registered.\r
 \r
 **/\r
 typedef \r
@@ -89,17 +86,15 @@ EFI_STATUS
   timer to TimerPeriod 100 nS units.  If TimerPeriod is 0, then the watchdog \r
   timer is disabled.\r
 \r
-  @param  This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TimerPeriod The amount of time in 100 nS units to wait before the watchdog\r
-  timer is fired.  If TimerPeriod is zero, then the watchdog\r
-  timer is disabled.\r
+  @param  This             The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      The amount of time in 100 nS units to wait before the watchdog\r
+                           timer is fired. If TimerPeriod is zero, then the watchdog\r
+                           timer is disabled.\r
 \r
-  @retval  EFI_SUCCESS The watchdog timer has been programmed to fire in Time\r
-  100 nS units.\r
-  \r
-  @retval  EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device\r
-  error.\r
+  @retval EFI_SUCCESS           The watchdog timer has been programmed to fire in Time\r
+                                100 nS units.\r
+  @retval EFI_DEVICE_ERROR      A watchdog timer could not be programmed due to a device\r
+                                error.\r
 \r
 **/\r
 typedef \r
@@ -114,16 +109,14 @@ EFI_STATUS
   the watchdog timer.  This period is returned in TimerPeriod, and EFI_SUCCESS \r
   is returned.  If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned.\r
 \r
-  @param  This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TimerPeriod A pointer to the amount of time in 100 nS units that the system\r
-  will wait before the watchdog timer is fired.  If TimerPeriod of\r
-  zero is returned, then the watchdog timer is disabled.\r
+  @param  This             The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      A pointer to the amount of time in 100 nS units that the system\r
+                           will wait before the watchdog timer is fired. If TimerPeriod of\r
+                           zero is returned, then the watchdog timer is disabled.\r
 \r
-  @retval  EFI_SUCCESS The amount of time that the system will wait before\r
-  firing the watchdog timer was returned in TimerPeriod.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
+  @retval EFI_SUCCESS           The amount of time that the system will wait before\r
+                                firing the watchdog timer was returned in TimerPeriod.\r
+  @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
 \r
 **/\r
 typedef \r
@@ -148,16 +141,16 @@ EFI_STATUS
   been registered, or the registered handler returns, then the system will be \r
   reset by calling the Runtime Service ResetSystem().\r
 \r
-  @param RegisterHandler - Registers a handler that is invoked when the watchdog \r
-  timer fires.\r
+  @param  RegisterHandler  Registers a handler that is invoked when the watchdog\r
+                           timer fires.\r
 \r
-  @param SetTimerPeriod  - Sets the amount of time in 100 ns units to wait before the \r
-  watchdog timer is fired.  If this function is supported, \r
-  then the watchdog timer period will be rounded up to the \r
-  nearest supported watchdog timer period.\r
+  @param  SetTimerPeriod   Sets the amount of time in 100 ns units to wait before the\r
+                           watchdog timer is fired. If this function is supported,\r
+                           then the watchdog timer period will be rounded up to the\r
+                           nearest supported watchdog timer period.\r
 \r
-  @param GetTimerPeriod  - Retrieves the amount of time in 100 ns units that the \r
-  system will wait before the watchdog timer is fired.\r
+  @param  GetTimerPeriod   Retrieves the amount of time in 100 ns units that the\r
+                           system will wait before the watchdog timer is fired.\r
 \r
 **/\r
 struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {\r
index a36481c..d048014 100644 (file)
@@ -39,7 +39,7 @@
 #endif\r
 \r
 //\r
-// BugBug: Implementation contamination of UEFI 2.0\r
+// Implementation contamination of UEFI 2.0\r
 // Pointer to internal runtime pointer\r
 //\r
 #define EFI_IPF_GP_POINTER  0x00000008\r
@@ -116,15 +116,12 @@ typedef struct {
   Adds reserved memory, system memory, or memory-mapped I/O resources to the\r
   global coherency domain of the processor.\r
 \r
-  @param  GcdMemoryType Memory type of the memory space.\r
-  \r
-  @param  BaseAddress Base address of the memory space.\r
-  \r
-  @param  Length Length of the memory space.\r
-  \r
-  @param  Capabilities alterable attributes of the memory space.\r
+  @param  GcdMemoryType    Memory type of the memory space.\r
+  @param  BaseAddress      Base address of the memory space.\r
+  @param  Length           Length of the memory space.\r
+  @param  Capabilities     alterable attributes of the memory space.\r
 \r
-  @retval  EFI_SUCCESS Merged this memory space into GCD map.\r
+  @retval EFI_SUCCESS           Merged this memory space into GCD map.\r
 \r
 **/\r
 typedef\r
@@ -141,25 +138,17 @@ EFI_STATUS
   Allocates nonexistent memory, reserved memory, system memory, or memorymapped\r
   I/O resources from the global coherency domain of the processor.\r
 \r
-  @param  GcdAllocateType The type of allocate operation\r
-  \r
-  @param  GcdMemoryType The desired memory type\r
-  \r
-  @param  Alignment Align with 2^Alignment\r
-  \r
-  @param  Length Length to allocate\r
-  \r
-  @param  BaseAddress Base address to allocate\r
-  \r
-  @param  Imagehandle The image handle consume the allocated space.\r
-  \r
-  @param  DeviceHandle The device handle consume the allocated space.\r
-\r
-  @retval  EFI_INVALID_PARAMETER Invalid parameter.\r
-  \r
-  @retval  EFI_NOT_FOUND No descriptor contains the desired space.\r
-  \r
-  @retval  EFI_SUCCESS Memory space successfully allocated.\r
+  @param  GcdAllocateType  The type of allocate operation\r
+  @param  GcdMemoryType    The desired memory type\r
+  @param  Alignment        Align with 2^Alignment\r
+  @param  Length           Length to allocate\r
+  @param  BaseAddress      Base address to allocate\r
+  @param  Imagehandle      The image handle consume the allocated space.\r
+  @param  DeviceHandle     The device handle consume the allocated space.\r
+\r
+  @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+  @retval EFI_NOT_FOUND         No descriptor contains the desired space.\r
+  @retval EFI_SUCCESS           Memory space successfully allocated.\r
 \r
 **/\r
 typedef\r
@@ -179,11 +168,10 @@ EFI_STATUS
   Frees nonexistent memory, reserved memory, system memory, or memory-mapped\r
   I/O resources from the global coherency domain of the processor.\r
 \r
-  @param  BaseAddress Base address of the segment.\r
-  \r
-  @param  Length Length of the segment.\r
+  @param  BaseAddress      Base address of the segment.\r
+  @param  Length           Length of the segment.\r
 \r
-  @retval  EFI_SUCCESS Space successfully freed.\r
+  @retval EFI_SUCCESS           Space successfully freed.\r
 \r
 **/\r
 typedef\r
@@ -198,11 +186,10 @@ EFI_STATUS
   Removes reserved memory, system memory, or memory-mapped I/O resources from\r
   the global coherency domain of the processor.\r
 \r
-  @param  BaseAddress Base address of the memory space.\r
-  \r
-  @param  Length Length of the memory space.\r
+  @param  BaseAddress      Base address of the memory space.\r
+  @param  Length           Length of the memory space.\r
 \r
-  @retval  EFI_SUCCESS Successfully remove a segment of memory space.\r
+  @retval EFI_SUCCESS           Successfully remove a segment of memory space.\r
 \r
 **/\r
 typedef\r
@@ -216,13 +203,11 @@ EFI_STATUS
 /**\r
   Retrieves the descriptor for a memory region containing a specified address.\r
 \r
-  @param  BaseAddress Specified start address\r
-  \r
-  @param  Descriptor Specified length\r
+  @param  BaseAddress      Specified start address\r
+  @param  Descriptor       Specified length\r
 \r
-  @retval  EFI_INVALID_PARAMETER Invalid parameter\r
-  \r
-  @retval  EFI_SUCCESS Successfully get memory space descriptor.\r
+  @retval EFI_INVALID_PARAMETER Invalid parameter\r
+  @retval EFI_SUCCESS           Successfully get memory space descriptor.\r
 \r
 **/\r
 typedef\r
@@ -237,13 +222,11 @@ EFI_STATUS
   Modifies the attributes for a memory region in the global coherency domain of the\r
   processor.\r
 \r
-  @param  BaseAddress Specified start address\r
-  \r
-  @param  Length Specified length\r
-  \r
-  @param  Attributes Specified attributes\r
+  @param  BaseAddress      Specified start address\r
+  @param  Length           Specified length\r
+  @param  Attributes       Specified attributes\r
 \r
-  @retval  EFI_SUCCESS Successfully set attribute of a segment of memory space.\r
+  @retval EFI_SUCCESS           Successfully set attribute of a segment of memory space.\r
 \r
 **/\r
 typedef\r
@@ -261,14 +244,11 @@ EFI_STATUS
   processor.\r
 \r
   @param  NumberOfDescriptors Number of descriptors.\r
-  \r
-  @param  MemorySpaceMap Descriptor array\r
+  @param  MemorySpaceMap      Descriptor array\r
 \r
-  @retval  EFI_INVALID_PARAMETER Invalid parameter\r
-  \r
-  @retval  EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
-  \r
-  @retval  EFI_SUCCESS Successfully get memory space map.\r
+  @retval EFI_INVALID_PARAMETER Invalid parameter\r
+  @retval EFI_OUT_OF_RESOURCES  No enough buffer to allocate\r
+  @retval EFI_SUCCESS           Successfully get memory space map.\r
 \r
 **/\r
 typedef\r
@@ -282,13 +262,11 @@ EFI_STATUS
 /**\r
   Adds reserved I/O or I/O resources to the global coherency domain of the processor.\r
 \r
-  @param  GcdIoType IO type of the segment.\r
-  \r
-  @param  BaseAddress Base address of the segment.\r
-  \r
-  @param  Length Length of the segment.\r
+  @param  GcdIoType        IO type of the segment.\r
+  @param  BaseAddress      Base address of the segment.\r
+  @param  Length           Length of the segment.\r
 \r
-  @retval  EFI_SUCCESS Merged this segment into GCD map.\r
+  @retval EFI_SUCCESS           Merged this segment into GCD map.\r
 \r
 **/\r
 typedef\r
@@ -304,25 +282,17 @@ EFI_STATUS
   Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency\r
   domain of the processor.\r
 \r
-  @param  GcdAllocateType The type of allocate operation\r
-  \r
-  @param  GcdIoType The desired IO type\r
-  \r
-  @param  Alignment Align with 2^Alignment\r
-  \r
-  @param  Length Length to allocate\r
-  \r
-  @param  BaseAddress Base address to allocate\r
-  \r
-  @param  Imagehandle The image handle consume the allocated space.\r
-  \r
-  @param  DeviceHandle The device handle consume the allocated space.\r
-\r
-  @retval  EFI_INVALID_PARAMETER Invalid parameter.\r
-  \r
-  @retval  EFI_NOT_FOUND No descriptor contains the desired space.\r
-  \r
-  @retval  EFI_SUCCESS IO space successfully allocated.\r
+  @param  GcdAllocateType  The type of allocate operation\r
+  @param  GcdIoType        The desired IO type\r
+  @param  Alignment        Align with 2^Alignment\r
+  @param  Length           Length to allocate\r
+  @param  BaseAddress      Base address to allocate\r
+  @param  Imagehandle      The image handle consume the allocated space.\r
+  @param  DeviceHandle     The device handle consume the allocated space.\r
+\r
+  @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+  @retval EFI_NOT_FOUND         No descriptor contains the desired space.\r
+  @retval EFI_SUCCESS           IO space successfully allocated.\r
 \r
 **/\r
 typedef\r
@@ -342,11 +312,10 @@ EFI_STATUS
   Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency\r
   domain of the processor.\r
 \r
-  @param  BaseAddress Base address of the segment.\r
-  \r
-  @param  Length Length of the segment.\r
+  @param  BaseAddress      Base address of the segment.\r
+  @param  Length           Length of the segment.\r
 \r
-  @retval  EFI_SUCCESS Space successfully freed.\r
+  @retval EFI_SUCCESS           Space successfully freed.\r
 \r
 **/\r
 typedef\r
@@ -361,11 +330,10 @@ EFI_STATUS
   Removes reserved I/O or I/O resources from the global coherency domain of the\r
   processor.\r
 \r
-  @param  BaseAddress Base address of the segment.\r
-  \r
-  @param  Length Length of the segment.\r
+  @param  BaseAddress      Base address of the segment.\r
+  @param Length Length of the segment.\r
 \r
-  @retval  EFI_SUCCESS Successfully removed a segment of IO space.\r
+  @retval EFI_SUCCESS           Successfully removed a segment of IO space.\r
 \r
 **/\r
 typedef\r
@@ -379,13 +347,11 @@ EFI_STATUS
 /**\r
   Retrieves the descriptor for an I/O region containing a specified address.\r
 \r
-  @param  BaseAddress Specified start address\r
-  \r
-  @param  Descriptor Specified length\r
+  @param  BaseAddress      Specified start address\r
+  @param  Descriptor       Specified length\r
 \r
-  @retval  EFI_INVALID_PARAMETER Descriptor is NULL.\r
-  \r
-  @retval  EFI_SUCCESS Successfully get the IO space descriptor.\r
+  @retval EFI_INVALID_PARAMETER Descriptor is NULL.\r
+  @retval EFI_SUCCESS           Successfully get the IO space descriptor.\r
 \r
 **/\r
 typedef\r
@@ -400,14 +366,11 @@ EFI_STATUS
   Returns a map of the I/O resources in the global coherency domain of the processor.\r
 \r
   @param  NumberOfDescriptors Number of descriptors.\r
-  \r
-  @param  MemorySpaceMap Descriptor array\r
+  @param  MemorySpaceMap      Descriptor array\r
 \r
-  @retval  EFI_INVALID_PARAMETER Invalid parameter\r
-  \r
-  @retval  EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
-  \r
-  @retval  EFI_SUCCESS Successfully get IO space map.\r
+  @retval EFI_INVALID_PARAMETER Invalid parameter\r
+  @retval EFI_OUT_OF_RESOURCES  No enough buffer to allocate\r
+  @retval EFI_SUCCESS           Successfully get IO space map.\r
 \r
 **/\r
 typedef\r
@@ -433,8 +396,7 @@ EFI_STATUS
   Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume.\r
 \r
   @param  FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.\r
-  \r
-  @param  DriverName A pointer to the name of the file in a firmware volume.\r
+  @param  DriverName           A pointer to the name of the file in a firmware volume.\r
 \r
   @return Status code\r
 \r
@@ -451,8 +413,7 @@ EFI_STATUS
   Promotes a file stored in a firmware volume from the untrusted to the trusted state.\r
 \r
   @param  FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.\r
-  \r
-  @param  DriverName A pointer to the name of the file in a firmware volume.\r
+  @param  DriverName           A pointer to the name of the file in a firmware volume.\r
 \r
   @return Status code\r
 \r
@@ -469,7 +430,7 @@ EFI_STATUS
   Creates a firmware volume handle for a firmware volume that is present in system memory.\r
 \r
   @param  FirmwareVolumeHeader A pointer to the header of the firmware volume.\r
-  @param  Size The size, in bytes, of the firmware volume.\r
+  @param  Size                 The size, in bytes, of the firmware volume.\r
   @param  FirmwareVolumeHandle On output, a pointer to the created handle.\r
 \r
   @return Status code\r
index 35a1a64..d2f2e17 100644 (file)
@@ -51,24 +51,17 @@ typedef enum {
   Provides the basic memory and I/O interfaces that are used to \r
   abstract accesses to devices.\r
 \r
-  @param  This The EFI_SMM_CPU_IO_INTERFACE instance.  \r
-  \r
-  @param  Width Signifies the width of the I/O operations. \r
-  \r
-  @param  Address The base address of the I/O operations.\r
-  \r
-  @param  Count The number of I/O operations to perform. \r
-  \r
-  @param  Buffer For read operations, the destination buffer to store the results.\r
-  For write operations, the source buffer from which to write data.\r
-\r
-  @retval EFI_SUCCESS The data was read from or written to the device.\r
-  \r
-  @retval EFI_UNSUPPORTED The Address is not valid for this system.\r
-  \r
+  @param  This             The EFI_SMM_CPU_IO_INTERFACE instance.\r
+  @param  Width            Signifies the width of the I/O operations.\r
+  @param  Address          The base address of the I/O operations.\r
+  @param  Count            The number of I/O operations to perform.\r
+  @param  Buffer           For read operations, the destination buffer to store the results.\r
+                           For write operations, the source buffer from which to write data.\r
+\r
+  @retval EFI_SUCCESS           The data was read from or written to the device.\r
+  @retval EFI_UNSUPPORTED       The Address is not valid for this system.\r
   @retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
+  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.\r
 \r
 **/\r
 typedef\r
@@ -95,18 +88,14 @@ struct _EFI_SMM_CPU_IO_INTERFACE {
   Allocates pool memory from SMRAM for IA-32 or runtime memory for \r
   the Itanium processor family.\r
 \r
-  @param  PoolType The type of pool to allocate.The only supported type is EfiRuntimeServicesData\r
-  \r
-  @param  Size The number of bytes to allocate from the pool.\r
-  \r
-  @param  Buffer A pointer to a pointer to the allocated buffer if the call \r
-  succeeds; undefined otherwise.\r
+  @param  PoolType         The type of pool to allocate.The only supported type is EfiRuntimeServicesData\r
+  @param  Size             The number of bytes to allocate from the pool.\r
+  @param  Buffer           A pointer to a pointer to the allocated buffer if the call\r
+                           succeeds; undefined otherwise.\r
 \r
-  @retval EFI_SUCCESS  The requested number of bytes was allocated.\r
-  \r
+  @retval EFI_SUCCESS           The requested number of bytes was allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.\r
-  \r
-  @retval EFI_UNSUPPORTED  In runtime.\r
+  @retval EFI_UNSUPPORTED       In runtime.\r
 \r
 **/\r
 typedef\r
@@ -120,13 +109,11 @@ EFI_STATUS
 /**\r
   Returns pool memory to the system.\r
 \r
-  @param  Buffer Pointer to the buffer to free.\r
+  @param  Buffer           Pointer to the buffer to free.\r
 \r
-  @retval EFI_SUCCESS  The memory was returned to the system.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  Buffer was invalid.  \r
-  \r
-  @retval EFI_UNSUPPORTED  In runtime.\r
+  @retval EFI_SUCCESS           The memory was returned to the system.\r
+  @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
+  @retval EFI_UNSUPPORTED       In runtime.\r
 \r
 **/\r
 typedef\r
@@ -138,24 +125,18 @@ EFI_STATUS
 /**\r
   Allocates memory pages from the system.\r
 \r
-  @param  Type The type of allocation to perform. \r
-  \r
-  @param  MemoryType The only supported type is EfiRuntimeServicesData\r
-  \r
-  @param  NumberofPages The number of contiguous 4 KB pages to allocate\r
-  \r
-  @param  Memory Pointer to a physical address. On input, the way in which \r
-  the address is used depends on the value of Type. On output, the address \r
-  is set to the base of the page range that was allocated.\r
-\r
-  @retval EFI_SUCCESS  The requested pages were allocated.\r
-  \r
+  @param  Type             The type of allocation to perform.\r
+  @param  MemoryType       The only supported type is EfiRuntimeServicesData\r
+  @param  NumberofPages    The number of contiguous 4 KB pages to allocate\r
+  @param  Memory           Pointer to a physical address. On input, the way in which\r
+                           the address is used depends on the value of Type. On output, the address\r
+                           is set to the base of the page range that was allocated.\r
+\r
+  @retval EFI_SUCCESS           The requested pages were allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pages requested could not be allocated.\r
-  \r
-  @retval EFI_NOT_FOUND   The requested pages could not be found.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  Type is not AllocateAnyPages or AllocateMaxAddress \r
-  or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
+  @retval EFI_NOT_FOUND         The requested pages could not be found.\r
+  @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
+                                or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
 \r
 **/\r
 typedef\r
@@ -170,15 +151,12 @@ EFI_STATUS
 /**\r
   Frees memory pages for the system.\r
 \r
-  @param  Memory The base physical address of the pages to be freed\r
-  \r
-  @param  NumberOfPages The number of contiguous 4 KB pages to free.\r
+  @param  Memory           The base physical address of the pages to be freed\r
+  @param  NumberOfPages    The number of contiguous 4 KB pages to free.\r
 \r
-  @retval EFI_SUCCESS  The requested memory pages were freed.\r
-  \r
-  @retval EFI_INVALID_PARAMETER   Memory is not a page-aligned address or NumberOfPages is invalid.\r
-  \r
-  @retval EFI_NOT_FOUND   The requested memory pages were not allocated with SmmAllocatePages().\r
+  @retval EFI_SUCCESS           The requested memory pages were freed.\r
+  @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.\r
+  @retval EFI_NOT_FOUND         The requested memory pages were not allocated with SmmAllocatePages().\r
 \r
 **/\r
 typedef\r
@@ -412,15 +390,14 @@ typedef union {
   This function is the main entry point for an SMM handler dispatch \r
   or communicate-based callback. \r
 \r
-  @param  SmmImageHandle A unique value returned by the SMM infrastructure \r
-  in response to registration for a communicate-based callback or dispatch. \r
-  \r
-  @param  CommunicationBuffer An optional buffer that will be populated \r
-  by the SMM infrastructure in response to a non-SMM agent (preboot or runtime) \r
-  invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.\r
-  \r
-  @param  SourceSize If CommunicationBuffer is non-NULL, this field \r
-  indicates the size of the data payload in this buffer.\r
+  @param  SmmImageHandle   A unique value returned by the SMM infrastructure\r
+                           in response to registration for a communicate-based callback or dispatch.\r
+  @param  CommunicationBuffer \r
+                           An optional buffer that will be populated\r
+                           by the SMM infrastructure in response to a non-SMM agent (preboot or runtime)\r
+                           invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.\r
+  @param  SourceSize       If CommunicationBuffer is non-NULL, this field\r
+                           indicates the size of the data payload in this buffer.\r
 \r
   @return Status Code\r
 \r
@@ -439,15 +416,15 @@ EFI_STATUS
   Table.  The list is stored as an array of (GUID, Pointer) pairs.  The list \r
   must be allocated from pool memory with PoolType set to EfiRuntimeServicesData.\r
 \r
-  @param  SystemTable A pointer to the SMM System Table.\r
-  @param  Guid A pointer to the GUID for the entry to add, update, or remove.\r
-  @param  Table A pointer to the buffer of the table to add.\r
-  @param  TableSize The size of the table to install.\r
+  @param  SystemTable      A pointer to the SMM System Table.\r
+  @param  Guid             A pointer to the GUID for the entry to add, update, or remove.\r
+  @param  Table            A pointer to the buffer of the table to add.\r
+  @param  TableSize        The size of the table to install.\r
 \r
-  @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.\r
+  @retval EFI_SUCCESS           The (Guid, Table) pair was added, updated, or removed.\r
   @retval EFI_INVALID_PARAMETER Guid is not valid.\r
-  @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.\r
-  @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.\r
+  @retval EFI_NOT_FOUND         An attempt was made to delete a non-existent entry.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough memory available to complete the operation.\r
 \r
 **/\r
 typedef\r
index a64f1b7..14b2b9f 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  GUIDs used for ACPI entries in the EFI 1.0 system table\r
+  GUIDs used for ACPI entries in the EFI system table\r
 \r
   These GUIDs point the ACPI tables as defined in the ACPI specifications.\r
   ACPI 2.0 specification defines the ACPI 2.0 GUID. UEFI 2.0 defines the \r
index f86abd4..cf68188 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  GUIDs for gBS->CreateEventEx Event Groups. Defined in EFI 2.0.\r
+  GUIDs for gBS->CreateEventEx Event Groups. Defined in UEFI spec 2.0.\r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 6700a2d..d38b427 100644 (file)
@@ -1,5 +1,7 @@
 /** @file\r
-  GUID is the name of events used with CreateEventEx in order to be notified when the EFI boot manager is about to boot a legacy boot option.  Events of this type are notificated just before Int19h is invoked. \r
+  GUID is the name of events used with CreateEventEx in order to be notified \r
+  when the EFI boot manager is about to boot a legacy boot option.\r
+  Events of this type are notificated just before Int19h is invoked. \r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 587d8a6..2ed3a02 100644 (file)
@@ -86,7 +86,7 @@
 \r
     //\r
     // Assume standard IA-32 alignment. \r
-    // BugBug: Need to check portability of long long\r
+    // Need to check portability of long long\r
     //\r
     typedef unsigned long long  UINT64;\r
     typedef long long           INT64;\r
index 4102309..f3112ae 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  support for SCSI standard\r
+  support for SCSI-2 standard\r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
index 4b2745d..b367b02 100644 (file)
@@ -134,7 +134,7 @@ GetFirstGuidHob (
   @param  ModuleName              The GUID File Name of the module.\r
   @param  MemoryAllocationModule  The 64 bit physical address of the module.\r
   @param  ModuleLength            The length of the module in bytes.\r
-  @param  EntryPoint              The 64 bit physical address of the module\92s entry point.\r
+  @param  EntryPoint              The 64 bit physical address of the module entry point.\r
 \r
 **/\r
 VOID\r
index 513138b..bb7847d 100644 (file)
@@ -63,9 +63,8 @@ typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;
   The PEI Dispatcher will invoke each PEIM one time.  During this pass, the PEI \r
   Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
 \r
-  @param  FfsHeader Pointer to the FFS file header. \r
-  \r
-  @param  PeiServices Describes the list of possible PEI Services.\r
+  @param  FfsHeader        Pointer to the FFS file header.\r
+  @param  PeiServices      Describes the list of possible PEI Services.\r
 \r
   @return Status code\r
 \r
@@ -80,11 +79,9 @@ EFI_STATUS
 /**\r
   Entry point of the notification callback function itself within the PEIM.\r
 \r
-  @param  PeiServices Indirect reference to the PEI Services Table.\r
-  \r
+  @param  PeiServices      Indirect reference to the PEI Services Table.\r
   @param  NotifyDescriptor Address of the notification descriptor data structure.\r
-  \r
-  @param  Ppi Address of the PPI that was installed.\r
+  @param  Ppi              Address of the PPI that was installed.\r
 \r
   @return Status code\r
   \r
@@ -125,16 +122,13 @@ struct _EFI_PEI_NOTIFY_DESCRIPTOR {
   service is to publish an interface that other parties can use to call \r
   additional PEIMs.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table \r
-  published by the PEI Foundation. \r
-  \r
-  @param  PpiList A pointer to the list of interfaces that the caller shall install.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table\r
+                           published by the PEI Foundation.\r
+  @param  PpiList          A pointer to the list of interfaces that the caller shall install.\r
 \r
-  @retval EFI_SUCCESS The interface was successfully installed.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. \r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
+  @retval EFI_SUCCESS           The interface was successfully installed.\r
+  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.\r
 \r
 **/\r
 typedef\r
@@ -150,20 +144,16 @@ EFI_STATUS
   can use to replace a same-named interface in the protocol database \r
   with a different interface. \r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table \r
-  published by the PEI Foundation. \r
-  \r
-  @param  OldPpi A pointer to the former PPI in the database. \r
-  \r
-  @param  NewPpi A pointer to the new interfaces that the caller shall install.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table\r
+                           published by the PEI Foundation.\r
+  @param  OldPpi           A pointer to the former PPI in the database.\r
+  @param  NewPpi           A pointer to the new interfaces that the caller shall install.\r
 \r
-  @retval EFI_SUCCESS The interface was successfully installed.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. \r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
-  \r
-  @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
+  @retval EFI_SUCCESS           The interface was successfully installed.\r
+  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+                                list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.\r
+  @retval EFI_NOT_FOUND         The PPI for which the reinstallation was requested has not been installed.\r
 \r
 **/\r
 typedef\r
@@ -177,19 +167,14 @@ EFI_STATUS
 /**\r
   This function locates an interface in the PEI PPI database by GUID. \r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
-  \r
-  @param  Guid A pointer to the GUID whose corresponding interface needs to be found.\r
-  \r
-  @param  Instance The N-th instance of the interface that is required.\r
-  \r
-  @param  PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r
-  \r
-  @param  Ppi A pointer to the instance of the interface.  \r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
+  @param  Guid             A pointer to the GUID whose corresponding interface needs to be found.\r
+  @param  Instance         The N-th instance of the interface that is required.\r
+  @param  PpiDescriptor    A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r
+  @param  Ppi              A pointer to the instance of the interface.\r
 \r
-  @retval EFI_SUCCESS The interface was successfully returned.\r
-  \r
-  @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r
+  @retval EFI_SUCCESS           The interface was successfully returned.\r
+  @retval EFI_NOT_FOUND         The PPI descriptor is not found in the database.\r
 \r
 **/\r
 typedef\r
@@ -208,15 +193,13 @@ EFI_STATUS
   is to publish an interface that other parties can use to call additional PPIs \r
   that may materialize later.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
-  \r
-  @param  NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+  @param  NotifyList       A pointer to the list of notification interfaces that the caller shall install.\r
 \r
-  @retval EFI_SUCCESS The interface was successfully installed.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. \r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
+  @retval EFI_SUCCESS           The interface was successfully installed.\r
+  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+                                list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.\r
 \r
 **/\r
 typedef\r
@@ -229,11 +212,10 @@ EFI_STATUS
 /**\r
   This function returns the present value of the boot mode.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. \r
-  \r
-  @param  BootMode A pointer to contain the value of the boot mode.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  BootMode         A pointer to contain the value of the boot mode.\r
 \r
-  @retval EFI_SUCCESS The boot mode was returned successfully.\r
+  @retval EFI_SUCCESS           The boot mode was returned successfully.\r
 \r
 **/\r
 typedef\r
@@ -246,11 +228,10 @@ EFI_STATUS
 /**\r
   This function sets the value of the boot mode.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
-  \r
-  @param  BootMode The value of the boot mode to set.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+  @param  BootMode         The value of the boot mode to set.\r
 \r
-  @retval EFI_SUCCESS The boot mode was returned successfully.\r
+  @retval EFI_SUCCESS           The boot mode was returned successfully.\r
 \r
 **/\r
 typedef\r
@@ -263,12 +244,10 @@ EFI_STATUS
 /**\r
   This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
-  \r
-  @param  HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
+  @param  HobList          A pointer to the list of HOBs that the PEI Foundation will initialize\r
 \r
-  @retval EFI_SUCCESS The list was successfully returned.\r
-  \r
+  @retval EFI_SUCCESS           The list was successfully returned.\r
   @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r
 \r
 **/\r
@@ -282,17 +261,13 @@ EFI_STATUS
 /**\r
   This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB¡¯s) headers.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  Type The type of HOB to be installed.\r
-  \r
-  @param  Length The length of the HOB to be added.\r
-  \r
-  @param  Hob The address of a pointer that will contain the HOB header.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  Type             The type of HOB to be installed.\r
+  @param  Length           The length of the HOB to be added.\r
+  @param  Hob              The address of a pointer that will contain the HOB header.\r
 \r
-  @retval EFI_SUCCESS The HOB was successfully created.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
+  @retval EFI_SUCCESS           The HOB was successfully created.\r
+  @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.\r
 \r
 **/\r
 typedef\r
@@ -310,16 +285,12 @@ EFI_STATUS
   Given the input file pointer, this service searches for the next \r
   matching file in the Firmware File System (FFS) volume.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  Instance This instance of the firmware volume to find.  The value 0 is the Boot Firmware Volume (BFV).\r
-  \r
-  @param  FwVolHeader Pointer to the firmware volume header of the volume to return.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  Instance         This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).\r
+  @param  FwVolHeader      Pointer to the firmware volume header of the volume to return.\r
 \r
-  @retval EFI_SUCCESS The volume was found.\r
-  \r
-  @retval EFI_NOT_FOUND The volume was not found.\r
-  \r
+  @retval EFI_SUCCESS           The volume was found.\r
+  @retval EFI_NOT_FOUND         The volume was not found.\r
   @retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r
 \r
 **/\r
@@ -337,19 +308,16 @@ EFI_STATUS
   Given the input file pointer, this service searches for the next matching \r
   file in the Firmware File System (FFS) volume.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  SearchType A filter to find files only of this type.\r
-  \r
-  @param  FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter must point to a valid FFS volume.\r
-  \r
-  @param  FileHeader Pointer to the current file from which to begin searching.This pointer will be updated upon return to reflect the file found.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  SearchType       A filter to find files only of this type.\r
+  @param  FwVolHeader      Pointer to the firmware volume header of the volume to search.This parameter \r
+                           must point to a valid FFS volume.\r
+  @param  FileHeader       Pointer to the current file from which to begin searching.This pointer will be \r
+                           updated upon return to reflect the file found.\r
 \r
-  @retval EFI_SUCCESS The file was found.\r
-  \r
-  @retval EFI_NOT_FOUND The file was not found.\r
-  \r
-  @retval EFI_NOT_FOUND The header checksum was not zero.\r
+  @retval EFI_SUCCESS           The file was found.\r
+  @retval EFI_NOT_FOUND         The file was not found.\r
+  @retval EFI_NOT_FOUND         The header checksum was not zero.\r
 \r
 **/\r
 typedef\r
@@ -365,17 +333,13 @@ EFI_STATUS
   Given the input file pointer, this service searches for the next \r
   matching file in the Firmware File System (FFS) volume. \r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  SectionType The value of the section type to find.\r
-  \r
-  @param  FfsFileHeader A pointer to the file header that contains the set of sections to be searched.\r
-  \r
-  @param  SectionData A pointer to the discovered section, if successful.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  SectionType      The value of the section type to find.\r
+  @param  FfsFileHeader    A pointer to the file header that contains the set of sections to be searched.\r
+  @param  SectionData      A pointer to the discovered section, if successful.\r
 \r
-  @retval EFI_SUCCESS The section was found.\r
-  \r
-  @retval EFI_NOT_FOUND The section was not found.\r
+  @retval EFI_SUCCESS           The section was found.\r
+  @retval EFI_NOT_FOUND         The section was not found.\r
 \r
 **/\r
 typedef\r
@@ -390,17 +354,13 @@ EFI_STATUS
 /**\r
   This function registers the found memory configuration with the PEI Foundation.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  MemoryBegin The value of a region of installed memory\r
-  \r
-  @param  MemoryLength The corresponding length of a region of installed memory.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  MemoryBegin      The value of a region of installed memory\r
+  @param  MemoryLength     The corresponding length of a region of installed memory.\r
 \r
-  @retval EFI_SUCCESS The region was successfully installed in a HOB.\r
-  \r
+  @retval EFI_SUCCESS           The region was successfully installed in a HOB.\r
   @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
+  @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.\r
 \r
 **/\r
 typedef\r
@@ -415,18 +375,14 @@ EFI_STATUS
   The purpose of the service is to publish an interface that allows \r
   PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  MemoryType The type of memory to allocate. \r
-  \r
-  @param  Pages The number of contiguous 4 KB pages to allocate.\r
-  \r
-  @param  Memory Pointer to a physical address. On output, the address is set to the base of the page range that was allocated.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  MemoryType       The type of memory to allocate.\r
+  @param  Pages            The number of contiguous 4 KB pages to allocate.\r
+  @param  Memory           Pointer to a physical address. On output, the address is set to the base \r
+                           of the page range that was allocated.\r
 \r
-  @retval EFI_SUCCESS The memory range was successfully allocated.\r
-  \r
+  @retval EFI_SUCCESS           The memory range was successfully allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pages could not be allocated.\r
-  \r
   @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r
 \r
 **/\r
@@ -443,15 +399,12 @@ EFI_STATUS
   The purpose of this service is to publish an interface that \r
   allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  Size The number of bytes to allocate from the pool.\r
-  \r
-  @param  Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  Size             The number of bytes to allocate from the pool.\r
+  @param  Buffer           If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r
 \r
-  @retval EFI_SUCCESS The allocation was successful.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r
+  @retval EFI_SUCCESS           The allocation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough heap to allocate the requested size.\r
 \r
 **/\r
 typedef\r
@@ -465,11 +418,9 @@ EFI_STATUS
 /**\r
   This service copies the contents of one buffer to another buffer.\r
 \r
-  @param  Destination Pointer to the destination buffer of the memory copy.\r
-  \r
-  @param  Source Pointer to the source buffer of the memory copy\r
-  \r
-  @param  Length Number of bytes to copy from Source to Destination.\r
+  @param  Destination      Pointer to the destination buffer of the memory copy.\r
+  @param  Source           Pointer to the source buffer of the memory copy\r
+  @param  Length           Number of bytes to copy from Source to Destination.\r
 \r
   @return None\r
 \r
@@ -485,11 +436,9 @@ VOID
 /**\r
   The service fills a buffer with a specified value.\r
 \r
-  @param  Buffer Pointer to the buffer to fill.\r
-  \r
-  @param  Size Number of bytes in Buffer to fill.\r
-  \r
-  @param  Value Value to fill Buffer with\r
+  @param  Buffer           Pointer to the buffer to fill.\r
+  @param  Size             Number of bytes in Buffer to fill.\r
+  @param  Value            Value to fill Buffer with\r
 \r
   @return None\r
 \r
@@ -505,30 +454,24 @@ VOID
 /**\r
   This service publishes an interface that allows PEIMs to report status codes.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
-  \r
-  @param  Type Indicates the type of status code being reported. \r
-  \r
-  @param  Value Describes the current status of a hardware or \r
-  software entity.  This includes information about the class and \r
-  subclass that is used to classify the entity as well as an operation.\r
-  For progress codes, the operation is the current activity.\r
-  For error codes, it is the exception.For debug codes,it is not defined at this time. \r
-  \r
-  @param  Instance The enumeration of a hardware or software entity within \r
-  the system.  A system may contain multiple entities that match a class/subclass \r
-  pairing.  The instance differentiates between them.  An instance of 0 indicates \r
-  that instance information is unavailable, not meaningful, or not relevant.\r
-  Valid instance numbers start with 1.\r
-  \r
-  @param  CallerId This optional parameter may be used to identify the caller. \r
-  This parameter allows the status code driver to apply different rules to \r
-  different callers.\r
-  \r
-  @param  Data This optional parameter may be used to pass additional data.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param  Type             Indicates the type of status code being reported.\r
+  @param  Value            Describes the current status of a hardware or\r
+                           software entity. This includes information about the class and\r
+                           subclass that is used to classify the entity as well as an operation.\r
+                           For progress codes, the operation is the current activity.\r
+                           For error codes, it is the exception.For debug codes,it is not defined at this time.\r
+  @param  Instance         The enumeration of a hardware or software entity within\r
+                           the system. A system may contain multiple entities that match a class/subclass\r
+                           pairing. The instance differentiates between them. An instance of 0 indicates\r
+                           that instance information is unavailable, not meaningful, or not relevant.\r
+                           Valid instance numbers start with 1.\r
+  @param  CallerId         This optional parameter may be used to identify the caller.\r
+                           This parameter allows the status code driver to apply different rules to\r
+                           different callers.\r
+  @param  Data             This optional parameter may be used to pass additional data.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.\r
 \r
 **/\r
@@ -546,11 +489,10 @@ EFI_STATUS
 /**\r
   Resets the entire platform.\r
 \r
-  @param  PeiServices An indirect pointer to the EFI_PEI_SERVICES \r
-  table published by the PEI Foundation.\r
+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES\r
+                           table published by the PEI Foundation.\r
 \r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
+  @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
 \r
 **/\r
index debcc0c..4bb029f 100644 (file)
@@ -48,10 +48,8 @@ typedef struct {
 /**\r
   Gets the count of block I/O devices that one specific block driver detects.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM.\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
-  \r
+  @param  PeiServices        General-purpose services that are available to every PEIM.\r
+  @param  This               Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
   @param  NumberBlockDevices The number of block I/O devices discovered.\r
 \r
   @return Status code\r
@@ -68,21 +66,17 @@ EFI_STATUS
 /**\r
   Gets a block device¡¯s media information.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. \r
-  \r
-  @param  DeviceIndex Specifies the block device to which the function \r
-  wants to talk. Because the driver that implements Block I/O PPIs \r
-  will manage multiple block devices, the PPIs that want to talk to a single \r
-  device must specify the device index that was assigned during the enumeration \r
-  process. This index is a number from one to NumberBlockDevices.\r
-  \r
-  @param  MediaInfo The media information of the specified block media.\r
-\r
-  @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.\r
-  \r
-  @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.\r
+  @param  PeiServices    General-purpose services that are available to every PEIM\r
+  @param  This           Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
+  @param  DeviceIndex    Specifies the block device to which the function\r
+                         wants to talk. Because the driver that implements Block I/O PPIs\r
+                         will manage multiple block devices, the PPIs that want to talk to a single\r
+                         device must specify the device index that was assigned during the enumeration\r
+                         process. This index is a number from one to NumberBlockDevices.\r
+  @param  MediaInfo      The media information of the specified block media.\r
+\r
+  @retval EFI_SUCCESS           Media information about the specified block device was obtained successfully.\r
+  @retval EFI_DEVICE_ERROR      Cannot get the media information due to a hardware error.\r
 \r
 **/\r
 typedef\r
@@ -97,31 +91,22 @@ EFI_STATUS
 /**\r
   Reads the requested number of blocks from the specified block device.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM.\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
-  \r
-  @param  DeviceIndex Specifies the block device to which the function wants to talk.\r
-  \r
-  @param  StartLBA The starting logical block address (LBA) to read from on the device\r
-  \r
-  @param  BufferSize The size of the Buffer in bytes. This number must \r
-  be a multiple of the intrinsic block size of the device.\r
-  \r
-  @param  Buffer A pointer to the destination buffer for the data.\r
-  The caller is responsible for the ownership of the buffer.\r
-\r
-  @retval EFI_SUCCESS The data was read correctly from the device.\r
-  \r
-  @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
-  \r
+  @param  PeiServices    General-purpose services that are available to every PEIM.\r
+  @param  This           Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
+  @param  DeviceIndex    Specifies the block device to which the function wants to talk.\r
+  @param  StartLBA       The starting logical block address (LBA) to read from on the device\r
+  @param  BufferSize     The size of the Buffer in bytes. This number must\r
+                         be a multiple of the intrinsic block size of the device.\r
+  @param  Buffer         A pointer to the destination buffer for the data.\r
+                         The caller is responsible for the ownership of the buffer.\r
+\r
+  @retval EFI_SUCCESS           The data was read correctly from the device.\r
+  @retval EFI_DEVICE_ERROR      The device reported an error while attempting to perform the read operation.\r
   @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
-  or the buffer is not properly aligned.\r
-  \r
-  @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of \r
-  the intrinsic block size of the device.\r
-  \r
-  @retval EFI_NO_MEDIA There is no media in the device.\r
+                                or the buffer is not properly aligned.\r
+  @retval EFI_BAD_BUFFER_SIZE   The BufferSize parameter is not a multiple of\r
+                                the intrinsic block size of the device.\r
+  @retval EFI_NO_MEDIA          There is no media in the device.\r
 \r
 **/\r
 typedef\r
index b73396d..5b10292 100644 (file)
@@ -31,25 +31,19 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
 /**\r
   Executes the Framework boot script table.\r
 \r
-  @param  PeiServices A pointer to the system PEI Services Table.\r
-  \r
-  @param  This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r
-  \r
-  @param  Address The physical memory address where the table is stored. \r
-  It must be zero if the table to be executed is stored in a firmware volume file.\r
-  \r
-  @param  FvFile The firmware volume file name that contains the table to \r
-  be executed. It must be NULL if the table to be executed is stored in physical memory.\r
-\r
-  @retval EFI_SUCCESS The boot script table was executed successfully.\r
-  \r
+  @param  PeiServices    A pointer to the system PEI Services Table.\r
+  @param  This           A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r
+  @param  Address        The physical memory address where the table is stored.\r
+                         It must be zero if the table to be executed is stored in a firmware volume file.\r
+  @param  FvFile         The firmware volume file name that contains the table to\r
+                         be executed. It must be NULL if the table to be executed is stored in physical memory.\r
+\r
+  @retval EFI_SUCCESS           The boot script table was executed successfully.\r
   @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r
-  \r
-  @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r
-  \r
-  @retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r
-  Or An unsupported opcode occurred in the table.\r
-  Or There were opcode execution errors, such as an insufficient dependency.\r
+  @retval EFI_NOT_FOUND         The file name specified in FvFile cannot be found.\r
+  @retval EFI_UNSUPPORTED       The format of the boot script table is invalid.\r
+                                Or An unsupported opcode occurred in the table.\r
+                                Or There were opcode execution errors, such as an insufficient dependency.\r
 \r
 **/\r
 typedef\r
index 0387033..791348d 100644 (file)
@@ -52,21 +52,15 @@ typedef enum {
 /**\r
   Memory-based access services and I/O-based access services.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Width The width of the access.  Enumerated in bytes.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Count The number of accesses to perform.\r
-  \r
-  @param  Buffer A pointer to the buffer of data.\r
-\r
-  @retval EFI_SUCCESS  The function completed successfully. \r
-  \r
-  @retval EFI_NOT_YET_AVAILABLE  The service has not been installed.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Width          The width of the access. Enumerated in bytes.\r
+  @param  Address        The physical address of the access.\r
+  @param  Count          The number of accesses to perform.\r
+  @param  Buffer         A pointer to the buffer of data.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
 \r
 **/\r
 typedef\r
@@ -93,11 +87,9 @@ typedef struct {
 /**\r
   8-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT8\r
 \r
@@ -113,11 +105,9 @@ UINT8
 /**\r
   16-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT16\r
 \r
@@ -133,11 +123,9 @@ UINT16
 /**\r
   32-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT32\r
 \r
@@ -153,11 +141,9 @@ UINT32
 /**\r
   64-bit I/O read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT64\r
 \r
@@ -173,13 +159,10 @@ UINT64
 /**\r
   8-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -196,13 +179,10 @@ VOID
 /**\r
   16-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -219,13 +199,10 @@ VOID
 /**\r
   32-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -242,13 +219,10 @@ VOID
 /**\r
   64-bit I/O write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -265,11 +239,9 @@ VOID
 /**\r
   8-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT8\r
 \r
@@ -285,11 +257,9 @@ UINT8
 /**\r
   16-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT16\r
 \r
@@ -305,11 +275,9 @@ UINT16
 /**\r
   32-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT32\r
 \r
@@ -325,11 +293,9 @@ UINT32
 /**\r
   64-bit Memory read operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
 \r
   @return UINT64\r
 \r
@@ -345,13 +311,10 @@ UINT64
 /**\r
   8-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -368,13 +331,10 @@ VOID
 /**\r
   16-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -391,13 +351,10 @@ VOID
 /**\r
   32-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
@@ -414,13 +371,10 @@ VOID
 /**\r
   64-bit Memory write operations.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Data The data to write.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Address        The physical address of the access.\r
+  @param  Data           The data to write.\r
 \r
   @return None\r
 \r
index 3847686..46c5cde 100644 (file)
@@ -34,19 +34,15 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL
   the capsules discovered. Entry 1 is assumed to be the highest load priority \r
   and entry N is assumed to be the lowest priority.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  \r
-  @param  NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output, \r
-  *NumberRecoveryCapsules contains the number of recovery capsule images available \r
-  for retrieval from this PEIM instance.\r
-\r
-  @retval EFI_SUCCESS One or more capsules were discovered.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  PeiServices            General-purpose services that are available to every PEIM\r
+  @param  This                   Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
+  @param  NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,\r
+                                 *NumberRecoveryCapsules contains the number of recovery capsule \r
+                                 images available for retrieval from this PEIM instance.\r
+\r
+  @retval EFI_SUCCESS           One or more capsules were discovered.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r
@@ -60,23 +56,17 @@ EFI_STATUS
 /**\r
   This function gets the size and type of the requested recovery capsule.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  \r
+  @param  PeiServices     General-purpose services that are available to every PEIM\r
+  @param  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
   @param  CapsuleInstance Specifies for which capsule instance to retrieve the information.\r
-  \r
-  @param  Size A pointer to a caller-allocated UINTN in which the size of \r
-  the requested recovery module is returned.\r
-  \r
-  @param  CapsuleType A pointer to a caller-allocated EFI_GUID in \r
-  which the type of the requested recovery capsule is returned.\r
-\r
-  @retval EFI_SUCCESS One or more capsules were discovered.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  Size            A pointer to a caller-allocated UINTN in which the size of\r
+                          the requested recovery module is returned.\r
+  @param  CapsuleType     A pointer to a caller-allocated EFI_GUID in\r
+                          which the type of the requested recovery capsule is returned.\r
+\r
+  @retval EFI_SUCCESS           One or more capsules were discovered.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r
@@ -93,19 +83,15 @@ EFI_STATUS
   This function, by whatever mechanism, retrieves a DXE capsule from some device \r
   and loads it into memory. Note that the published interface is device neutral.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  \r
+  @param  PeiServices     General-purpose services that are available to every PEIM\r
+  @param  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
   @param  CapsuleInstance Specifies which capsule instance to retrieve.\r
-  \r
-  @param  Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned. \r
-\r
-  @retval EFI_SUCCESS One or more capsules were discovered.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  Buffer          Specifies a caller-allocated buffer in which the requested \r
+                          recovery capsule will be returned.\r
+\r
+  @retval EFI_SUCCESS           One or more capsules were discovered.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r
index bed5795..3a92135 100644 (file)
@@ -33,14 +33,12 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
   The architectural PPI that the PEI Foundation invokes when \r
   there are no additional PEIMs to invoke.\r
 \r
-  @param  This Pointer to the DXE IPL PPI instance\r
-  \r
-  @param  PeiServices Pointer to the PEI Services Table.\r
-  \r
-  @param  HobList Pointer to the list of Hand-Off Block (HOB) entries.\r
-\r
-  @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter \r
-  some exception handling.Under normal circumstances, the DXE IPL PPI should not return.\r
+  @param  This           Pointer to the DXE IPL PPI instance\r
+  @param  PeiServices    Pointer to the PEI Services Table.\r
+  @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.\r
+\r
+  @retval EFI_SUCCESS           Upon this return code, the PEI Foundation should enter\r
+                                some exception handling.Under normal circumstances, the DXE IPL PPI should not return.\r
 \r
 **/\r
 typedef\r
index 9715125..9a3e173 100644 (file)
@@ -33,18 +33,13 @@ typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
   was passed in FvNumber.Once this function reports a firmware volume \r
   index/base address pair, that index/address pairing must continue throughout PEI.\r
 \r
-  @param  PeiServices Pointer to the PEI Services Table.\r
-  \r
-  @param  This Interface pointer that implements the Find FV service.\r
-  \r
-  @param  FvNumber The index of the firmware volume to locate.\r
-  \r
-  @param  FvAddress The address of the volume to discover.\r
-\r
-  @retval EFI_SUCCESS An additional firmware volume was found.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.\r
-  \r
+  @param  PeiServices    Pointer to the PEI Services Table.\r
+  @param  This           Interface pointer that implements the Find FV service.\r
+  @param  FvNumber       The index of the firmware volume to locate.\r
+  @param  FvAddress      The address of the volume to discover.\r
+\r
+  @retval EFI_SUCCESS           An additional firmware volume was found.\r
+  @retval EFI_OUT_OF_RESOURCES  There are no firmware volumes for the given FvNumber.\r
   @retval EFI_INVALID_PARAMETER *FvAddress is NULL.\r
 \r
 **/\r
index af02be7..f6d8a70 100644 (file)
@@ -30,22 +30,16 @@ typedef struct _EFI_PEI_FV_FILE_LOADER_PPI  EFI_PEI_FV_FILE_LOADER_PPI;
 /**\r
   Loads a PEIM into memory for subsequent execution.\r
 \r
-  @param  This Interface pointer that implements the Load File PPI instance.\r
-  \r
-  @param  FfsHeader Pointer to the FFS header of the file to load.\r
-  \r
-  @param  ImageAddress Pointer to the address of the loaded Image\r
-  \r
-  @param  ImageSize Pointer to the size of the loaded image.\r
-  \r
-  @param  EntryPoint Pointer to the entry point of the image.\r
-\r
-  @retval EFI_SUCCESS The image was loaded successfully.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There was not enough memory.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The contents of the FFS file did not \r
-  contain a valid PE/COFF image that could be loaded.\r
+  @param  This           Interface pointer that implements the Load File PPI instance.\r
+  @param  FfsHeader      Pointer to the FFS header of the file to load.\r
+  @param  ImageAddress   Pointer to the address of the loaded Image\r
+  @param  ImageSize      Pointer to the size of the loaded image.\r
+  @param  EntryPoint     Pointer to the entry point of the image.\r
+\r
+  @retval EFI_SUCCESS           The image was loaded successfully.\r
+  @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
+  @retval EFI_INVALID_PARAMETER The contents of the FFS file did not\r
+                                contain a valid PE/COFF image that could be loaded.\r
 \r
 **/\r
 typedef\r
index b38a0db..987f54e 100644 (file)
@@ -51,19 +51,14 @@ typedef struct {
 /**\r
   PCI read and write operation.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table \r
-  published by the PEI Foundation.\r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Width The width of the access. Enumerated in bytes.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  Buffer A pointer to the buffer of data.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
+  @param  PeiServices    An indirect pointer to the PEI Services Table\r
+                         published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Width          The width of the access. Enumerated in bytes.\r
+  @param  Address        The physical address of the access.\r
+  @param  Buffer         A pointer to the buffer of data.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
 \r
 **/\r
@@ -80,20 +75,15 @@ EFI_STATUS
 /**\r
   PCI read-modify-write operation.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table \r
-  published by the PEI Foundation.\r
-  \r
-  @param  This Pointer to local data for the interface.\r
-  \r
-  @param  Width The width of the access. Enumerated in bytes.\r
-  \r
-  @param  Address The physical address of the access.\r
-  \r
-  @param  SetBits Value of the bits to set.\r
-  \r
-  @param  ClearBits Value of the bits to clear.\r
-\r
-  @retval EFI_SUCCESS  The function completed successfully.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table\r
+                         published by the PEI Foundation.\r
+  @param  This           Pointer to local data for the interface.\r
+  @param  Width          The width of the access. Enumerated in bytes.\r
+  @param  Address        The physical address of the access.\r
+  @param  SetBits        Value of the bits to set.\r
+  @param  ClearBits      Value of the bits to clear.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
 \r
 **/\r
 typedef\r
@@ -119,7 +109,7 @@ EFI_STATUS
   PCI write services.  See the Write() function description.\r
 \r
   @param Modify\r
-PCI read-modify-write services.  See the Modify() function description.\r
+  PCI read-modify-write services.  See the Modify() function description.\r
 \r
 **/\r
 struct _EFI_PEI_PCI_CFG_PPI {\r
index 3ea3c77..e730ce8 100644 (file)
@@ -39,29 +39,20 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 /**\r
   Get Variable value by Name and GUID pair\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
-  @param  VariableName A NULL-terminated Unicode string that is the name of the vendor¡¯s variable. \r
-  \r
-  @param  VendorGuid A unique identifier for the vendor.\r
-  \r
-  @param  Attributes If not NULL, a pointer to the memory location to return \r
-  the attributes bitmask for the variable.\r
-  \r
-  @param  DataSize On input, the size in bytes of the return Data buffer.\r
-  On output, the size of data returned in Data.\r
-  \r
-  @param  Data The buffer to return the contents of the variable.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
-  @retval EFI_NOT_FOUND The variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r
-  \r
+  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param  VariableName   A NULL-terminated Unicode string that is the name of the vendor¡¯s variable.\r
+  @param  VendorGuid     A unique identifier for the vendor.\r
+  @param  Attributes     If not NULL, a pointer to the memory location to return\r
+                         the attributes bitmask for the variable.\r
+  @param  DataSize       On input, the size in bytes of the return Data buffer.\r
+                         On output, the size of data returned in Data.\r
+  @param  Data           The buffer to return the contents of the variable.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The BufferSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be retrieved due to a hardware error.\r
 \r
 **/\r
 typedef\r
@@ -82,27 +73,20 @@ EFI_STATUS
   and on output the interface returns the next variable name data.  When the \r
   entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. \r
-  \r
+  @param  PeiServices      An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  VariableNameSize The size of the VariableName buffer.\r
-  \r
-  @param  VariableName On input, supplies the last VariableName that was \r
-  returned by GetNextVariableName().  On output, returns the Null-terminated \r
-  Unicode string of the current variable.\r
-  \r
-  @param  VendorGuid On input, supplies the last VendorGuid that was \r
-  returned by GetNextVariableName().  On output, returns the VendorGuid \r
-  of the current variable.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
-  @retval EFI_NOT_FOUND The next variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r
-  \r
+  @param  VariableName     On input, supplies the last VariableName that was\r
+                           returned by GetNextVariableName(). On output, returns the Null-terminated\r
+                           Unicode string of the current variable.\r
+  @param  VendorGuid       On input, supplies the last VendorGuid that was\r
+                           returned by GetNextVariableName(). On output, returns the VendorGuid\r
+                           of the current variable.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The next variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r
+  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to a hardware error.\r
 \r
 **/\r
 typedef\r
index 044a68a..8dbb951 100644 (file)
@@ -32,15 +32,12 @@ typedef struct _EFI_PEI_RECOVERY_MODULE_PPI EFI_PEI_RECOVERY_MODULE_PPI;
   Loads a DXE capsule from some media into memory and updates the HOB table \r
   with the DXE firmware volume information.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM.\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance. \r
-\r
-  @retval EFI_SUCCESS The capsule was loaded correctly.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  PeiServices    General-purpose services that are available to every PEIM.\r
+  @param  This           Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.\r
+\r
+  @retval EFI_SUCCESS           The capsule was loaded correctly.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r
index c458430..c5c0259 100644 (file)
@@ -32,12 +32,11 @@ typedef struct _EFI_PEI_S3_RESUME_PPI   EFI_PEI_S3_RESUME_PPI;
   Restores the platform to its preboot configuration for an S3 resume and \r
   jumps to the OS waking vector.\r
 \r
-  @param  PeiServices Pointer to the PEI Services Table\r
+  @param  PeiServices    Pointer to the PEI Services Table\r
 \r
-  @retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r
-  \r
-  @retval EFI_NOT_FOUND Some necessary information that is used for \r
-  the S3 resume boot path could not be located.\r
+  @retval EFI_ABORTED           Execution of the S3 resume boot script table failed.\r
+  @retval EFI_NOT_FOUND         Some necessary information that is used for\r
+                                the S3 resume boot path could not be located.\r
 \r
 **/\r
 typedef\r
index 1e96259..b7dd03e 100644 (file)
@@ -54,15 +54,12 @@ typedef struct {
 /**\r
   This interface conveys state information out of the Security (SEC) phase into PEI.\r
 \r
-  @param  PeiServices Pointer to the PEI Services Table.\r
-  \r
-  @param  StructureSize Pointer to the variable describing size of the input buffer.\r
-  \r
-  @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD. \r
-\r
-  @retval EFI_SUCCESS The data was successfully returned.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer was too small.\r
+  @param  PeiServices               Pointer to the PEI Services Table.\r
+  @param  StructureSize             Pointer to the variable describing size of the input buffer.\r
+  @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
+\r
+  @retval EFI_SUCCESS           The data was successfully returned.\r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.\r
 \r
 **/\r
 typedef\r
index afa473d..fb95f60 100644 (file)
@@ -41,50 +41,40 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
   It will retrieve both encapsulation sections and leaf sections in their entirety,\r
   exclusive of the section header.\r
 \r
-  @param  PeiServices Pointer to the PEI Services Table.\r
-  \r
-  @param  This Indicates the calling context\r
-  \r
-  @param  SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL, \r
-  the contents of the entire section are returned in Buffer. If SectionType \r
-  is not NULL, only the requested section is returned.\r
-  \r
-  @param  SectionDefinitionGuid Pointer to an EFI_GUID.\r
-  If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid \r
-  indicates for which section GUID to search.\r
-  If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid \r
-  is unused and is ignored.\r
-  \r
-  @param  SectionInstance If SectionType is not NULL, indicates which \r
-  instance of the requested section type to return.\r
-  \r
-  @param  Buffer Pointer to a pointer to a buffer in which the section \r
-  contents are returned.\r
-  \r
-  @param  BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize \r
-  indicates the size in bytes of the memory region pointed to by Buffer.On output,\r
-  *BufferSize contains the number of bytes required to read the section.\r
-  \r
-  @param  AuthenticationStatus A pointer to a caller-allocated UINT32 in \r
-  which any metadata from encapsulating GUID-defined sections is returned.\r
-\r
-  @retval EFI_SUCCESS The section was successfully processed and the section \r
-  contents were returned in Buffer.\r
-  \r
-  @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in \r
-  the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but \r
-  there was no corresponding GUIDed Section Extraction Protocol in the \r
-  handle database.*Buffer is unmodified.\r
-  \r
-  @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.\r
-  \r
+  @param  PeiServices    Pointer to the PEI Services Table.\r
+  @param  This           Indicates the calling context\r
+  @param  SectionType    Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,\r
+                         the contents of the entire section are returned in Buffer. If SectionType\r
+                         is not NULL, only the requested section is returned.\r
+  @param  SectionDefinitionGuid \r
+                         Pointer to an EFI_GUID.\r
+                         If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
+                         indicates for which section GUID to search.\r
+                         If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
+                         is unused and is ignored.\r
+  @param  SectionInstance If SectionType is not NULL, indicates which\r
+                         instance of the requested section type to return.\r
+  @param  Buffer         Pointer to a pointer to a buffer in which the section\r
+                         contents are returned.\r
+  @param  BufferSize     A pointer to a caller-allocated UINT32.On input, *BufferSize\r
+                         indicates the size in bytes of the memory region pointed to by Buffer.On output,\r
+                         *BufferSize contains the number of bytes required to read the section.\r
+  @param  AuthenticationStatus \r
+                         A pointer to a caller-allocated UINT32 in\r
+                         which any metadata from encapsulating GUID-defined sections is returned.\r
+\r
+  @retval EFI_SUCCESS           The section was successfully processed and the section\r
+                                contents were returned in Buffer.\r
+  @retval EFI_PROTOCOL_ERROR    A GUID-defined section was encountered in\r
+                                the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but\r
+                                there was no corresponding GUIDed Section Extraction Protocol in the\r
+                                handle database.*Buffer is unmodified.\r
+  @retval EFI_NOT_FOUND         The requested section does not exist.*Buffer is unmodified.\r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to process the request.\r
   @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
-  \r
-  @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to \r
-  contain the requested section.  The input buffer is filled and contents are\r
-  section contents are truncated.\r
+  @retval EFI_WARN_TOO_SMALL    The size of the input buffer is insufficient to\r
+                                contain the requested section. The input buffer is filled and contents are\r
+                                section contents are truncated.\r
 \r
 **/\r
 typedef\r
index cc59023..b0f0626 100644 (file)
@@ -32,18 +32,14 @@ typedef struct _EFI_PEI_SECURITY_PPI  EFI_PEI_SECURITY_PPI;
   Allows the platform builder to implement a security policy in response \r
   to varying file authentication states.\r
 \r
-  @param  PeiServices Pointer to the PEI Services Table.\r
-  \r
-  @param  This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.\r
-  \r
-  @param  AuthenticationStatus Status returned by the verification service as part of section extraction.\r
-  \r
-  @param  FfsFileHeader Pointer to the file under review. \r
-  \r
+  @param  PeiServices    Pointer to the PEI Services Table.\r
+  @param  This           Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.\r
+  @param  AuthenticationStatus \r
+                         Status returned by the verification service as part of section extraction.\r
+  @param  FfsFileHeader  Pointer to the file under review.\r
   @param  DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.\r
 \r
-  @retval EFI_SUCCESS The service performed its action successfully.\r
-  \r
+  @retval EFI_SUCCESS           The service performed its action successfully.\r
   @retval EFI_SECURITY_VIOLATION The object cannot be trusted\r
 \r
 **/\r
index 7360e5b..c0e1d90 100644 (file)
@@ -31,48 +31,34 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
 /**\r
   Executes an SMBus operation to an SMBus controller.\r
 \r
-  @param  PeiServices A pointer to the system PEI Services Table.\r
-  \r
-  @param  This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  \r
-  @param  SlaveAddress The SMBUS hardware address to which the SMBUS \r
-  device is preassigned or allocated. \r
-  \r
-  @param  Command This command is transmitted by the SMBus host \r
-  controller to the SMBus slave device and the interpretation is \r
-  SMBus slave device specific.\r
-  \r
-  @param  Operation Signifies which particular SMBus hardware protocol \r
-  instance that it will use to execute the SMBus transactions. \r
-  \r
-  @param  PecCheck Defines if Packet Error Code (PEC) checking is required \r
-  for this operation.\r
-  \r
-  @param  Length Signifies the number of bytes that this operation will do.\r
-  \r
-  @param  Buffer Contains the value of data to execute to the SMBus slave device.\r
-\r
-  @retval EFI_SUCCESS The last data that was returned from the access \r
-  matched the poll exit criteria.\r
-  \r
-  @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)\r
-  \r
-  @retval EFI_TIMEOUT Timeout expired before the operation was completed. \r
-  Timeout is determined by the SMBus host controller device.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES The request could not be completed \r
-  due to a lack of resources.\r
-  \r
-  @retval EFI_DEVICE_ERROR The request was not completed because \r
-  a failure reflected in the Host Status Register bit.\r
-  \r
+  @param  PeiServices    A pointer to the system PEI Services Table.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
+                         device is preassigned or allocated.\r
+  @param  Command        This command is transmitted by the SMBus host\r
+                         controller to the SMBus slave device and the interpretation is\r
+                         SMBus slave device specific.\r
+  @param  Operation      Signifies which particular SMBus hardware protocol\r
+                         instance that it will use to execute the SMBus transactions.\r
+  @param  PecCheck       Defines if Packet Error Code (PEC) checking is required\r
+                         for this operation.\r
+  @param  Length         Signifies the number of bytes that this operation will do.\r
+  @param  Buffer         Contains the value of data to execute to the SMBus slave device.\r
+\r
+  @retval EFI_SUCCESS           The last data that was returned from the access\r
+                                matched the poll exit criteria.\r
+  @retval EFI_CRC_ERROR         The checksum is not correct (PEC is incorrect)\r
+  @retval EFI_TIMEOUT           Timeout expired before the operation was completed.\r
+                                Timeout is determined by the SMBus host controller device.\r
+  @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
+                                due to a lack of resources.\r
+  @retval EFI_DEVICE_ERROR      The request was not completed because\r
+                                a failure reflected in the Host Status Register bit.\r
   @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
-  Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and \r
-  EfiSmbusQuickWrite. Length is outside the range of valid values.\r
-  \r
-  @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.\r
+                                Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\r
+                                EfiSmbusQuickWrite. Length is outside the range of valid values.\r
+  @retval EFI_UNSUPPORTED       The SMBus operation or PEC is not supported.\r
+  @retval EFI_BUFFER_TOO_SMALL  Buffer is not sufficient for this operation.\r
 \r
 **/\r
 typedef\r
@@ -102,15 +88,12 @@ typedef struct {
 /**\r
   CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
 \r
-  @param  PeiServices A pointer to the system PEI Services Table.\r
-  \r
-  @param  This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  \r
-  @param  SlaveAddress The SMBUS hardware address to which the SMBUS \r
-  device is preassigned or allocated.\r
-  \r
-  @param  Data Data of the SMBus host notify command that \r
-  the caller wants to be called.\r
+  @param  PeiServices    A pointer to the system PEI Services Table.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  SlaveAddress   The SMBUS hardware address to which the SMBUS\r
+                         device is preassigned or allocated.\r
+  @param  Data           Data of the SMBus host notify command that\r
+                         the caller wants to be called.\r
 \r
   @return Status Code\r
 \r
@@ -128,32 +111,24 @@ EFI_STATUS
   The ArpDevice() function enumerates the entire bus or enumerates a specific \r
   device that is identified by SmbusUdid. \r
 \r
-  @param  PeiServices A pointer to the system PEI Services Table.\r
-  \r
-  @param  This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  \r
-  @param  ArpAll A Boolean expression that indicates if the host drivers need \r
-  to enumerate all the devices or enumerate only the device that is identified \r
-  by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional. \r
-  If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address \r
-  will be at SlaveAddress.\r
-  \r
-  @param  SmbusUdid The targeted SMBus Unique Device Identifier (UDID). \r
-  The UDID may not exist for SMBus devices with fixed addresses. \r
-  \r
-  @param  SlaveAddress The new SMBus address for the slave device for \r
-  which the operation is targeted. \r
-\r
-  @retval EFI_SUCCESS The SMBus slave device address was set.\r
-  \r
+  @param  PeiServices    A pointer to the system PEI Services Table.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  ArpAll         A Boolean expression that indicates if the host drivers need\r
+                         to enumerate all the devices or enumerate only the device that is identified\r
+                         by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.\r
+                         If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address\r
+                         will be at SlaveAddress.\r
+  @param  SmbusUdid      The targeted SMBus Unique Device Identifier (UDID).\r
+                         The UDID may not exist for SMBus devices with fixed addresses.\r
+  @param  SlaveAddress   The new SMBus address for the slave device for\r
+                         which the operation is targeted.\r
+\r
+  @retval EFI_SUCCESS           The SMBus slave device address was set.\r
   @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES The request could not be completed \r
-  due to a lack of resources.\r
-  \r
-  @retval EFI_TIMEOUT The SMBus slave device did not respond.\r
-  \r
-  @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.\r
+  @retval EFI_OUT_OF_RESOURCES  The request could not be completed\r
+                                due to a lack of resources.\r
+  @retval EFI_TIMEOUT           The SMBus slave device did not respond.\r
+  @retval EFI_DEVICE_ERROR      The request was not completed because the transaction failed.\r
 \r
 **/\r
 typedef\r
@@ -175,16 +150,13 @@ typedef struct {
   The GetArpMap() function returns the mapping of all the SMBus devices \r
   that are enumerated by the SMBus host driver. \r
 \r
-  @param  PeiServices A pointer to the system PEI Services Table.\r
-  \r
-  @param  This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  \r
-  @param  Length Size of the buffer that contains the SMBus device map.\r
-  \r
-  @param  SmbusDeviceMap The pointer to the device map as enumerated \r
-  by the SMBus controller driver.\r
+  @param  PeiServices    A pointer to the system PEI Services Table.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  Length         Size of the buffer that contains the SMBus device map.\r
+  @param  SmbusDeviceMap The pointer to the device map as enumerated\r
+                         by the SMBus controller driver.\r
 \r
-  @retval EFI_SUCCESS The device map was returned correctly in the buffer.\r
+  @retval EFI_SUCCESS           The device map was returned correctly in the buffer.\r
 \r
 **/\r
 typedef\r
@@ -200,20 +172,16 @@ EFI_STATUS
   The Notify() function registers all the callback functions to allow the \r
   bus driver to call these functions when the SlaveAddress/Data pair happens.\r
 \r
-  @param  PeiServices A pointer to the system PEI Services Table.\r
-  \r
-  @param  This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
-  \r
-  @param  SlaveAddress Address that the host controller detects as \r
-  sending a message and calls all the registered functions.\r
-  \r
-  @param  Data Data that the host controller detects as sending a message \r
-  and calls all the registered functions.\r
-  \r
-  @param  NotifyFunction The function to call when the bus driver \r
-  detects the SlaveAddress and Data pair.\r
-\r
-  @retval EFI_SUCCESS NotifyFunction has been registered.\r
+  @param  PeiServices    A pointer to the system PEI Services Table.\r
+  @param  This           A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+  @param  SlaveAddress   Address that the host controller detects as\r
+                         sending a message and calls all the registered functions.\r
+  @param  Data           Data that the host controller detects as sending a message\r
+                         and calls all the registered functions.\r
+  @param  NotifyFunction The function to call when the bus driver\r
+                         detects the SlaveAddress and Data pair.\r
+\r
+  @retval EFI_SUCCESS           NotifyFunction has been registered.\r
 \r
 **/\r
 typedef\r
index 363baa6..a54e7ce 100644 (file)
@@ -34,14 +34,12 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI;
   The Stall() function provides a blocking stall for at least the number \r
   of microseconds stipulated in the final argument of the API.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table \r
-  published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to the local data for the interface.\r
-  \r
-  @param  Microseconds Number of microseconds for which to stall.\r
-\r
-  @retval EFI_SUCCESS The service provided at least the required delay.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table\r
+                         published by the PEI Foundation.\r
+  @param  This           Pointer to the local data for the interface.\r
+  @param  Microseconds   Number of microseconds for which to stall.\r
+\r
+  @retval EFI_SUCCESS           The service provided at least the required delay.\r
 \r
 **/\r
 typedef\r
index 790cdf2..5702cb4 100644 (file)
@@ -64,19 +64,14 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;
 /**\r
   Returns a requested ACPI table.\r
 \r
-  @param  This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
-  \r
-  @param  Index The zero-based index of the table to retrieve.\r
-  \r
-  @param  Table Pointer for returning the table buffer.\r
-  \r
-  @param  Version Updated with the ACPI versions to which this table belongs.\r
-  \r
-  @param  Handle Pointer for identifying the table.\r
+  @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+  @param  Index                 The zero-based index of the table to retrieve.\r
+  @param  Table                 Pointer for returning the table buffer.\r
+  @param  Version               Updated with the ACPI versions to which this table belongs.\r
+  @param  Handle                Pointer for identifying the table.\r
 \r
-  @retval EFI_SUCCESS The function completed successfully.\r
-  \r
-  @retval EFI_NOT_FOUND The requested index is too large and a table was not found.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The requested index is too large and a table was not found.\r
 \r
 **/\r
 typedef\r
@@ -92,22 +87,16 @@ EFI_STATUS
 /**\r
   Used to add, remove, or update ACPI tables.\r
 \r
-  @param  This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
-  \r
-  @param  Table Pointer to the new table to add or update.\r
-  \r
-  @param  Checksum If TRUE, indicates that the checksum should be \r
-  calculated for this table.\r
-  \r
-  @param  Version Indicates to which version(s) of ACPI the table should be added.\r
-  \r
-  @param  Pointer to the handle of the table to remove or update.\r
+  @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+  @param  Table                 Pointer to the new table to add or update.\r
+  @param  Checksum              If TRUE, indicates that the checksum should be\r
+                                calculated for this table.\r
+  @param  Version               Indicates to which version(s) of ACPI the table should be added.\r
+  @param  Pointer               to the handle of the table to remove or update.\r
 \r
-  @retval EFI_SUCCESS The function completed successfully.\r
-  \r
+  @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r
-  \r
-  @retval EFI_ABORTED Could not complete the desired action.\r
+  @retval EFI_ABORTED           Could not complete the desired action.\r
 \r
 **/\r
 typedef\r
@@ -124,13 +113,11 @@ EFI_STATUS
   Causes one or more versions of the ACPI tables to be published in \r
   the EFI system configuration tables.\r
 \r
-  @param  This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
-  \r
-  @param  Version Indicates to which version(s) of ACPI that the table should be published. \r
+  @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+  @param  Version               Indicates to which version(s) of ACPI that the table should be published.\r
 \r
-  @retval EFI_SUCCESS The function completed successfully.\r
-  \r
-  @retval EFI_ABORTED An error occurred and the function could not complete successfully.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_ABORTED           An error occurred and the function could not complete successfully.\r
 \r
 **/\r
 typedef\r
index ffc66f6..138a327 100644 (file)
@@ -136,7 +136,7 @@ typedef struct {
                                    version numbers are updated with the major and minor version\r
                                    numbers of the interface                                    \r
   @param  TargetAddress            Indicates a network or device address of the BIS platform to connect to.                                                                 \r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the                \r
                                    caller was not compatible with the interface version of the\r
@@ -164,7 +164,7 @@ EFI_STATUS
   @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
                                    of the BIS service.                                                                                         \r
   @param  ToFree                   An EFI_BIS_DATA* and associated memory block to be freed.\r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_NO_MAPPING           The AppHandle parameter is not or is no longer a valid\r
                                    application instance handle associated with the EFI_BIS protocol.                                     \r
@@ -186,7 +186,7 @@ EFI_STATUS
       \r
   @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
                                    of the BIS service.                                                                                           \r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_NO_MAPPING           The AppHandle parameter is not or is no longer a valid\r
                                    application instance handle associated with the EFI_BIS protocol.                                     \r
@@ -208,7 +208,7 @@ EFI_STATUS
                                    of the BIS service.                                                                                           \r
   @param  Certificate              The function writes an allocated EFI_BIS_DATA* containing the Boot\r
                                    Object Authorization Certificate object.                            \r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_NO_MAPPING           The AppHandle parameter is not or is no longer a valid\r
                                    application instance handle associated with the EFI_BIS protocol.                                     \r
index 4dff3a9..ae4d862 100644 (file)
@@ -36,20 +36,15 @@ typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;
 /**\r
   Adds a record into a specified Framework boot script table.\r
 \r
-  @param  This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
-  \r
-  @param  TableName Name of the script table.Currently, the only meaningful \r
-  value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r
-  \r
-  @param  OpCode The operation code (opcode) number.\r
-  \r
-  @param  ... Argument list that is specific to each opcode.\r
-\r
-  @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.\r
-  \r
+  @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
+  @param  TableName             Name of the script table.Currently, the only meaningful\r
+                                value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r
+  @param  OpCode                The operation code (opcode) number.\r
+  @param  ...                   Argument list that is specific to each opcode.\r
+\r
+  @retval EFI_SUCCESS           The operation succeeded. A record was added into the specified script table.\r
   @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r
+  @retval EFI_OUT_OF_RESOURCES  There is insufficient memory to store the boot script.\r
 \r
 **/\r
 typedef\r
@@ -64,17 +59,13 @@ EFI_STATUS
 /**\r
   Closes the specified script table.\r
 \r
-  @param  This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
-  \r
-  @param  TableName Name of the script table.\r
-  \r
-  @param  Address A pointer to the physical address where the table begins.\r
-\r
-  @retval EFI_SUCCESS The table was successfully returned.\r
-  \r
-  @retval EFI_NOT_FOUND The specified table was not created previously.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.\r
+  @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
+  @param  TableName             Name of the script table.\r
+  @param  Address               A pointer to the physical address where the table begins.\r
+\r
+  @retval EFI_SUCCESS           The table was successfully returned.\r
+  @retval EFI_NOT_FOUND         The specified table was not created previously.\r
+  @retval EFI_OUT_OF_RESOURCES  Memory is insufficient to hold the reorganized boot script table.\r
 \r
 **/\r
 typedef\r
index 619878c..d7fce60 100644 (file)
@@ -58,24 +58,18 @@ typedef enum {
   Enables a driver to access memory-mapped registers in the EFI system memory space.\r
   Or, Enables a driver to access registers in the EFI CPU I/O space.\r
 \r
-  @param  This A pointer to the EFI_CPU_IO_PROTOCOL instance.\r
-  \r
-  @param  Width Signifies the width of the I/O or Memory operation. \r
-  \r
-  @param  Address The base address of the I/O or Memoryoperation. \r
-  \r
-  @param  Count The number of I/O or Memory operations to perform.\r
-  The number of bytes moved is Width size * Count, starting at Address.\r
-  \r
-  @param  Buffer For read operations, the destination buffer to store the results.\r
-  For write operations, the source buffer from which to write data.\r
-\r
-  @retval EFI_SUCCESS The data was read from or written to the EFI system.\r
-  \r
+  @param  This                  A pointer to the EFI_CPU_IO_PROTOCOL instance.\r
+  @param  Width                 Signifies the width of the I/O or Memory operation.\r
+  @param  Address               The base address of the I/O or Memoryoperation.\r
+  @param  Count                 The number of I/O or Memory operations to perform.\r
+                                The number of bytes moved is Width size * Count, starting at Address.\r
+  @param  Buffer                For read operations, the destination buffer to store the results.\r
+                                For write operations, the source buffer from which to write data.\r
+\r
+  @retval EFI_SUCCESS           The data was read from or written to the EFI system.\r
   @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.\r
-  \r
-  @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width. \r
-  Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
+  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.\r
+                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
 \r
 **/\r
 typedef\r
index 15d3cc6..affe4b8 100644 (file)
@@ -78,22 +78,15 @@ typedef struct _EFI_DATA_HUB_PROTOCOL EFI_DATA_HUB_PROTOCOL;
 /**\r
   Logs a data record to the system event log.\r
 \r
-  @param  This The EFI_DATA_HUB_PROTOCOL instance.\r
-  \r
+  @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
   @param  description\r
-  \r
-  @param  DataRecordGuid A GUID that indicates the format of the data passed into RawData.\r
-  \r
-  @param  ProducerName A GUID that indicates the identity of the caller to this API.\r
-  \r
-  @param  DataRecordClass This class indicates the generic type of the data record. \r
-  \r
-  @param  RawData The DataRecordGuid-defined data to be logged.\r
-  \r
-  @param  RawDataSize The size in bytes of RawData.\r
-\r
-  @retval EFI_SUCCESS  Data was logged.\r
-  \r
+  @param  DataRecordGuid        A GUID that indicates the format of the data passed into RawData.\r
+  @param  ProducerName          A GUID that indicates the identity of the caller to this API.\r
+  @param  DataRecordClass       This class indicates the generic type of the data record.\r
+  @param  RawData               The DataRecordGuid-defined data to be logged.\r
+  @param  RawDataSize           The size in bytes of RawData.\r
+\r
+  @retval EFI_SUCCESS           Data was logged.\r
   @retval EFI_OUT_OF_RESOURCES  Data was not logged due to lack of system resources.\r
 \r
 **/\r
@@ -111,29 +104,23 @@ EFI_STATUS
 /**\r
   Allows the system data log to be searched.\r
 \r
-  @param  This The EFI_DATA_HUB_PROTOCOL instance. \r
-  \r
-  @param  MonotonicCount On input, it specifies the Record to return. \r
-  An input of zero means to return the first record.\r
-  \r
-  @param  FilterDriver If FilterDriver is not passed in a MonotonicCount of zero, \r
-  it means to return the first data record. If FilterDriver is passed in, \r
-  then a MonotonicCount of zero means to return the first data not yet read \r
-  by FilterDriver.\r
-  \r
-  @param  Record Returns a dynamically allocated memory buffer with a data \r
-  record that matches MonotonicCount.\r
-\r
-  @retval EFI_SUCCESS  Data was returned in Record.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  FilterDriver was passed in but does not exist.\r
-  \r
-  @retval EFI_NOT_FOUND  MonotonicCount does not match any data record \r
-  in the system.  If a MonotonicCount of zero was passed in, then no \r
-  data records exist in the system.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES  Record was not returned due to lack \r
-  of system resources.\r
+  @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
+  @param  MonotonicCount        On input, it specifies the Record to return.\r
+                                An input of zero means to return the first record.\r
+  @param  FilterDriver          If FilterDriver is not passed in a MonotonicCount of zero,\r
+                                it means to return the first data record. If FilterDriver is passed in,\r
+                                then a MonotonicCount of zero means to return the first data not yet read\r
+                                by FilterDriver.\r
+  @param  Record                Returns a dynamically allocated memory buffer with a data\r
+                                record that matches MonotonicCount.\r
+\r
+  @retval EFI_SUCCESS           Data was returned in Record.\r
+  @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.\r
+  @retval EFI_NOT_FOUND         MonotonicCount does not match any data record\r
+                                in the system. If a MonotonicCount of zero was passed in, then no\r
+                                data records exist in the system.\r
+  @retval EFI_OUT_OF_RESOURCES  Record was not returned due to lack\r
+                                of system resources.\r
 \r
 **/\r
 typedef\r
@@ -148,28 +135,22 @@ EFI_STATUS
 /**\r
   Registers an event to be signaled every time a data record is logged in the system.\r
 \r
-  @param  This The EFI_DATA_HUB_PROTOCOL instance. \r
-  \r
-  @param  FilterEvent The EFI_EVENT to signal whenever data that matches \r
-  FilterClass is logged in the system. \r
-  \r
-  @param  FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.\r
-  It is strongly recommended that you use the lowest EFI_TPL possible. \r
-  \r
-  @param  FilterClass FilterEvent will be signaled whenever a bit \r
-  in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass. \r
-  If FilterClass is zero, no class-based filtering will be performed. \r
-  \r
-  @param  FilterDataRecordGuid FilterEvent will be signaled whenever \r
-  FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid. \r
-  If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed. \r
-\r
-  @retval EFI_SUCCESS  The filter driver event was registered\r
-  \r
-  @retval EFI_ALREADY_STARTED  FilterEvent was previously registered and cannot be registered again.\r
-  \r
+  @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
+  @param  FilterEvent           The EFI_EVENT to signal whenever data that matches\r
+                                FilterClass is logged in the system.\r
+  @param  FilterTpl             The maximum EFI_TPL at which FilterEvent can be signaled.\r
+                                It is strongly recommended that you use the lowest EFI_TPL possible.\r
+  @param  FilterClass           FilterEvent will be signaled whenever a bit\r
+                                in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.\r
+                                If FilterClass is zero, no class-based filtering will be performed.\r
+  @param  FilterDataRecordGuid  FilterEvent will be signaled whenever\r
+                                FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.\r
+                                If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.\r
+\r
+  @retval EFI_SUCCESS           The filter driver event was registered\r
+  @retval EFI_ALREADY_STARTED   FilterEvent was previously registered and cannot be registered again.\r
   @retval EFI_OUT_OF_RESOURCES  The filter driver event was not registered\r
-  due to lack of system resources.\r
+                                due to lack of system resources.\r
 \r
 **/\r
 typedef\r
@@ -185,14 +166,12 @@ EFI_STATUS
 /**\r
   Stops a filter driver from being notified when data records are logged.\r
 \r
-  @param  This The EFI_DATA_HUB_PROTOCOL instance. \r
-  \r
-  @param  FilterEvent The EFI_EVENT to remove from the list of events to be \r
-  signaled every time errors are logged.\r
+  @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
+  @param  FilterEvent           The EFI_EVENT to remove from the list of events to be\r
+                                signaled every time errors are logged.\r
 \r
-  @retval EFI_SUCCESS  The filter driver represented by FilterEvent was shut off.\r
-  \r
-  @retval EFI_NOT_FOUND  FilterEvent did not exist.\r
+  @retval EFI_SUCCESS           The filter driver represented by FilterEvent was shut off.\r
+  @retval EFI_NOT_FOUND         FilterEvent did not exist.\r
 \r
 **/\r
 typedef\r
index 0d70632..643c810 100644 (file)
@@ -47,7 +47,7 @@ typedef enum {
   @param  Count                 The number of I/O operations to perform.\r
   @param  Buffer                For read operations, the destination buffer to store the results. For write\r
                                 operations, the source buffer to write data from.                \r
-  \r
+\r
   @retval EFI_SUCCESS           The data was read from or written to the device.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
   @retval EFI_INVALID_PARAMETER Width is invalid.\r
@@ -76,7 +76,7 @@ typedef struct {
                                 is going to be returned.  \r
   @param  PciDevicePath         A pointer to the pointer for the EFI Device Path for PciAddress.\r
                                 Memory for the Device Path is allocated from the pool.          \r
-  \r
+\r
   @retval EFI_SUCCESS           The PciDevicePath returns a pointer to a valid EFI Device Path.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
   @retval EFI_UNSUPPORTED       The PciAddress does not map to a valid EFI Device Path.\r
@@ -106,7 +106,7 @@ typedef enum {
   @param  DeviceAddress         The resulting map address for the bus master device to use to access the\r
                                 hosts HostAddress.\r
   @param  Mapping               A resulting value to pass to Unmap().\r
-  \r
+\r
   @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
   @retval EFI_UNSUPPORTED       The HostAddress cannot be mapped as a common buffer.\r
@@ -130,7 +130,7 @@ EFI_STATUS
     \r
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
   @param  Mapping               A resulting value to pass to Unmap().\r
-  \r
+\r
   @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.\r
   @retval EFI_DEVICE_ERROR      The system hardware could not map the requested address.\r
                                    \r
@@ -151,7 +151,7 @@ EFI_STATUS
                                 EfiRuntimeServicesData.\r
   @param  Pages                 The number of pages to allocate.\r
   @param  HostAddress           A pointer to store the base address of the allocated range.                                \r
-  \r
+\r
   @retval EFI_SUCCESS           The requested memory pages were allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The memory pages could not be allocated.\r
   @retval EFI_INVALID_PARAMETER The requested memory type is invalid.\r
@@ -173,7 +173,7 @@ EFI_STATUS
   Flushes any posted write data to the device.\r
     \r
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
-  \r
+\r
   @retval EFI_SUCCESS           The buffers were flushed.\r
   @retval EFI_DEVICE_ERROR      The buffers were not flushed due to a hardware error.                                 \r
   \r
@@ -190,7 +190,7 @@ EFI_STATUS
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.  \r
   @param  Pages                 The number of pages to free.\r
   @param  HostAddress           The base address of the range to free.\r
-  \r
+\r
   @retval EFI_SUCCESS           The requested memory pages were allocated.\r
   @retval EFI_NOT_FOUND         The requested memory pages were not allocated with\r
                                 AllocateBuffer().  \r
index 7f86dbb..310ea83 100644 (file)
@@ -82,8 +82,8 @@ typedef UINT64  EFI_FV_ATTRIBUTES;
   Retrieves attributes, insures positive polarity of attribute bits, returns\r
   resulting attributes in output parameter\r
 \r
-  @param  This Calling context\r
-  @param  Attributes output buffer which contains attributes\r
+  @param  This                  Calling context\r
+  @param  Attributes            output buffer which contains attributes\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_SUCCESS\r
@@ -99,8 +99,8 @@ EFI_STATUS
 /**\r
   Sets volume attributes\r
 \r
-  @param  This Calling context\r
-  @param  Attributes Buffer which contains attributes\r
+  @param  This                  Calling context\r
+  @param  Attributes            Buffer which contains attributes\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_DEVICE_ERROR\r
@@ -121,24 +121,23 @@ typedef UINT32  EFI_FV_FILE_ATTRIBUTES;
 /**\r
   Read the requested file (NameGuid) and returns data in Buffer.\r
 \r
-  @param  This Calling context\r
-  @param  NameGuid Filename identifying which file to read\r
-  @param  Buffer Pointer to pointer to buffer in which contents of file are returned.\r
-  <br>\r
-  If Buffer is NULL, only type, attributes, and size are returned as\r
-  there is no output buffer.\r
-  <br>\r
-  If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
-  from BS pool by ReadFile\r
-  <br>\r
-  If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
-  allocated by the caller and is being passed in.\r
-  \r
-  @param  BufferSize Indicates the buffer size passed in, and on output the size\r
-  required to complete the read\r
-  @param  FoundType Indicates the type of the file who's data is returned\r
-  @param  FileAttributes Indicates the attributes of the file who's data is resturned\r
-  @param  AuthenticationStatus Indicates the authentication status of the data\r
+  @param  This                  Calling context\r
+  @param  NameGuid              Filename identifying which file to read\r
+  @param  Buffer                Pointer to pointer to buffer in which contents of file are returned.\r
+                                <br>\r
+                                If Buffer is NULL, only type, attributes, and size are returned as\r
+                                there is no output buffer.\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
+                                from BS pool by ReadFile\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
+                                allocated by the caller and is being passed in.\r
+  @param  BufferSize            Indicates the buffer size passed in, and on output the size\r
+                                required to complete the read\r
+  @param  FoundType             Indicates the type of the file who's data is returned\r
+  @param  FileAttributes        Indicates the attributes of the file who's data is resturned\r
+  @param  AuthenticationStatus  Indicates the authentication status of the data\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_WARN_BUFFER_TOO_SMALL\r
@@ -162,24 +161,23 @@ EFI_STATUS
 /**\r
   Read the requested section from the specified file and returns data in Buffer.\r
 \r
-  @param  This Calling context\r
-  @param  NameGuid Filename identifying the file from which to read\r
-  @param  SectionType Indicates what section type to retrieve\r
-  @param  SectionInstance Indicates which instance of SectionType to retrieve\r
-  @param  Buffer Pointer to pointer to buffer in which contents of file are returned.\r
-  <br>\r
-  If Buffer is NULL, only type, attributes, and size are returned as\r
-  there is no output buffer.\r
-  <br>\r
-  If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
-  from BS pool by ReadFile\r
-  <br>\r
-  If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
-  allocated by the caller and is being passed in.\r
-  \r
-  @param  BufferSize Indicates the buffer size passed in, and on output the size\r
-  required to complete the read\r
-  @param  AuthenticationStatus Indicates the authentication status of the data\r
+  @param  This                  Calling context\r
+  @param  NameGuid              Filename identifying the file from which to read\r
+  @param  SectionType           Indicates what section type to retrieve\r
+  @param  SectionInstance       Indicates which instance of SectionType to retrieve\r
+  @param  Buffer                Pointer to pointer to buffer in which contents of file are returned.\r
+                                <br>\r
+                                If Buffer is NULL, only type, attributes, and size are returned as\r
+                                there is no output buffer.\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
+                                from BS pool by ReadFile\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
+                                allocated by the caller and is being passed in.\r
+  @param  BufferSize            Indicates the buffer size passed in, and on output the size\r
+                                required to complete the read\r
+  @param  AuthenticationStatus  Indicates the authentication status of the data\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_WARN_BUFFER_TOO_SMALL\r
@@ -217,13 +215,13 @@ typedef struct {
 /**\r
   Write the supplied file (NameGuid) to the FV.\r
 \r
-  @param  This Calling context\r
-  @param  NumberOfFiles Indicates the number of file records pointed to by FileData\r
-  @param  WritePolicy Indicates the level of reliability of the write with respect to\r
-  things like power failure events.\r
-  @param  FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures.  Each\r
-  element in the array indicates a file to write, and there are\r
-  NumberOfFiles elements in the input array.\r
+  @param  This                  Calling context\r
+  @param  NumberOfFiles         Indicates the number of file records pointed to by FileData\r
+  @param  WritePolicy           Indicates the level of reliability of the write with respect to\r
+                                things like power failure events.\r
+  @param  FileData              A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each\r
+                                element in the array indicates a file to write, and there are\r
+                                NumberOfFiles elements in the input array.\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_OUT_OF_RESOURCES\r
@@ -245,14 +243,14 @@ EFI_STATUS
 /**\r
   Given the input key, search for the next matching file in the volume.\r
 \r
-  @param  This Calling context\r
-  @param  Key Pointer to a caller allocated buffer that contains an implementation\r
-  specific key that is used to track where to begin searching on\r
-  successive calls.\r
-  @param  FileType Indicates the file type to filter for\r
-  @param  NameGuid Guid filename of the file found\r
-  @param  Attributes Attributes of the file found\r
-  @param  Size Size in bytes of the file found\r
+  @param  This                  Calling context\r
+  @param  Key                   Pointer to a caller allocated buffer that contains an implementation\r
+                                specific key that is used to track where to begin searching on\r
+                                successive calls.\r
+  @param  FileType              Indicates the file type to filter for\r
+  @param  NameGuid              Guid filename of the file found\r
+  @param  Attributes            Attributes of the file found\r
+  @param  Size                  Size in bytes of the file found\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_NOT_FOUND\r
index ee849a1..0c3d032 100644 (file)
@@ -35,8 +35,8 @@ typedef struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  EFI_FIRMWARE_VOLUME_BLOCK_PR
 /**\r
   Retrieves Volume attributes.  No polarity translations are done.\r
 \r
-  @param  This Calling context\r
-  @param  Attributes output buffer which contains attributes\r
+  @param  This                  Calling context\r
+  @param  Attributes            output buffer which contains attributes\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_SUCCESS\r
@@ -53,9 +53,9 @@ EFI_STATUS
 /**\r
   Sets Volume attributes.  No polarity translations are done.\r
 \r
-  @param  This Calling context\r
-  @param  Attributes On input: contains new attributes\r
-  On output: contains current attributes of FV\r
+  @param  This                  Calling context\r
+  @param  Attributes            On input: contains new attributes\r
+                                On output: contains current attributes of FV\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_SUCCESS\r
@@ -72,10 +72,10 @@ EFI_STATUS
 /**\r
   Retrieves the physical address of a memory mapped FV.\r
 \r
-  @param  This Calling context\r
-  @param  Attributes Address is a pointer to a caller allocated EFI_PHYSICAL_ADDRESS\r
-  that on successful return from GetPhysicalAddress() contains the\r
-  base address of the firmware volume.\r
+  @param  This                  Calling context\r
+  @param  Attributes            Address is a pointer to a caller allocated EFI_PHYSICAL_ADDRESS\r
+                                that on successful return from GetPhysicalAddress() contains the\r
+                                base address of the firmware volume.\r
 \r
   @retval EFI_UNSUPPORTED\r
   @retval EFI_SUCCESS\r
@@ -92,14 +92,14 @@ EFI_STATUS
 /**\r
   Retrieves the size in bytes of a specific block within an FV.\r
 \r
-  @param  This Calling context.\r
-  @param  Lba Indicates which block to return the size for.\r
-  @param  BlockSize BlockSize is a pointer to a caller allocated\r
-  UINTN in which the size of the block is returned.\r
-  @param  NumberOfBlocks NumberOfBlocks is a pointer to a caller allocated\r
-  UINTN in which the number of consecutive blocks\r
-  starting with Lba is returned. All blocks in this\r
-  range have a size of BlockSize.\r
+  @param  This                  Calling context.\r
+  @param  Lba                   Indicates which block to return the size for.\r
+  @param  BlockSize             BlockSize is a pointer to a caller allocated\r
+                                UINTN in which the size of the block is returned.\r
+  @param  NumberOfBlocks        NumberOfBlocks is a pointer to a caller allocated\r
+                                UINTN in which the number of consecutive blocks\r
+                                starting with Lba is returned. All blocks in this\r
+                                range have a size of BlockSize.\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_SUCCESS\r
@@ -121,12 +121,12 @@ EFI_STATUS
   a block boundary is reached.  *NumBytes is updated to reflect the actual\r
   number of bytes read.\r
 \r
-  @param  This Calling context\r
-  @param  Lba Block in which to begin read\r
-  @param  Offset Offset in the block at which to begin read\r
-  @param  NumBytes At input, indicates the requested read size.  At output, indicates\r
-  the actual number of bytes read.\r
-  @param  Buffer Data buffer in which to place data read.\r
+  @param  This                  Calling context\r
+  @param  Lba                   Block in which to begin read\r
+  @param  Offset                Offset in the block at which to begin read\r
+  @param  NumBytes              At input, indicates the requested read size. At output, indicates\r
+                                the actual number of bytes read.\r
+  @param  Buffer                Data buffer in which to place data read.\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_NOT_FOUND\r
@@ -151,12 +151,12 @@ EFI_STATUS
   reached.  *NumBytes is updated to reflect the actual number of bytes\r
   written.\r
 \r
-  @param  This Calling context\r
-  @param  Lba Block in which to begin write\r
-  @param  Offset Offset in the block at which to begin write\r
-  @param  NumBytes At input, indicates the requested write size.  At output, indicates\r
-  the actual number of bytes written.\r
-  @param  Buffer Buffer containing source data for the write.\r
+  @param  This                  Calling context\r
+  @param  Lba                   Block in which to begin write\r
+  @param  Offset                Offset in the block at which to begin write\r
+  @param  NumBytes              At input, indicates the requested write size. At output, indicates\r
+                                the actual number of bytes written.\r
+  @param  Buffer                Buffer containing source data for the write.\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_NOT_FOUND\r
@@ -185,9 +185,9 @@ EFI_STATUS
   block of the firmware volume), the EraseBlock() function must return\r
   EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.\r
 \r
-  @param  This Calling context\r
-  @param  ... Starting LBA followed by Number of Lba to erase. a -1 to terminate\r
-  the list.\r
+  @param  This                  Calling context\r
+  @param  ...                   Starting LBA followed by Number of Lba to erase. a -1 to terminate\r
+                                the list.\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_DEVICE_ERROR\r
index c0ee94a..0e52f1e 100644 (file)
@@ -55,48 +55,36 @@ typedef struct {
   database or a passed-in set of data. This function also establishes a \r
   pointer to the calling driver¡¯s callback interface. \r
 \r
-  @param  This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.\r
-  \r
-  @param  UseDatabase Determines whether the HII database is to be \r
-  used to gather information. If the value is FALSE, the configuration \r
-  driver will get the information provided in the passed-in Packet parameters.\r
-  \r
-  @param  Handle A pointer to an array of HII handles to display. This value \r
-  should correspond to the value of the HII form package that is required to \r
-  be displayed.\r
-  \r
-  @param  HandleCount The number of handles in the array specified by Handle.\r
-  \r
-  @param  Packet A pointer to a set of data containing pointers to IFR \r
-  and/or string data. \r
-  \r
-  @param  CallbackHandle The handle to the driver¡¯s callback interface. \r
-  This parameter is used only when the UseDatabase parameter is FALSE \r
-  and an application wants to register a callback with the browser\r
-  \r
-  @param  NvMapOverride This buffer is used only when there is no NV variable \r
-  to define the current settings and the caller needs to provide to the browser \r
-  the current settings for the "fake" NV variable.\r
-  \r
-  @param  ScreenDimensions Allows the browser to be called so that it occupies \r
-  a portion of the physical screen instead of dynamically determining the \r
-  screen dimensions. \r
-  \r
-  @param  ResetRequired This BOOLEAN value will tell the caller if a reset \r
-  is required based on the data that might have been changed. The ResetRequired \r
-  parameter is primarily applicable for configuration applications, and is an \r
-  optional parameter. \r
-\r
-  @retval EFI_SUCCESS The function completed successfully\r
-  \r
-  @retval EFI_NOT_FOUND The variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. \r
-  DataSize has been updated with the size needed to complete the request.\r
-  \r
+  @param  This                  A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.\r
+  @param  UseDatabase           Determines whether the HII database is to be\r
+                                used to gather information. If the value is FALSE, the configuration\r
+                                driver will get the information provided in the passed-in Packet parameters.\r
+  @param  Handle                A pointer to an array of HII handles to display. This value\r
+                                should correspond to the value of the HII form package that is required to\r
+                                be displayed.\r
+  @param  HandleCount           The number of handles in the array specified by Handle.\r
+  @param  Packet                A pointer to a set of data containing pointers to IFR\r
+                                and/or string data.\r
+  @param  CallbackHandle        The handle to the driver¡¯s callback interface.\r
+                                This parameter is used only when the UseDatabase parameter is FALSE\r
+                                and an application wants to register a callback with the browser\r
+  @param  NvMapOverride         This buffer is used only when there is no NV variable\r
+                                to define the current settings and the caller needs to provide to the browser\r
+                                the current settings for the "fake" NV variable.\r
+  @param  ScreenDimensions      Allows the browser to be called so that it occupies\r
+                                a portion of the physical screen instead of dynamically determining the\r
+                                screen dimensions.\r
+  @param  ResetRequired         This BOOLEAN value will tell the caller if a reset\r
+                                is required based on the data that might have been changed. The ResetRequired\r
+                                parameter is primarily applicable for configuration applications, and is an\r
+                                optional parameter.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully\r
+  @retval EFI_NOT_FOUND         The variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result.\r
+                                DataSize has been updated with the size needed to complete the request.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure. \r
+  @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.\r
 \r
 **/\r
 typedef\r
@@ -117,29 +105,21 @@ EFI_STATUS
   Routine used to abstract a generic dialog interface and return the selected \r
   key or string.\r
 \r
-  @param  NumberOfLines The number of lines for the dialog box.\r
-  \r
-  @param  HotKey Defines whether a single character is parsed (TRUE) \r
-  and returned in KeyValue or if a string is returned in StringBuffer. \r
-  \r
-  @param  MaximumStringSize The maximum size in bytes of a typed-in string. \r
-  Because each character is a CHAR16, the minimum string returned is two bytes.\r
-  \r
-  @param  StringBuffer The passed-in pointer to the buffer that will hold \r
-  the typed in string if HotKey is FALSE.\r
-  \r
-  @param  KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.\r
-  \r
-  @param  String The pointer to the first string in the list of strings \r
-  that comprise the dialog box.\r
-  \r
-  @param  ... A series of NumberOfLines text strings that will be used \r
-  to construct the dialog box. \r
-\r
-  @retval EFI_SUCCESS The dialog was displayed and user interaction was received.\r
-  \r
-  @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.\r
-  \r
+  @param  NumberOfLines         The number of lines for the dialog box.\r
+  @param  HotKey                Defines whether a single character is parsed (TRUE)\r
+                                and returned in KeyValue or if a string is returned in StringBuffer.\r
+  @param  MaximumStringSize     The maximum size in bytes of a typed-in string.\r
+                                Because each character is a CHAR16, the minimum string returned is two bytes.\r
+  @param  StringBuffer          The passed-in pointer to the buffer that will hold\r
+                                the typed in string if HotKey is FALSE.\r
+  @param  KeyValue              The EFI_INPUT_KEY value returned if HotKey is TRUE.\r
+  @param  String                The pointer to the first string in the list of strings\r
+                                that comprise the dialog box.\r
+  @param  ...                   A series of NumberOfLines text strings that will be used\r
+                                to construct the dialog box.\r
+\r
+  @retval EFI_SUCCESS           The dialog was displayed and user interaction was received.\r
+  @retval EFI_DEVICE_ERROR      The user typed in an ESC character to exit the routine.\r
   @retval EFI_INVALID_PARAMETER One of the parameters was invalid\r
 \r
 **/\r
index 7a1c539..2f3a527 100644 (file)
@@ -88,31 +88,22 @@ typedef struct {
 /**\r
   Returns the value of a variable. \r
 \r
-  @param  This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
-  \r
-  @param  VariableName A NULL-terminated Unicode string that is the \r
-  name of the vendor¡¯s variable. \r
-  \r
-  @param  VendorGuid A unique identifier for the vendor.\r
-  \r
-  @param  Attributes If not NULL, a pointer to the memory location to \r
-  return the attribute's bit-mask for the variable. \r
-  \r
-  @param  DataSize The size in bytes of the Buffer. A size of zero causes \r
-  the variable to be deleted.\r
-  \r
-  @param  Buffer The buffer to return the contents of the variable.\r
-\r
-  @retval EFI_SUCCESS  The function completed successfully.\r
-  \r
-  @retval EFI_NOT_FOUND  The variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result. \r
-  DataSize has been updated with the size needed to complete the request.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR  The variable could not be saved due to a hardware failure. \r
+  @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+  @param  VariableName          A NULL-terminated Unicode string that is the\r
+                                name of the vendor¡¯s variable.\r
+  @param  VendorGuid            A unique identifier for the vendor.\r
+  @param  Attributes            If not NULL, a pointer to the memory location to\r
+                                return the attribute's bit-mask for the variable.\r
+  @param  DataSize              The size in bytes of the Buffer. A size of zero causes\r
+                                the variable to be deleted.\r
+  @param  Buffer                The buffer to return the contents of the variable.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result.\r
+                                DataSize has been updated with the size needed to complete the request.\r
+  @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.\r
 \r
 **/\r
 typedef\r
@@ -129,35 +120,26 @@ EFI_STATUS
 /**\r
   Sets the value of a variable. \r
 \r
-  @param  This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
-  \r
-  @param  VariableName A NULL-terminated Unicode string that is the \r
-  name of the vendor's variable. Each VariableName is unique for each VendorGuid.\r
-  \r
-  @param  VendorGuid A unique identifier for the vendor.\r
-  \r
-  @param  Attributes Attributes bit-mask to set for the variable. \r
-  \r
-  @param  DataSize The size in bytes of the Buffer. A size of zero causes \r
-  the variable to be deleted.\r
-  \r
-  @param  Buffer The buffer containing the contents of the variable.\r
-  \r
-  @param  ResetRequired Returns a value from the driver that abstracts \r
-  this information and will enable a system to know if a system reset \r
-  is required to achieve the configuration changes being enabled through \r
-  this function.\r
-\r
-  @retval EFI_SUCCESS  The firmware has successfully stored the variable and \r
-  its data as defined by the Attributes.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold \r
-  the variable and its data.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  An invalid combination of Attributes bits \r
-  was supplied, or the DataSize exceeds the maximum allowed.\r
-  \r
-  @retval EFI_DEVICE_ERROR  The variable could not be saved due to a hardware failure. \r
+  @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+  @param  VariableName          A NULL-terminated Unicode string that is the\r
+                                name of the vendor's variable. Each VariableName is unique for each VendorGuid.\r
+  @param  VendorGuid            A unique identifier for the vendor.\r
+  @param  Attributes            Attributes bit-mask to set for the variable.\r
+  @param  DataSize              The size in bytes of the Buffer. A size of zero causes\r
+                                the variable to be deleted.\r
+  @param  Buffer                The buffer containing the contents of the variable.\r
+  @param  ResetRequired         Returns a value from the driver that abstracts\r
+                                this information and will enable a system to know if a system reset\r
+                                is required to achieve the configuration changes being enabled through\r
+                                this function.\r
+\r
+  @retval EFI_SUCCESS           The firmware has successfully stored the variable and\r
+                                its data as defined by the Attributes.\r
+  @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold\r
+                                the variable and its data.\r
+  @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits\r
+                                was supplied, or the DataSize exceeds the maximum allowed.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.\r
 \r
 **/\r
 typedef\r
@@ -175,16 +157,13 @@ EFI_STATUS
 /**\r
   This function is called to provide results data to the driver. \r
 \r
-  @param  This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
-  \r
-  @param  KeyValue A unique value which is sent to the original exporting \r
-  driver so that it can identify the type of data to expect. The format of \r
-  the data tends to vary based on the opcode that generated the callback. \r
-  \r
-  @param  Data A pointer to the data being sent to the original exporting driver. \r
-  \r
-  @param  Packet A pointer to a packet of information which a driver passes \r
-  back to the browser.\r
+  @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+  @param  KeyValue              A unique value which is sent to the original exporting\r
+                                driver so that it can identify the type of data to expect. The format of\r
+                                the data tends to vary based on the opcode that generated the callback.\r
+  @param  Data                  A pointer to the data being sent to the original exporting driver.\r
+  @param  Packet                A pointer to a packet of information which a driver passes\r
+                                back to the browser.\r
 \r
   @return Status Code\r
 \r
index d98c56a..8368e28 100644 (file)
@@ -49,20 +49,20 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL  EFI_GUIDED_SECTION_EXTRA
   Processes the input section and returns the data contained therein along \r
   with the authentication status.\r
 \r
-  @param  This                  Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.  \r
-  @param  InputSection          Buffer containing the input GUIDed section to be processed.  \r
-  @param  OutputBuffer          *OutputBuffer is allocated from boot services pool memory \r
-                                and contains the new section stream.  \r
-  @param  OutputSize            A pointer to a caller-allocated UINTN in which the size \r
-                                of *OutputBuffer allocation is stored.   \r
-  @param  AuthenticationStatus  A pointer to a caller-allocated UINT32 that \r
+  @param  This                  Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\r
+  @param  InputSection          Buffer containing the input GUIDed section to be processed.\r
+  @param  OutputBuffer          *OutputBuffer is allocated from boot services pool memory\r
+                                and contains the new section stream.\r
+  @param  OutputSize            A pointer to a caller-allocated UINTN in which the size\r
+                                of *OutputBuffer allocation is stored.\r
+  @param  AuthenticationStatus  A pointer to a caller-allocated UINT32 that\r
                                 indicates the authentication status of the output buffer.\r
                                 \r
-  @retval EFI_SUCCESS           The InputSection was successfully processed and the \r
+  @retval EFI_SUCCESS           The InputSection was successfully processed and the\r
                                 section contents were returned.\r
-  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to \r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to\r
                                 process the request.\r
-  @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match \r
+  @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match\r
                                 this instance of the GUIDed Section Extraction Protocol.\r
 \r
 **/\r
index ceeba1c..bb213d8 100644 (file)
@@ -412,16 +412,13 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST {
 /**\r
   Registers the various packs that are passed in via the Packages parameter. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Packages A pointer to an EFI_HII_PACKAGES package instance.\r
-  \r
-  @param  Handle A pointer to the EFI_HII_HANDLE instance.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Packages              A pointer to an EFI_HII_PACKAGES package instance.\r
+  @param  Handle                A pointer to the EFI_HII_HANDLE instance.\r
 \r
-  @retval EFI_SUCCESS Data was extracted from Packages, the database \r
-  was updated with the data, and Handle returned successfully.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The content of Packages  was invalid. \r
+  @retval EFI_SUCCESS           Data was extracted from Packages, the database\r
+                                was updated with the data, and Handle returned successfully.\r
+  @retval EFI_INVALID_PARAMETER The content of Packages was invalid.\r
 \r
 **/\r
 typedef\r
@@ -435,15 +432,13 @@ EFI_STATUS
 /**\r
   Removes a package from the HII database. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle that was registered to the data that is requested \r
-  for removal. \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle that was registered to the data that is requested\r
+                                for removal.\r
 \r
-  @retval EFI_SUCCESS The data associated with the Handle was removed \r
-  from the HII database.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The Handle was not valid. \r
+  @retval EFI_SUCCESS           The data associated with the Handle was removed\r
+                                from the HII database.\r
+  @retval EFI_INVALID_PARAMETER The Handle was not valid.\r
 \r
 **/\r
 typedef\r
@@ -456,18 +451,15 @@ EFI_STATUS
 /**\r
   Determines the handles that are currently active in the database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  HandleBufferLength On input, a pointer to the length of the handle \r
-  buffer. On output, the length of the handle buffer that is required \r
-  for the handles found.\r
-  \r
-  @param  Handle An array of EFI_HII_HANDLE instances returned.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  HandleBufferLength    On input, a pointer to the length of the handle\r
+                                buffer. On output, the length of the handle buffer that is required\r
+                                for the handles found.\r
+  @param  Handle                An array of EFI_HII_HANDLE instances returned.\r
 \r
-  @retval EFI_SUCCESS Handle was updated successfully.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates \r
-  that Handle is too small to support the number of handles.\r
+  @retval EFI_SUCCESS           Handle was updated successfully.\r
+  @retval EFI_BUFFER_TOO_SMALL  The HandleBufferLength parameter indicates\r
+                                that Handle is too small to support the number of handles.\r
 \r
 **/\r
 typedef\r
@@ -481,22 +473,18 @@ EFI_STATUS
 /**\r
   Exports the contents of the database into a buffer.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle An EFI_HII_HANDLE that corresponds to the desired \r
-  handle to export. If the value is 0, the entire database will be exported.\r
-  In either case, the data will be exported in a format described by the \r
-  structure definition of EFI_HII_EXPORT_TABLE.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                An EFI_HII_HANDLE that corresponds to the desired\r
+                                handle to export. If the value is 0, the entire database will be exported.\r
+                                In either case, the data will be exported in a format described by the\r
+                                structure definition of EFI_HII_EXPORT_TABLE.\r
   @param  BufferSize\r
   On input, a pointer to the length of the buffer. On output, the length \r
   of the buffer that is required for the export data.\r
-  \r
-  @param  Buffer A pointer to a buffer that will contain the results of the export function.\r
+  @param  Buffer                A pointer to a buffer that will contain the results of the export function.\r
 \r
-  @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.\r
+  @retval EFI_SUCCESS           The buffer was successfully filled with BufferSize amount of data.\r
+  @retval EFI_BUFFER_TOO_SMALL  The value in BufferSize was too small to contain the export data.\r
 \r
 **/\r
 typedef\r
@@ -512,12 +500,10 @@ EFI_STATUS
   Remove any new strings that were added after the initial string export \r
   for this handle.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the string resides.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the string resides.\r
 \r
-  @retval EFI_SUCCESS Remove strings from the handle successfully.\r
-  \r
+  @retval EFI_SUCCESS           Remove strings from the handle successfully.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -531,24 +517,20 @@ EFI_STATUS
 /**\r
   Tests if all of the characters in a string have corresponding font characters.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  StringToTest A pointer to a Unicode string.\r
-  \r
-  @param  FirstMissing A pointer to an index into the string. On input, \r
-  the index of the first character in the StringToTest to examine. On exit, \r
-  the index of the first character encountered for which a glyph is unavailable.\r
-  If all glyphs in the string are available, the index is the index of the \r
-  terminator of the string.\r
-  \r
-  @param  GlyphBufferSize A pointer to a value. On output, if the function \r
-  returns EFI_SUCCESS, it contains the amount of memory that is required to \r
-  store the string¡¯s glyph equivalent.\r
-\r
-  @retval EFI_SUCCESS All glyphs are available. Note that an empty string \r
-  always returns this value.\r
-  \r
-  @retval EFI_NOT_FOUND A glyph was not found for a character.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  StringToTest          A pointer to a Unicode string.\r
+  @param  FirstMissing          A pointer to an index into the string. On input,\r
+                                the index of the first character in the StringToTest to examine. On exit,\r
+                                the index of the first character encountered for which a glyph is unavailable.\r
+                                If all glyphs in the string are available, the index is the index of the\r
+                                terminator of the string.\r
+  @param  GlyphBufferSize       A pointer to a value. On output, if the function\r
+                                returns EFI_SUCCESS, it contains the amount of memory that is required to\r
+                                store the string¡¯s glyph equivalent.\r
+\r
+  @retval EFI_SUCCESS           All glyphs are available. Note that an empty string\r
+                                always returns this value.\r
+  @retval EFI_NOT_FOUND         A glyph was not found for a character.\r
 \r
 **/\r
 typedef\r
@@ -563,28 +545,22 @@ EFI_STATUS
 /**\r
   Translates a Unicode character into the corresponding font glyph.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Source A pointer to a Unicode string.\r
-  \r
-  @param  Index On input, the offset into the string from which to fetch \r
-  the character.On successful completion, the index is updated to the first \r
-  character past the character(s) making up the just extracted glyph. \r
-  \r
-  @param  GlyphBuffer Pointer to an array where the glyphs corresponding \r
-  to the characters in the source may be stored. GlyphBuffer is assumed \r
-  to be wide enough to accept a wide glyph character.\r
-  \r
-  @param  BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by \r
-  this value is filled with the length of the glyph in pixels. It is unchanged \r
-  if the call was unsuccessful.\r
-  \r
-  @param  InternalStatus The cell pointed to by this parameter must be \r
-  initialized to zero prior to invoking the call the first time for any string.\r
-\r
-  @retval EFI_SUCCESS It worked.\r
-  \r
-  @retval EFI_NOT_FOUND A glyph for a character was not found.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Source                A pointer to a Unicode string.\r
+  @param  Index                 On input, the offset into the string from which to fetch\r
+                                the character.On successful completion, the index is updated to the first\r
+                                character past the character(s) making up the just extracted glyph.\r
+  @param  GlyphBuffer           Pointer to an array where the glyphs corresponding\r
+                                to the characters in the source may be stored. GlyphBuffer is assumed\r
+                                to be wide enough to accept a wide glyph character.\r
+  @param  BitWidth              If EFI_SUCCESS was returned, the UINT16 pointed to by\r
+                                this value is filled with the length of the glyph in pixels. It is unchanged\r
+                                if the call was unsuccessful.\r
+  @param  InternalStatus        The cell pointed to by this parameter must be\r
+                                initialized to zero prior to invoking the call the first time for any string.\r
+\r
+  @retval EFI_SUCCESS           It worked.\r
+  @retval EFI_NOT_FOUND         A glyph for a character was not found.\r
 \r
 **/\r
 typedef\r
@@ -602,28 +578,20 @@ EFI_STATUS
   Translates a glyph into the format required for input to the Universal \r
   Graphics Adapter (UGA) Block Transfer (BLT) routines.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  GlyphBuffer A pointer to the buffer that contains glyph data.\r
-  \r
-  @param  Foreground The foreground setting requested to be used for the \r
-  generated BltBuffer data. \r
-  \r
-  @param  Background The background setting requested to be used for the \r
-  generated BltBuffer data.\r
-  \r
-  @param  Count The entry in the BltBuffer upon which to act.\r
-  \r
-  @param  Width The width in bits of the glyph being converted.\r
-  \r
-  @param  Height The height in bits of the glyph being converted\r
-  \r
-  @param  BltBuffer A pointer to the buffer that contains the data that is \r
-  ready to be used by the UGA BLT routines. \r
-\r
-  @retval EFI_SUCCESS It worked.\r
-  \r
-  @retval EFI_NOT_FOUND A glyph for a character was not found.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  GlyphBuffer           A pointer to the buffer that contains glyph data.\r
+  @param  Foreground            The foreground setting requested to be used for the\r
+                                generated BltBuffer data.\r
+  @param  Background            The background setting requested to be used for the\r
+                                generated BltBuffer data.\r
+  @param  Count                 The entry in the BltBuffer upon which to act.\r
+  @param  Width                 The width in bits of the glyph being converted.\r
+  @param  Height                The height in bits of the glyph being converted\r
+  @param  BltBuffer             A pointer to the buffer that contains the data that is\r
+                                ready to be used by the UGA BLT routines.\r
+\r
+  @retval EFI_SUCCESS           It worked.\r
+  @retval EFI_NOT_FOUND         A glyph for a character was not found.\r
 \r
 **/\r
 typedef\r
@@ -642,22 +610,17 @@ EFI_STATUS
 /**\r
   Allows a new string to be added to an already existing string package.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Pointer to a NULL-terminated string containing a single ISO 639-2 \r
-  language identifier, indicating the language in which the string is translated. \r
-  \r
-  @param  Handle The handle of the language pack to which the string is to be added.\r
-  \r
-  @param  Reference The identifier of the string to be added. If the reference \r
-  value is zero, then the string will be assigned a new identifier on that \r
-  handle for the language specified. Otherwise, the string will be updated \r
-  with the NewString Value. \r
-  \r
-  @param  NewString The string to be added.\r
-\r
-  @retval EFI_SUCCESS The string was effectively registered.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Pointer               to a NULL-terminated string containing a single ISO 639-2\r
+                                language identifier, indicating the language in which the string is translated.\r
+  @param  Handle                The handle of the language pack to which the string is to be added.\r
+  @param  Reference             The identifier of the string to be added. If the reference\r
+                                value is zero, then the string will be assigned a new identifier on that\r
+                                handle for the language specified. Otherwise, the string will be updated\r
+                                with the NewString Value.\r
+  @param  NewString             The string to be added.\r
+\r
+  @retval EFI_SUCCESS           The string was effectively registered.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -675,15 +638,12 @@ EFI_STATUS
   Allows a program to determine the primary languages that are supported \r
   on a given handle.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the strings reside.\r
-  \r
-  @param  LanguageString A string allocated by GetPrimaryLanguages() that \r
-  contains a list of all primary languages registered on the handle. \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the strings reside.\r
+  @param  LanguageString        A string allocated by GetPrimaryLanguages() that\r
+                                contains a list of all primary languages registered on the handle.\r
 \r
-  @retval EFI_SUCCESS LanguageString was correctly returned.\r
-  \r
+  @retval EFI_SUCCESS           LanguageString was correctly returned.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -699,18 +659,14 @@ EFI_STATUS
   Allows a program to determine which secondary languages are supported \r
   on a given handle for a given primary language.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the strings reside.\r
-  \r
-  @param  PrimaryLanguage Pointer to a NULL-terminated string containing a single \r
-  ISO 639-2 language identifier, indicating the primary language.\r
-  \r
-  @param  LanguageString A string allocated by GetSecondaryLanguages() \r
-  containing a list of all secondary languages registered on the handle.\r
-\r
-  @retval EFI_SUCCESS LanguageString was correctly returned.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the strings reside.\r
+  @param  PrimaryLanguage       Pointer to a NULL-terminated string containing a single\r
+                                ISO 639-2 language identifier, indicating the primary language.\r
+  @param  LanguageString        A string allocated by GetSecondaryLanguages()\r
+                                containing a list of all secondary languages registered on the handle.\r
+\r
+  @retval EFI_SUCCESS           LanguageString was correctly returned.\r
   @retval EFI_INVALID_PARAMETER The Handle was unknown.\r
 \r
 **/\r
@@ -726,32 +682,24 @@ EFI_STATUS
 /**\r
   Extracts a string from a package already registered with the EFI HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the string resides.\r
-  \r
-  @param  Token The string token assigned to the string.\r
-  \r
-  @param  Raw If TRUE, the string is returned unedited in the internal \r
-  storage format described above. If false, the string returned is edited \r
-  by replacing <cr> with <space> and by removing special characters such \r
-  as the <wide> prefix.\r
-  \r
-  @param  LanguageString Pointer to a NULL-terminated string containing a \r
-  single ISO 639-2 language identifier, indicating the language to print. \r
-  If the LanguageString is empty (starts with a NULL), the default system \r
-  language will be used to determine the language.\r
-  \r
-  @param  BufferLength Length of the StringBuffer.\r
-  \r
-  @param  StringBuffer The buffer designed to receive the characters in the string.\r
-\r
-  @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the string resides.\r
+  @param  Token                 The string token assigned to the string.\r
+  @param  Raw                   If TRUE, the string is returned unedited in the internal\r
+                                storage format described above. If false, the string returned is edited\r
+                                by replacing <cr> with <space> and by removing special characters such\r
+                                as the <wide> prefix.\r
+  @param  LanguageString        Pointer to a NULL-terminated string containing a\r
+                                single ISO 639-2 language identifier, indicating the language to print.\r
+                                If the LanguageString is empty (starts with a NULL), the default system\r
+                                language will be used to determine the language.\r
+  @param  BufferLength          Length of the StringBuffer.\r
+  @param  StringBuffer          The buffer designed to receive the characters in the string.\r
+\r
+  @retval EFI_SUCCESS           StringBuffer is filled with a NULL-terminated string.\r
   @retval EFI_INVALID_PARAMETER The handle or string token is unknown.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to \r
-  allow the entire string to be stored. \r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer provided was not large enough to\r
+                                allow the entire string to be stored.\r
 \r
 **/\r
 typedef\r
@@ -769,32 +717,23 @@ EFI_STATUS
 /**\r
   Allows a program to extract a part of a string of not more than a given width. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The handle on which the string resides.\r
-  \r
-  @param  Token The string token assigned to the string. \r
-  \r
-  @param  Index On input, the offset into the string where the line is to start.\r
-  On output, the index is updated to point to beyond the last character returned \r
-  in the call.\r
-  \r
-  @param  LineWidth The maximum width of the line in units of narrow glyphs.\r
-  \r
-  @param  LanguageString Pointer to a NULL-terminated string containing a \r
-  single ISO 639-2 language identifier, indicating the language to print.\r
-  \r
-  @param  BufferLength Pointer to the length of the StringBuffer. \r
-  \r
-  @param  StringBuffer The buffer designed to receive the characters in the string. \r
-\r
-  @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.\r
-  \r
-  @retval EFI_NOT_FOUND The font glyph for at least one of the characters in \r
-  the string is not in the font database.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough \r
-  to allow the entire string to be stored.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The handle on which the string resides.\r
+  @param  Token                 The string token assigned to the string.\r
+  @param  Index                 On input, the offset into the string where the line is to start.\r
+                                On output, the index is updated to point to beyond the last character returned\r
+                                in the call.\r
+  @param  LineWidth             The maximum width of the line in units of narrow glyphs.\r
+  @param  LanguageString        Pointer to a NULL-terminated string containing a\r
+                                single ISO 639-2 language identifier, indicating the language to print.\r
+  @param  BufferLength          Pointer to the length of the StringBuffer.\r
+  @param  StringBuffer          The buffer designed to receive the characters in the string.\r
+\r
+  @retval EFI_SUCCESS           StringBuffer filled with characters that will fit on the line.\r
+  @retval EFI_NOT_FOUND         The font glyph for at least one of the characters in\r
+                                the string is not in the font database.\r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer provided was not large enough\r
+                                to allow the entire string to be stored.\r
 \r
 **/\r
 typedef\r
@@ -814,28 +753,21 @@ EFI_STATUS
   Allows a program to extract a form or form package that has previously \r
   been registered with the HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle Handle on which the form resides.\r
-  \r
-  @param  FormId The ID of the form to return. If the ID is zero, \r
-  the entire form package is returned. \r
-  \r
-  @param  BufferLength On input, the length of the Buffer. On output, \r
-  the length of the returned buffer, \r
-  \r
-  @param  Buffer The buffer designed to receive the form(s).\r
-\r
-  @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength \r
-  was updated.\r
-  \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                Handle on which the form resides.\r
+  @param  FormId                The ID of the form to return. If the ID is zero,\r
+                                the entire form package is returned.\r
+  @param  BufferLength          On input, the length of the Buffer. On output,\r
+                                the length of the returned buffer,\r
+  @param  Buffer                The buffer designed to receive the form(s).\r
+\r
+  @retval EFI_SUCCESS           Buffer filled with the requested forms. BufferLength\r
+                                was updated.\r
   @retval EFI_INVALID_PARAMETER The handle is unknown.\r
-  \r
-  @retval EFI_NOT_FOUND A form on the requested handle cannot be found with \r
-  the requested FormId.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough \r
-  to allow the form to be stored. \r
+  @retval EFI_NOT_FOUND         A form on the requested handle cannot be found with\r
+                                the requested FormId.\r
+  @retval EFI_BUFFER_TOO_SMALL  The buffer provided was not large enough\r
+                                to allow the form to be stored.\r
 \r
 **/\r
 typedef\r
@@ -851,23 +783,18 @@ EFI_STATUS
 /**\r
   Extracts the defaults that are associated with a given handle in the HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle The HII handle from which will have default data retrieved.\r
-  \r
-  @param  DefaultMask The mask used to specify some type of default override when extracting \r
-  the default image data.\r
-  \r
-  @param  VariablePackList A indirect pointer to the first entry of a link list with \r
-  type EFI_HII_VARIABLE_PACK_LIST. \r
-\r
-  @retval EFI_SUCCESS The VariablePackList was populated with the appropriate \r
-  default setting data.\r
-  \r
-  @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).\r
-  \r
-  @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle \r
-  contain invalid data.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                The HII handle from which will have default data retrieved.\r
+  @param  DefaultMask           The mask used to specify some type of default override when extracting\r
+                                the default image data.\r
+  @param  VariablePackList      A indirect pointer to the first entry of a link list with\r
+                                type EFI_HII_VARIABLE_PACK_LIST.\r
+\r
+  @retval EFI_SUCCESS           The VariablePackList was populated with the appropriate\r
+                                default setting data.\r
+  @retval EFI_NOT_FOUND         The IFR does not have any explicit or default map(s).\r
+  @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle\r
+                                contain invalid data.\r
 \r
 **/\r
 typedef\r
@@ -883,23 +810,17 @@ EFI_STATUS
   Allows the caller to update a form or form package that has previously been \r
   registered with the EFI HII database.\r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  Handle Handle of the package where the form to be updated resides.\r
-  \r
-  @param  Label The label inside the form package where the update is to take place.\r
-  \r
-  @param  AddData If TRUE, adding data at a given Label; otherwise, \r
-  if FALSE, removing data at a given Label.\r
-  \r
-  @param  Data The buffer containing the new tags to insert after the Label\r
-\r
-  @retval EFI_SUCCESS The form was updated with the new tags.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not \r
-  contain an integral number of tags.\r
-  \r
-  @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found. \r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  Handle                Handle of the package where the form to be updated resides.\r
+  @param  Label                 The label inside the form package where the update is to take place.\r
+  @param  AddData               If TRUE, adding data at a given Label; otherwise,\r
+                                if FALSE, removing data at a given Label.\r
+  @param  Data                  The buffer containing the new tags to insert after the Label\r
+\r
+  @retval EFI_SUCCESS           The form was updated with the new tags.\r
+  @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not\r
+                                contain an integral number of tags.\r
+  @retval EFI_NOT_FOUND         The Handle, Label, or FormId was not found.\r
 \r
 **/\r
 typedef\r
@@ -915,15 +836,13 @@ EFI_STATUS
 /**\r
   Retrieves the current keyboard layout. \r
 \r
-  @param  This A pointer to the EFI_HII_PROTOCOL instance.\r
-  \r
-  @param  DescriptorCount A pointer to the number of Descriptor entries being \r
-  described in the keyboard layout being retrieved.\r
-  \r
-  @param  Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR \r
-  entries. Each entry will reflect the definition of a specific physical key.\r
+  @param  This                  A pointer to the EFI_HII_PROTOCOL instance.\r
+  @param  DescriptorCount       A pointer to the number of Descriptor entries being\r
+                                described in the keyboard layout being retrieved.\r
+  @param  Descriptor            A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR\r
+                                entries. Each entry will reflect the definition of a specific physical key.\r
 \r
-  @retval EFI_SUCCESS The keyboard layout was retrieved successfully.\r
+  @retval EFI_SUCCESS           The keyboard layout was retrieved successfully.\r
 \r
 **/\r
 typedef\r
index beaac30..0249055 100644 (file)
@@ -263,18 +263,14 @@ typedef union {
 /**\r
   Returns the information about the specified IDE channel. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Enabled TRUE if this channel is enabled. Disabled channels are not scanned \r
-  to see if any devices are present.\r
-  \r
-  @param  MaxDevices The maximum number of IDE devices that the bus driver \r
-  can expect on this channel. \r
-\r
-  @retval EFI_SUCCESS Information was returned without any errors.\r
-  \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Enabled               TRUE if this channel is enabled. Disabled channels are not scanned\r
+                                to see if any devices are present.\r
+  @param  MaxDevices            The maximum number of IDE devices that the bus driver\r
+                                can expect on this channel.\r
+\r
+  @retval EFI_SUCCESS           Information was returned without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
 \r
 **/\r
@@ -291,19 +287,14 @@ EFI_STATUS
   The notifications from the IDE bus driver that it is about to enter a certain \r
   phase of the IDE channel enumeration process. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Phase The phase during enumeration. \r
-  \r
-  @param  Channel Zero-based channel number.\r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Phase                 The phase during enumeration.\r
+  @param  Channel               Zero-based channel number.\r
 \r
-  @retval EFI_SUCCESS The notification was accepted without any errors.\r
-  \r
-  @retval EFI_NOT_SUPPORTED Phase is not supported.\r
-  \r
+  @retval EFI_SUCCESS           The notification was accepted without any errors.\r
+  @retval EFI_NOT_SUPPORTED     Phase is not supported.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  \r
-  @retval EFI_NOT_READY This phase cannot be entered at this time.\r
+  @retval EFI_NOT_READY         This phase cannot be entered at this time.\r
 \r
 **/\r
 typedef \r
@@ -317,18 +308,14 @@ EFI_STATUS
 /**\r
   Submits the device information to the IDE controller driver. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  IdentifyData The device¡¯s response to the ATA IDENTIFY_DEVICE command.\r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  IdentifyData          The device¡¯s response to the ATA IDENTIFY_DEVICE command.\r
 \r
-  @retval EFI_SUCCESS The information was accepted without any errors.\r
-  \r
+  @retval EFI_SUCCESS           The information was accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid.\r
+                                Or Device is invalid.\r
 \r
 **/\r
 typedef \r
@@ -343,19 +330,15 @@ EFI_STATUS
 /**\r
   Disqualifies specific modes for an IDE device. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  BadModes The modes that the device does not support and that \r
-  should be disqualified.\r
-\r
-  @retval EFI_SUCCESS The modes were accepted without any errors.\r
-  \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  BadModes              The modes that the device does not support and that\r
+                                should be disqualified.\r
+\r
+  @retval EFI_SUCCESS           The modes were accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid.\r
+                                Or Device is invalid.\r
 \r
 **/\r
 typedef\r
@@ -370,20 +353,15 @@ EFI_STATUS
 /**\r
   Returns the information about the optimum modes for the specified IDE device.\r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  SupportedModes The optimum modes for the device. \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  SupportedModes        The optimum modes for the device.\r
 \r
-  @retval EFI_SUCCESS SupportedModes was returned.\r
-  \r
+  @retval EFI_SUCCESS           SupportedModes was returned.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid. Or SupportedModes is NULL.\r
-  \r
-  @retval EFI_NOT_READY Modes cannot be calculated due to a lack of data. \r
+                                Or Device is invalid. Or SupportedModes is NULL.\r
+  @retval EFI_NOT_READY         Modes cannot be calculated due to a lack of data.\r
 \r
 **/\r
 typedef\r
@@ -399,23 +377,17 @@ EFI_STATUS
   Commands the IDE controller driver to program the IDE controller hardware \r
   so that the specified device can operate at the specified mode. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  Modes The modes to set. \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  Modes                 The modes to set.\r
 \r
-  @retval EFI_SUCCESS The command was accepted without any errors.\r
-  \r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid.\r
-  \r
-  @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.\r
-  \r
-  @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure. \r
-  The IDE bus driver should not use this device.\r
+                                Or Device is invalid.\r
+  @retval EFI_NOT_READY         Modes cannot be set at this time due to lack of data.\r
+  @retval EFI_DEVICE_ERROR      Modes cannot be set due to hardware failure.\r
+                                The IDE bus driver should not use this device.\r
 \r
 **/\r
 typedef\r
index 03a5b2e..7357212 100644 (file)
@@ -30,22 +30,16 @@ typedef struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL EFI_INCOMPATIBLE_PC
   Returns a list of ACPI resource descriptors that detail the special \r
   resource configuration requirements for an incompatible PCI device.\r
 \r
-  @param  This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance. \r
-  \r
-  @param  VendorID A unique ID to identify the manufacturer of the PCI device.\r
-  \r
-  @param  DeviceID A unique ID to identify the particular PCI device.\r
-  \r
-  @param  RevisionID A PCI device-specific revision identifier.\r
-  \r
-  @param  SubsystemVendorId Specifies the subsystem vendor ID. \r
-  \r
-  @param  SubsystemDeviceId Specifies the subsystem device ID.\r
-  \r
-  @param  Configuration A list of ACPI resource descriptors that detail \r
-  the configuration requirement. \r
-\r
-  @retval EFI_SUCCESS The function always returns EFI_SUCCESS.\r
+  @param  This                  Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance.\r
+  @param  VendorID              A unique ID to identify the manufacturer of the PCI device.\r
+  @param  DeviceID              A unique ID to identify the particular PCI device.\r
+  @param  RevisionID            A PCI device-specific revision identifier.\r
+  @param  SubsystemVendorId     Specifies the subsystem vendor ID.\r
+  @param  SubsystemDeviceId     Specifies the subsystem device ID.\r
+  @param  Configuration         A list of ACPI resource descriptors that detail\r
+                                the configuration requirement.\r
+\r
+  @retval EFI_SUCCESS           The function always returns EFI_SUCCESS.\r
 \r
 **/\r
 typedef\r
index c30a5e5..6be8f89 100644 (file)
@@ -60,12 +60,12 @@ typedef enum {
   the legacy mode mask and the protected mode mask. The base address for the 8259\r
   is different for legacy and protected mode, so two masks are required.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  MasterBase The base vector for the Master PIC in the 8259 controller\r
-  @param  Slavebase The base vector for the Master PIC in the 8259 controller\r
+  @param  This                  Protocol instance pointer.\r
+  @param  MasterBase            The base vector for the Master PIC in the 8259 controller\r
+  @param  Slavebase             The base vector for the Master PIC in the 8259 controller\r
 \r
-  @retval  EFI_SUCCESS The new bases were programmed\r
-  @retval  EFI_DEVICE_ERROR A device erro occured programming the vector bases\r
+  @retval EFI_SUCCESS           The new bases were programmed\r
+  @retval EFI_DEVICE_ERROR      A device erro occured programming the vector bases\r
 \r
 **/\r
 typedef\r
@@ -82,14 +82,14 @@ EFI_STATUS
   the legacy mode mask and the protected mode mask. The base address for the 8259\r
   is different for legacy and protected mode, so two masks are required.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMask            Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  LegacyEdgeLevel       Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedMask         Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedEdgeLevel    Bit 0 is Irq0 - Bit 15 is Irq15\r
 \r
-  @retval  EFI_SUCCESS 8259 status returned\r
-  @retval  EFI_DEVICE_ERROR Error reading 8259\r
+  @retval EFI_SUCCESS           8259 status returned\r
+  @retval EFI_DEVICE_ERROR      Error reading 8259\r
 \r
 **/\r
 typedef\r
@@ -109,14 +109,14 @@ EFI_STATUS
   is different for legacy and protected mode, so two masks are required.\r
   Also set the edge/level masks.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15\r
-  @param  ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMask            Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  LegacyEdgeLevel       Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedMask         Bit 0 is Irq0 - Bit 15 is Irq15\r
+  @param  ProtectedEdgeLevel    Bit 0 is Irq0 - Bit 15 is Irq15\r
 \r
-  @retval  EFI_SUCCESS 8259 status returned\r
-  @retval  EFI_DEVICE_ERROR Error reading 8259\r
+  @retval EFI_SUCCESS           8259 status returned\r
+  @retval EFI_DEVICE_ERROR      Error reading 8259\r
 \r
 **/\r
 typedef\r
@@ -139,13 +139,13 @@ EFI_STATUS
   mask for the new mode is Mask, or if Mask does not exist the previously saved\r
   mask is used.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Mode of operation. i.e. real mode or protected mode\r
-  @param  Mask Optional interupt mask for the new mode.\r
-  @param  EdgeLevel Optional trigger mask for the new mode.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Mode of operation. i.e. real mode or protected mode\r
+  @param  Mask                  Optional interupt mask for the new mode.\r
+  @param  EdgeLevel             Optional trigger mask for the new mode.\r
 \r
-  @retval  EFI_SUCCESS 8259 programmed\r
-  @retval  EFI_DEVICE_ERROR Error writting to 8259\r
+  @retval EFI_SUCCESS           8259 programmed\r
+  @retval EFI_DEVICE_ERROR      Error writting to 8259\r
 \r
 **/\r
 typedef\r
@@ -161,12 +161,12 @@ EFI_STATUS
 /**\r
   Convert from IRQ to processor interrupt vector number.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
-  @param  Vector Processor vector number that matches Irq\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
+  @param  Vector                Processor vector number that matches Irq\r
 \r
-  @retval  EFI_SUCCESS The Vector matching Irq is returned\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           The Vector matching Irq is returned\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
@@ -181,12 +181,12 @@ EFI_STATUS
 /**\r
   Enable Irq by unmasking interrupt in 8259\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
-  @param  LevelTriggered TRUE if level triggered.  FALSE if edge triggered.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
+  @param  LevelTriggered        TRUE if level triggered. FALSE if edge triggered.\r
 \r
-  @retval  EFI_SUCCESS Irq enabled on 8259\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           Irq enabled on 8259\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
@@ -201,11 +201,11 @@ EFI_STATUS
 /**\r
   Disable Irq by masking interrupt in 8259\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
 \r
-  @retval  EFI_SUCCESS Irq disabled on 8259\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           Irq disabled on 8259\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
@@ -222,12 +222,12 @@ EFI_STATUS
   that is programmed into the Interrupt Line (from the PCI config space)\r
   register.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  PciHandle PCI function to return vector for\r
-  @param  Vector Vector for fucntion that matches\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PciHandle             PCI function to return vector for\r
+  @param  Vector                Vector for fucntion that matches\r
 \r
-  @retval  EFI_SUCCESS A valid Vector is returned\r
-  @retval  EFI_INVALID_PARAMETER PciHandle not valid\r
+  @retval EFI_SUCCESS           A valid Vector is returned\r
+  @retval EFI_INVALID_PARAMETER PciHandle not valid\r
 \r
 **/\r
 typedef\r
@@ -242,11 +242,11 @@ EFI_STATUS
 /**\r
   Send an EOI to 8259\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Irq 8259 IRQ0 - IRQ15\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Irq                   8259 IRQ0 - IRQ15\r
 \r
-  @retval  EFI_SUCCESS EOI successfully sent to 8259\r
-  @retval  EFI_INVALID_PARAMETER Irq not valid\r
+  @retval EFI_SUCCESS           EOI successfully sent to 8259\r
+  @retval EFI_INVALID_PARAMETER Irq not valid\r
 \r
 **/\r
 typedef\r
index aa94cfb..c508009 100644 (file)
@@ -343,14 +343,14 @@ typedef struct {
   of BiosInt. Regs will contain the 16-bit register context on entry and \r
   exit.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  BiosInt Processor interrupt vector to invoke\r
-  @param  Reg Register contexted passed into (and returned) from thunk to\r
-  16-bit mode\r
+  @param  This                  Protocol instance pointer.\r
+  @param  BiosInt               Processor interrupt vector to invoke\r
+  @param  Reg                   Register contexted passed into (and returned) from thunk to\r
+                                16-bit mode\r
 \r
-  @retval  FALSE Thunk completed, and there were no BIOS errors in the target code.\r
-  See Regs for status.\r
-  @retval  TRUE There was a BIOS erro in the target code.\r
+  @retval FALSE                 Thunk completed, and there were no BIOS errors in the target code.\r
+                                See Regs for status.\r
+  @retval TRUE                  There was a BIOS erro in the target code.\r
 \r
 **/\r
 typedef\r
@@ -367,17 +367,17 @@ BOOLEAN
   16-bit register context on entry and exit. Arguments can be passed on \r
   the Stack argument\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Segment Segemnt of 16-bit mode call\r
-  @param  Offset Offset of 16-bit mdoe call\r
-  @param  Reg Register contexted passed into (and returned) from thunk to\r
-  16-bit mode\r
-  @param  Stack Caller allocated stack used to pass arguments\r
-  @param  StackSize Size of Stack in bytes\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Segment               Segemnt of 16-bit mode call\r
+  @param  Offset                Offset of 16-bit mdoe call\r
+  @param  Reg                   Register contexted passed into (and returned) from thunk to\r
+                                16-bit mode\r
+  @param  Stack                 Caller allocated stack used to pass arguments\r
+  @param  StackSize             Size of Stack in bytes\r
 \r
-  @retval  FALSE Thunk completed, and there were no BIOS errors in the target code.\r
-  See Regs for status.\r
-  @retval  TRUE There was a BIOS erro in the target code.\r
+  @retval FALSE                 Thunk completed, and there were no BIOS errors in the target code.\r
+                                See Regs for status.\r
+  @retval TRUE                  There was a BIOS erro in the target code.\r
 \r
 **/\r
 typedef\r
@@ -405,14 +405,14 @@ EFI_STATUS
   Test to see if a legacy PCI ROM exists for this device. Optionally return\r
   the Legacy ROM instance for this PCI device.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
-  @param  RomImage Return the legacy PCI ROM for this device\r
-  @param  RomSize Size of ROM Image\r
-  @param  Flags Indicates if ROM found and if PC-AT.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PciHandle             The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
+  @param  RomImage              Return the legacy PCI ROM for this device\r
+  @param  RomSize               Size of ROM Image\r
+  @param  Flags                 Indicates if ROM found and if PC-AT.\r
 \r
-  @retval  EFI_SUCCESS Legacy Option ROM availible for this device\r
-  @retval  EFI_UNSUPPORTED Legacy Option ROM not supported.\r
+  @retval EFI_SUCCESS           Legacy Option ROM availible for this device\r
+  @retval EFI_UNSUPPORTED       Legacy Option ROM not supported.\r
 \r
 **/\r
   )\r
@@ -423,23 +423,23 @@ EFI_STATUS
   about how many disks were added by the OPROM and the shadow address and\r
   size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r
-  This value is NULL if RomImage is non-NULL. This is the normal\r
-  case.\r
-  @param  RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is\r
-  no hardware associated with the ROM and thus no PciHandle,\r
-  otherwise is must be NULL.\r
-  Example is PXE base code.\r
-  @param  Flags Return Status if ROM was found and if was Legacy OPROM.\r
-  @param  DiskStart Disk number of first device hooked by the ROM. If DiskStart\r
-  is the same as DiskEnd no disked were hooked.\r
-  @param  DiskEnd Disk number of the last device hooked by the ROM.\r
-  @param  RomShadowAddress Shadow address of PC-AT ROM\r
-  @param  RomShadowSize Size of RomShadowAddress in bytes\r
-\r
-  @retval  EFI_SUCCESS Thunk completed, see Regs for status.\r
-  @retval  EFI_INVALID_PARAMETER PciHandle not found\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PciHandle             The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r
+                                This value is NULL if RomImage is non-NULL. This is the normal\r
+                                case.\r
+  @param  RomImage              A PCI PC-AT ROM image. This argument is non-NULL if there is\r
+                                no hardware associated with the ROM and thus no PciHandle,\r
+                                otherwise is must be NULL.\r
+                                Example is PXE base code.\r
+  @param  Flags                 Return Status if ROM was found and if was Legacy OPROM.\r
+  @param  DiskStart             Disk number of first device hooked by the ROM. If DiskStart\r
+                                is the same as DiskEnd no disked were hooked.\r
+  @param  DiskEnd               Disk number of the last device hooked by the ROM.\r
+  @param  RomShadowAddress      Shadow address of PC-AT ROM\r
+  @param  RomShadowSize         Size of RomShadowAddress in bytes\r
+\r
+  @retval EFI_SUCCESS           Thunk completed, see Regs for status.\r
+  @retval EFI_INVALID_PARAMETER PciHandle not found\r
 \r
 **/\r
 typedef\r
@@ -460,24 +460,24 @@ EFI_STATUS
   Attempt to legacy boot the BootOption. If the EFI contexted has been \r
   compromised this function will not return.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  BootOption EFI Device Path from BootXXXX variable.\r
-  @param  LoadOptionSize Size of LoadOption in size.\r
-  @param  LoadOption LoadOption from BootXXXX variable\r
+  @param  This                  Protocol instance pointer.\r
+  @param  BootOption            EFI Device Path from BootXXXX variable.\r
+  @param  LoadOptionSize        Size of LoadOption in size.\r
+  @param  LoadOption            LoadOption from BootXXXX variable\r
 \r
-  @retval  EFI_SUCCESS Removable media not present\r
+  @retval EFI_SUCCESS           Removable media not present\r
 \r
 **/\r
 /**\r
   Update BDA with current Scroll, Num & Cap lock LEDS\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Leds Status of current Scroll, Num & Cap lock LEDS\r
-  Bit 0 is Scroll Lock  0 = Not locked\r
-  Bit 1 is Num Lock\r
-  Bit 2 is Caps Lock\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Leds                  Status of current Scroll, Num & Cap lock LEDS\r
+                                Bit 0 is Scroll Lock 0 = Not locked\r
+                                Bit 1 is Num Lock\r
+                                Bit 2 is Caps Lock\r
 \r
-  @retval  EFI_SUCCESS Removable media not present\r
+  @retval EFI_SUCCESS           Removable media not present\r
 \r
 **/\r
 typedef\r
@@ -500,13 +500,13 @@ EFI_STATUS
 /**\r
   Retrieve legacy BBS info and assign boot priority.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  HddCount Number of HDD_INFO structures\r
-  @param  HddInfo Onboard IDE controller information\r
-  @param  BbsCount Number of BBS_TABLE structures\r
-  @param  BbsTable List BBS entries\r
+  @param  This                  Protocol instance pointer.\r
+  @param  HddCount              Number of HDD_INFO structures\r
+  @param  HddInfo               Onboard IDE controller information\r
+  @param  BbsCount              Number of BBS_TABLE structures\r
+  @param  BbsTable              List BBS entries\r
 \r
-  @retval  EFI_SUCCESS Tables returned\r
+  @retval EFI_SUCCESS           Tables returned\r
 \r
 **/\r
 typedef\r
@@ -524,11 +524,11 @@ EFI_STATUS
   Assign drive number to legacy HDD drives prior to booting an EFI\r
   aware OS so the OS can access drives without an EFI driver.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  BbsCount Number of BBS_TABLE structures\r
-  @param  BbsTable List BBS entries\r
+  @param  This                  Protocol instance pointer.\r
+  @param  BbsCount              Number of BBS_TABLE structures\r
+  @param  BbsTable              List BBS entries\r
 \r
-  @retval  EFI_SUCCESS Drive numbers assigned\r
+  @retval EFI_SUCCESS           Drive numbers assigned\r
 \r
 **/\r
 typedef\r
@@ -544,14 +544,14 @@ EFI_STATUS
   To boot from an unconventional device like parties and/or execute\r
   HDD diagnostics.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Attributes How to interpret the other input parameters\r
-  @param  BbsEntry The 0-based index into the BbsTable for the parent\r
-  device.\r
-  @param  BeerData Pointer to the 128 bytes of ram BEER data.\r
-  @param  ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The\r
-  caller must provide a pointer to the specific Service\r
-  Area and not the start all Service Areas.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Attributes            How to interpret the other input parameters\r
+  @param  BbsEntry              The 0-based index into the BbsTable for the parent\r
+                                device.\r
+  @param  BeerData              Pointer to the 128 bytes of ram BEER data.\r
+  @param  ServiceAreaData       Pointer to the 64 bytes of raw Service Area data. The\r
+                                caller must provide a pointer to the specific Service\r
+                                Area and not the start all Service Areas.\r
 \r
   EFI_INVALID_PARAMETER if error. Does NOT return if no error.\r
 \r
@@ -573,7 +573,7 @@ EFI_STATUS
   drivers. If used externally then caller must re-connect EFI\r
   drivers.\r
 \r
-  @retval  EFI_SUCCESS OPROMs shadowed\r
+  @retval EFI_SUCCESS           OPROMs shadowed\r
 \r
 **/\r
 typedef\r
@@ -586,19 +586,18 @@ EFI_STATUS
 /**\r
   Get a region from the LegacyBios for S3 usage.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMemorySize Size of required region\r
-  @param  Region Region to use.\r
-  00 = Either 0xE0000 or 0xF0000 block\r
-  Bit0 = 1 0xF0000 block\r
-  Bit1 = 1 0xE0000 block\r
-  @param  Alignment Address alignment. Bit mapped. First non-zero\r
-  bit from right is alignment.\r
-  @param  LegacyMemoryAddress Region Assigned\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMemorySize      Size of required region\r
+  @param  Region                Region to use.\r
+                                00 = Either 0xE0000 or 0xF0000 block\r
+                                Bit0 = 1 0xF0000 block\r
+                                Bit1 = 1 0xE0000 block\r
+  @param  Alignment             Address alignment. Bit mapped. First non-zero\r
+                                bit from right is alignment.\r
+  @param  LegacyMemoryAddress   Region Assigned\r
 \r
-  @retval  EFI_SUCCESS Region assigned\r
-  \r
-  @retval  Other Region not assigned\r
+  @retval EFI_SUCCESS           Region assigned\r
+  @retval Other                 Region not assigned\r
 \r
 **/\r
 typedef\r
@@ -615,15 +614,16 @@ EFI_STATUS
 /**\r
   Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMemorySize Size of data to copy\r
-  @param  LegacyMemoryAddress Legacy Region destination address\r
-  Note: must be in region assigned by\r
-  LegacyBiosGetLegacyRegion\r
-  @param  LegacyMemorySourceAddress Source of data\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMemorySize      Size of data to copy\r
+  @param  LegacyMemoryAddress   Legacy Region destination address\r
+                                Note: must be in region assigned by\r
+                                LegacyBiosGetLegacyRegion\r
+  @param  LegacyMemorySourceAddress \r
+                                Source of data\r
 \r
-  @retval  EFI_SUCCESS Region assigned\r
-  @retval  EFI_ACCESS_DENIED Destination outside assigned region\r
+  @retval EFI_SUCCESS           Region assigned\r
+  @retval EFI_ACCESS_DENIED     Destination outside assigned region\r
 \r
 **/\r
 typedef\r
index 56d6724..8a0604f 100644 (file)
@@ -79,24 +79,24 @@ typedef enum {
 /**\r
   Finds the binary data or other platform information.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Specifies what data to return\r
-  @param  Table Pointer to MP table.\r
-  @param  TableSize Size in bytes of table.\r
-  @param  Location Legacy region requested\r
-  0x00 = Any location\r
-  Bit 0 = 0xF0000 region\r
-  Bit 1 = 0xE0000 region\r
-  Multiple bits can be set\r
-  @param  Alignment Address alignment for allocation.\r
-  Bit mapped. First non-zero bit from right\r
-  is alignment.\r
-  @param  LegacySegment Segment in LegacyBios where Table is stored\r
-  @param  LegacyOffset Offset in LegacyBios where Table is stored\r
-\r
-  @retval  EFI_SUCCESS Data was returned successfully.\r
-  @retval  EFI_UNSUPPORTED Mode is not supported on the platform.\r
-  @retval  EFI_NOT_FOUND Binary image or table not found.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Specifies what data to return\r
+  @param  Table                 Pointer to MP table.\r
+  @param  TableSize             Size in bytes of table.\r
+  @param  Location              Legacy region requested\r
+                                0x00 = Any location\r
+                                Bit 0 = 0xF0000 region\r
+                                Bit 1 = 0xE0000 region\r
+                                Multiple bits can be set\r
+  @param  Alignment             Address alignment for allocation.\r
+                                Bit mapped. First non-zero bit from right\r
+                                is alignment.\r
+  @param  LegacySegment         Segment in LegacyBios where Table is stored\r
+  @param  LegacyOffset          Offset in LegacyBios where Table is stored\r
+\r
+  @retval EFI_SUCCESS           Data was returned successfully.\r
+  @retval EFI_UNSUPPORTED       Mode is not supported on the platform.\r
+  @retval EFI_NOT_FOUND         Binary image or table not found.\r
 \r
 **/\r
 typedef\r
@@ -116,17 +116,17 @@ EFI_STATUS
 /**\r
   Returns a buffer of handles for the requested sub-function.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Specifies what handle to return.\r
-  @param  Type Type from Device Path for Handle to represent.\r
-  @param  HandleBuffer Handles of the device/controller in priority order\r
-  with HandleBuffer[0] highest priority.\r
-  @param  HandleCount Number of handles in the buffer.\r
-  @param  AdditionalData Mode specific.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Specifies what handle to return.\r
+  @param  Type                  Type from Device Path for Handle to represent.\r
+  @param  HandleBuffer          Handles of the device/controller in priority order\r
+                                with HandleBuffer[0] highest priority.\r
+  @param  HandleCount           Number of handles in the buffer.\r
+  @param  AdditionalData        Mode specific.\r
 \r
-  @retval  EFI_SUCCESS Handle is valid\r
-  @retval  EFI_UNSUPPORTED Mode is not supported on the platform.\r
-  @retval  EFI_NOT_FOUND Handle is not known\r
+  @retval EFI_SUCCESS           Handle is valid\r
+  @retval EFI_UNSUPPORTED       Mode is not supported on the platform.\r
+  @retval EFI_NOT_FOUND         Handle is not known\r
 \r
 **/\r
 typedef\r
@@ -144,11 +144,11 @@ EFI_STATUS
 /**\r
   Load and initialize the Legacy BIOS SMM handler.\r
 \r
-  @param  This Protocol instance pointer.\r
+  @param  This                   Protocol instance pointer.\r
   @param  EfiToLegacy16BootTable Pointer to Legacy16 boot table.\r
 \r
-  @retval  EFI_SUCCESS SMM code loaded.\r
-  @retval  EFI_DEVICE_ERROR SMM code failed to load\r