]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Code Scrub for MdePkg.
authoryshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 25 Jul 2008 12:21:57 +0000 (12:21 +0000)
committeryshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 25 Jul 2008 12:21:57 +0000 (12:21 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5567 6f19259b-4bc3-4df7-8a09-765794883524

176 files changed:
MdePkg/Include/IndustryStandard/Acpi1_0.h
MdePkg/Include/IndustryStandard/Acpi2_0.h
MdePkg/Include/IndustryStandard/Acpi3_0.h
MdePkg/Include/IndustryStandard/AlertStandardFormatTable.h
MdePkg/Include/IndustryStandard/Atapi.h
MdePkg/Include/IndustryStandard/HighPrecisionEventTimerTable.h
MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h
MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h
MdePkg/Include/IndustryStandard/Pci.h
MdePkg/Include/IndustryStandard/Pci22.h
MdePkg/Include/IndustryStandard/Pci23.h
MdePkg/Include/IndustryStandard/SdramSpd.h
MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h
MdePkg/Include/IndustryStandard/Tpm12.h
MdePkg/Include/IndustryStandard/Usb.h
MdePkg/Include/IndustryStandard/WatchdogActionTable.h
MdePkg/Include/IndustryStandard/WatchdogResourceTable.h
MdePkg/Include/Library/BaseLib.h
MdePkg/Include/Library/DxePiLib.h
MdePkg/Include/Library/GraphicsLib.h
MdePkg/Include/Library/PciSegmentLib.h
MdePkg/Include/Library/PeiPiLib.h
MdePkg/Include/Library/ScsiLib.h
MdePkg/Include/Library/UefiApplicationEntryPoint.h
MdePkg/Include/Library/UefiDriverEntryPoint.h
MdePkg/Include/Library/UefiRuntimeLib.h
MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicInternal.h
MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c
MdePkg/Library/BaseLib/BaseLibInternals.h
MdePkg/Library/BaseLib/ChkStkGcc.c
MdePkg/Library/BaseLib/Ia32/ARShiftU64.c
MdePkg/Library/BaseLib/Ia32/CpuBreakpoint.c
MdePkg/Library/BaseLib/Ia32/CpuId.c
MdePkg/Library/BaseLib/Ia32/CpuIdEx.c
MdePkg/Library/BaseLib/Ia32/CpuPause.c
MdePkg/Library/BaseLib/Ia32/CpuSleep.c
MdePkg/Library/BaseLib/Ia32/DisableInterrupts.c
MdePkg/Library/BaseLib/Ia32/DisablePaging32.c
MdePkg/Library/BaseLib/Ia32/DivU64x32.c
MdePkg/Library/BaseLib/Ia32/DivU64x32Remainder.c
MdePkg/Library/BaseLib/Ia32/EnableDisableInterrupts.c
MdePkg/Library/BaseLib/Ia32/EnableInterrupts.c
MdePkg/Library/BaseLib/Ia32/EnablePaging32.c
MdePkg/Library/BaseLib/Ia32/FlushCacheLine.c
MdePkg/Library/BaseLib/Ia32/FxRestore.c
MdePkg/Library/BaseLib/Ia32/FxSave.c
MdePkg/Library/BaseLib/Ia32/InterlockedCompareExchange32.c
MdePkg/Library/BaseLib/Ia32/InterlockedCompareExchange64.c
MdePkg/Library/BaseLib/Ia32/InterlockedDecrement.c
MdePkg/Library/BaseLib/Ia32/InterlockedIncrement.c
MdePkg/Library/BaseLib/Ia32/Invd.c
MdePkg/Library/BaseLib/Ia32/LRotU64.c
MdePkg/Library/BaseLib/Ia32/LShiftU64.c
MdePkg/Library/BaseLib/Ia32/LongJump.c
MdePkg/Library/BaseLib/Ia32/ModU64x32.c
MdePkg/Library/BaseLib/Ia32/Monitor.c
MdePkg/Library/BaseLib/Ia32/MultU64x32.c
MdePkg/Library/BaseLib/Ia32/MultU64x64.c
MdePkg/Library/BaseLib/Ia32/Mwait.c
MdePkg/Library/BaseLib/Ia32/RRotU64.c
MdePkg/Library/BaseLib/Ia32/RShiftU64.c
MdePkg/Library/BaseLib/Ia32/ReadCr0.c
MdePkg/Library/BaseLib/Ia32/ReadCr2.c
MdePkg/Library/BaseLib/Ia32/ReadCr3.c
MdePkg/Library/BaseLib/Ia32/ReadCr4.c
MdePkg/Library/BaseLib/Ia32/ReadCs.c
MdePkg/Library/BaseLib/Ia32/ReadDr0.c
MdePkg/Library/BaseLib/Ia32/ReadDr1.c
MdePkg/Library/BaseLib/Ia32/ReadDr2.c
MdePkg/Library/BaseLib/Ia32/ReadDr3.c
MdePkg/Library/BaseLib/Ia32/ReadDr4.c
MdePkg/Library/BaseLib/Ia32/ReadDr5.c
MdePkg/Library/BaseLib/Ia32/ReadDr6.c
MdePkg/Library/BaseLib/Ia32/ReadDr7.c
MdePkg/Library/BaseLib/Ia32/ReadDs.c
MdePkg/Library/BaseLib/Ia32/ReadEflags.c
MdePkg/Library/BaseLib/Ia32/ReadEs.c
MdePkg/Library/BaseLib/Ia32/ReadFs.c
MdePkg/Library/BaseLib/Ia32/ReadGdtr.c
MdePkg/Library/BaseLib/Ia32/ReadGs.c
MdePkg/Library/BaseLib/Ia32/ReadIdtr.c
MdePkg/Library/BaseLib/Ia32/ReadLdtr.c
MdePkg/Library/BaseLib/Ia32/ReadMm0.c
MdePkg/Library/BaseLib/Ia32/ReadMm1.c
MdePkg/Library/BaseLib/Ia32/ReadMm2.c
MdePkg/Library/BaseLib/Ia32/ReadMm3.c
MdePkg/Library/BaseLib/Ia32/ReadMm4.c
MdePkg/Library/BaseLib/Ia32/ReadMm5.c
MdePkg/Library/BaseLib/Ia32/ReadMm6.c
MdePkg/Library/BaseLib/Ia32/ReadMm7.c
MdePkg/Library/BaseLib/Ia32/ReadMsr64.c
MdePkg/Library/BaseLib/Ia32/ReadPmc.c
MdePkg/Library/BaseLib/Ia32/ReadSs.c
MdePkg/Library/BaseLib/Ia32/ReadTr.c
MdePkg/Library/BaseLib/Ia32/ReadTsc.c
MdePkg/Library/BaseLib/Ia32/SetJump.c
MdePkg/Library/BaseLib/Ia32/SwapBytes64.c
MdePkg/Library/BaseLib/Ia32/Wbinvd.c
MdePkg/Library/BaseLib/Ia32/WriteCr0.c
MdePkg/Library/BaseLib/Ia32/WriteCr2.c
MdePkg/Library/BaseLib/Ia32/WriteCr3.c
MdePkg/Library/BaseLib/Ia32/WriteCr4.c
MdePkg/Library/BaseLib/Ia32/WriteDr0.c
MdePkg/Library/BaseLib/Ia32/WriteDr1.c
MdePkg/Library/BaseLib/Ia32/WriteDr2.c
MdePkg/Library/BaseLib/Ia32/WriteDr3.c
MdePkg/Library/BaseLib/Ia32/WriteDr4.c
MdePkg/Library/BaseLib/Ia32/WriteDr5.c
MdePkg/Library/BaseLib/Ia32/WriteDr6.c
MdePkg/Library/BaseLib/Ia32/WriteDr7.c
MdePkg/Library/BaseLib/Ia32/WriteGdtr.c
MdePkg/Library/BaseLib/Ia32/WriteIdtr.c
MdePkg/Library/BaseLib/Ia32/WriteLdtr.c
MdePkg/Library/BaseLib/Ia32/WriteMm0.c
MdePkg/Library/BaseLib/Ia32/WriteMm1.c
MdePkg/Library/BaseLib/Ia32/WriteMm2.c
MdePkg/Library/BaseLib/Ia32/WriteMm3.c
MdePkg/Library/BaseLib/Ia32/WriteMm4.c
MdePkg/Library/BaseLib/Ia32/WriteMm5.c
MdePkg/Library/BaseLib/Ia32/WriteMm6.c
MdePkg/Library/BaseLib/Ia32/WriteMm7.c
MdePkg/Library/BaseLib/Ia32/WriteMsr64.c
MdePkg/Library/BaseLib/Ipf/asm.h
MdePkg/Library/BaseLib/Ipf/ia_64gen.h
MdePkg/Library/BaseLib/String.c
MdePkg/Library/BaseLib/SwitchStack.c
MdePkg/Library/BaseLib/SynchronizationMsc.c
MdePkg/Library/BaseLib/X64/CpuBreakpoint.c
MdePkg/Library/BaseLib/X64/InterlockedCompareExchange32.c
MdePkg/Library/BaseLib/X64/InterlockedCompareExchange64.c
MdePkg/Library/BaseLib/X64/InterlockedDecrement.c
MdePkg/Library/BaseLib/X64/InterlockedIncrement.c
MdePkg/Library/BaseLib/X64/ReadMsr64.c
MdePkg/Library/BaseLib/X64/WriteMsr64.c
MdePkg/Library/BaseMemoryLib/MemLibGeneric.c
MdePkg/Library/BaseMemoryLib/MemLibInternals.h
MdePkg/Library/BaseMemoryLibMmx/MemLibInternals.h
MdePkg/Library/BaseMemoryLibOptPei/MemLibInternals.h
MdePkg/Library/BaseMemoryLibRepStr/MemLibInternals.h
MdePkg/Library/BaseMemoryLibSse2/MemLibInternals.h
MdePkg/Library/BasePciLibCf8/PciLib.c
MdePkg/Library/BasePciLibPciExpress/PciLib.c
MdePkg/Library/CpuLib/Ia32/CpuFlushTlb.c
MdePkg/Library/DxeHobLib/HobLibInternal.h
MdePkg/Library/DxeMemoryAllocationLib/MemoryAllocationLib.c
MdePkg/Library/DxeMemoryLib/MemLib.c
MdePkg/Library/DxeMemoryLib/MemLibGeneric.c
MdePkg/Library/DxeMemoryLib/MemLibInternals.h
MdePkg/Library/DxePcdLib/DxePcdLib.c
MdePkg/Library/DxePiLib/DxePiLib.c
MdePkg/Library/DxeServicesTableLib/DxeServicesTableLibInternal.h
MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h
MdePkg/Library/PeiHobLib/HobLib.c
MdePkg/Library/PeiIoLibCpuIo/IoLibMmioBuffer.c
MdePkg/Library/PeiMemoryLib/MemLib.c
MdePkg/Library/PeiMemoryLib/MemLibGeneric.c
MdePkg/Library/PeiMemoryLib/MemLibInternals.h
MdePkg/Library/PeiPiLib/PeiPiLib.c
MdePkg/Library/PeiServicesLib/PeiServicesLib.c
MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointerInternal.h
MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
MdePkg/Library/SecPeiDxeTimerLibCpu/IpfTimerLib.c
MdePkg/Library/SecPeiDxeTimerLibCpu/X86TimerLib.c
MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLibInternal.h
MdePkg/Library/UefiLib/UefiLib.c
MdePkg/Library/UefiLib/UefiLibInternal.h
MdePkg/Library/UefiLib/UefiLibPrint.c
MdePkg/Library/UefiLib/UefiNotTiano.c
MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
MdePkg/Library/UefiRuntimeLib/RuntimeService.c
MdePkg/Library/UefiScsiLib/UefiScsiLib.c

index 553a0b2b8bd7570eaa0e0c42860403d97489471f..93a3f6beaa423de82340329790544d4db34d632d 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-       @file   \r
+/** @file   \r
        ACPI 1.0b definitions from the ACPI Specification, revision 1.0b\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation\r
index 77c0284e09cacdc8d4f93899fc108e895c77b35a..3264b961e040b097de28bbceb1e3f34b7f1ce7cf 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-       @file   \r
+/** @file   \r
        ACPI 2.0 definitions from the ACPI Specification, revision 2.0\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation\r
index 04b79a47bff344ad077d2fea2c197595973f7146..3cdf3103be66c004c7c58793dad3c5617165325a 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-    @file   \r
+/** @file   \r
     ACPI 3.0 definitions from the ACPI Specification Revision 3.0 September 2, 2004\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation\r
index 90cc10ca148fa61af2e492bb2f09f8b8e33e37d6..5a9e57660f6dd6d35a600294dbbe1eda11ff6701 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-       @file   \r
+/** @file   \r
        ACPI Alert Standard Format Description Table ASF! as described in the ASF2.0 Specification\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation\r
index ff6cc593bb9a88fa65efbb941f5511eecc4218ab..f73805664a53435064f98d4790472f0142b785d7 100644 (file)
@@ -15,8 +15,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _ATAPI_H\r
-#define _ATAPI_H\r
+#ifndef _ATAPI_H_\r
+#define _ATAPI_H_\r
 \r
 #pragma pack(1)\r
 \r
index af961c49a97315c5280806954b98151694c42aef..37dda9fb614861a298177cc974b89cc9a2ecdfdf 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   ACPI high precision event timer table definition, defined at \r
   ftp://download.intel.com/labs/platcomp/hpet/download/hpetspec098a.pdf.\r
   Specification name is IA-PC HPET (High Precision Event Timers) Specification.\r
index ec31e6188cdaba598bff215ffb078fbb8ce25bf0..934939fcd15637490fec306bcb448e99bf72dfb2 100644 (file)
 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_REVISION            0x01\r
 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_ALIGNMENT 8\r
 \r
-enum {\r
+typedef enum {\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_RESERVED_STRUCTURE_ID = 0,\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_ID,\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_ID,\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_ID,\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_ID,\r
   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_EXTERNSIONS_STRUCTURE_ID\r
-};\r
+} EFI_ACPI_ISCSI_ID_DEFINITIONS;\r
 \r
-enum {\r
+typedef enum {\r
   IpPrefixOriginOther = 0,\r
   IpPrefixOriginManual,\r
   IpPrefixOriginWellKnown,\r
   IpPrefixOriginDhcp,\r
   IpPrefixOriginRouterAdvertisement,\r
   IpPrefixOriginUnchanged = 16\r
-};\r
+} IP_PREFIX_VALUE;\r
 \r
 #pragma pack(1)\r
 \r
index d826b62b8384c7eae5b80d2bf967b53f10f584e8..6539f19c25c28c013a8613953206b4d3f30a7505 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   ACPI memory mapped configuration space access table definition, defined at \r
   in the PCI Firmware Specification, version 3.0 draft version 0.5.\r
   Specification is available at http://www.pcisig.com.\r
index 0551fbfb7f2c53abc99d7f6b6309bae47c3b2a68..65d93f6165ec59a85a6f6f70ddfe3846d67654eb 100644 (file)
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _PCI_H\r
-#define _PCI_H\r
+#ifndef _PCI_H_\r
+#define _PCI_H_\r
 \r
 #include <IndustryStandard/Pci30.h>\r
 \r
index b1c66e824e2b50ef00390f0ad71a5a955be8e8c8..60fd98dfa664a70ba70602ebab5808efa11c65af 100644 (file)
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _PCI22_H\r
-#define _PCI22_H\r
+#ifndef _PCI22_H_\r
+#define _PCI22_H_\r
 \r
 #define PCI_MAX_SEGMENT 0\r
 \r
index b0cb21b546ac9704f0eed222c15ed531477ba8e9..6ddd6970cd39bead1269bb2a1e3878615d29bcdc 100644 (file)
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _PCI23_H\r
-#define _PCI23_H\r
+#ifndef _PCI23_H_\r
+#define _PCI23_H_\r
 \r
 \r
 #define PCI_EXP_MAX_CONFIG_OFFSET     0x1000\r
index 59302ee7dae1c5fbc2ff60e38018409c0517ca7f..864b465d0e7befeeaa6ff7d57d020075d381cccc 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   This file contains definitions for the SPD fields on an SDRAM.\r
     \r
   Copyright (c) 2007, Intel Corporation\r
@@ -11,8 +11,8 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 **/\r
 \r
-#ifndef _SDRAM_SPD_H\r
-#define _SDRAM_SPD_H\r
+#ifndef _SDRAM_SPD_H_\r
+#define _SDRAM_SPD_H_\r
 \r
 //\r
 // SDRAM SPD field definitions\r
index 381bb8f7a6bbf4c12df1a7256e90ec610c67fdfd..ab0bf9d73118d3c298e7e6f6274563765ace3dca 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   ACPI Serial Port Console Redirection Table as defined by Microsoft in\r
   http://www.microsoft.com/whdc/system/platform/server/spcr.mspx\r
     \r
index 613ee61902861ea47b76934019f11f89466f9990..ddf10d22669e567538ecf384aa887314b7469aa0 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-       @file   \r
+/** @file   \r
   TPM Specification data structures (TCG TPM Specification Version 1.2 Revision 94)\r
   See http://trustedcomputinggroup.org for latest specification updates\r
 \r
index f64d96c87c3dc37baa95312384dda1511849a7f1..01913d3b8b6c3e4aee7317f3ce71b8d85df71fa4 100644 (file)
@@ -129,7 +129,7 @@ typedef struct {
 #pragma pack()\r
 \r
 \r
-enum {\r
+typedef enum {\r
   //\r
   // USB request type\r
   //\r
@@ -191,7 +191,7 @@ enum {
   //Use 200 ms to increase the error handling response time\r
   //\r
   EFI_USB_INTERRUPT_DELAY = 2000000\r
-};\r
+} USB_TYPES_DEFINITION;\r
 \r
 \r
 //\r
index e429c9a69ee0458f80aa6085a9d58b7a384005cf..67dabc4379302cc09d3424bf7ed68648a5df8997 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-    @file   \r
+/** @file   \r
   ACPI Watchdog Action Table as defined at\r
   Microsoft Hardware Watchdog Timer Specification.\r
 \r
index 5afe1a4bb7ac8e107d7b44bd5fbf2920f7139fe8..2e416dfbb2ee1b935e48fc775ca976138a91822f 100644 (file)
@@ -1,5 +1,4 @@
-/** \r
-       @file   \r
+/** @file   \r
   ACPI Watchdog Resource Table as defined at\r
   Microsoft Hardware Watchdog Timer Specification.\r
 \r
index 95e1b6d3144119f35a16c9f7a1b6dba44c9e7cfe..83bdc3a168f10f3e8bd9591db5d411eb53c1fdc9 100644 (file)
@@ -3675,6 +3675,8 @@ CpuPause (
                       function.\r
   @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                       function.\r
+  @param  ...         Extended parameters.\r
+\r
 \r
 **/\r
 VOID\r
@@ -4930,9 +4932,9 @@ AsmSwitchStackAndBackingStore (
   @param  PalEntryPoint The entry point address of PAL. The address in ar.kr5\r
                         would be used if this parameter were NULL on input.\r
   @param  Arg1          The first argument of a PAL call.\r
-  @param  Arg1          The second argument of a PAL call.\r
-  @param  Arg1          The third argument of a PAL call.\r
-  @param  Arg1          The fourth argument of a PAL call.\r
+  @param  Arg2          The second argument of a PAL call.\r
+  @param  Arg3          The third argument of a PAL call.\r
+  @param  Arg4          The fourth argument of a PAL call.\r
 \r
   @return The values returned in r8, r9, r10 and r11.\r
 \r
@@ -7061,7 +7063,7 @@ AsmDisablePaging32 (
   If EntryPoint is 0, then ASSERT().\r
   If NewStack is 0, then ASSERT().\r
 \r
-  @param  Cs          The 16-bit selector to load in the CS before EntryPoint\r
+  @param  CodeSelector The 16-bit selector to load in the CS before EntryPoint\r
                       is called. The descriptor in the GDT that this selector\r
                       references must be setup for long mode.\r
   @param  EntryPoint  The 64-bit virtual address of the function to call with\r
@@ -7102,7 +7104,7 @@ AsmEnablePaging64 (
   If EntryPoint is 0, then ASSERT().\r
   If NewStack is 0, then ASSERT().\r
 \r
-  @param  Cs          The 16-bit selector to load in the CS before EntryPoint\r
+  @param  CodeSelector The 16-bit selector to load in the CS before EntryPoint\r
                       is called. The descriptor in the GDT that this selector\r
                       references must be setup for 32-bit protected mode.\r
   @param  EntryPoint  The 64-bit virtual address of the function to call with\r
index 3a86d52b3c95e873876e5e273f1aa42574cb3065..16ede8147e967a2a2a48ade76a10d866f0e3279e 100644 (file)
@@ -139,13 +139,11 @@ PiLibGetSectionFromCurrentFv (
     The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated \r
     by this function. This function can only be called at TPL_NOTIFY and below.\r
     \r
-    If FvHandle is NULL and WithinImage is TRUE, then ASSERT ();\r
-    If NameGuid is NULL, then ASSERT();\r
     If Buffer is NULL, then ASSERT();\r
     If Size is NULL, then ASSERT().\r
   \r
-    @param  NameGuid             The GUID name of a Firmware File.\r
     @param  SectionType         The Firmware Section type.\r
+    @param  Instance            Instance number of a section.\r
     @param  Buffer                  On output, Buffer contains the the data read from the section in the Firmware File found.\r
     @param  Size                    On output, the size of Buffer.\r
   \r
index 31a391bd7ee5a9234c9d758877b7edb84fa5f05c..0c2812be2fba016722aeacc577f581c214881949 100644 (file)
@@ -79,8 +79,8 @@ GetGraphicsBitMapFromFVEx (
 \r
   @param[in]      BmpImage      Pointer to BMP file\r
   @param[in]      BmpImageSize  Number of bytes in BmpImage\r
-  @param[in,out]  UgaBlt        Buffer containing UGA version of BmpImage.\r
-  @param[in,out]  UgaBltSize    Size of UgaBlt in bytes.\r
+  @param[in out]  UgaBlt        Buffer containing UGA version of BmpImage.\r
+  @param[in out]  UgaBltSize    Size of UgaBlt in bytes.\r
   @param[out]     PixelHeight   Height of UgaBlt/BmpImage in pixels\r
   @param[out]     PixelWidth    Width of UgaBlt/BmpImage in pixels\r
 \r
index 57f4c10a345a4b2e4a1ed0f8186385bc40c11f0a..e0b16c20c000ae52d527b200af7ec346b544cbda 100644 (file)
@@ -142,7 +142,7 @@ PciSegmentAnd8 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData    The value to AND with the PCI configuration register.\r
   @param  OrData    The value to OR with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
@@ -416,7 +416,7 @@ PciSegmentAnd16 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData    The value to AND with the PCI configuration register.\r
   @param  OrData    The value to OR with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
index 5603689d88e0b1e58534919fed88f03e200a9799..341ae81aaec87814b8680568146faeb659611fbb 100644 (file)
@@ -36,8 +36,7 @@
                                           from a firmware file, these should be NULL\r
   \r
  \r
-  **/\r
-\r
+**/\r
 VOID\r
 EFIAPI\r
 PiLibInstallFvInfoPpi (\r
index 13a4bb3634d89cd6678329560621542095b39577..2087d82ad3d100198443ba865841e97564ee8f29 100644 (file)
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _SCSI_LIB_H\r
-#define _SCSI_LIB_H\r
+#ifndef _SCSI_LIB_H_\r
+#define _SCSI_LIB_H_\r
 \r
 #include <Protocol/ScsiIo.h>\r
 \r
@@ -29,7 +29,7 @@
 // since the value output by this macro is in 100ns unit,\r
 // not 1us unit (1us = 1000ns)\r
 //\r
-#define EfiScsiStallSeconds(a)  (a) * EFI_SCSI_STALL_1_SECOND\r
+#define EfiScsiStallSeconds(a)  ((a) * EFI_SCSI_STALL_1_SECOND)\r
 \r
 \r
 /**
@@ -77,12 +77,12 @@ ScsiTestUnitReadyCommand (
 
   @param[in]     ScsiIo             SCSI IO Protocol to use
   @param[in]     Timeout            The length of timeout period.
-  @param[out]    SenseData          A pointer to output sense data.
-  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[in]     SenseData          A pointer to output sense data.
+  @param[in out] SenseDataLength    The length of output sense data.
   @param[out]    HostAdapterStatus  The status of Host Adapter.
   @param[out]    TargetStatus       The status of the target.
-  @param[in,out] InquirydataBuffer  A pointer to inquiry data buffer.
-  @param[in,out] InquiryDataLength  The length of inquiry data buffer.
+  @param[in out] InquirydataBuffer  A pointer to inquiry data buffer.
+  @param[in out] InquiryDataLength  The length of inquiry data buffer.
   @param[in]     EnableVitalProductData  Boolean to enable Vital Product Data.
 
   @retval EFI_SUCCESS         The status of the unit is tested successfully.\r
@@ -123,12 +123,12 @@ ScsiInquiryCommand (
 
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
   @param[in]     Timeout            The length of timeout period.
-  @param[out]    SenseData          A pointer to output sense data.
-  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[in]    SenseData          A pointer to output sense data.
+  @param[in out] SenseDataLength    The length of output sense data.
   @param[out]    HostAdapterStatus  The status of Host Adapter.
   @param[out]    TargetStatus       The status of the target.
   @param[in]     DataBuffer         A pointer to input data buffer.
-  @param[in,out] DataLength         The length of input data buffer.
+  @param[in out] DataLength         The length of input data buffer.
   @param[in]     DBDField           The DBD Field (Optional).
   @param[in]     PageControl        Page Control.
   @param[in]     PageCode           Page code.
@@ -180,8 +180,8 @@ ScsiModeSense10Command (
 
   @param[in]     ScsiIo             SCSI IO Protocol to use
   @param[in]     Timeout            TODO:
-  @param[out]    SenseData          TODO:
-  @param[in,out] SenseDataLength    TODO:
+  @param[in]     SenseData          TODO:
+  @param[in out] SenseDataLength    TODO:
   @param[out]    HostAdapterStatus  TODO:
   @param[out]    TargetStatus       TODO:
 
@@ -221,12 +221,12 @@ ScsiRequestSenseCommand (
 \r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
   @param[in]     Timeout            The length of timeout period.
-  @param[out]    SenseData          A pointer to output sense data.
-  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[in]    SenseData          A pointer to output sense data.
+  @param[in out] SenseDataLength    The length of output sense data.
   @param[out]    HostAdapterStatus  The status of Host Adapter.
   @param[out]    TargetStatus       The status of the target.
   @param[out]    DataBuffer         A pointer to a data buffer.
-  @param[in,out] DataLength         The length of data buffer.
+  @param[in out] DataLength         The length of data buffer.
   @param[in]     PMI                Partial medium indicator.
 
   @retval  EFI_SUCCESS                The status of the unit is tested successfully.\r
@@ -267,12 +267,12 @@ ScsiReadCapacityCommand (
 
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.
   @param[in]     Timeout            The length of timeout period.
-  @param[out]    SenseData          A pointer to output sense data.
-  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[in]    SenseData          A pointer to output sense data.
+  @param[in out] SenseDataLength    The length of output sense data.
   @param[out]    HostAdapterStatus  The status of Host Adapter.
   @param[out]    TargetStatus       The status of the target.
   @param[out]    DataBuffer         Read 10 command data.
-  @param[in,out] DataLength         The length of data buffer.
+  @param[in out] DataLength         The length of data buffer.
   @param[in]     StartLba           The start address of LBA.
   @param[in]     SectorSize         The sector size.
 
@@ -315,12 +315,12 @@ ScsiRead10Command (
 
   @param[in]     ScsiIo             SCSI IO Protocol to use
   @param[in]     Timeout            The length of timeout period.
-  @param[out]    SenseData          A pointer to output sense data.
-  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[in]    SenseData          A pointer to output sense data.
+  @param[in out] SenseDataLength    The length of output sense data.
   @param[out]    HostAdapterStatus  The status of Host Adapter.
   @param[out]    TargetStatus       The status of the target.
   @param[out]    DataBuffer         A pointer to a data buffer.
-  @param[in,out] DataLength         The length of data buffer.
+  @param[in out] DataLength         The length of data buffer.
   @param[in]     StartLba           The start address of LBA.
   @param[in]     SectorSize         The sector size.
 
index 8ab07d9653e2f51e141cfaa18d2d3c58a9bde9b0..b1067acf727c4e341756b733e0a3cca54568915b 100644 (file)
@@ -113,7 +113,6 @@ ProcessLibraryDestructorList (
           the user.  \r
  \r
 **/\r
-\r
 EFI_STATUS\r
 EFIAPI\r
 ProcessModuleEntryPointList (\r
index 6269876738ea715ef0ebc9765b48c5489cf6a941..6908830f13c4154042cefe440775c6bec5c72835 100644 (file)
@@ -129,6 +129,15 @@ ProcessLibraryDestructorList (
  \r
 **/\r
 \r
+/**\r
+  Call the list of driver entry points. Automatics Generated by tool.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+  @return Status returned by entry points of drivers.  \r
\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 ProcessModuleEntryPointList (\r
index 99b41102159fbdba6fe6add9ddaa63be2e6bad0e..f4b63f4b9077dfc546befb6240790ea7696b6003 100644 (file)
@@ -355,7 +355,7 @@ EfiUpdateCapsule (
                                 stored in contiguous virtual memory.\r
   @param  CapsuleCount          Number of pointers to EFI_CAPSULE_HEADER in\r
                                 CaspuleHeaderArray.\r
-  @param  MaxiumCapsuleSize     On output the maximum size that UpdateCapsule() can\r
+  @param  MaximumCapsuleSize     On output the maximum size that UpdateCapsule() can\r
                                 support as an argument to UpdateCapsule() via\r
                                 CapsuleHeaderArray and ScatterGatherList.\r
                                 Undefined on input.\r
@@ -411,7 +411,7 @@ EfiQueryCapsuleCapabilities (
 EFI_STATUS\r
 EFIAPI\r
 EfiQueryVariableInfo (\r
-  IN UINT32   Attrubutes,\r
+  IN UINT32   Attributes,\r
   OUT UINT64  *MaximumVariableStorageSize,\r
   OUT UINT64  *RemainingVariableStorageSize,\r
   OUT UINT64  *MaximumVariableSize\r
index 4a29835ea3583ca4b30a12cfa6a89e54c8ccf0aa..1a30d26fc4329ff5e6600d11eac035053480723d 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   Common header file shared by all source files.\r
 \r
   This file includes package header files, dependent library classes.\r
index 8eec29551f07ea12a6e69c308ae44c85e214e600..bcd376aa630d321c84f9bf05cd4b7be772f1b4a5 100644 (file)
@@ -147,7 +147,7 @@ IoRead64 (
   operations are serialized.\r
 \r
   @param  Port  The I/O port to write.\r
-  @param  Value The value to write to the I/O port.\r
+  @param  Data  The value to write to the I/O port.\r
 \r
   @return The value written to the I/O port. It equals to the\r
           input Value instead of the actual value read back from\r
@@ -172,7 +172,7 @@ IoWrite8 (
   operations are serialized.\r
 \r
   @param  Port  The I/O port to write.\r
-  @param  Value The value to write to the I/O port.\r
+  @param  Data  The value to write to the I/O port.\r
 \r
   @return The value written to the I/O port. It equals to the\r
           input Value instead of the actual value read back from\r
@@ -197,7 +197,7 @@ IoWrite16 (
   operations are serialized.\r
 \r
   @param  Port  The I/O port to write.\r
-  @param  Value The value to write to the I/O port.\r
+  @param  Data  The value to write to the I/O port.\r
 \r
   @return The value written to the I/O port. It equals to the\r
           input Value instead of the actual value read back from\r
index 20c4693f3a5d31473308f0fc20b984229ff562a7..4a54837413753706ca65f91350cf4ae3458ef5dc 100644 (file)
@@ -47,7 +47,7 @@ MmioReadBuffer8 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length--) {\r
+  while (Length-- != 0) {\r
     *(Buffer++) = MmioRead8 (StartAddress++);\r
   }\r
 \r
@@ -96,7 +96,7 @@ MmioReadBuffer16 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     *(Buffer++) = MmioRead16 (StartAddress);\r
     StartAddress += sizeof (UINT16);\r
     Length -= sizeof (UINT16);\r
@@ -147,7 +147,7 @@ MmioReadBuffer32 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     *(Buffer++) = MmioRead32 (StartAddress);\r
     StartAddress += sizeof (UINT32);\r
     Length -= sizeof (UINT32);\r
@@ -198,7 +198,7 @@ MmioReadBuffer64 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     *(Buffer++) = MmioRead64 (StartAddress);\r
     StartAddress += sizeof (UINT64);\r
     Length -= sizeof (UINT64);\r
@@ -241,7 +241,7 @@ MmioWriteBuffer8 (
  \r
   ReturnBuffer = (UINT8 *) Buffer;\r
   \r
-  while (Length--) {\r
+  while (Length-- != 0) {\r
      MmioWrite8 (StartAddress++, *(Buffer++));\r
   }\r
 \r
@@ -292,7 +292,7 @@ MmioWriteBuffer16 (
 \r
   ReturnBuffer = (UINT16 *) Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     MmioWrite16 (StartAddress, *(Buffer++));\r
     \r
     StartAddress += sizeof (UINT16);\r
@@ -346,7 +346,7 @@ MmioWriteBuffer32 (
 \r
   ReturnBuffer = (UINT32 *) Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     MmioWrite32 (StartAddress, *(Buffer++));\r
     \r
     StartAddress += sizeof (UINT32);\r
@@ -399,7 +399,7 @@ MmioWriteBuffer64 (
 \r
   ReturnBuffer = (UINT64 *) Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     MmioWrite64 (StartAddress, *(Buffer++));\r
     \r
     StartAddress += sizeof (UINT64);\r
index 1e903a7e254aa20aa53b95c04022b062a946ad8f..43c3b79eee3aa40d60a932086f33bc2deb45fbbd 100644 (file)
@@ -26,8 +26,9 @@
 #include "BaseIoLibIntrinsicInternal.h"\r
 \r
 //\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
+// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
 //\r
+\r
 int            _inp (unsigned short port);\r
 unsigned short _inpw (unsigned short port);\r
 unsigned long  _inpd (unsigned short port);\r
index 04f622b79ae11b6b031677aed6b0aaa8874a994a..984c0cdfc38db7a00ce34e07564e07c11a2ce964 100644 (file)
@@ -265,7 +265,7 @@ EFIAPI
 InternalMathDivRemU64x32 (\r
   IN      UINT64                    Dividend,\r
   IN      UINT32                    Divisor,\r
-  OUT     UINT32                    *Remainder\r
+  OUT     UINT32                    *Remainder OPTIONAL\r
   );\r
 \r
 /**\r
@@ -290,7 +290,7 @@ EFIAPI
 InternalMathDivRemU64x64 (\r
   IN      UINT64                    Dividend,\r
   IN      UINT64                    Divisor,\r
-  OUT     UINT64                    *Remainder\r
+  OUT     UINT64                    *Remainder OPTIONAL\r
   );\r
 \r
 /**\r
index f6ae9b03db8d39e98ef07fdea54d739f29bdd794..f86d53919a4dc2afc091fbc946454af1113d477c 100644 (file)
 \r
 \r
 #include "BaseLibInternals.h"\r
-\r
-VOID __chkstk() {\r
+/**\r
+  Hack function for passing GCC build.\r
+**/\r
+VOID \r
+__chkstk() \r
+{\r
 }\r
 \r
index fb5f4282bb21fe495893f4af7e3da234227883f3..dab93257eec87b17fedb897340da5306c2266c65 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Shifts a 64-bit integer right between 0 and 63 bits. The high bits\r
+  are filled with original integer's bit 63. The shifted value is returned.\r
+\r
+  This function shifts the 64-bit value Operand to the right by Count bits. The\r
+  high Count bits are set to bit 63 of Operand.  The shifted value is returned.\r
+\r
+  @param  Operand The 64-bit operand to shift right.\r
+  @param  Count   The number of bits to shift right.\r
+\r
+  @return Operand arithmetically shifted right by Count\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathARShiftU64 (\r
index 35d0fc9c2302a9c8aaabc00849804a05859fd6e2..d4fce47c00ef60f1f5ade337a6ca432c6391ab7a 100644 (file)
 //\r
 \r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 void __debugbreak ();\r
 \r
 #pragma intrinsic(__debugbreak)\r
 \r
+/**\r
+  Generates a breakpoint on the CPU.\r
+\r
+  Generates a breakpoint on the CPU. The breakpoint must be implemented such\r
+  that code can resume normal execution after the breakpoint.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 CpuBreakpoint (\r
index 73f12bcaeeb1938a79cd2a2cdd0727e0cdc0753b..6fbc5375bced4a509a1666e6ee79a52dc1455e18 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Retrieves CPUID information.\r
+\r
+  Executes the CPUID instruction with EAX set to the value specified by Index.\r
+  This function always returns Index.\r
+  If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.\r
+  If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.\r
+  If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.\r
+  If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.\r
+  This function is only available on IA-32 and X64.\r
+\r
+  @param  Index The 32-bit value to load into EAX prior to invoking the CPUID\r
+                instruction.\r
+  @param  Eax   Pointer to the 32-bit EAX value returned by the CPUID\r
+                instruction. This is an optional parameter that may be NULL.\r
+  @param  Ebx   Pointer to the 32-bit EBX value returned by the CPUID\r
+                instruction. This is an optional parameter that may be NULL.\r
+  @param  Ecx   Pointer to the 32-bit ECX value returned by the CPUID\r
+                instruction. This is an optional parameter that may be NULL.\r
+  @param  Edx   Pointer to the 32-bit EDX value returned by the CPUID\r
+                instruction. This is an optional parameter that may be NULL.\r
+\r
+  @return Index\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 AsmCpuid (\r
index 2c1eca670e491b2f7db2b1985ce231d9bf51bb21..c685e5ec4e299c9cc6a4779be7861905e08e82b5 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Retrieves CPUID information using an extended leaf identifier.\r
+\r
+  Executes the CPUID instruction with EAX set to the value specified by Index\r
+  and ECX set to the value specified by SubIndex. This function always returns\r
+  Index. This function is only available on IA-32 and x64.\r
+\r
+  If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.\r
+  If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.\r
+  If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.\r
+  If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.\r
+\r
+  @param  Index     The 32-bit value to load into EAX prior to invoking the\r
+                    CPUID instruction.\r
+  @param  SubIndex  The 32-bit value to load into ECX prior to invoking the\r
+                    CPUID instruction.\r
+  @param  Eax       Pointer to the 32-bit EAX value returned by the CPUID\r
+                    instruction. This is an optional parameter that may be\r
+                    NULL.\r
+  @param  Ebx       Pointer to the 32-bit EBX value returned by the CPUID\r
+                    instruction. This is an optional parameter that may be\r
+                    NULL.\r
+  @param  Ecx       Pointer to the 32-bit ECX value returned by the CPUID\r
+                    instruction. This is an optional parameter that may be\r
+                    NULL.\r
+  @param  Edx       Pointer to the 32-bit EDX value returned by the CPUID\r
+                    instruction. This is an optional parameter that may be\r
+                    NULL.\r
+\r
+  @return Index\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 AsmCpuidEx (\r
index ee7c96736b344dc32ee9ef602f8b0645a9c1626a..138e3a3a09f08521db4f6464573e2cdcba4b507a 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Requests CPU to pause for a short period of time.\r
+\r
+  Requests CPU to pause for a short period of time. Typically used in MP\r
+  systems to prevent memory starvation while waiting for a spin lock.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 CpuPause (\r
index 690f9b359886d6e75bc7703dba5cac7308014b35..8861e3369dd3383ae512e7475b0936bb6f65ddde 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Places the CPU in a sleep state until an interrupt is received.\r
+\r
+  Places the CPU in a sleep state until an interrupt is received. If interrupts\r
+  are disabled prior to calling this function, then the CPU will be placed in a\r
+  sleep state indefinitely.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 CpuSleep (\r
index 60c1169a57d846a0695ad7b4095a78f601a38eb4..b9e31c66c3cf5a75926cdc836ee55c16700e9cda 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Disables CPU interrupts.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 DisableInterrupts (\r
index d462c01ff398ab8268bd6840a523c997c5e4b643..1ab21224ca67d0db481b19dbe287e914a5c79dde 100644 (file)
 \r
 #if _MSC_EXTENSIONS\r
 \r
+/**\r
+  Disables the 32-bit paging mode on the CPU.\r
+\r
+  Disables the 32-bit paging mode on the CPU and returns to 32-bit protected\r
+  mode. This function assumes the current execution mode is 32-paged protected\r
+  mode. This function is only available on IA-32. After the 32-bit paging mode\r
+  is disabled, control is transferred to the function specified by EntryPoint\r
+  using the new stack specified by NewStack and passing in the parameters\r
+  specified by Context1 and Context2. Context1 and Context2 are optional and\r
+  may be NULL. The function EntryPoint must never return.\r
+\r
+  There are a number of constraints that must be followed before calling this\r
+  function:\r
+  1)  Interrupts must be disabled.\r
+  2)  The caller must be in 32-bit paged mode.\r
+  3)  CR0, CR3, and CR4 must be compatible with 32-bit paged mode.\r
+  4)  CR3 must point to valid page tables that guarantee that the pages for\r
+      this function and the stack are identity mapped.\r
+\r
+  @param  EntryPoint  A pointer to function to call with the new stack after\r
+                      paging is disabled.\r
+  @param  Context1    A pointer to the context to pass into the EntryPoint\r
+                      function as the first parameter after paging is disabled.\r
+  @param  Context2    A pointer to the context to pass into the EntryPoint\r
+                      function as the second parameter after paging is\r
+                      disabled.\r
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
+                      function after paging is disabled.\r
+\r
+**/\r
 __declspec (naked)\r
 VOID\r
 EFIAPI\r
index 0ec3c6319bb11995cf13e4efc3907af4c2e4a337..92eb9e115bfcc65814d475b2121838268cb01b03 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
+  generates a 64-bit unsigned result.\r
+\r
+  This function divides the 64-bit unsigned value Dividend by the 32-bit\r
+  unsigned value Divisor and generates a 64-bit unsigned quotient. This\r
+  function returns the 64-bit unsigned quotient.\r
+\r
+   @param  Dividend  A 64-bit unsigned value.\r
+  @param  Divisor   A 32-bit unsigned value.\r
+\r
+  @return Dividend / Divisor\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathDivU64x32 (\r
index 54da1e9ab0470f1fe11182f5a45034f233455cbc..4127004da565996b6657e8319ca8f00ffac1e57c 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
+  generates a 64-bit unsigned result and an optional 32-bit unsigned remainder.\r
+\r
+  This function divides the 64-bit unsigned value Dividend by the 32-bit\r
+  unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder\r
+  is not NULL, then the 32-bit unsigned remainder is returned in Remainder.\r
+  This function returns the 64-bit unsigned quotient.\r
+\r
+  @param  Dividend  A 64-bit unsigned value.\r
+  @param  Divisor   A 32-bit unsigned value.\r
+  @param  Remainder A pointer to a 32-bit unsigned value. This parameter is\r
+                    optional and may be NULL.\r
+\r
+  @return Dividend / Divisor\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathDivRemU64x32 (\r
index 39118728f0d60b7148393f4e7427848a907c9e75..6e0d3fbdde6606e9443464dfa9c4fab55d322f58 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Enables CPU interrupts for the smallest window required to capture any\r
+  pending interrupts.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 EnableDisableInterrupts (\r
index cb4ee2e3ad49d2f6f57133597386637bfdd20370..7f50bb769eb90d39a9a9627a294a033824f3a4b8 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Enables CPU interrupts.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 EnableInterrupts (\r
index 3cb290c516ed1ccfdfd2d5f329c0445a36cca0ab..87e31cac835181bb672af6abaf65a6aa17e19086 100644 (file)
 \r
 #if _MSC_EXTENSIONS\r
 \r
+/**\r
+  Enables the 32-bit paging mode on the CPU.\r
+\r
+  Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables\r
+  must be properly initialized prior to calling this service. This function\r
+  assumes the current execution mode is 32-bit protected mode. This function is\r
+  only available on IA-32. After the 32-bit paging mode is enabled, control is\r
+  transferred to the function specified by EntryPoint using the new stack\r
+  specified by NewStack and passing in the parameters specified by Context1 and\r
+  Context2. Context1 and Context2 are optional and may be NULL. The function\r
+  EntryPoint must never return.\r
+\r
+  There are a number of constraints that must be followed before calling this\r
+  function:\r
+  1)  Interrupts must be disabled.\r
+  2)  The caller must be in 32-bit protected mode with flat descriptors. This\r
+      means all descriptors must have a base of 0 and a limit of 4GB.\r
+  3)  CR0 and CR4 must be compatible with 32-bit protected mode with flat\r
+      descriptors.\r
+  4)  CR3 must point to valid page tables that will be used once the transition\r
+      is complete, and those page tables must guarantee that the pages for this\r
+      function and the stack are identity mapped.\r
+\r
+  @param  EntryPoint  A pointer to function to call with the new stack after\r
+                      paging is enabled.\r
+  @param  Context1    A pointer to the context to pass into the EntryPoint\r
+                      function as the first parameter after paging is enabled.\r
+  @param  Context2    A pointer to the context to pass into the EntryPoint\r
+                      function as the second parameter after paging is enabled.\r
+  @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
+                      function after paging is enabled.\r
+\r
+**/\r
 __declspec (naked)\r
 VOID\r
 EFIAPI\r
index 1c7cc0f33f06cc9ff123dc8c2d2c01c8ee66748e..d6fa2d39e4cbbc6766c6673035542b0be4d3a681 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Flushes a cache line from all the instruction and data caches within the\r
+  coherency domain of the CPU.\r
+\r
+  Flushed the cache line specified by LinearAddress, and returns LinearAddress.\r
+  This function is only available on IA-32 and X64.\r
+\r
+  @param  LinearAddress The address of the cache line to flush. If the CPU is\r
+                        in a physical addressing mode, then LinearAddress is a\r
+                        physical address. If the CPU is in a virtual\r
+                        addressing mode, then LinearAddress is a virtual\r
+                        address.\r
+\r
+  @return LinearAddress\r
+**/\r
 VOID *\r
 EFIAPI\r
 AsmFlushCacheLine (\r
index 1314da4194165bc367a60551ecc048db56e3d5c4..f5e1966e4adb4c5e75005f2a0e7aecd57e4749a6 100644 (file)
 #include <BaseLibInternals.h>\r
 \r
 \r
+/**\r
+  Restores the current floating point/SSE/SSE2 context from a buffer.\r
+\r
+  Restores the current floating point/SSE/SSE2 state from the buffer specified\r
+  by Buffer. Buffer must be aligned on a 16-byte boundary. This function is\r
+  only available on IA-32 and X64.\r
+\r
+  @param  Buffer  Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalX86FxRestore (\r
index 44aaee0090690d3add98f31955e06588d406687e..a57312d42d31bdf60937c104c8195f76e5fd5f85 100644 (file)
 #include <BaseLibInternals.h>\r
 \r
 \r
+/**\r
+  Save the current floating point/SSE/SSE2 context to a buffer.\r
+\r
+  Saves the current floating point/SSE/SSE2 state to the buffer specified by\r
+  Buffer. Buffer must be aligned on a 16-byte boundary. This function is only\r
+  available on IA-32 and X64.\r
+\r
+  @param  Buffer  Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalX86FxSave (\r
index ec60f973449fcc347598a5193be29642fa7ff215..cbc8a5749623e7a27082f42a978f0fa24bc5a86f 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Performs an atomic compare exchange operation on a 32-bit unsigned integer.\r
+\r
+  Performs an atomic compare exchange operation on the 32-bit unsigned integer\r
+  specified by Value.  If Value is equal to CompareValue, then Value is set to\r
+  ExchangeValue and CompareValue is returned.  If Value is not equal to CompareValue,\r
+  then Value is returned.  The compare exchange operation must be performed using\r
+  MP safe mechanisms.\r
+\r
+  @param  Value         A pointer to the 32-bit value for the compare exchange\r
+                        operation.\r
+  @param  CompareValue  32-bit value used in compare operation.\r
+  @param  ExchangeValue 32-bit value used in exchange operation.\r
+\r
+  @return The original *Value before exchange.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncCompareExchange32 (\r
index 6bdbedad1f05f47a36975e0214259f0be527ccfc..5bbba48702c0719e3f0b88f62f1c3bad3e807368 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Performs an atomic compare exchange operation on a 64-bit unsigned integer.\r
+\r
+  Performs an atomic compare exchange operation on the 64-bit unsigned integer specified\r
+  by Value.  If Value is equal to CompareValue, then Value is set to ExchangeValue and\r
+  CompareValue is returned.  If Value is not equal to CompareValue, then Value is returned.\r
+  The compare exchange operation must be performed using MP safe mechanisms.\r
+\r
+  @param  Value         A pointer to the 64-bit value for the compare exchange\r
+                        operation.\r
+  @param  CompareValue  64-bit value used in compare operation.\r
+  @param  ExchangeValue 64-bit value used in exchange operation.\r
+\r
+  @return The original *Value before exchange.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalSyncCompareExchange64 (\r
index c7ace7ad5443bf162596729be9743a229f90f295..df6908ef2723cdeb741509de9fd4a534b670c103 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Performs an atomic decrement of an 32-bit unsigned integer.\r
+\r
+  Performs an atomic decrement of the 32-bit unsigned integer specified by\r
+  Value and returns the decrement value. The decrement operation must be\r
+  performed using MP safe mechanisms. The state of the return value is not\r
+  guaranteed to be MP safe.\r
+\r
+  @param  Value A pointer to the 32-bit value to decrement.\r
+\r
+  @return The decrement value.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncDecrement (\r
index f34f4748ebdf618dafc8e9cac193d5fcb139db31..8bbd1886513e519f939e7e9c5e272fe92c5bd104 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Performs an atomic increment of an 32-bit unsigned integer.\r
+\r
+  Performs an atomic increment of the 32-bit unsigned integer specified by\r
+  Value and returns the incremented value. The increment operation must be\r
+  performed using MP safe mechanisms. The state of the return value is not\r
+  guaranteed to be MP safe.\r
+\r
+  @param  Value A pointer to the 32-bit value to increment.\r
+\r
+  @return The incremented value.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncIncrement (\r
index 0206e6d44b1880d4c3add695348752039e9c4bdc..96de45514e0b8c004afa1d2a919027128ede85b5 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Executes a INVD instruction.\r
+\r
+  Executes a INVD instruction. This function is only available on IA-32 and\r
+  X64.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmInvd (\r
index 9a5deea70d401435394882fd1120119e71f64790..ac7305105a282946fce6c40aa265920d48b36973 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Rotates a 64-bit integer left between 0 and 63 bits, filling\r
+  the low bits with the high bits that were rotated.\r
+\r
+  This function rotates the 64-bit value Operand to the left by Count bits. The\r
+  low Count bits are fill with the high Count bits of Operand. The rotated\r
+  value is returned.\r
+\r
+  @param  Operand The 64-bit operand to rotate left.\r
+  @param  Count   The number of bits to rotate left.\r
+\r
+  @return Operand <<< Count\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathLRotU64 (\r
index 4324bfb53b5c8706c80a0989d9ab0810824c7b3c..f684e1f29a03f2955456a00ffd59c45513a9aec1 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Shifts a 64-bit integer left between 0 and 63 bits. The low bits\r
+  are filled with zeros. The shifted value is returned.\r
+\r
+  This function shifts the 64-bit value Operand to the left by Count bits. The\r
+  low Count bits are set to zero. The shifted value is returned.\r
+\r
+  @param  Operand The 64-bit operand to shift left.\r
+  @param  Count   The number of bits to shift left.\r
+\r
+  @return Operand << Count\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathLShiftU64 (\r
index f0408b83fa385b08f09e77bce92aad549b35aea3..f4dbcfdf1a45706c82abf6edb48eb70870cebc0e 100644 (file)
 #include <BaseLibInternals.h>\r
 \r
 \r
+/**\r
+  Restores the CPU context that was saved with SetJump().\r
+\r
+  Restores the CPU context from the buffer specified by JumpBuffer.\r
+  This function never returns to the caller.\r
+  Instead is resumes execution based on the state of JumpBuffer.\r
+\r
+  @param  JumpBuffer    A pointer to CPU context buffer.\r
+  @param  Value         The value to return when the SetJump() context is restored.\r
+\r
+**/\r
 __declspec (naked)\r
 VOID\r
 EFIAPI\r
index 59ed50433a7d447f22e863a064f70dee8031d1d3..a2727ea6d4fabc22dd9dd726de0f6d7c42b1901e 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and\r
+  generates a 32-bit unsigned remainder.\r
+\r
+  This function divides the 64-bit unsigned value Dividend by the 32-bit\r
+  unsigned value Divisor and generates a 32-bit remainder. This function\r
+  returns the 32-bit unsigned remainder.\r
+\r
+  @param  Dividend  A 64-bit unsigned value.\r
+  @param  Divisor   A 32-bit unsigned value.\r
+\r
+  @return Dividend % Divisor\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalMathModU64x32 (\r
index 469aa6d7fa87005d4d6dfe198d13a2d62bf3829b..68da9c68c731b275ef1150a96ec26963dba0028e 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Sets up a monitor buffer that is used by AsmMwait().\r
+\r
+  Executes a MONITOR instruction with the register state specified by Eax, Ecx\r
+  and Edx. Returns Eax. This function is only available on IA-32 and X64.\r
+\r
+  @param  Eax The value to load into EAX or RAX before executing the MONITOR\r
+              instruction.\r
+  @param  Ecx The value to load into ECX or RCX before executing the MONITOR\r
+              instruction.\r
+  @param  Edx The value to load into EDX or RDX before executing the MONITOR\r
+              instruction.\r
+\r
+  @return Eax\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmMonitor (\r
index db911cadb2303cdab05f0860aa8e8a9e841fdd91..36e9227dd45c4086eaeaffaa9b10d8c4251ad10a 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Multiples a 64-bit unsigned integer by a 32-bit unsigned integer\r
+  and generates a 64-bit unsigned result.\r
+\r
+  This function multiples the 64-bit unsigned value Multiplicand by the 32-bit\r
+  unsigned value Multiplier and generates a 64-bit unsigned result. This 64-\r
+  bit unsigned result is returned.\r
+\r
+  @param  Multiplicand  A 64-bit unsigned value.\r
+  @param  Multiplier    A 32-bit unsigned value.\r
+\r
+  @return Multiplicand * Multiplier\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathMultU64x32 (\r
index ddafff47ae56eef0c617454ce8251ece2a3c0e04..e2b7e6852f39e92f1174654162e9eaf2a1f65a26 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Multiples a 64-bit unsigned integer by a 64-bit unsigned integer\r
+  and generates a 64-bit unsigned result.\r
+\r
+  This function multiples the 64-bit unsigned value Multiplicand by the 64-bit\r
+  unsigned value Multiplier and generates a 64-bit unsigned result. This 64-\r
+  bit unsigned result is returned.\r
+\r
+  @param  Multiplicand  A 64-bit unsigned value.\r
+  @param  Multiplier    A 64-bit unsigned value.\r
+\r
+  @return Multiplicand * Multiplier\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathMultU64x64 (\r
index 0629afe2956ecd337b5e6936a88a94879ac56898..64fccddc689a6950882414477dfc6c2107f2429e 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Executes an MWAIT instruction.\r
+\r
+  Executes an MWAIT instruction with the register state specified by Eax and\r
+  Ecx. Returns Eax. This function is only available on IA-32 and X64.\r
+\r
+  @param  Eax The value to load into EAX or RAX before executing the MONITOR\r
+              instruction.\r
+  @param  Ecx The value to load into ECX or RCX before executing the MONITOR\r
+              instruction.\r
+\r
+  @return Eax\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmMwait (\r
index 31274aac2c52bab65bb2fa39e9c7ec27a6dbbb26..59d42b19ef96ba02166f0fe2932bfb89161e16d2 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Rotates a 64-bit integer right between 0 and 63 bits, filling\r
+  the high bits with the high low bits that were rotated.\r
+\r
+  This function rotates the 64-bit value Operand to the right by Count bits.\r
+  The high Count bits are fill with the low Count bits of Operand. The rotated\r
+  value is returned.\r
+\r
+  @param  Operand The 64-bit operand to rotate right.\r
+  @param  Count   The number of bits to rotate right.\r
+\r
+  @return Operand >>> Count\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathRRotU64 (\r
index a6b957bacc6eaf61fee73c04b839fc8490af8909..a4d1db9547d86aadd1b64b33aebd8eb0870c9241 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Shifts a 64-bit integer right between 0 and 63 bits. This high bits\r
+  are filled with zeros. The shifted value is returned.\r
+\r
+  This function shifts the 64-bit value Operand to the right by Count bits. The\r
+  high Count bits are set to zero. The shifted value is returned.\r
+\r
+  @param  Operand The 64-bit operand to shift right.\r
+  @param  Count   The number of bits to shift right.\r
+\r
+  @return Operand >> Count\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathRShiftU64 (\r
index 8c6ab3527f50b0fad768b19d5ac89056461fa29d..5444aafb6a9f287e39d700509a9142cc83a6c0a4 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of the Control Register 0 (CR0).\r
+\r
+  Reads and returns the current value of CR4. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of the Control Register 0 (CR0).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadCr0 (\r
index 1c682b3899c4e14eb6d215f460d86188bfdcb461..4e97814ee3e48cc14f455dc3dacc9952e7ca64ec 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of the Control Register 2 (CR2).\r
+\r
+  Reads and returns the current value of CR2. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of the Control Register 2 (CR2).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadCr2 (\r
index 39ad5e4f2f58e09dd29ae391997f7630d5a81092..1f6afb39c000f1bcc56859f3f2aa3aff80609552 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of the Control Register 3 (CR3).\r
+\r
+  Reads and returns the current value of CR3. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of the Control Register 3 (CR3).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadCr3 (\r
index 71ffa9b72dd8422733766c0e1c72213a07b967fb..5d24f570389d08e1be61337473d3eaa9bbd5b287 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of the Control Register 4 (CR4).\r
+\r
+  Reads and returns the current value of CR4. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of the Control Register 4 (CR4).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadCr4 (\r
index cd9bad54e7da64be792253178dedc0332e4ad361..86c7257158e0f3ea2bb62673e6c44dab13760581 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Code Segment Register (CS).\r
+\r
+  Reads and returns the current value of CS. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of CS.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadCs (\r
index 7c6f0c629a7ef0424faf815ccf9c320902fdb5d3..23880a416ef79f8d738317b9b630239d06a3af1e 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 0 (DR0).\r
+\r
+  Reads and returns the current value of DR0. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 0 (DR0).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr0 (\r
index 573f658864f151b84243e4ca4b0a5711a763781f..77a9adac66997e42d88f1618cc8a694122408c64 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 1 (DR1).\r
+\r
+  Reads and returns the current value of DR1. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 1 (DR1).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr1 (\r
index 6685d775f767bacbbf653f316c79297a20cc76a0..02ba6a8545611db983ead6cbdeb5408ddc3e130f 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 2 (DR2).\r
+\r
+  Reads and returns the current value of DR2. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 2 (DR2).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr2 (\r
index e8a4bcc6bb6bf3aaccd29a74cdb6c3887fca8a81..10d219943d857798f14ce58e480cb598af2ef387 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 3 (DR3).\r
+\r
+  Reads and returns the current value of DR3. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 3 (DR3).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr3 (\r
index 9ec23218d4fd9ecaac099d16af73cc4069bb6ed5..ff37daa58aa19ad06bda88322fd3507b1c1e8e02 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 4 (DR4).\r
+\r
+  Reads and returns the current value of DR4. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 4 (DR4).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr4 (\r
index 3470524b22549340872e7e0678bd767a49697ca5..ca422e47a5efa0bdb9698030114e8b04ec196204 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 5 (DR5).\r
+\r
+  Reads and returns the current value of DR5. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 5 (DR5).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr5 (\r
index debeecb24f7c0a80a0baf9240e93d9518def791e..921ccc8a0b4c1f6dfdb1d34c8e61f80b8e7a70a3 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 6 (DR6).\r
+\r
+  Reads and returns the current value of DR6. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 6 (DR6).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr6 (\r
index da7a120d705aa46abe1355b9510359b77b6ce2be..cb15e1a706f571b9c85bd45502bb4f545200d224 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Debug Register 7 (DR7).\r
+\r
+  Reads and returns the current value of DR7. This function is only available\r
+  on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on\r
+  X64.\r
+\r
+  @return The value of Debug Register 7 (DR7).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadDr7 (\r
index 91294896e01cb2753947a61771881cc08252f759..e80b3948269c2255dcf6278bd35d61dae7098096 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Data Segment Register (DS).\r
+\r
+  Reads and returns the current value of DS. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of DS.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadDs (\r
index ca5d19c5ac829c1c656fd5b929a5b98683561756..eab499532cf3683af4decaff82c42ca203aeadf5 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of the EFLAGS register.\r
+\r
+  Reads and returns the current value of the EFLAGS register. This function is\r
+  only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a\r
+  64-bit value on X64.\r
+\r
+  @return EFLAGS on IA-32 or RFLAGS on X64.\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmReadEflags (\r
index 8f73b99e6b489e5dee9a95f2aa57d945a4d0aa2d..bcf6d9081c38cdfd0c059a223db7d0309da21636 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of ES Data Segment Register (ES).\r
+\r
+  Reads and returns the current value of ES. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of ES.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadEs (\r
index 848d15581bc41ff9ba1b26c81bed88755d727356..25fee08e4c6cd90a25a49092d09fd72d749cec09 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of FS Data Segment Register (FS).\r
+\r
+  Reads and returns the current value of FS. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of FS.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadFs (\r
index 1bff03c7d6be302ddce25d184480d2e55f515985..1d70b7da1251caa634f65463721312a00fcf0f54 100644 (file)
 #include <BaseLibInternals.h>\r
 \r
 \r
+/**\r
+  Reads the current Global Descriptor Table Register(GDTR) descriptor.\r
+\r
+  Reads and returns the current GDTR descriptor and returns it in Gdtr. This\r
+  function is only available on IA-32 and X64.\r
+\r
+  @param  Gdtr  Pointer to a GDTR descriptor.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalX86ReadGdtr (\r
index df495a0ff9b54806191c59d462b524a7cb5e3e0a..61ba83ef1c73d6ce4f89efd2c92a29dc24a2d58d 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of GS Data Segment Register (GS).\r
+\r
+  Reads and returns the current value of GS. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of GS.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadGs (\r
index 0cfbd63ff4a4da7be12833e498ca9f9bf1bad2dc..db43e9a0d718e56fa754a7d8a36fbd8851839342 100644 (file)
 #include <BaseLibInternals.h>\r
 \r
 \r
+/**\r
+  Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.\r
+\r
+  Reads and returns the current IDTR descriptor and returns it in Idtr. This\r
+  function is only available on IA-32 and X64.\r
+\r
+  @param  Idtr  Pointer to a IDTR descriptor.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalX86ReadIdtr (\r
index 813c08442e95475b7956af20522b9dcd7c96cf4c..c9e372486eb313ac4347ad31a5551bf1c8931f92 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current Local Descriptor Table Register(LDTR) selector.\r
+\r
+  Reads and returns the current 16-bit LDTR descriptor value. This function is\r
+  only available on IA-32 and X64.\r
+\r
+  @return The current selector of LDT.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadLdtr (\r
index 279e657edf4dd598a9a04189ae1f7f896e834a69..75b26827cdd1ff2c659433ad490ff044bcbdc9c4 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #0 (MM0).\r
+\r
+  Reads and returns the current value of MM0. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM0.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm0 (\r
index b46a44c8de5ec9fef37f3ac7078b9a0a72a253b2..1dde8e1bfd1bb0b866b4a0ff90320971a0efd746 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #1 (MM1).\r
+\r
+  Reads and returns the current value of MM1. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM1.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm1 (\r
index 1e4905f20eb8f4e25d149c3500a1a155e7333a7d..bbe80726d1951b38c7a9173a6f910ff04527d11e 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #2 (MM2).\r
+\r
+  Reads and returns the current value of MM2. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM2.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm2 (\r
index f742a9f6aa671995645d24b25085a445ebb0f5e6..868ef7a2c44748a5e7f1cdbdff1d5fd97a01d926 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #3 (MM3).\r
+\r
+  Reads and returns the current value of MM3. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM3.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm3 (\r
index 5b9920bf5b4664a3581206d37aa2405ab0922f6a..3297c1851cdfc330dd15f75594b78f7d8b1d9dfc 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #4 (MM4).\r
+\r
+  Reads and returns the current value of MM4. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM4.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm4 (\r
index 6b5d5df5b72a7ded7867847262f7347fefaf90e1..04db90bcc70c8b980f058d23ff97f369c78a5b10 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #5 (MM5).\r
+\r
+  Reads and returns the current value of MM5. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM5.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm5 (\r
index c0b1b511953946a87b44c81f6b20e0f2e4bda277..ed913945b7670dd8605ffdb3ce1c4479911edae2 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #6 (MM6).\r
+\r
+  Reads and returns the current value of MM6. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM6.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm6 (\r
index af98994636536c38e3788d09226f461e163abcaa..fd24ff8cbd7d0a880bd89f4a47c3f6ea0700e423 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of 64-bit MMX Register #7 (MM7).\r
+\r
+  Reads and returns the current value of MM7. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of MM7.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMm7 (\r
index d93b9cd6e426473c78f7c760b3fdf0f41fc05817..eed41d41dfa18ad84a409eea5cc8f1a6337b525a 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Returns a 64-bit Machine Specific Register(MSR).\r
+\r
+  Reads and returns the 64-bit MSR specified by Index. No parameter checking is\r
+  performed on Index, and some Index values may cause CPU exceptions. The\r
+  caller must either guarantee that Index is valid, or the caller must set up\r
+  exception handlers to catch the exceptions. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @param  Index The 32-bit MSR index to read.\r
+\r
+  @return The value of the MSR identified by Index.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadMsr64 (\r
index 761fa6bf4ed90025188f5dce16306b6fe6bffcda..432c0139f9e08a0550aa6c479088bd476f7ad057 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of a Performance Counter (PMC).\r
+\r
+  Reads and returns the current value of performance counter specified by\r
+  Index. This function is only available on IA-32 and X64.\r
+\r
+  @param  Index The 32-bit Performance Counter index to read.\r
+\r
+  @return The value of the PMC specified by Index.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadPmc (\r
index 002b20cbba162dd0475b1525d36ff79a204b5a42..47750b93cceca632ec05faeceba220ea72c21cf5 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Stack Segment Register (SS).\r
+\r
+  Reads and returns the current value of SS. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of SS.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadSs (\r
index 0069811f46f9e2ae5ab9b56d34562ff1ed158705..dd94b0b4d28c70925fa5dcabd283226c37da5f78 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Task Register (TR).\r
+\r
+  Reads and returns the current value of TR. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @return The current value of TR.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadTr (\r
index 3946ffc792117aace938bd286417f4b09661b691..5689da71468c841fec92adeb8afff1ac377beee5 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Reads the current value of Time Stamp Counter (TSC).\r
+\r
+  Reads and returns the current value of TSC. This function is only available\r
+  on IA-32 and X64.\r
+\r
+  @return The current value of TSC\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmReadTsc (\r
index 5d8692a619cd4e5c4f04b5ffd460ce2abac793ea..67d0571ecf5505d7ca510e633492559d538bacc0 100644 (file)
 //\r
 #include <BaseLibInternals.h>\r
 \r
+/**\r
+  Worker function that checks ASSERT condition for JumpBuffer\r
 \r
+  Checks ASSERT condition for JumpBuffer.\r
+\r
+  If JumpBuffer is NULL, then ASSERT().\r
+  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().\r
+\r
+  @param  JumpBuffer    A pointer to CPU context buffer.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalAssertJumpBuffer (\r
   IN      BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer\r
   );\r
 \r
+/**\r
+  Saves the current CPU context that can be restored with a call to LongJump()\r
+  and returns 0.\r
+\r
+  Saves the current CPU context in the buffer specified by JumpBuffer and\r
+  returns 0. The initial call to SetJump() must always return 0. Subsequent\r
+  calls to LongJump() cause a non-zero value to be returned by SetJump().\r
+\r
+  If JumpBuffer is NULL, then ASSERT().\r
+  For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().\r
+\r
+  @param  JumpBuffer  A pointer to CPU context buffer.\r
+\r
+  @retval 0 Indicates a return from SetJump().\r
+\r
+**/\r
 _declspec (naked)\r
 UINTN\r
 EFIAPI\r
index 714fd8acdcf64c2d8115f25831caaae96e268ffb..018790041fc7c17822435cf7664f9295cd36148f 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Switches the endianess of a 64-bit integer.\r
+\r
+  This function swaps the bytes in a 64-bit unsigned value to switch the value\r
+  from little endian to big endian or vice versa. The byte swapped value is\r
+  returned.\r
+\r
+  @param  Operand A 64-bit unsigned value.\r
+\r
+  @return The byte swaped Operand.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalMathSwapBytes64 (\r
index fa9c8b13a08562c8f44082b2c25a3a0b16bb4449..194d787f9c18e258e42e76765ff7afc05c5afeb3 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Executes a WBINVD instruction.\r
+\r
+  Executes a WBINVD instruction. This function is only available on IA-32 and\r
+  X64.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWbinvd (\r
index 4f2406c67eaabffd2e33756394b866d536d4e033..da9ba8d8b6f97ae66293ab48e32e977bf9f58695 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Control Register 0 (CR0).\r
+\r
+  Writes and returns a new value to CR0. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Cr0 The value to write to CR0.\r
+\r
+  @return The value written to CR0.\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteCr0 (\r
index 8c5d617d539dc15492c009669a312c635fc227be..98e44388b54ba93108a9af6097df3e6899777773 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Control Register 2 (CR2).\r
+\r
+  Writes and returns a new value to CR2. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Cr2 The value to write to CR2.\r
+\r
+  @return The value written to CR2.\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteCr2 (\r
index 7bcf537a7d6377c34829df368cdc468c48ffcdac..ca8784510fa31aeef6f7e9a2b4dbf3e0f5a14cf1 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Control Register 3 (CR3).\r
+\r
+  Writes and returns a new value to CR3. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Cr3 The value to write to CR3.\r
+\r
+  @return The value written to CR3.\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteCr3 (\r
index 04e7b0049162338e8de6fa9bef00131690c9dd55..548d30ee3141b0a101041c09d52a1345789cb501 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Control Register 4 (CR4).\r
+\r
+  Writes and returns a new value to CR4. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Cr4 The value to write to CR4.\r
+\r
+  @return The value written to CR4.\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteCr4 (\r
index 0e9da73bf811e3cf874e45898b5908f9b237e443..4ff4269a318736bc246e7b81db3af0b87e6a32eb 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 0 (DR0).\r
+\r
+  Writes and returns a new value to DR0. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr0 The value to write to Dr0.\r
+\r
+  @return The value written to Debug Register 0 (DR0).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr0 (\r
index f9d1c2b5fb21d1c3099aafe64fd0671476b60f25..480ff5bb32f37759547a3553839502e5b25cba65 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 1 (DR1).\r
+\r
+  Writes and returns a new value to DR1. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr1 The value to write to Dr1.\r
+\r
+  @return The value written to Debug Register 1 (DR1).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr1 (\r
index 61f0979bf12ef7fe3c78f8d3e2c233415eeb5138..2116a1047e7726fc70cf4956e2493b5ded9c547e 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 2 (DR2).\r
+\r
+  Writes and returns a new value to DR2. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr2 The value to write to Dr2.\r
+\r
+  @return The value written to Debug Register 2 (DR2).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr2 (\r
index b39c7a4f9d1088706b9bbfcd0ad5dc778fa405a0..3294e9ecbe7b50065a552a1047a53fc35998dafd 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 3 (DR3).\r
+\r
+  Writes and returns a new value to DR3. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr3 The value to write to Dr3.\r
+\r
+  @return The value written to Debug Register 3 (DR3).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr3 (\r
index c2503c26a85ab8d3e24683b10a54e5b6888b7204..418b6404e524d99d6c3db09f2b2654da7d03c60b 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 4 (DR4).\r
+\r
+  Writes and returns a new value to DR4. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr4 The value to write to Dr4.\r
+\r
+  @return The value written to Debug Register 4 (DR4).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr4 (\r
index dbc6dc90d6d01f8f72a58c7a6fec2f71d8cde453..05267ae7e6e54980680a8fdfbde73a1d71cb743c 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 5 (DR5).\r
+\r
+  Writes and returns a new value to DR5. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr5 The value to write to Dr5.\r
+\r
+  @return The value written to Debug Register 5 (DR5).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr5 (\r
index 1da2a0fec429414e8b8da4578faeb5cbd7142752..2c3085e31d22845d8a33ca71dcf099af5ebe2114 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 6 (DR6).\r
+\r
+  Writes and returns a new value to DR6. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr6 The value to write to Dr6.\r
+\r
+  @return The value written to Debug Register 6 (DR6).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr6 (\r
index 22d28636fab6941c03e31977bdf3b174efdfd3e0..aeb08ada5ddd706e36419d26a1273f5392b639cb 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a value to Debug Register 7 (DR7).\r
+\r
+  Writes and returns a new value to DR7. This function is only available on\r
+  IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.\r
+\r
+  @param  Dr7 The value to write to Dr7.\r
+\r
+  @return The value written to Debug Register 7 (DR7).\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteDr7 (\r
index bc599e09454e9ead82de10e214d71c195b4f0573..4ed0180e6f3678662ad7edc406578f004807634c 100644 (file)
 #include <BaseLibInternals.h>\r
 \r
 \r
+/**\r
+  Writes the current Global Descriptor Table Register (GDTR) descriptor.\r
+\r
+  Writes and the current GDTR descriptor specified by Gdtr. This function is\r
+  only available on IA-32 and X64.\r
+\r
+  @param  Gdtr  Pointer to a GDTR descriptor.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalX86WriteGdtr (\r
index b92dfbdfb9781457b90ab2185f67916bb5ac1c56..88c74b60e88eab51a875d0e54aa52c1db68f3d9b 100644 (file)
 //\r
 #include <BaseLibInternals.h>\r
 \r
+/**\r
+  Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.\r
+\r
+  Writes the current IDTR descriptor and returns it in Idtr. This function is\r
+  only available on IA-32 and X64.\r
+\r
+  @param  Idtr  Pointer to a IDTR descriptor.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalX86WriteIdtr (\r
index 600f015b3552e4aaa7bd939779a9839e04c6da3e..82ba9d0ff9ec19e45fff4df3c7daa2af15c89b47 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current Local Descriptor Table Register (GDTR) selector.\r
+\r
+  Writes and the current LDTR descriptor specified by Ldtr. This function is\r
+  only available on IA-32 and X64.\r
+\r
+  @param  Ldtr  16-bit LDTR selector value.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteLdtr (\r
index c9789315b1ea2c7978fa934b8b926789433ab9bf..703ef29a33ec72fe62c25e1187271db4e9377756 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #0 (MM0).\r
+\r
+  Writes the current value of MM0. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM0.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm0 (\r
index 8a9900bedef6cba0fda7d500f48d9474d74632d4..ee08ab7ac96778fd2d020a07a5c65a2c7f210b31 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #1 (MM1).\r
+\r
+  Writes the current value of MM1. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM1.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm1 (\r
index fb2196963ce2f6f3370880f77da2b142139875d2..08bbb6645e0b0b9a34db3bebad4dd2269254e0c9 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #2 (MM2).\r
+\r
+  Writes the current value of MM2. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM2.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm2 (\r
index d788f3be8c5a80dd9d3ef6db19455409436f33c7..bef0f6502d611eb9a47267b97ca26083cc6ba45b 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #3 (MM3).\r
+\r
+  Writes the current value of MM3. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM3.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm3 (\r
index 7b0160d2a9039bfdb6c711e4e5aca250f7e32a11..eed122d42c871dc91c2a49176002436d54c294ca 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #4 (MM4).\r
+\r
+  Writes the current value of MM4. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM4.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm4 (\r
index 0dd02b706f6ae1b694b77953893058fe702bcd2d..2f94baddfa82cd34e8363fb227676f5b95170ed1 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #5 (MM5).\r
+\r
+  Writes the current value of MM5. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM5.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm5 (\r
index de081405e1d7cc2ae1772e0201f9fc84eb471213..32563770f7b0880e104019331608301fd9c27a3b 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #6 (MM6).\r
+\r
+  Writes the current value of MM6. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM6.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm6 (\r
index 0bb8d205a9272ba2f6fc4ce5881ab402b5040f20..c5a859eb57c6d0c68989711d3bdfa3accc9a40a7 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes the current value of 64-bit MMX Register #7 (MM7).\r
+\r
+  Writes the current value of MM7. This function is only available on IA32 and\r
+  X64.\r
+\r
+  @param  Value The 64-bit value to write to MM7.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 AsmWriteMm7 (\r
index 06cf910c48fbf80d3e141bd652a16e47de9aa33b..77a068950a6885ee4f8934cae730b984cfd99756 100644 (file)
 //\r
 \r
 \r
+/**\r
+  Writes a 64-bit value to a Machine Specific Register(MSR), and returns the\r
+  value.\r
+\r
+  Writes the 64-bit value specified by Value to the MSR specified by Index. The\r
+  64-bit value written to the MSR is returned. No parameter checking is\r
+  performed on Index or Value, and some of these may cause CPU exceptions. The\r
+  caller must either guarantee that Index and Value are valid, or the caller\r
+  must establish proper exception handlers. This function is only available on\r
+  IA-32 and X64.\r
+\r
+  @param  Index The 32-bit MSR index to write.\r
+  @param  Value The 64-bit value to write to the MSR.\r
+\r
+  @return Value\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmWriteMsr64 (\r
index f152f803035e57e0a5fbefe105b6fcb687a71082..3067d4bee610c2c869f09b7b737e44dc22085d61 100644 (file)
@@ -1,18 +1,17 @@
-/// @file\r
-///   This module contains generic macros for an assembly writer.\r
-///\r
-/// Copyright (c) 2006, Intel Corporation<BR>\r
-/// All rights reserved. This program and the accompanying materials\r
-/// are licensed and made available under the terms and conditions of the BSD License\r
-/// which accompanies this distribution.  The full text of the license may be found at\r
-/// http://opensource.org/licenses/bsd-license.php\r
-///\r
-/// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-/// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-///\r
-///\r
-#ifndef _ASM_H\r
-#define _ASM_H\r
+/** @file This module contains generic macros for an assembly writer.\r
+\r
+ Copyright (c) 2006, Intel Corporation<BR>\r
+ All rights reserved. This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution.  The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+**/\r
+\r
+#ifndef _ASM_H_\r
+#define _ASM_H_\r
 \r
 #define TRUE  1\r
 #define FALSE 0\r
index 220a19ef22c14831c7f1b614bdf1c7a5a41dc864..616716bc4c4006d6bc84c46b4ffecb31db650f09 100644 (file)
@@ -1,18 +1,18 @@
-/// @file\r
-/// \r
-/// \r
-/// Copyright (c) 2006, Intel Corporation<BR>\r
-/// All rights reserved. This program and the accompanying materials\r
-/// are licensed and made available under the terms and conditions of the BSD License\r
-/// which accompanies this distribution.  The full text of the license may be found at\r
-/// http://opensource.org/licenses/bsd-license.php\r
-///\r
-/// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-/// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
-/// \r
-///\r
-#ifndef _IA64GEN_H\r
-#define _IA64GEN_H\r
+/** @file Register Definition for IPF.\r
\r
\r
+ Copyright (c) 2006, Intel Corporation<BR>\r
+ All rights reserved. This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution.  The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
+**/\r
+#ifndef _IA64GEN_H_\r
+#define _IA64GEN_H_\r
 \r
 #define TT_UNAT           0\r
 #define C_PSR             0\r
index bdfa7a3c6d15c7756190ea42cbe104ed8af6ce05..6b68bb2eeca8b3fa0a087709f40b3d893a81a2ab 100644 (file)
@@ -64,7 +64,7 @@ StrCpy (
   ASSERT ((UINTN)(Source - Destination) > StrLen (Source));\r
 \r
   ReturnValue = Destination;\r
-  while (*Source) {\r
+  while (*Source != 0) {\r
     *(Destination++) = *(Source++);\r
   }\r
   *Destination = 0;\r
@@ -500,8 +500,8 @@ StrStr (
   @retval FALSE Otherwise.\r
 \r
 **/\r
-STATIC\r
 BOOLEAN\r
+EFIAPI\r
 InternalIsDecimalDigitCharacter (\r
   IN      CHAR16                    Char\r
   )\r
@@ -525,8 +525,8 @@ InternalIsDecimalDigitCharacter (
   @retval Unchanged        Otherwise.\r
 \r
 **/\r
-STATIC\r
 CHAR16\r
+EFIAPI\r
 InternalCharToUpper (\r
   IN      CHAR16                    Char\r
   )\r
@@ -551,8 +551,8 @@ InternalCharToUpper (
   @retval UINTN   The numerical value converted.\r
 \r
 **/\r
-STATIC\r
 UINTN\r
+EFIAPI\r
 InternalHexCharToUintn (\r
   IN      CHAR16                    Char\r
   )\r
@@ -578,8 +578,8 @@ InternalHexCharToUintn (
   @retval FALSE Otherwise.\r
 \r
 **/\r
-STATIC\r
 BOOLEAN\r
+EFIAPI\r
 InternalIsHexaDecimalDigitCharacter (\r
   IN      CHAR16                    Char\r
   )\r
@@ -954,8 +954,8 @@ StrHexToUint64 (
   @retval FALSE Otherwise.\r
 \r
 **/\r
-STATIC\r
 BOOLEAN\r
+EFIAPI\r
 InternalAsciiIsDecimalDigitCharacter (\r
   IN      CHAR8                     Char\r
   )\r
@@ -977,8 +977,8 @@ InternalAsciiIsDecimalDigitCharacter (
   @retval FALSE Otherwise.\r
 \r
 **/\r
-STATIC\r
 BOOLEAN\r
+EFIAPI\r
 InternalAsciiIsHexaDecimalDigitCharacter (\r
   IN      CHAR8                    Char\r
   )\r
@@ -1110,7 +1110,7 @@ AsciiStrCpy (
   ASSERT ((UINTN)(Source - Destination) > AsciiStrLen (Source));\r
 \r
   ReturnValue = Destination;\r
-  while (*Source) {\r
+  while (*Source != 0) {\r
     *(Destination++) = *(Source++);\r
   }\r
   *Destination = 0;\r
@@ -1170,7 +1170,7 @@ AsciiStrnCpy (
 \r
   ReturnValue = Destination;\r
 \r
-  while (*Source && Length > 0) {\r
+  while (*Source != 0 && Length > 0) {\r
     *(Destination++) = *(Source++);\r
     Length--;\r
   }\r
@@ -1298,13 +1298,13 @@ AsciiStrCmp (
   If Value >= 0xA0, then ASSERT().\r
   If (Value & 0x0F) >= 0x0A, then ASSERT().\r
 \r
-  @param  chr   one Ascii character\r
+  @param  Chr   one Ascii character\r
 \r
   @return The uppercase value of Ascii character \r
 \r
 **/\r
-STATIC\r
 CHAR8\r
+EFIAPI\r
 AsciiToUpper (\r
   IN      CHAR8                     Chr\r
   )\r
@@ -1325,8 +1325,8 @@ AsciiToUpper (
   @retval UINTN   The numerical value converted.\r
 \r
 **/\r
-STATIC\r
 UINTN\r
+EFIAPI\r
 InternalAsciiHexCharToUintn (\r
   IN      CHAR8                    Char\r
   )\r
index acc0e715ca7c13888881ee0e9348c97d383fc968..d2f00fded51ef095cc76e596fe753d2ef3c1f2c3 100644 (file)
@@ -41,6 +41,7 @@
                       function.\r
   @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                       function.\r
+  @param  ...         Extended parameters.\r
 \r
 **/\r
 VOID\r
index a4fc399387b98a5906a4e4ab893423325d2c1b37..587623597046d866c3e321d05d68f1f69ae287ca 100644 (file)
@@ -19,9 +19,9 @@
 \r
 #include "BaseLibInternals.h"\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for read write barrier Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for read write barrier Intrinsics.\r
+**/\r
 void    _ReadWriteBarrier (void);\r
 #pragma intrinsic(_ReadWriteBarrier)\r
 \r
index 01939e91280260280e79b92342c30aeed65c8d60..049e34eaaec3e69e5511092b83671d2c1c42a8e3 100644 (file)
 **/\r
 \r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 void __debugbreak ();\r
 \r
 #pragma intrinsic(__debugbreak)\r
 \r
+/**\r
+  Generates a breakpoint on the CPU.\r
+\r
+  Generates a breakpoint on the CPU. The breakpoint must be implemented such\r
+  that code can resume normal execution after the breakpoint.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 CpuBreakpoint (\r
index 4a9fe6aca66fe599697a48b93253db3634ea6b64..de1aac7e6a4742eed1949949fdcb3e8226c14775 100644 (file)
@@ -12,9 +12,9 @@
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 long _InterlockedCompareExchange(\r
    long volatile * Destination,\r
    long Exchange,\r
@@ -23,6 +23,23 @@ long _InterlockedCompareExchange(
 \r
 #pragma intrinsic(_InterlockedCompareExchange)\r
 \r
+/**\r
+  Performs an atomic compare exchange operation on a 32-bit unsigned integer.\r
+\r
+  Performs an atomic compare exchange operation on the 32-bit unsigned integer\r
+  specified by Value.  If Value is equal to CompareValue, then Value is set to\r
+  ExchangeValue and CompareValue is returned.  If Value is not equal to CompareValue,\r
+  then Value is returned.  The compare exchange operation must be performed using\r
+  MP safe mechanisms.\r
+\r
+  @param  Value         A pointer to the 32-bit value for the compare exchange\r
+                        operation.\r
+  @param  CompareValue  32-bit value used in compare operation.\r
+  @param  ExchangeValue 32-bit value used in exchange operation.\r
+\r
+  @return The original *Value before exchange.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncCompareExchange32 (\r
index bed1dc8972271275ebbf24ce9ea1dc27b2b5ffed..1206a1732c5b9c223269e6122567560fb024704c 100644 (file)
@@ -12,9 +12,9 @@
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 __int64 _InterlockedCompareExchange64(\r
    __int64 volatile * Destination,\r
    __int64 Exchange,\r
@@ -23,6 +23,22 @@ __int64 _InterlockedCompareExchange64(
 \r
 #pragma intrinsic(_InterlockedCompareExchange64)\r
 \r
+/**\r
+  Performs an atomic compare exchange operation on a 64-bit unsigned integer.\r
+\r
+  Performs an atomic compare exchange operation on the 64-bit unsigned integer specified\r
+  by Value.  If Value is equal to CompareValue, then Value is set to ExchangeValue and\r
+  CompareValue is returned.  If Value is not equal to CompareValue, then Value is returned.\r
+  The compare exchange operation must be performed using MP safe mechanisms.\r
+\r
+  @param  Value         A pointer to the 64-bit value for the compare exchange\r
+                        operation.\r
+  @param  CompareValue  64-bit value used in compare operation.\r
+  @param  ExchangeValue 64-bit value used in exchange operation.\r
+\r
+  @return The original *Value before exchange.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalSyncCompareExchange64 (\r
index 19e6a5dc49c0af59e3f3149e5ac8bf440f180be3..0f321f8f181a76c2c4b8c16c81d0a9eafcda3180 100644 (file)
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 long _InterlockedDecrement(\r
    long * lpAddend\r
 );\r
 \r
 #pragma intrinsic(_InterlockedDecrement)\r
 \r
+/**\r
+  Performs an atomic decrement of an 32-bit unsigned integer.\r
+\r
+  Performs an atomic decrement of the 32-bit unsigned integer specified by\r
+  Value and returns the decrement value. The decrement operation must be\r
+  performed using MP safe mechanisms. The state of the return value is not\r
+  guaranteed to be MP safe.\r
+\r
+  @param  Value A pointer to the 32-bit value to decrement.\r
+\r
+  @return The decrement value.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncDecrement (\r
index eda9f79a5b205160cba92bc78cb9e8e990d5df22..80921c82dfffd4d37f2e5d31840eb798e6c88729 100644 (file)
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 long _InterlockedIncrement(\r
    long * lpAddend\r
 );\r
 \r
 #pragma intrinsic(_InterlockedIncrement)\r
 \r
+/**\r
+  Performs an atomic increment of an 32-bit unsigned integer.\r
+\r
+  Performs an atomic increment of the 32-bit unsigned integer specified by\r
+  Value and returns the incremented value. The increment operation must be\r
+  performed using MP safe mechanisms. The state of the return value is not\r
+  guaranteed to be MP safe.\r
+\r
+  @param  Value A pointer to the 32-bit value to increment.\r
+\r
+  @return The incremented value.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 InternalSyncIncrement (\r
index 15a573fc09308b55a68ed9efc29df848aa946cf6..19f79396545d35b53d2abe51d587e5d58dc204ff 100644 (file)
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 unsigned __int64 __readmsr (int register);\r
 \r
 #pragma intrinsic(__readmsr)\r
 \r
+/**\r
+  Read data to MSR.\r
+\r
+  @param  Index                Register index of MSR.\r
+\r
+  @return Value read from MSR.\r
+\r
+**/\r
 \r
 UINT64\r
 EFIAPI\r
index 1d1e0bc3324693c71ccdad6105d78d82dd70791f..77d8c597240e171f6e70373e58e49239c11990f2 100644 (file)
 \r
 **/\r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 void __writemsr (unsigned long Register, unsigned __int64 Value);\r
 \r
 #pragma intrinsic(__writemsr)\r
 \r
+/**\r
+  Write data to MSR.\r
+\r
+  @param  Index                Register index of MSR.\r
+  @param  Value                Data wants to be written.\r
+\r
+  @return Value written to MSR.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 AsmWriteMsr64 (\r
index eb73f3637c9bd1fda5bf241cd3db5a4a26db78b2..c6d109a0bb9a26bb362c476c1dc4011b40f438a1 100644 (file)
@@ -101,7 +101,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
index ceddbbe7a05b30419497fa9c491fcbe03993c8b4..fa5619db7c663d250f9fe0e4f679f4aabebb0637 100644 (file)
@@ -32,8 +32,8 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer Place to copy from\r
   @param  Length Number of bytes to copy\r
 \r
   @return Destination\r
@@ -51,7 +51,7 @@ InternalMemCopyMem (
   Set Buffer to Value for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
   @param  Value Value of the set operation.\r
 \r
   @return Buffer\r
@@ -123,7 +123,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
index e8d72dd04c794e45ceb21da59d90f71d889439cb..202aa19e5aab44065c5aa2fc47939fff1b7ef4d0 100644 (file)
@@ -34,8 +34,8 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer Place to copy from\r
   @param  Length Number of bytes to copy\r
 \r
   @return Destination\r
index ce55f447c05afdd66ab392086545278f7143ba1d..fa5619db7c663d250f9fe0e4f679f4aabebb0637 100644 (file)
@@ -32,8 +32,8 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer Place to copy from\r
   @param  Length Number of bytes to copy\r
 \r
   @return Destination\r
index ce55f447c05afdd66ab392086545278f7143ba1d..fa5619db7c663d250f9fe0e4f679f4aabebb0637 100644 (file)
@@ -32,8 +32,8 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer Place to copy from\r
   @param  Length Number of bytes to copy\r
 \r
   @return Destination\r
index ce55f447c05afdd66ab392086545278f7143ba1d..fa5619db7c663d250f9fe0e4f679f4aabebb0637 100644 (file)
@@ -32,8 +32,8 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer Place to copy from\r
   @param  Length Number of bytes to copy\r
 \r
   @return Destination\r
index af71b88e597b9f9146069837d9e40823a7f5e1d3..d82bfe259b704300a4a4d4a080c9c62d82d7056a 100644 (file)
@@ -54,7 +54,7 @@ PciRead8 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value   The value to write.\r
+  @param  Data    The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -382,7 +382,7 @@ PciRead16 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value   The value to write.\r
+  @param  Data    The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -710,7 +710,7 @@ PciRead32 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value   The value to write.\r
+  @param  Data    The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
index c993848043d157b52312017d072c61c2310847e0..33526a7d93f65de353e0cd35d16cab55bb90c786 100644 (file)
@@ -54,7 +54,7 @@ PciRead8 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value   The value to write.\r
+  @param  Data    The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -382,7 +382,7 @@ PciRead16 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value   The value to write.\r
+  @param  Data   The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -710,7 +710,7 @@ PciRead32 (
 \r
   @param  Address Address that encodes the PCI Bus, Device, Function and\r
                   Register.\r
-  @param  Value   The value to write.\r
+  @param  Data    The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
index e785095d7ace410bcda213dcd7450ff97b0326db..b0f154bce53030745a7ef0c035d667d6dc4a1453 100644 (file)
 // Include common header file for this module.\r
 //\r
 \r
+/**\r
+  Flush TLB of current processor.\r
 \r
+**/\r
 VOID\r
 EFIAPI\r
 CpuFlushTlb (\r
index 639886bd1b7dcdbd21548c4094ab4493e359e33b..2a2fb8c47d69ff773cd20a3e7db7f969860a6362 100644 (file)
 #ifndef _DXE_HOB_LIB_INTERNAL_H__\r
 #define _DXE_HOB_LIB_INTERNAL_H__\r
 \r
+/**\r
+  \r
+  Initialize Hob list.\r
+   \r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
+  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 HobLibConstructor (\r
index 773797a291151f032cdb49a7e488525d72ad735d..42d05d78263e15e0e2ec86f757c57979ce17d5e7 100644 (file)
@@ -1078,7 +1078,14 @@ FreeAlignedPool (
   ASSERT_EFI_ERROR (Status);\r
 }\r
 \r
+/**\r
+  Frees buffer that were previously allocated with one of the\r
+  memory allocation functions in the Memory Allocation Library.\r
+\r
+  @param  Buffer                Pointer to the buffer of pages\r
+                                to free.\r
 \r
+**/\r
 VOID\r
 EFIAPI\r
 SafeFreePool (\r
index 6bbd9be77e94dae43d59ab5770294ef3a58ce4d3..faa32f539072edea15a30dda7c1296103406d19b 100644 (file)
@@ -44,7 +44,7 @@ InternalMemCopyMem (
   This function wraps the gBS->SetMem().\r
 \r
   @param  Buffer    Memory to set.\r
-  @param  Length    Number of bytes to set.\r
+  @param  Size      Number of bytes to set.\r
   @param  Value     Value of the set operation.\r
 \r
   @return Buffer.\r
index 8fb417604d7f5b60fe546dc0a1d4eb282d9f068a..2be052d4b97a5538bc60e80dda86b819eec7e4eb 100644 (file)
@@ -96,7 +96,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
index 51877359c089026f765912890106471d5df34fa7..223cb25cf71700a5301b58c03775874de73a10f4 100644 (file)
@@ -36,8 +36,8 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer Place to copy from\r
   @param  Length Number of bytes to copy\r
 \r
   @return Destination\r
@@ -55,7 +55,7 @@ InternalMemCopyMem (
   Set Buffer to Value for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
   @param  Value Value of the set operation.\r
 \r
   @return Buffer\r
@@ -127,7 +127,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
index ccf7b7d213a37612b26eaff816755ae884860a8d..3062df4fcd1876c43d40b09c679a53e179097fa7 100644 (file)
@@ -524,7 +524,6 @@ LibPcdSet64 (
   @retval VOID* Return the pointer for the buffer been set.\r
 \r
 **/\r
-\r
 VOID *\r
 EFIAPI\r
 LibPcdSetPtr (\r
index 41384987902356a07fbe2768f6efeae506a859cb..9953095e7dc9632b3088f04e9935116ce4c4d70e 100644 (file)
@@ -324,7 +324,6 @@ Done:
     @retval  EFI_ACCESS_DENIED  The firmware volume containing the searched Firmware File is configured to disallow reads.\r
   \r
 **/\r
-\r
 EFI_STATUS\r
 EFIAPI\r
 PiLibGetSectionFromCurrentFv (\r
@@ -385,7 +384,6 @@ PiLibGetSectionFromCurrentFv (
     @retval  EFI_ACCESS_DENIED  The firmware volume containing the searched Firmware File is configured to disallow reads.\r
   \r
 **/\r
-\r
 EFI_STATUS\r
 EFIAPI\r
 PiLibGetSectionFromCurrentFfs (\r
index 0a5d4a254bbe9e782eb2ec83a4023f2991a094e2..b9cea72439930abb044fde1a841d0514ccb2936e 100644 (file)
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _DXE_SERVICE_TABLE_LIB_INTERNAL_H\r
-#define _DXE_SERVICE_TABLE_LIB_INTERNAL_H\r
+#ifndef _DXE_SERVICE_TABLE_LIB_INTERNAL_H_\r
+#define _DXE_SERVICE_TABLE_LIB_INTERNAL_H_\r
 \r
 \r
 /**\r
index 7273559127718176bb8d8b6a7259542bb4fc7950..95d9048eee7e1b75354e45dc0d71464b898a8191 100644 (file)
@@ -13,8 +13,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef __INTERNAL_SMBUS_LIB_H\r
-#define __INTERNAL_SMBUS_LIB_H\r
+#ifndef __INTERNAL_SMBUS_LIB_H_\r
+#define __INTERNAL_SMBUS_LIB_H_\r
 \r
 \r
 #include <PiDxe.h>\r
index a70162c831288e89eb7b3352d7ac11ac1ea647d7..aa54e4fbe30c21ee73ddbffbc3d9b4c981132c9f 100644 (file)
@@ -210,8 +210,8 @@ GetBootModeHob (
   @return The address of new HOB.\r
 \r
 **/\r
-STATIC\r
 VOID *\r
+EFIAPI\r
 InternalPeiCreateHob (\r
   IN UINT16                      Type,\r
   IN UINT16                      Length\r
index 133f5c2a2a6cb3147c82951ceda2f095d02b4031..bc81ca2243a9d81cf2524820e13ddcfdeaa561f8 100644 (file)
@@ -53,7 +53,7 @@ MmioReadBuffer8 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length--) {\r
+  while (Length-- != 0) {\r
     *(Buffer++) = MmioRead8 (StartAddress++);\r
   }\r
 \r
@@ -102,7 +102,7 @@ MmioReadBuffer16 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     *(Buffer++) = MmioRead16 (StartAddress);\r
     StartAddress += sizeof (UINT16);\r
     Length -= sizeof (UINT16);\r
@@ -153,7 +153,7 @@ MmioReadBuffer32 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     *(Buffer++) = MmioRead32 (StartAddress);\r
     StartAddress += sizeof (UINT32);\r
     Length -= sizeof (UINT32);\r
@@ -204,7 +204,7 @@ MmioReadBuffer64 (
  \r
   ReturnBuffer = Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     *(Buffer++) = MmioRead64 (StartAddress);\r
     StartAddress += sizeof (UINT64);\r
     Length -= sizeof (UINT64);\r
@@ -247,7 +247,7 @@ MmioWriteBuffer8 (
  \r
   ReturnBuffer = (UINT8 *) Buffer;\r
   \r
-  while (Length--) {\r
+  while (Length-- != 0) {\r
      MmioWrite8 (StartAddress++, *(Buffer++));\r
   }\r
 \r
@@ -298,7 +298,7 @@ MmioWriteBuffer16 (
 \r
   ReturnBuffer = (UINT16 *) Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     MmioWrite16 (StartAddress, *(Buffer++));\r
     \r
     StartAddress += sizeof (UINT16);\r
@@ -352,7 +352,7 @@ MmioWriteBuffer32 (
 \r
   ReturnBuffer = (UINT32 *) Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     MmioWrite32 (StartAddress, *(Buffer++));\r
     \r
     StartAddress += sizeof (UINT32);\r
@@ -405,7 +405,7 @@ MmioWriteBuffer64 (
 \r
   ReturnBuffer = (UINT64 *) Buffer;\r
   \r
-  while (Length) {\r
+  while (Length != 0) {\r
     MmioWrite64 (StartAddress, *(Buffer++));\r
     \r
     StartAddress += sizeof (UINT64);\r
index 207f580d4552e4ffab4f11c0bc7100a1cf5c6bfa..82e50825c05b851e30119c01665b55dad32f2391 100644 (file)
@@ -48,7 +48,7 @@ InternalMemCopyMem (
   This function wraps the gPS->SetMem ().\r
   \r
   @param  Buffer    Memory to set.\r
-  @param  Length    Number of bytes to set.\r
+  @param  Size    Number of bytes to set.\r
   @param  Value     Value of the set operation.\r
 \r
   @return Buffer.\r
index 8fb417604d7f5b60fe546dc0a1d4eb282d9f068a..2be052d4b97a5538bc60e80dda86b819eec7e4eb 100644 (file)
@@ -96,7 +96,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
index 3a0ab3481d8e56c52f81d6c70dcc07064efa493d..f7eba17988c9aa297a036aa52474f4f0abe7ed9b 100644 (file)
@@ -35,9 +35,9 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
-  @param  Length Number of bytes to copy\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer      Place to copy from\r
+  @param  Length            Number of bytes to copy\r
 \r
   @return Destination\r
 \r
@@ -54,7 +54,7 @@ InternalMemCopyMem (
   Set Buffer to Value for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
   @param  Value Value of the set operation.\r
 \r
   @return Buffer\r
@@ -126,7 +126,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
index a76a29bf3a16ed2eb8f3699265514ee73176e645..cbdc92b6ab478d1175875907d95ebd9e83915238 100644 (file)
@@ -46,9 +46,12 @@ CONST EFI_PEI_FIRMWARE_VOLUME_INFO_PPI mFvInfoPpiTemplate = {
                                          firmware volume.\r
     @param  FvInfoSize          Size of the data provided by FvInfo. For memory-mapped firmware volumes, this is\r
                                          typically the size of the firmware volume.\r
-    @param  ParentFvName, ParentFileName      If the firmware volume originally came from a firmware file, then these point to the\r
-                                          parent firmware volume name and firmware volume file. If it did not originally come\r
-                                          from a firmware file, these should be NULL\r
+    @param  ParentFvName        If the firmware volume originally came from a firmware file, then these point to the\r
+                                          parent firmware volume name. If it did not originally come\r
+                                          from a firmware file, these should be NULL.\r
+    @param  ParentFileName      If the firmware volume originally came from a firmware file, then these point to the\r
+                                          firmware volume file. If it did not originally come\r
+                                          from a firmware file, these should be NULL.\r
   \r
 **/\r
 VOID\r
index 9e3adbe66d2bafac4d12799f09c4f8533abd3bd6..0d495601f14d735b5f270055c950bab0efd2352d 100644 (file)
@@ -217,7 +217,7 @@ PeiServicesCreateHob (
 \r
   @param  Instance              This instance of the firmware volume to find.  The value 0 is the\r
                                 Boot Firmware Volume (BFV).\r
-  @param  FwVolHeader           Pointer to the firmware volume header of the volume to return.\r
+  @param  VolumeHandle          Handle of the firmware volume header of the volume to return.\r
 \r
   @retval EFI_SUCCESS           The volume was found.\r
   @retval EFI_NOT_FOUND         The volume was not found.\r
@@ -241,9 +241,9 @@ PeiServicesFfsFindNextVolume (
   This service enables PEIMs to discover additional firmware files.\r
 \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.\r
+  @param  VolumeHandle          Pointer to the firmware volume header of the volume to search.\r
                                 This parameter must point to a valid FFS volume.\r
-  @param  FileHeader            Pointer to the current file from which to begin searching.\r
+  @param  FileHandle            Handle of the current file from which to begin searching.\r
 \r
   @retval EFI_SUCCESS           The file was found.\r
   @retval EFI_NOT_FOUND         The file was not found.\r
@@ -267,7 +267,7 @@ PeiServicesFfsFindNextFile (
 /**\r
   This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
 \r
-  @param  SearchType            The value of the section type to find.\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\r
                                 be searched.\r
   @param  SectionData           A pointer to the discovered section, if successful.\r
@@ -461,6 +461,8 @@ PeiServicesFfsGetFileInfo (
                         Upon exit, points to the found file's\r
                         handle or NULL if it could not be found.\r
 \r
+  @param FileHandle     The filehandle found in volume.\r
+\r
   @retval EFI_SUCCESS             File was found.\r
 \r
   @retval EFI_NOT_FOUND           File was not found.\r
index 7e482b6df29ba1af3c42c376390dca689c999c7b..43293fb83c62941997e68ec2a40879cebc0b30e8 100644 (file)
@@ -18,7 +18,7 @@
 \r
 #include "PeiServicesTablePointerInternal.h"\r
 \r
-static EFI_PEI_SERVICES  **gPeiServices;\r
+STATIC EFI_PEI_SERVICES  **gPeiServices;\r
 \r
 /**\r
   The function set the pointer of PEI services immediately preceding the IDT table\r
@@ -60,7 +60,7 @@ GetPeiServicesTablePointer (
   The constructor function caches the pointer to PEI services.\r
   It will always return EFI_SUCCESS.\r
 \r
-  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
+  @param  FileHandle   Handle of FFS header the loaded driver.\r
   @param  PeiServices Pointer to the PEI services.\r
 \r
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
index 32714b089264e38096b53ca6025447c640657a12..f6d9efd10fd1d64f44d05c3f7089c8dc8c8dd947 100644 (file)
 \r
 #ifndef _PEI_SERVICE_TABLE_POINTER_INTERNAL_H_\r
 #define _PEI_SERVICE_TABLE_POINTER_INTERNAL_H_\r
+\r
 /**\r
   The constructor function caches the pointer to PEI services.\r
   \r
   The constructor function caches the pointer to PEI services.\r
   It will always return EFI_SUCCESS.\r
 \r
-  @param  FfsHeader   Pointer to FFS header the loaded driver.\r
+  @param  FileHandle  Handle of FFS header the loaded driver.\r
   @param  PeiServices Pointer to the PEI services.\r
 \r
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
index 7c1f7abfa25b7de33a64a2584dcc6aefa337d918..db858330378b1a1da4e77d063ce2921bbe136f8c 100644 (file)
@@ -66,7 +66,7 @@ PeiServicesTablePointerLibConstructor (
   The function set the pointer of PEI services immediately preceding the IDT table\r
   according to PI specification.\r
   \r
-  @param    PeiServices   The address of PeiServices pointer.\r
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.\r
 **/\r
 VOID\r
 EFIAPI\r
index acd7ab7a25111d0d79262a823804c8bbb079806b..cd472c1b8395d0e4fe1ffdf7c28ed8b6f962a9aa 100644 (file)
@@ -13,8 +13,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef __INTERNAL_SMBUS_LIB_H\r
-#define __INTERNAL_SMBUS_LIB_H\r
+#ifndef __INTERNAL_SMBUS_LIB_H_\r
+#define __INTERNAL_SMBUS_LIB_H_\r
 \r
 \r
 #include <PiPei.h>\r
index e3f47d2673b6f791addb6f50867eb976a57baaa5..1849f01bc764d8ce6d915066999fbbfa1fb874f2 100644 (file)
@@ -1,4 +1,3 @@
-\r
 /** @file\r
   Entry point to a PEIM.\r
 \r
index 9e477723031aca22f919da60da8a22a27b0f6bbd..1fe1ff691515fa6707a63bdf945550f70b280258 100644 (file)
@@ -31,6 +31,7 @@
 \r
 **/\r
 VOID\r
+EFIAPI\r
 InternalIpfDelay (\r
   IN      INT64                     Delay\r
   )\r
index 99b75d5251d76d00f5db7d8f2a065dabfc399d06..98e86403bdfeda323238d43f578ef18715c44824 100644 (file)
@@ -41,6 +41,7 @@ CONST UINT8                           mTimerLibLocalApicDivisor[] = {
 \r
 **/\r
 UINTN\r
+EFIAPI\r
 InternalX86GetApicBase (\r
   VOID\r
   )\r
@@ -59,6 +60,7 @@ InternalX86GetApicBase (
 \r
 **/\r
 UINT32\r
+EFIAPI\r
 InternalX86GetTimerFrequency (\r
   IN      UINTN                     ApicBase\r
   )\r
@@ -79,6 +81,7 @@ InternalX86GetTimerFrequency (
 \r
 **/\r
 INT32\r
+EFIAPI\r
 InternalX86GetTimerTick (\r
   IN      UINTN                     ApicBase\r
   )\r
@@ -97,6 +100,7 @@ InternalX86GetTimerTick (
 \r
 **/\r
 VOID\r
+EFIAPI\r
 InternalX86Delay (\r
   IN      UINTN                     ApicBase,\r
   IN      UINT32                    Delay\r
index 63a138a558ddbc6d8688273ccc25e3807f001e03..db8468eb83fca50a232d41629c24982956652876 100644 (file)
 \r
 **/\r
 \r
-#ifndef _UefiBootServicesTable_Lib_H\r
-#define _UefiBootServicesTable_Lib_H\r
+#ifndef _UEFIBOOTSERVICESTABLE_LIB_H_\r
+#define _UEFIBOOTSERVICESTABLE_LIB_H_\r
+/**\r
+  \r
+  Initialize gBS.\r
+   \r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
 \r
+  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
+  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 UefiBootServicesTableLibConstructor (\r
index d7d7043a238ca337a6b53aff36c2cf324ea107b3..877c320ff77710cbc25f56277cd18bf943fd6137 100644 (file)
@@ -27,7 +27,6 @@
   @retval FALSE     Language 1 and language 2 are not the same.\r
 \r
 **/\r
-STATIC\r
 BOOLEAN\r
 CompareIso639LanguageCode (\r
   IN CONST CHAR8  *Language1,\r
@@ -257,7 +256,7 @@ EfiNamedEventSignal (
 \r
   @param  VOID\r
 \r
-  @retvale EFI_TPL              The current TPL.\r
+  @retval EFI_TPL              The current TPL.\r
 \r
 **/\r
 EFI_TPL\r
@@ -308,7 +307,7 @@ EfiInitializeLock (
   priority level of the mutual exclusion lock.  Then, it places the lock in the\r
   acquired state.\r
 \r
-  @param  Priority  The task priority level of the lock.\r
+  @param  Lock   The task lock with priority level.\r
 \r
 **/\r
 VOID\r
@@ -457,7 +456,7 @@ EfiTestManagedDevice (
 \r
   @param  ControllerHandle     A handle for a (parent) controller to test.\r
   @param  ChildHandle          A child handle to test.\r
-  @param  ConsumsedGuid        Supplies the protocol that the child controller\r
+  @param  ProtocolGuid         Supplies the protocol that the child controller\r
                                opens on its parent controller.\r
 \r
   @retval EFI_SUCCESS          ChildHandle is a child of the ControllerHandle.\r
@@ -1076,7 +1075,7 @@ AddUnicodeString2 (
     while (OldUnicodeStringTable->Language != NULL) {\r
       LanguageString = OldUnicodeStringTable->Language;\r
 \r
-      while (*LanguageString) {\r
+      while (*LanguageString != 0) {\r
         for (Index = 0; LanguageString[Index] != 0 && LanguageString[Index] != ';'; Index++);\r
 \r
         if (AsciiStrnCmp (Language, LanguageString, Index) == 0) { \r
index b21e5d15595cb13cf09ab37862d40011ae5252ed..970df2bc797a9dcf649a73bbc21825b8786b6165 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   Internal include file for UefiLib.\r
 \r
   Copyright (c) 2007, Intel Corporation.<BR>\r
index df9e4d341dbb12ae2ead41cbaac128e0668d3206..c277974ab4fd36bb58e09b6c3bb46db6a55372ef 100644 (file)
@@ -36,9 +36,8 @@
   @return The number of Unicode characters in the produced\r
           output buffer not including the Null-terminator.\r
 **/\r
-\r
-STATIC\r
 UINTN\r
+EFIAPI\r
 InternalPrint (\r
   IN  CONST CHAR16                     *Format,\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Console,\r
@@ -170,8 +169,8 @@ ErrorPrint (
           output buffer not including the Null-terminator.\r
 \r
 **/\r
-STATIC\r
 UINTN\r
+EFIAPI\r
 AsciiInternalPrint (\r
   IN  CONST CHAR8                      *Format,\r
   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Console,\r
index b621963fbc7430c672f29c81c158ddb7429f5a6a..522367993cec4660b288e712c481e0bbb67746ea 100644 (file)
@@ -28,9 +28,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   This empty function ensures that EFI_EVENT_NOTIFY_SIGNAL_ALL is error\r
   checked correctly since it is now mapped into CreateEventEx() in UEFI 2.0.\r
\r
+  @param  Event                 Event whose notification function is being invoked.\r
+  @param  Context               Pointer to the notification function's context,\r
+                                which is implementation-dependent.\r
 \r
 **/\r
-STATIC\r
 VOID\r
 EFIAPI\r
 InternalEmptyFuntion (\r
@@ -135,7 +138,7 @@ EfiCreateEventLegacyBootEx (
   the EDK/EFI 1.10 form and EDK II/UEFI 2.0 form and allows common code to\r
   work both ways.\r
 \r
-  @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
+  @param  ReadyToBootEvent  Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
   @retval EFI_SUCCESS       Event was created.\r
   @retval Other             Event was not created.\r
@@ -168,7 +171,7 @@ EfiCreateEventReadyToBoot (
   @param  NotifyTpl         The task priority level of the event.\r
   @param  NotifyFunction    The notification function to call when the event is signaled.\r
   @param  NotifyContext     The content to pass to NotifyFunction when the event is signaled.\r
-  @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
+  @param  ReadyToBootEvent  Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
   @retval EFI_SUCCESS       Event was created.\r
   @retval Other             Event was not created.\r
@@ -269,7 +272,7 @@ EfiSignalEventLegacyBoot (
   function points to a location in FvDevicePathNode and it does not allocate\r
   new memory for the GUID pointer that is returned.\r
 \r
-  @param  FvDevicePathNode  Pointer to FV device path to check.\r
+  @param  FvFileDevicePathNode  Pointer to FV device path to check.\r
 \r
   @retval NULL              FvDevicePathNode is not valid.\r
   @retval Other             FvDevicePathNode is valid and pointer to NameGuid was returned.\r
@@ -302,7 +305,7 @@ EfiGetNameGuidFromFwVolDevicePathNode (
   is compiled to conform with the UEFI 2.0 specification use the new device path\r
   else use the old form for backwards compatability.\r
 \r
-  @param  FvDevicePathNode  Pointer to a FV device path node to initialize\r
+  @param  FvFileDevicePathNode  Pointer to a FV device path node to initialize\r
   @param  NameGuid          FV file name to use in FvDevicePathNode\r
 \r
 **/\r
index ec7eacc7699a959468428d4ea870fe023000e731..4565955690fd41981af9ff421ec91aad844a39e7 100644 (file)
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   Library utility functions for Runtime driver.\r
 \r
 Copyright (c) 2006 Intel Corporation. <BR>\r
@@ -25,7 +25,7 @@ STATIC BOOLEAN                mEfiAtRuntime           = FALSE;
 EFI_RUNTIME_SERVICES          *mRT;\r
 \r
 /**\r
-  Set AtRuntime flag as TRUE after ExitBootServices\r
+  Set AtRuntime flag as TRUE after ExitBootServices.\r
 \r
   @param[in]  Event   The Event that is being processed\r
   @param[in]  Context Event Context\r
@@ -120,6 +120,9 @@ RuntimeDriverLibConstruct (
   EfiInitializeRuntimeDriverLib(). If a runtime driver exits with an error,\r
   it must call this routine to free the allocated resource before the exiting.\r
 \r
+  @param[in]  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param[in]  SystemTable   A pointer to the EFI System Table.\r
+\r
   @retval     EFI_SUCCESS       Shutdown the Runtime Driver Lib successfully\r
   @retval     EFI_UNSUPPORTED   Runtime Driver lib was not initialized at all\r
 **/\r
@@ -146,7 +149,7 @@ RuntimeDriverLibDeconstruct (
 }\r
 \r
 /**\r
-  Return TRUE if ExitBootServices () has been called\r
+  Return TRUE if ExitBootServices () has been called.\r
 \r
   @retval TRUE If ExitBootServices () has been called\r
 **/\r
@@ -160,7 +163,7 @@ EfiAtRuntime (
 }\r
 \r
 /**\r
-  Return TRUE if SetVirtualAddressMap () has been called\r
+  Return TRUE if SetVirtualAddressMap () has been called.\r
 \r
   @retval TRUE  If SetVirtualAddressMap () has been called\r
 **/\r
index a14b99e7b2f57cb9b0f3efa1792c5477b283d24b..941426e0a4f1c31b9d526bc80a68ff51f5f9ccf8 100644 (file)
@@ -411,7 +411,7 @@ EfiUpdateCapsule (
                                 stored in contiguous virtual memory.\r
   @param  CapsuleCount          Number of pointers to EFI_CAPSULE_HEADER in\r
                                 CaspuleHeaderArray.\r
-  @param  MaxiumCapsuleSize     On output the maximum size that UpdateCapsule() can\r
+  @param  MaximumCapsuleSize    On output the maximum size that UpdateCapsule() can\r
                                 support as an argument to UpdateCapsule() via\r
                                 CapsuleHeaderArray and ScatterGatherList.\r
                                 Undefined on input.\r
index ac032cd4d5bce9964a97ecb2716204291809d812..bbf63179e7f532315f2597db2635d729e66279be 100644 (file)
@@ -113,13 +113,13 @@ ScsiTestUnitReadyCommand (
 \r
   @param[in]     ScsiIo             SCSI IO Protocol to use\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[out]    SenseData          A pointer to output sense data.\r
+  @param[in]    SenseData          A pointer to output sense data.\r
   @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
                                     output, the number of bytes written to the SenseData buffer.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
-  @param[in]     InquirydataBuffer  A pointer to inquiry data buffer.\r
-  @param[in,out] InquiryDataLength  The length of inquiry data buffer.\r
+  @param[in]     InquirydDtaBuffer  A pointer to inquiry data buffer.\r
+  @param[in out] InquiryDataLength  The length of inquiry data buffer.\r
   @param[in]     EnableVitalProductData  Boolean to enable Vital Product Data.\r
 \r
   @retval EFI_SUCCESS         The status of the unit is tested successfully.\r
@@ -213,13 +213,13 @@ ScsiInquiryCommand (
 \r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[out]    SenseData          A pointer to output sense data.\r
+  @param[in]    SenseData          A pointer to output sense data.\r
   @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
                                     output, the number of bytes written to the SenseData buffer.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
   @param[in]     DataBuffer         A pointer to input data buffer.\r
-  @param[in,out] DataLength         The length of input data buffer.\r
+  @param[in out] DataLength         The length of input data buffer.\r
   @param[in]     DBDField           The DBD Field (Optional).\r
   @param[in]     PageControl        Page Control.\r
   @param[in]     PageCode           Page code.\r
@@ -402,13 +402,13 @@ ScsiRequestSenseCommand (
 \r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[out]    SenseData          A pointer to output sense data.\r
+  @param[in]    SenseData          A pointer to output sense data.\r
   @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
                                     output, the number of bytes written to the SenseData buffer.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
   @param[out]    DataBuffer         A pointer to a data buffer.\r
-  @param[in,out] DataLength         The length of data buffer.\r
+  @param[in out] DataLength         The length of data buffer.\r
   @param[in]     PMI                Partial medium indicator.\r
 \r
   @retval  EFI_SUCCESS                The status of the unit is tested successfully.\r
@@ -504,13 +504,13 @@ ScsiReadCapacityCommand (
 \r
   @param[in]     ScsiIo             A pointer to SCSI IO protocol.\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[out]    SenseData          A pointer to output sense data.\r
+  @param[in]     SenseData          A pointer to output sense data.\r
   @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
                                     output, the number of bytes written to the SenseData buffer.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
   @param[out]    DataBuffer         Read 10 command data.\r
-  @param[in,out] DataLength         The length of data buffer.\r
+  @param[in out] DataLength         The length of data buffer.\r
   @param[in]     StartLba           The start address of LBA.\r
   @param[in]     SectorSize         The sector size.\r
 \r
@@ -606,13 +606,13 @@ ScsiRead10Command (
 \r
   @param[in]     ScsiIo             SCSI IO Protocol to use\r
   @param[in]     Timeout            The length of timeout period.\r
-  @param[out]    SenseData          A pointer to output sense data.\r
-  @param[in out] SenseDataLength    On input, the length in bytes of the SenseData buffer. On\r
+  @param[in]    SenseData          A pointer to output sense data.\r
+  @param[in out]  SenseDataLength   On input, the length in bytes of the SenseData buffer. On\r
                                     output, the number of bytes written to the SenseData buffer.\r
   @param[out]    HostAdapterStatus  The status of Host Adapter.\r
   @param[out]    TargetStatus       The status of the target.\r
   @param[out]    DataBuffer         A pointer to a data buffer.\r
-  @param[in,out] DataLength         The length of data buffer.\r
+  @param[in out] DataLength         The length of data buffer.\r
   @param[in]     StartLba           The start address of LBA.\r
   @param[in]     SectorSize         The sector size.\r
 \r