Correct the structure's comments to follow doxygen format.
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 2 Jul 2009 07:40:24 +0000 (07:40 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 2 Jul 2009 07:40:24 +0000 (07:40 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8721 6f19259b-4bc3-4df7-8a09-765794883524

38 files changed:
IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
IntelFrameworkPkg/Include/Framework/Hob.h
IntelFrameworkPkg/Include/Framework/SmmCis.h
IntelFrameworkPkg/Include/Guid/Capsule.h
IntelFrameworkPkg/Include/Guid/DataHubRecords.h
IntelFrameworkPkg/Include/Guid/FirmwareFileSystem.h
IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
IntelFrameworkPkg/Include/Ppi/BlockIo.h
IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
IntelFrameworkPkg/Include/Ppi/FindFv.h
IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
IntelFrameworkPkg/Include/Ppi/PciCfg.h
IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
IntelFrameworkPkg/Include/Ppi/S3Resume.h
IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
IntelFrameworkPkg/Include/Ppi/Smbus.h
IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
IntelFrameworkPkg/Include/Protocol/FrameworkHii.h
IntelFrameworkPkg/Include/Protocol/IdeControllerInit.h
IntelFrameworkPkg/Include/Protocol/IncompatiblePciDeviceSupport.h
IntelFrameworkPkg/Include/Protocol/LegacyBios.h
IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
IntelFrameworkPkg/Include/Protocol/PciHostBridgeResourceAllocation.h
IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
IntelFrameworkPkg/Include/Protocol/SectionExtraction.h
IntelFrameworkPkg/Include/Protocol/SmmAccess.h
IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h

index 6ea3d39..c2baa8f 100644 (file)
@@ -3,7 +3,7 @@
   Framework IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r
   internal application and drivers as well as all add-in card option-ROM drivers\r
 \r
-  Copyright (c) 2007, Intel Corporation                                                         \r
+  Copyright (c) 2007 - 2009, Intel Corporation                                                         \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
@@ -31,7 +31,7 @@
 #define FRAMEWORK_EFI_IFR_CHECKBOX_OP             0x06\r
 #define FRAMEWORK_EFI_IFR_NUMERIC_OP              0x07\r
 #define FRAMEWORK_EFI_IFR_PASSWORD_OP             0x08\r
-#define FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP        0x09  // ONEOF OPTION field\r
+#define FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP        0x09  ///< ONEOF OPTION field\r
 #define FRAMEWORK_EFI_IFR_SUPPRESS_IF_OP          0x0A\r
 #define FRAMEWORK_EFI_IFR_END_FORM_OP             0x0B\r
 #define FRAMEWORK_EFI_IFR_HIDDEN_OP               0x0C\r
@@ -47,7 +47,7 @@
 #define FRAMEWORK_EFI_IFR_AND_OP                  0x15\r
 #define FRAMEWORK_EFI_IFR_OR_OP                   0x16\r
 #define FRAMEWORK_EFI_IFR_NOT_OP                  0x17\r
-#define FRAMEWORK_EFI_IFR_END_IF_OP               0x18  // for endif of inconsistentif, suppressif, grayoutif\r
+#define FRAMEWORK_EFI_IFR_END_IF_OP               0x18  ///< for endif of inconsistentif, suppressif, grayoutif\r
 #define FRAMEWORK_EFI_IFR_GRAYOUT_IF_OP           0x19\r
 #define FRAMEWORK_EFI_IFR_DATE_OP                 0x1A\r
 #define FRAMEWORK_EFI_IFR_TIME_OP                 0x1B\r
@@ -77,7 +77,7 @@
 #define FRAMEWORK_EFI_IFR_FLAG_RESET_REQUIRED     0x10\r
 #define FRAMEWORK_EFI_IFR_FLAG_LATE_CHECK         0x20\r
 \r
-#define EFI_NON_DEVICE_CLASS              0x00  // Useful when you do not want something in the Device Manager\r
+#define EFI_NON_DEVICE_CLASS              0x00  ///< Useful when you do not want something in the Device Manager\r
 #define EFI_DISK_DEVICE_CLASS             0x01\r
 #define EFI_VIDEO_DEVICE_CLASS            0x02\r
 #define EFI_NETWORK_DEVICE_CLASS          0x04\r
 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00\r
 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01\r
 #define EFI_FRONT_PAGE_SUBCLASS           0x02\r
-#define EFI_SINGLE_USE_SUBCLASS           0x03  // Used to display a single entity and then exit\r
-\r
-//\r
-// Used to flag dynamically created op-codes. This is meaningful to the IFR Library set\r
-// and the browser since we need to distinguish between compiled NV map data and created data.\r
-// We do not allow new entries to be created in the NV map dynamically however we still need\r
-// to display this information correctly.  To dynamically create op-codes and assume that their\r
-// data will be saved, ensure that the NV starting location they refer to is pre-defined in the\r
-// NV map.\r
-//\r
+#define EFI_SINGLE_USE_SUBCLASS           0x03  ///< Used to display a single entity and then exit\r
+\r
+///\r
+/// Used to flag dynamically created op-codes. This is meaningful to the IFR Library set\r
+/// and the browser since we need to distinguish between compiled NV map data and created data.\r
+/// We do not allow new entries to be created in the NV map dynamically however we still need\r
+/// to display this information correctly.  To dynamically create op-codes and assume that their\r
+/// data will be saved, ensure that the NV starting location they refer to is pre-defined in the\r
+/// NV map.\r
+///\r
 #define FRAMEWORK_EFI_IFR_FLAG_CREATED  128\r
 \r
 \r
@@ -118,7 +118,7 @@ typedef struct {
   EFI_PHYSICAL_ADDRESS              CallbackHandle;\r
   UINT16                            Class;\r
   UINT16                            SubClass;\r
-  UINT16                            NvDataSize; // set once, size of the NV data as defined in the script\r
+  UINT16                            NvDataSize; ///< set once, size of the NV data as defined in the script\r
 } FRAMEWORK_EFI_IFR_FORM_SET;\r
 \r
 typedef struct {\r
@@ -142,8 +142,8 @@ typedef struct {
   STRING_REF                        Help;\r
   STRING_REF                        Text;\r
   STRING_REF                        TextTwo;\r
-  UINT8                             Flags;  // This is included solely for purposes of interactive/dynamic support.\r
-  UINT16                            Key;    // Value to be passed to caller to identify this particular op-code\r
+  UINT8                             Flags;  ///< This is included solely for purposes of interactive/dynamic support.\r
+  UINT16                            Key;    ///< Value to be passed to caller to identify this particular op-code\r
 } FRAMEWORK_EFI_IFR_TEXT;\r
 \r
 //\r
@@ -153,9 +153,9 @@ typedef struct {
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
   UINT16                            FormId;\r
   STRING_REF                        Prompt;\r
-  STRING_REF                        Help;   // The string Token for the context-help\r
-  UINT8                             Flags;  // This is included solely for purposes of interactive/dynamic support.\r
-  UINT16                            Key;    // Value to be passed to caller to identify this particular op-code\r
+  STRING_REF                        Help;   ///< The string Token for the context-help\r
+  UINT8                             Flags;  ///< This is included solely for purposes of interactive/dynamic support.\r
+  UINT16                            Key;    ///< Value to be passed to caller to identify this particular op-code\r
 } FRAMEWORK_EFI_IFR_REF;\r
 \r
 typedef struct {\r
@@ -172,49 +172,49 @@ typedef struct {
 //\r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId; // The ID designating what the question is about...\r
-  UINT8                             Width;      // The Size of the Data being saved\r
-  STRING_REF                        Prompt;     // The String Token for the Prompt\r
-  STRING_REF                        Help;       // The string Token for the context-help\r
+  UINT16                            QuestionId; ///< The ID designating what the question is about...\r
+  UINT8                             Width;      ///< The Size of the Data being saved\r
+  STRING_REF                        Prompt;     ///< The String Token for the Prompt\r
+  STRING_REF                        Help;       ///< The string Token for the context-help\r
 } FRAMEWORK_EFI_IFR_ONE_OF;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId; // The offset in NV for storage of the data\r
-  UINT8                             MaxEntries; // The maximum number of options in the ordered list (=size of NVStore)\r
-  STRING_REF                        Prompt;     // The string token for the prompt\r
-  STRING_REF                        Help;       // The string token for the context-help\r
+  UINT16                            QuestionId; ///< The offset in NV for storage of the data\r
+  UINT8                             MaxEntries; ///< The maximum number of options in the ordered list (=size of NVStore)\r
+  STRING_REF                        Prompt;     ///< The string token for the prompt\r
+  STRING_REF                        Help;       ///< The string token for the context-help\r
 } FRAMEWORK_EFI_IFR_ORDERED_LIST;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId; // The ID designating what the question is about...\r
-  UINT8                             Width;      // The Size of the Data being saved\r
-  STRING_REF                        Prompt;     // The String Token for the Prompt\r
-  STRING_REF                        Help;       // The string Token for the context-help\r
-  UINT8                             Flags;      // If non-zero, means that it is the default option\r
-  UINT16                            Key;        // Value to be passed to caller to identify this particular op-code\r
+  UINT16                            QuestionId; ///< The ID designating what the question is about...\r
+  UINT8                             Width;      ///< The Size of the Data being saved\r
+  STRING_REF                        Prompt;     ///< The String Token for the Prompt\r
+  STRING_REF                        Help;       ///< The string Token for the context-help\r
+  UINT8                             Flags;      ///< If non-zero, means that it is the default option\r
+  UINT16                            Key;        ///< Value to be passed to caller to identify this particular op-code\r
 } FRAMEWORK_EFI_IFR_CHECKBOX, FRAMEWORK_EFI_IFR_CHECK_BOX;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  STRING_REF                        Option; // The string token describing the option\r
-  UINT16                            Value;  // The value associated with this option that is stored in the NVRAM\r
-  UINT8                             Flags;  // If non-zero, means that it is the default option\r
-  UINT16                            Key;    // Value to be passed to caller to identify this particular op-code\r
+  STRING_REF                        Option;     ///< The string token describing the option\r
+  UINT16                            Value;      ///< The value associated with this option that is stored in the NVRAM\r
+  UINT8                             Flags;      ///< If non-zero, means that it is the default option\r
+  UINT16                            Key;        ///< Value to be passed to caller to identify this particular op-code\r
 } FRAMEWORK_EFI_IFR_ONE_OF_OPTION;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId; // The ID designating what the question is about...\r
-  UINT8                             Width;      // The Size of the Data being saved\r
-  STRING_REF                        Prompt;     // The String Token for the Prompt\r
-  STRING_REF                        Help;       // The string Token for the context-help\r
-  UINT8                             Flags;      // This is included solely for purposes of interactive/dynamic support.\r
-  UINT16                            Key;        // Value to be passed to caller to identify this particular op-code\r
+  UINT16                            QuestionId; ///< The ID designating what the question is about...\r
+  UINT8                             Width;      ///< The Size of the Data being saved\r
+  STRING_REF                        Prompt;     ///< The String Token for the Prompt\r
+  STRING_REF                        Help;       ///< The string Token for the context-help\r
+  UINT8                             Flags;      ///< This is included solely for purposes of interactive/dynamic support.\r
+  UINT16                            Key;        ///< Value to be passed to caller to identify this particular op-code\r
   UINT16                            Minimum;\r
   UINT16                            Maximum;\r
-  UINT16                            Step;       // Zero means manual input, otherwise, arrow selection is called for\r
+  UINT16                            Step;       ///< Zero means manual input, otherwise, arrow selection is called for\r
   UINT16                            Default;\r
 } FRAMEWORK_EFI_IFR_NUMERIC;\r
 \r
@@ -240,27 +240,27 @@ typedef struct {
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId;// The ID designating what the question is about...\r
-  UINT8                             Width;     // The Size of the Data being saved\r
-  STRING_REF                        Prompt;    // The String Token for the Prompt\r
-  STRING_REF                        Help;      // The string Token for the context-help\r
-  UINT8                             Flags;     // This is included solely for purposes of interactive/dynamic support.\r
-  UINT16                            Key;       // Value to be passed to caller to identify this particular op-code\r
-  UINT8                             MinSize;   // Minimum allowable sized password\r
-  UINT8                             MaxSize;   // Maximum allowable sized password\r
+  UINT16                            QuestionId;///< The ID designating what the question is about...\r
+  UINT8                             Width;     ///< The Size of the Data being saved\r
+  STRING_REF                        Prompt;    ///< The String Token for the Prompt\r
+  STRING_REF                        Help;      ///< The string Token for the context-help\r
+  UINT8                             Flags;     ///< This is included solely for purposes of interactive/dynamic support.\r
+  UINT16                            Key;       ///< Value to be passed to caller to identify this particular op-code\r
+  UINT8                             MinSize;   ///< Minimum allowable sized password\r
+  UINT8                             MaxSize;   ///< Maximum allowable sized password\r
   UINT16                            Encoding;\r
 } FRAMEWORK_EFI_IFR_PASSWORD;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId; // The ID designating what the question is about...\r
-  UINT8                             Width;      // The Size of the Data being saved \r
-  STRING_REF                        Prompt;     // The String Token for the Prompt\r
-  STRING_REF                        Help;       // The string Token for the context-help\r
-  UINT8                             Flags;      // This is included solely for purposes of interactive/dynamic support.\r
-  UINT16                            Key;        // Value to be passed to caller to identify this particular op-code\r
-  UINT8                             MinSize;    // Minimum allowable sized password\r
-  UINT8                             MaxSize;    // Maximum allowable sized password\r
+  UINT16                            QuestionId; ///< The ID designating what the question is about...\r
+  UINT8                             Width;      ///< The Size of the Data being saved \r
+  STRING_REF                        Prompt;     ///< The String Token for the Prompt\r
+  STRING_REF                        Help;       ///< The string Token for the context-help\r
+  UINT8                             Flags;      ///< This is included solely for purposes of interactive/dynamic support.\r
+  UINT16                            Key;        ///< Value to be passed to caller to identify this particular op-code\r
+  UINT8                             MinSize;    ///< Minimum allowable sized password\r
+  UINT8                             MaxSize;    ///< Maximum allowable sized password\r
 } FRAMEWORK_EFI_IFR_STRING;\r
 \r
 typedef struct {\r
@@ -291,30 +291,30 @@ typedef struct {
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId;   // offset into variable storage\r
-  UINT8                             Width;        // size of variable storage\r
-  UINT16                            Value;        // value to compare against\r
+  UINT16                            QuestionId;   ///< offset into variable storage\r
+  UINT8                             Width;        ///< size of variable storage\r
+  UINT16                            Value;        ///< value to compare against\r
 } FRAMEWORK_EFI_IFR_EQ_ID_VAL;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId;   // offset into variable storage\r
-  UINT8                             Width;        // size of variable storage\r
+  UINT16                            QuestionId;   ///< offset into variable storage\r
+  UINT8                             Width;        ///< size of variable storage\r
   UINT16                            ListLength;\r
   UINT16                            ValueList[1];\r
 } FRAMEWORK_EFI_IFR_EQ_ID_LIST;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            QuestionId1;  // offset into variable storage for first value to compare\r
-  UINT8                             Width;        // size of variable storage (must be same for both)\r
-  UINT16                            QuestionId2;  // offset into variable storage for second value to compare\r
+  UINT16                            QuestionId1;  ///< offset into variable storage for first value to compare\r
+  UINT8                             Width;        ///< size of variable storage (must be same for both)\r
+  UINT16                            QuestionId2;  ///< offset into variable storage for second value to compare\r
 } FRAMEWORK_EFI_IFR_EQ_ID_ID;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            VariableId;   // offset into variable storage\r
-  UINT16                            Value;        // value to compare against\r
+  UINT16                            VariableId;   ///< offset into variable storage\r
+  UINT16                            Value;        ///< value to compare against\r
 } FRAMEWORK_EFI_IFR_EQ_VAR_VAL;\r
 \r
 typedef struct {\r
@@ -346,43 +346,43 @@ typedef struct {
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
   STRING_REF                        Help;\r
   STRING_REF                        Text;\r
-  STRING_REF                        TextTwo; // optional text\r
+  STRING_REF                        TextTwo;    ///< optional text\r
 } FRAMEWORK_EFI_IFR_INVENTORY;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  EFI_GUID                          Guid;    // GUID for the variable\r
-  UINT16                            VarId;   // variable store ID, as referenced elsewhere in the form\r
-  UINT16                            Size;    // size of the variable storage\r
+  EFI_GUID                          Guid;       ///< GUID for the variable\r
+  UINT16                            VarId;      ///< variable store ID, as referenced elsewhere in the form\r
+  UINT16                            Size;       ///< size of the variable storage\r
 } FRAMEWORK_EFI_IFR_VARSTORE;\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            VarId;   // variable store ID, as referenced elsewhere in the form\r
+  UINT16                            VarId;      ///< variable store ID, as referenced elsewhere in the form\r
 } FRAMEWORK_EFI_IFR_VARSTORE_SELECT;\r
 \r
-//\r
-// Used for the ideqid VFR statement where two variable stores may be referenced in the\r
-// same VFR statement.\r
-// A browser should treat this as an FRAMEWORK_EFI_IFR_VARSTORE_SELECT statement and assume that all following\r
-// IFR opcodes use the VarId as defined here.\r
-//\r
+///\r
+/// Used for the ideqid VFR statement where two variable stores may be referenced in the\r
+/// same VFR statement.\r
+/// A browser should treat this as an FRAMEWORK_EFI_IFR_VARSTORE_SELECT statement and assume that all following\r
+/// IFR opcodes use the VarId as defined here.\r
+///\r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  UINT16                            VarId;          // variable store ID, as referenced elsewhere in the form\r
-  UINT16                            SecondaryVarId; // variable store ID, as referenced elsewhere in the form\r
+  UINT16                            VarId;          ///< variable store ID, as referenced elsewhere in the form\r
+  UINT16                            SecondaryVarId; ///< variable store ID, as referenced elsewhere in the form\r
 } FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR;\r
 \r
-//\r
-// Save defaults and restore defaults have same structure\r
-//\r
+///\r
+/// Save defaults and restore defaults have same structure\r
+///\r
 #define FRAMEWORK_EFI_IFR_RESTORE_DEFAULTS  FRAMEWORK_EFI_IFR_SAVE_DEFAULTS\r
 \r
 typedef struct {\r
   FRAMEWORK_EFI_IFR_OP_HEADER       Header;\r
-  STRING_REF                        Title;        // The string token for the banner title\r
-  UINT16                            LineNumber;   // 1-based line number\r
-  UINT8                             Alignment;    // left, center, or right-aligned\r
+  STRING_REF                        Title;        ///< The string token for the banner title\r
+  UINT16                            LineNumber;   ///< 1-based line number\r
+  UINT8                             Alignment;    ///< left, center, or right-aligned\r
 } FRAMEWORK_EFI_IFR_BANNER;\r
 \r
 #define FRAMEWORK_EFI_IFR_BANNER_ALIGN_LEFT   0\r
index 193451e..b26cb4e 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This file defines the data structures per HOB specification v0.9.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -22,9 +22,9 @@
 \r
 #include <PiPei.h>\r
 \r
-//\r
-// Capsule volume HOB -- identical to a firmware volume\r
-//\r
+///\r
+/// Capsule volume HOB -- identical to a firmware volume\r
+///\r
 #define EFI_HOB_TYPE_CV           0x0008\r
 \r
 typedef struct {\r
index bef0bb7..31dcc93 100644 (file)
@@ -73,8 +73,8 @@ EFI_STATUS
   );\r
 \r
 typedef struct {\r
-  EFI_SMM_CPU_IO  Read;  ///> This service provides the various modalities of memory and I/O read.\r
-  EFI_SMM_CPU_IO  Write; ///> This service provides the various modalities of memory and I/O write.\r
+  EFI_SMM_CPU_IO  Read;  ///< This service provides the various modalities of memory and I/O read.\r
+  EFI_SMM_CPU_IO  Write; ///< This service provides the various modalities of memory and I/O write.\r
 } EFI_SMM_IO_ACCESS;\r
 \r
 ///\r
index d0f3df7..dc9d2be 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   GUIDs used for EFI Capsule\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
 // a capsule update.\r
 //\r
 typedef struct {\r
-  UINT64                Length;     // length of the data block\r
-  EFI_PHYSICAL_ADDRESS  Data;       // physical address of the data block\r
-  UINT32                Signature;  // CBDS\r
-  UINT32                CheckSum;   // to sum this structure to 0\r
+  UINT64                Length;     ///< length of the data block\r
+  EFI_PHYSICAL_ADDRESS  Data;       ///< physical address of the data block\r
+  UINT32                Signature;  ///< CBDS\r
+  UINT32                CheckSum;   ///< to sum this structure to 0\r
 } FRAMEWORK_EFI_CAPSULE_BLOCK_DESCRIPTOR;\r
 \r
 typedef struct {\r
index 323acdb..b8ff601 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   DataHubRecord.h include all data hub sub class GUID defitions.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -33,10 +33,10 @@ extern  EFI_GUID gEfiProcessorSubClassGuid;
 \r
 extern  EFI_GUID gEfiCacheSubClassGuid;\r
 \r
-//\r
-// The memory subclass belongs to the data class and is identified as the memory \r
-// subclass by the GUID.\r
-//\r
+///\r
+/// The memory subclass belongs to the data class and is identified as the memory \r
+/// subclass by the GUID.\r
+///\r
 #define EFI_MEMORY_SUBCLASS_GUID \\r
   {0x4E8F4EBB, 0x64B9, 0x4e05, {0x9B, 0x18, 0x4C, 0xFE, 0x49, 0x23, 0x50, 0x97} }\r
 \r
index af091a5..a27a8a2 100644 (file)
@@ -2,7 +2,7 @@
   Guid used to define the Firmware File System.  See the Framework Firmware\r
   File System Specification for more details.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, Intel Corporation\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
@@ -23,9 +23,9 @@
 \r
 #include <PiPei.h>\r
 \r
-//\r
-// GUIDs defined by the FFS specification.\r
-//\r
+///\r
+/// GUIDs defined by the FFS specification.\r
+///\r
 #define EFI_FIRMWARE_FILE_SYSTEM_GUID \\r
   { 0x7A9354D9, 0x0468, 0x444a, {0x81, 0xCE, 0x0B, 0xF6, 0x17, 0xD8, 0x90, 0xDF }}\r
 \r
index d13119d..fcdcf1d 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   GUID for use in reserving SMRAM regions.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -33,8 +33,8 @@
 // *******************************************************\r
 //\r
 typedef struct {\r
-  EFI_PHYSICAL_ADDRESS  PhysicalStart;  // Phsyical location in DRAM\r
-  EFI_PHYSICAL_ADDRESS  CpuStart;       // Address CPU uses to access the SMI handler\r
+  EFI_PHYSICAL_ADDRESS  PhysicalStart;  ///< Phsyical location in DRAM\r
+  EFI_PHYSICAL_ADDRESS  CpuStart;       ///< Address CPU uses to access the SMI handler\r
   // May or may not match PhysicalStart\r
   //\r
   UINT64                PhysicalSize;\r
index 014cca5..145139b 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This file declares BlockIo PPI used to access block-oriented storage devices\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -132,24 +132,24 @@ EFI_STATUS
   OUT VOID                                     *Buffer\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
-  to access a block I/O device during PEI recovery boot mode.\r
-\r
-  @param GetNumberOfBlockDevices\r
-  Gets the number of block I/O devices that the specific block driver manages.\r
-\r
-  @param GetBlockDeviceMediaInfo\r
-  Gets the specified media information.\r
-\r
-  @param ReadBlocks\r
-  Reads the requested number of blocks from the specified block device.\r
-\r
-**/\r
+///\r
+///  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
+///  to access a block I/O device during PEI recovery boot mode.\r
+///\r
 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {\r
+  ///\r
+  /// Gets the number of block I/O devices that the specific block driver manages.\r
+  ///\r
   EFI_PEI_GET_NUMBER_BLOCK_DEVICES      GetNumberOfBlockDevices;\r
+  \r
+  ///\r
+  /// Gets the specified media information.\r
+  ///\r
   EFI_PEI_GET_DEVICE_MEDIA_INFORMATION  GetBlockDeviceMediaInfo;\r
+  \r
+  ///\r
+  /// Reads the requested number of blocks from the specified block device.\r
+  ///\r
   EFI_PEI_READ_BLOCKS                   ReadBlocks;\r
 };\r
 \r
index cc803b6..bb6120b 100644 (file)
@@ -8,7 +8,7 @@
   execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
   by issuing the native IA-32 instruction.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -110,16 +110,11 @@ EFI_STATUS
   IN     EFI_GUID                                *FvFile OPTIONAL\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI produces functions to interpret and execute the Framework boot script table.\r
-\r
-  @param Execute\r
-  Executes a boot script table.\r
-\r
-**/\r
+///\r
+/// This PPI produces functions to interpret and execute the Framework boot script table.\r
+///\r
 struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
-  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r
+  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  ///< Executes a boot script table.\r
 };\r
 \r
 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r
index 74d1259..aee8d0c 100644 (file)
@@ -8,7 +8,7 @@
   module determines the internal search order, with capsule number 1 as the highest load priority and\r
   number N as the lowest priority.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -112,24 +112,24 @@ EFI_STATUS
   OUT VOID                                        *Buffer\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,\r
-  regardless of the underlying device(s).\r
-\r
-  @param GetNumberRecoveryCapsules\r
-  Returns the number of DXE capsules that were found.\r
-\r
-  @param GetRecoveryCapsuleInfo\r
-  Returns the capsule image type and the size of a given image.\r
-\r
-  @param LoadRecoveryCapsule\r
-  Loads a DXE capsule into memory\r
-\r
-**/\r
+///\r
+/// Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,\r
+/// regardless of the underlying device(s).\r
+///\r
 struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {\r
+  ///\r
+  /// Returns the number of DXE capsules that were found.\r
+  ///\r
   EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;\r
+  \r
+  ///\r
+  /// Returns the capsule image type and the size of a given image.\r
+  ///\r
   EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;\r
+  \r
+  ///\r
+  /// Loads a DXE capsule into memory\r
+  ///\r
   EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;\r
 };\r
 \r
index d7206d2..4af010b 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -55,17 +55,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   Hardware mechanisms for locating FVs in a platform vary widely.\r
   EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the\r
   PEI Foundation can remain standard across a wide variety of platforms.\r
-\r
-  @param FindFv\r
-  Service that abstracts the location of additional firmware volumes.\r
-\r
 **/\r
 struct _EFI_PEI_FIND_FV_PPI {\r
-  EFI_PEI_FIND_FV_FINDFV  FindFv;\r
+  EFI_PEI_FIND_FV_FINDFV  FindFv;   ///< Service that abstracts the location of additional firmware volumes.\r
 };\r
 \r
 extern EFI_GUID gEfiFindFvPpiGuid;\r
index abe4f3a..3c66b32 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Load image file from fv to memory.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -53,16 +53,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   This PPI is a pointer to the Load File service. This service will be\r
   published by a PEIM.The PEI Foundation will use this service to\r
-  launch the known non-XIP PE/COFF PEIM images.  This service may\r
+  launch the known non-XIP PE/COFF PEIM images. This service may\r
   depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.\r
 **/\r
 struct _EFI_PEI_FV_FILE_LOADER_PPI {\r
-///\r
-/// Loads a PEIM into memory for subsequent execution\r
-///\r
+  ///\r
+  /// Loads a PEIM into memory for subsequent execution\r
+  ///\r
   EFI_PEI_FV_LOAD_FILE  FvLoadFile;\r
 };\r
 \r
index 34773fc..3f4398a 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This file declares PciCfg PPI used to access PCI configuration space in PEI\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, Intel Corporation                                                         \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
@@ -90,20 +90,21 @@ EFI_STATUS
 /**\r
   The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
   controllers behind a PCI root bridge controller.\r
-\r
-  @param Read\r
-  PCI read services.  See the Read() function description.\r
-\r
-  @param Write\r
-  PCI write services.  See the Write() function description.\r
-\r
-  @param Modify\r
-  PCI read-modify-write services.  See the Modify() function description.\r
-\r
 **/\r
 struct _EFI_PEI_PCI_CFG_PPI {\r
+  ///\r
+  /// PCI read services.  See the Read() function description.\r
+  ///\r
   EFI_PEI_PCI_CFG_PPI_IO  Read;\r
+  \r
+  ///\r
+  /// PCI write services.  See the Write() function description.\r
+  ///\r
   EFI_PEI_PCI_CFG_PPI_IO  Write;\r
+  \r
+  ///\r
+  /// PCI read-modify-write services.  See the Modify() function description.\r
+  ///\r
   EFI_PEI_PCI_CFG_PPI_RW  Modify;\r
 };\r
 \r
index b757662..c93ad26 100644 (file)
@@ -6,7 +6,7 @@
   storage; as such, a write command to certain technologies would alter the contents of the entire part,\r
   thus making the in situ PEIM execution not follow the required flow.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, Intel Corporation\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
@@ -106,20 +106,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   This PPI provides a lightweight, read-only variant of the full EFI\r
   variable services.\r
-\r
-  @param GetVariable\r
-  A service to ascertain a given variable name.\r
-\r
-  @param GetNextVariableName\r
-  A service to ascertain a variable based upon a given, known variable\r
-\r
 **/\r
 struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r
-  EFI_PEI_GET_VARIABLE            PeiGetVariable;\r
-  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName;\r
+  EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.\r
+  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r
index 5637c80..f4c7467 100644 (file)
@@ -2,7 +2,7 @@
   This file declares Recovery Module PPI. \r
   This PPI is used to find and load the recovery files.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -51,15 +51,10 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   Finds and loads the recovery files.\r
-\r
-  @param LoadRecoveryCapsule\r
-  Loads a DXE binary capsule into memory.\r
-\r
 **/\r
 struct _EFI_PEI_RECOVERY_MODULE_PPI {\r
-  EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;\r
+  EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;  ///< Loads a DXE binary capsule into memory.\r
 };\r
 \r
 extern EFI_GUID gEfiPeiRecoveryModulePpiGuid;\r
index 4629611..2509eb5 100644 (file)
@@ -64,15 +64,14 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot\r
   path and transfers control to OS.\r
 **/\r
 struct _EFI_PEI_S3_RESUME_PPI {\r
-///\r
-/// Restores the platform to its preboot configuration for an S3 resume and\r
-/// jumps to the OS waking vector.\r
-///\r
+  ///\r
+  /// Restores the platform to its preboot configuration for an S3 resume and\r
+  /// jumps to the OS waking vector.\r
+  ///\r
   EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG  S3RestoreConfig;\r
 };\r
 \r
index 5f0dde5..53e3d38 100644 (file)
@@ -95,16 +95,11 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   This PPI supports encapsulating sections, such as GUIDed sections used to\r
   authenticate the file encapsulation of other domain-specific wrapping.\r
-\r
-  @param GetSection\r
-  Retrieves a section from within a section file.\r
-\r
 **/\r
 struct _EFI_PEI_SECTION_EXTRACTION_PPI {\r
-  EFI_PEI_GET_SECTION PeiGetSection;\r
+  EFI_PEI_GET_SECTION PeiGetSection;  ///< Retrieves a section from within a section file.\r
 };\r
 \r
 extern EFI_GUID gEfiPeiSectionExtractionPpiGuid;\r
index dff06ce..77f52af 100644 (file)
@@ -2,7 +2,7 @@
   This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM \r
   uses to access its SMBus controller and the slave devices attached to it.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -183,29 +183,30 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   Provides the basic I/O interfaces that a PEIM uses to access\r
   its SMBus controller and the slave devices attached to it.\r
-\r
-  @param Execute\r
-  Executes the SMBus operation to an SMBus slave device.\r
-\r
-  @param ArpDevice\r
-  Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
-\r
-  @param GetArpMap\r
-  Allows a PEIM to retrieve the address that was allocated by the SMBus\r
-  host controller during enumeration/ARP.\r
-\r
-  @param Notify\r
-  Allows a driver to register for a callback to the SMBus host\r
-  controller driver when the bus issues a notification to the bus controller PEIM.\r
-\r
 **/\r
 struct _EFI_PEI_SMBUS_PPI {\r
+  ///\r
+  /// Executes the SMBus operation to an SMBus slave device.\r
+  ///\r
   EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;\r
+  \r
+  ///\r
+  /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
+  ///\r
   EFI_PEI_SMBUS_PPI_ARP_DEVICE        ArpDevice;\r
+  \r
+  ///\r
+  /// Allows a PEIM to retrieve the address that was allocated by the SMBus\r
+  /// host controller during enumeration/ARP.  \r
+  ///\r
   EFI_PEI_SMBUS_PPI_GET_ARP_MAP       GetArpMap;\r
+  \r
+  ///\r
+  /// Allows a driver to register for a callback to the SMBus host\r
+  /// controller driver when the bus issues a notification to the bus controller PEIM.  \r
+  ///\r
   EFI_PEI_SMBUS_PPI_NOTIFY            Notify;\r
 };\r
 \r
index cb81d1a..6c80469 100644 (file)
@@ -95,7 +95,6 @@ EFI_STATUS
 );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The EFI_ACPI_S3_SAVE_PROTOCOL is responsible for preparing all the information that the\r
   Framework needs to restore the platform's preboot state during an S3 resume boot. This\r
   information can include the following:\r
@@ -114,16 +113,16 @@ EFI_STATUS
   that the target platform supports an S3 resume and then call EFI_ACPI_S3_SAVE_PROTOCOL\r
   to save the S3 resume information. The entire Framework boot script table will then be generated,\r
   assuming the platform currently is in the preboot state.\r
-\r
-  @param GetLegacyMemorySize\r
-  Gets the size of legacy memory below 1 MB that is required for S3 resume.\r
-\r
-  @param S3Save\r
-  Prepare all information for an S3 resume.\r
-  \r
 **/\r
 struct _EFI_ACPI_S3_SAVE_PROTOCOL {\r
+  ///\r
+  /// Gets the size of legacy memory below 1 MB that is required for S3 resume.\r
+  ///\r
   EFI_ACPI_GET_LEGACY_MEMORY_SIZE   GetLegacyMemorySize;\r
+  \r
+  ///\r
+  /// Prepare all information for an S3 resume.\r
+  ///\r
   EFI_ACPI_S3_SAVE                  S3Save;\r
 };\r
 \r
index 1b4e0ab..19d0e21 100644 (file)
@@ -149,17 +149,19 @@ EFI_STATUS
   to publish a set of tables.\r
 **/\r
 struct _EFI_ACPI_SUPPORT_PROTOCOL {\r
-///\r
-/// Returns a table specified by an index if it exists.\r
-///\r
+  ///\r
+  /// Returns a table specified by an index if it exists.\r
+  ///\r
   EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r
-///\r
-/// Adds, removes, or updates ACPI tables\r
-///\r
+\r
+  ///\r
+  /// Adds, removes, or updates ACPI tables\r
+  ///\r
   EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r
-///\r
-/// Publishes the ACPI tables.\r
-///\r
+\r
+  ///\r
+  /// Publishes the ACPI tables.\r
+  ///\r
   EFI_ACPI_PUBLISH_TABLES PublishTables;\r
 };\r
 \r
index 7dd8470..ebe2e1e 100644 (file)
@@ -2,7 +2,7 @@
   This protocol is used to store or record various boot scripts into boot \r
   script tables.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -85,20 +85,12 @@ EFI_STATUS
 // S3 Save Protocol data structure\r
 //\r
 /**\r
-  @par Protocol Description:\r
   The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions\r
   to store or record various boot scripts into boot script tables.\r
-\r
-  @param Write\r
-  Writes various boot scripts to a boot script table.\r
-\r
-  @param CloseTable\r
-  Retrieves and closes a script table.\r
-\r
 **/\r
 struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {\r
-  EFI_BOOT_SCRIPT_WRITE       Write;\r
-  EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;\r
+  EFI_BOOT_SCRIPT_WRITE       Write;      ///< Writes various boot scripts to a boot script table.\r
+  EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable; ///< Retrieves and closes a script table.\r
 };\r
 \r
 extern EFI_GUID gEfiBootScriptSaveProtocolGuid;\r
index 86bcc8c..c2a7246 100644 (file)
@@ -7,7 +7,7 @@
   Volume Protocol also provides mechanisms for determining and modifying some\r
   attributes of the firmware volume.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -288,38 +288,45 @@ EFI_STATUS
 // Protocol interface structure\r
 //\r
 struct _EFI_FIRMWARE_VOLUME_PROTOCOL {\r
-///\r
-/// Retrieves volume capabilities and current settings.\r
-///\r
+  ///\r
+  /// Retrieves volume capabilities and current settings.\r
+  ///\r
   FRAMEWORK_EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r
-///\r
-/// Modifies the current settings of the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Modifies the current settings of the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;\r
-///\r
-/// Reads an entire file from the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Reads an entire file from the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_READ_FILE      ReadFile;\r
-///\r
-/// Reads a single section from a file into a buffer.\r
-///\r
+\r
+  ///\r
+  /// Reads a single section from a file into a buffer.\r
+  ///\r
   FRAMEWORK_EFI_FV_READ_SECTION   ReadSection;\r
-///\r
-/// Writes an entire file into the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Writes an entire file into the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_WRITE_FILE     WriteFile;\r
-///\r
-/// Provides service to allow searching the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Provides service to allow searching the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_GET_NEXT_FILE  GetNextFile;\r
-///\r
-///  Data field that indicates the size in bytes of the Key input buffer for\r
-///  the GetNextFile() API.\r
-///\r
-UINT32                KeySize;\r
-///\r
-///  Handle of the parent firmware volume.\r
-///\r
+\r
+  ///\r
+  ///  Data field that indicates the size in bytes of the Key input buffer for\r
+  ///  the GetNextFile() API.\r
+  ///\r
+  UINT32                KeySize;\r
+\r
+  ///\r
+  ///  Handle of the parent firmware volume.\r
+  ///\r
   EFI_HANDLE            ParentHandle;\r
 };\r
 \r
index 6f42064..db3809a 100644 (file)
@@ -5,7 +5,7 @@
   in packet of data.  This will also allow the caller to post messages\r
   into the configuration drivers internal mailbox.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, Intel Corporation\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
@@ -143,22 +143,21 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The EFI_FORM_BROWSER_PROTOCOL is the interface to call for drivers to\r
   leverage the EFI configuration driver interface.\r
-\r
-  @param SendForm\r
-  Provides direction to the configuration driver whether to use the HII\r
-  database or to use a passed-in set of data. This functions also establishes\r
-  a pointer to the calling driver's callback interface.\r
-\r
-  @param CreatePopUp\r
-  Routine used to abstract a generic dialog interface and return the\r
-  selected key or string.\r
-\r
 **/\r
 struct _EFI_FORM_BROWSER_PROTOCOL {\r
+  ///\r
+  /// Provides direction to the configuration driver whether to use the HII\r
+  /// database or to use a passed-in set of data. This functions also establishes\r
+  /// a pointer to the calling driver's callback interface.\r
+  ///\r
   EFI_SEND_FORM     SendForm;\r
+  \r
+  ///\r
+  /// Routine used to abstract a generic dialog interface and return the\r
+  /// selected key or string.  \r
+  ///\r
   EFI_CREATE_POP_UP CreatePopUp;\r
 };\r
 \r
index f44c906..e42459d 100644 (file)
@@ -5,7 +5,7 @@
   specific drivers which want to export access to custom hardware storage or\r
   publish IFR which has a requirement to call back the original driver.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, Intel Corporation\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
@@ -183,27 +183,16 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to\r
   custom NVS devices as well as communication of user selections in a more\r
   interactive environment. This protocol should be published by hardware-specific\r
   drivers that want to export access to custom hardware storage or publish IFR\r
   that has a requirement to call back the original driver.\r
-\r
-  @param NvRead\r
-  The read operation to access the NV data serviced by a hardware-specific driver.\r
-\r
-  @param NvWrite\r
-  The write operation to access the NV data serviced by a hardware-specific driver.\r
-\r
-  @param Callback\r
-  The function that is called from the configuration browser to communicate key value pairs.\r
-\r
 **/\r
 struct _EFI_FORM_CALLBACK_PROTOCOL {\r
-  EFI_NV_READ       NvRead;\r
-  EFI_NV_WRITE      NvWrite;\r
-  EFI_FORM_CALLBACK Callback;\r
+  EFI_NV_READ       NvRead;     ///< The read operation to access the NV data serviced by a hardware-specific driver.\r
+  EFI_NV_WRITE      NvWrite;    ///< The write operation to access the NV data serviced by a hardware-specific driver.\r
+  EFI_FORM_CALLBACK Callback;   ///< The function that is called from the configuration browser to communicate key value pairs.\r
 };\r
 \r
 extern EFI_GUID gEfiFormCallbackProtocolGuid;\r
index c6e131e..43fb641 100644 (file)
@@ -751,87 +751,98 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The HII Protocol manages the HII database, which is a repository for data\r
   having to do with fonts, strings, forms, keyboards, and other future human\r
   interface items.\r
-\r
-  @param NewPack\r
-  Extracts the various packs from a package list.\r
-\r
-  @param RemovePack\r
-  Removes a package from the HII database.\r
-\r
-  @param FindHandles\r
-  Determines the handles that are currently active in the database.\r
-\r
-  @param ExportDatabase\r
-  Export the entire contents of the database to a buffer.\r
-\r
-  @param TestString\r
-  Tests if all of the characters in a string have corresponding font characters.\r
-\r
-  @param GetGlyph\r
-  Translates a Unicode character into the corresponding font glyph.\r
-\r
-  @param GlyphToBlt\r
-  Converts a glyph value into a format that is ready for a UGA BLT command.\r
-\r
-  @param NewString\r
-  Allows a new string to be added to an already existing string package.\r
-\r
-  @param GetPrimaryLanguages\r
-  Allows a program to determine the primary languages that are supported\r
-  on a given handle.\r
-\r
-  @param GetSecondaryLanguages\r
-  Allows a program to determine which secondary languages are supported\r
-  on a given handle for a given primary language.\r
-\r
-  @param GetString\r
-  Extracts a string from a package that is already registered with the\r
-  EFI HII database.\r
-\r
-  @param ResetString\r
-  Remove any new strings that were added after the initial string export\r
-  for this handle.\r
-\r
-  @param GetLine\r
-  Allows a program to extract a part of a string of not more than a given width.\r
-\r
-  @param GetForms\r
-  Allows a program to extract a form or form package that has been previously registered.\r
-\r
-  @param GetDefaultImage\r
-  Allows a program to extract the nonvolatile image that represents the default storage image.\r
-\r
-  @param UpdateForm\r
-  Allows a program to update a previously registered form.\r
-\r
-  @param GetKeyboardLayout\r
-  Allows a program to extract the current keyboard layout.\r
-\r
 **/\r
 struct _EFI_HII_PROTOCOL {\r
+  ///\r
+  /// Extracts the various packs from a package list.\r
+  ///\r
   FRAMEWORK_EFI_HII_NEW_PACK            NewPack;\r
+  \r
+  ///\r
+  /// Removes a package from the HII database.\r
+  ///\r
   FRAMEWORK_EFI_HII_REMOVE_PACK         RemovePack;\r
+  \r
+  ///\r
+  /// Determines the handles that are currently active in the database.\r
+  /// \r
   FRAMEWORK_EFI_HII_FIND_HANDLES        FindHandles;\r
+  \r
+  ///\r
+  /// Export the entire contents of the database to a buffer.\r
+  ///\r
   FRAMEWORK_EFI_HII_EXPORT              ExportDatabase;\r
 \r
+  ///\r
+  /// Tests if all of the characters in a string have corresponding font characters.\r
+  ///\r
   FRAMEWORK_EFI_HII_TEST_STRING         TestString;\r
+  \r
+  ///\r
+  /// Translates a Unicode character into the corresponding font glyph.\r
+  ///\r
   FRAMEWORK_EFI_HII_GET_GLYPH           GetGlyph;\r
+  \r
+  ///\r
+  /// Converts a glyph value into a format that is ready for a UGA BLT command.\r
+  ///\r
   FRAMEWORK_EFI_HII_GLYPH_TO_BLT        GlyphToBlt;\r
 \r
+  ///\r
+  /// Allows a new string to be added to an already existing string package.\r
+  ///\r
   FRAMEWORK_EFI_HII_NEW_STRING          NewString;\r
+  \r
+  ///\r
+  /// Allows a program to determine the primary languages that are supported\r
+  /// on a given handle.  \r
+  ///\r
   FRAMEWORK_EFI_HII_GET_PRI_LANGUAGES   GetPrimaryLanguages;\r
+  \r
+  ///\r
+  /// Allows a program to determine which secondary languages are supported\r
+  /// on a given handle for a given primary language.  \r
+  ///\r
   FRAMEWORK_EFI_HII_GET_SEC_LANGUAGES   GetSecondaryLanguages;\r
+  \r
+  ///\r
+  /// Extracts a string from a package that is already registered with the\r
+  /// EFI HII database.  \r
+  ///\r
   FRAMEWORK_EFI_HII_GET_STRING          GetString;\r
+  \r
+  ///\r
+  /// Remove any new strings that were added after the initial string export\r
+  /// for this handle.  \r
+  ///\r
   FRAMEWORK_EFI_HII_RESET_STRINGS       ResetStrings;\r
+  \r
+  ///\r
+  /// Allows a program to extract a part of a string of not more than a given width.\r
+  ///\r
   FRAMEWORK_EFI_HII_GET_LINE            GetLine;\r
+  \r
+  ///\r
+  /// Allows a program to extract a form or form package that has been previously registered.\r
+  ///\r
   FRAMEWORK_EFI_HII_GET_FORMS           GetForms;\r
+  \r
+  ///\r
+  /// Allows a program to extract the nonvolatile image that represents the default storage image.\r
+  ///\r
   FRAMEWORK_EFI_HII_GET_DEFAULT_IMAGE   GetDefaultImage;\r
+  \r
+  ///\r
+  /// Allows a program to update a previously registered form.\r
+  ///\r
   FRAMEWORK_EFI_HII_UPDATE_FORM         UpdateForm;\r
 \r
+  ///\r
+  /// Allows a program to extract the current keyboard layout.\r
+  ///\r
   FRAMEWORK_EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r
 };\r
 \r
index dd6c3f4..8b23693 100644 (file)
@@ -9,7 +9,7 @@
   retrieve the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance that is associated with the\r
   controller to be managed.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the EFI Platform IDE Protocol GUID\r
-//\r
+///\r
+/// Global ID for the EFI Platform IDE Protocol GUID\r
+///\r
 #define EFI_IDE_CONTROLLER_INIT_PROTOCOL_GUID \\r
   { 0xa1e37052, 0x80d9, 0x4e65, {0xa3, 0x17, 0x3e, 0x9a, 0x55, 0xc4, 0x3e, 0xc9 } }\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL  EFI_IDE_CONTROLLER_INIT_PROTOCOL;\r
 \r
 //\r
@@ -133,19 +133,19 @@ typedef struct {
 #pragma pack(1)\r
 \r
 typedef struct {\r
-  UINT16  config;             // General Configuration\r
-  UINT16  cylinders;          // Number of Cylinders\r
+  UINT16  config;                 ///< General Configuration\r
+  UINT16  cylinders;              ///< Number of Cylinders\r
   UINT16  reserved_2;\r
-  UINT16  heads;              //Number of logical heads\r
+  UINT16  heads;                  ///< Number of logical heads\r
   UINT16  vendor_data1;\r
   UINT16  vendor_data2;\r
   UINT16  sectors_per_track;\r
   UINT16  vendor_specific_7_9[3];\r
-  CHAR8   SerialNo[20];       // ASCII\r
+  CHAR8   SerialNo[20];           ///< ASCII\r
   UINT16  vendor_specific_20_21[2];\r
   UINT16  ecc_bytes_available;\r
-  CHAR8   FirmwareVer[8];     // ASCII\r
-  CHAR8   ModelName[40];      // ASCII\r
+  CHAR8   FirmwareVer[8];         ///< ASCII\r
+  CHAR8   ModelName[40];          ///< ASCII\r
   UINT16  multi_sector_cmd_max_sct_cnt;\r
   UINT16  reserved_48;\r
   UINT16  capabilities;\r
@@ -171,23 +171,23 @@ typedef struct {
   UINT16  reserved_69_79[11];\r
   UINT16  major_version_no;\r
   UINT16  minor_version_no;\r
-  UINT16  command_set_supported_82; // word 82\r
-  UINT16  command_set_supported_83; // word 83\r
-  UINT16  command_set_feature_extn; // word 84\r
-  UINT16  command_set_feature_enb_85; // word 85\r
-  UINT16  command_set_feature_enb_86; // word 86\r
-  UINT16  command_set_feature_default; // word 87\r
-  UINT16  ultra_dma_mode; // word 88\r
+  UINT16  command_set_supported_82;   ///< word 82\r
+  UINT16  command_set_supported_83;   ///< word 83\r
+  UINT16  command_set_feature_extn;   ///< word 84\r
+  UINT16  command_set_feature_enb_85; ///< word 85\r
+  UINT16  command_set_feature_enb_86; ///< word 86\r
+  UINT16  command_set_feature_default; ///< word 87\r
+  UINT16  ultra_dma_mode;             ///< word 88\r
   UINT16  reserved_89_105[17];\r
-  UINT16  phy_logic_sector_support; // word 106\r
+  UINT16  phy_logic_sector_support;   ///< word 106\r
   UINT16  reserved_107_116[10];\r
-  UINT16  logic_sector_size_lo; // word 117\r
-  UINT16  logic_sector_size_hi; // word 118\r
+  UINT16  logic_sector_size_lo;       ///< word 117\r
+  UINT16  logic_sector_size_hi;       ///< word 118\r
   UINT16  reserved_119_127[9];\r
   UINT16  security_status;\r
   UINT16  vendor_data_129_159[31];\r
   UINT16  reserved_160_208[49];\r
-  UINT16  alignment_logic_in_phy_blocks; // word 209\r
+  UINT16  alignment_logic_in_phy_blocks; ///< word 209\r
   UINT16  reserved_210_255[46];\r
 } EFI_ATA_IDENTIFY_DATA;\r
 \r
@@ -199,7 +199,7 @@ typedef struct {
 //\r
 #pragma pack(1)\r
 typedef struct {\r
-    UINT16  config;             // General Configuration\r
+    UINT16  config;             ///< General Configuration\r
     UINT16  obsolete_1;\r
     UINT16  specific_config;\r
     UINT16  obsolete_3;\r
@@ -207,11 +207,11 @@ typedef struct {
     UINT16  obsolete_6;\r
     UINT16  cfa_reserved_7_8[2];\r
     UINT16  retired_9;\r
-    CHAR8   SerialNo[20];       // ASCII\r
+    CHAR8   SerialNo[20];       ///< ASCII\r
     UINT16  retired_20_21[2];\r
     UINT16  obsolete_22;\r
-    CHAR8   FirmwareVer[8];     // ASCII\r
-    CHAR8   ModelName[40];      // ASCII\r
+    CHAR8   FirmwareVer[8];     ///< ASCII\r
+    CHAR8   ModelName[40];      ///< ASCII\r
     UINT16  multi_sector_cmd_max_sct_cnt;\r
     UINT16  reserved_48;\r
     UINT16  capabilities_49;\r
@@ -425,46 +425,51 @@ EFI_STATUS
 // EFI_IDE_CONTROLLER_INIT_PROTOCOL instances.\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the basic interfaces to abstract an IDE controller.\r
-\r
-  @param GetChannelInfo\r
-  Returns the information about a specific channel.\r
-\r
-  @param NotifyPhase\r
-  The notification that the IDE bus driver is about to enter the\r
-  specified phase during the enumeration process.\r
-\r
-  @param SubmitData\r
-  Submits the Drive Identify data that was returned by the device.\r
-\r
-  @param DisqualifyMode\r
-  Submits information about modes that should be disqualified.\r
-\r
-  @param CalculateMode\r
-  Calculates and returns the optimum mode for a particular IDE device.\r
-\r
-  @param SetTiming\r
-  Programs the IDE controller hardware to the default timing or per the modes\r
-  that were returned by the last call to CalculateMode().\r
-\r
-  @param EnumAll\r
-  Set to TRUE if the enumeration group includes all the channels that are\r
-  produced by this controller. FALSE if an enumeration group consists of\r
-  only one channel.\r
-\r
-  @param ChannelCount\r
-  The number of channels that are produced by this controller.\r
-\r
 **/\r
 struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL {\r
+  ///\r
+  /// Returns the information about a specific channel.\r
+  ///\r
   EFI_IDE_CONTROLLER_GET_CHANNEL_INFO    GetChannelInfo;\r
+  \r
+  ///\r
+  /// The notification that the IDE bus driver is about to enter the\r
+  /// specified phase during the enumeration process.  \r
+  ///\r
   EFI_IDE_CONTROLLER_NOTIFY_PHASE        NotifyPhase;\r
+  \r
+  ///\r
+  /// Submits the Drive Identify data that was returned by the device.\r
+  ///\r
   EFI_IDE_CONTROLLER_SUBMIT_DATA         SubmitData;\r
+  \r
+  ///\r
+  /// Submits information about modes that should be disqualified.\r
+  ///\r
   EFI_IDE_CONTROLLER_DISQUALIFY_MODE     DisqualifyMode;\r
+  \r
+  ///\r
+  /// Calculates and returns the optimum mode for a particular IDE device.\r
+  ///\r
   EFI_IDE_CONTROLLER_CALCULATE_MODE      CalculateMode;\r
+  \r
+  ///\r
+  /// Programs the IDE controller hardware to the default timing or per the modes\r
+  /// that were returned by the last call to CalculateMode().  \r
+  ///\r
   EFI_IDE_CONTROLLER_SET_TIMING          SetTiming;\r
+  \r
+  ///\r
+  /// Set to TRUE if the enumeration group includes all the channels that are\r
+  /// produced by this controller. FALSE if an enumeration group consists of\r
+  /// only one channel.  \r
+  ///\r
   BOOLEAN                                EnumAll;\r
+  \r
+  ///\r
+  /// The number of channels that are produced by this controller.\r
+  ///\r
   UINT8                                  ChannelCount;\r
 };\r
 \r
index 6b74a74..75b7db5 100644 (file)
@@ -15,7 +15,7 @@
   (DXE) driver and must be made available before the Boot Device Selection (BDS) phase. The PCI\r
   bus driver will look for the presence of this protocol before it begins PCI enumeration.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -71,15 +71,15 @@ EFI_STATUS
 );\r
 \r
 \r
-//\r
-// Interface structure for the Incompatible PCI Device Support Protocol\r
-//\r
-struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL {\r
 ///\r
-///  Returns a list of ACPI resource descriptors that detail any special\r
-///  resource configuration requirements if the specified device is a recognized\r
-///  incompatible PCI device.\r
+/// Interface structure for the Incompatible PCI Device Support Protocol\r
 ///\r
+struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL {\r
+  ///\r
+  ///  Returns a list of ACPI resource descriptors that detail any special\r
+  ///  resource configuration requirements if the specified device is a recognized\r
+  ///  incompatible PCI device.\r
+  ///\r
   EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_CHECK_DEVICE      CheckDevice;\r
 };\r
 \r
index eef3fbe..c881d9c 100644 (file)
@@ -12,7 +12,7 @@
   You most likely should not use this protocol! Find the EFI way to solve the\r
   problem to make your code portable\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -470,62 +470,71 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   Abstracts the traditional BIOS from the rest of EFI. The LegacyBoot()\r
   member function allows the BDS to support booting a traditional OS.\r
   EFI thunks drivers that make EFI bindings for BIOS INT services use\r
   all the other member functions.\r
-\r
-  @param Int86\r
-  Performs traditional software INT. See the Int86() function description.\r
-\r
-  @param FarCall86\r
-  Performs a far call into Compatibility16 or traditional OpROM code.\r
-\r
-  @param CheckPciRom\r
-  Checks if a traditional OpROM exists for this device.\r
-\r
-  @param InstallPciRom\r
-  Loads a traditional OpROM in traditional OpROM address space.\r
-\r
-  @param LegacyBoot\r
-  Boots a traditional OS.\r
-\r
-  @param UpdateKeyboardLedStatus\r
-  Updates BDA to reflect the current EFI keyboard LED status.\r
-\r
-  @param GetBbsInfo\r
-  Allows an external agent, such as BIOS Setup, to get the BBS data.\r
-\r
-  @param ShadowAllLegacyOproms\r
-  Causes all legacy OpROMs to be shadowed.\r
-\r
-  @param PrepareToBootEfi\r
-  Performs all actions prior to boot. Used when booting an EFI-aware OS\r
-  rather than a legacy OS.\r
-\r
-  @param GetLegacyRegion\r
-  Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r
-\r
-  @param CopyLegacyRegion\r
-  Allows EFI to copy data to the area specified by GetLegacyRegion.\r
-\r
-  @param BootUnconventionalDevice\r
-  Allows the user to boot off an unconventional device such as a PARTIES partition.\r
-\r
 **/\r
 struct _EFI_LEGACY_BIOS_PROTOCOL {\r
+  ///\r
+  /// Performs traditional software INT. See the Int86() function description.\r
+  ///\r
   EFI_LEGACY_BIOS_INT86                       Int86;\r
+  \r
+  ///\r
+  /// Performs a far call into Compatibility16 or traditional OpROM code.\r
+  ///\r
   EFI_LEGACY_BIOS_FARCALL86                   FarCall86;\r
+  \r
+  ///\r
+  /// Checks if a traditional OpROM exists for this device.\r
+  ///\r
   EFI_LEGACY_BIOS_CHECK_ROM                   CheckPciRom;\r
+  \r
+  ///\r
+  /// Loads a traditional OpROM in traditional OpROM address space.\r
+  ///\r
   EFI_LEGACY_BIOS_INSTALL_ROM                 InstallPciRom;\r
+  \r
+  ///\r
+  /// Boots a traditional OS.\r
+  ///\r
   EFI_LEGACY_BIOS_BOOT                        LegacyBoot;\r
+  \r
+  ///\r
+  /// Updates BDA to reflect the current EFI keyboard LED status.\r
+  ///\r
   EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS  UpdateKeyboardLedStatus;\r
+  \r
+  ///\r
+  /// Allows an external agent, such as BIOS Setup, to get the BBS data.\r
+  ///\r
   EFI_LEGACY_BIOS_GET_BBS_INFO                GetBbsInfo;\r
+  \r
+  ///\r
+  /// Causes all legacy OpROMs to be shadowed.\r
+  ///\r
   EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS    ShadowAllLegacyOproms;\r
+  \r
+  ///\r
+  /// Performs all actions prior to boot. Used when booting an EFI-aware OS\r
+  /// rather than a legacy OS.  \r
+  ///\r
   EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI         PrepareToBootEfi;\r
+  \r
+  ///\r
+  /// Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r
+  ///\r
   EFI_LEGACY_BIOS_GET_LEGACY_REGION           GetLegacyRegion;\r
+  \r
+  ///\r
+  /// Allows EFI to copy data to the area specified by GetLegacyRegion.\r
+  ///\r
   EFI_LEGACY_BIOS_COPY_LEGACY_REGION          CopyLegacyRegion;\r
+  \r
+  ///\r
+  /// Allows the user to boot off an unconventional device such as a PARTIES partition.\r
+  ///\r
   EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE  BootUnconventionalDevice;\r
 };\r
 \r
index 8c952eb..a43b91a 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This protocol abstracts the PIRQ programming from the generic EFI Compatibility Support Modules (CSMs).\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -103,21 +103,24 @@ EFI_STATUS
   );\r
 \r
 struct _EFI_LEGACY_INTERRUPT_PROTOCOL {\r
-///\r
-///   Gets the number of PIRQs supported.\r
-///\r
+  ///\r
+  ///   Gets the number of PIRQs supported.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS GetNumberPirqs;\r
-///\r
-/// Gets the PCI bus, device, and function that associated with this protocol.\r
-///\r
+\r
+  ///\r
+  /// Gets the PCI bus, device, and function that associated with this protocol.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_GET_LOCATION     GetLocation;\r
-///\r
-/// Reads the indicated PIRQ register.\r
-///\r
+\r
+  ///\r
+  /// Reads the indicated PIRQ register.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_READ_PIRQ        ReadPirq;\r
-///\r
-/// Writes to the indicated PIRQ register.\r
-///\r
+\r
+  ///\r
+  /// Writes to the indicated PIRQ register.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_WRITE_PIRQ       WritePirq;\r
 };\r
 \r
index 09a8dcb..0b3ab83 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This protocol manages the legacy memory regions between 0xc0000 - 0xfffff\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -112,29 +112,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   Abstracts the hardware control of the physical address region 0xC0000-C0xFFFFF\r
   for the traditional BIOS.\r
-\r
-  @param Decode\r
-  Specifies a region for the chipset to decode\r
-\r
-  @param Lock\r
-  Makes the specified OpROM region read only or locked.\r
-\r
-  @param BootLock\r
-  Sets a region to read only and ensures tat flash is locked from\r
-  inadvertent modification.\r
-\r
-  @param Unlock\r
-  Makes the specified OpROM region read-write or unlocked.\r
-\r
 **/\r
 struct _EFI_LEGACY_REGION_PROTOCOL {\r
-  EFI_LEGACY_REGION_DECODE    Decode;\r
-  EFI_LEGACY_REGION_LOCK      Lock;\r
-  EFI_LEGACY_REGION_BOOT_LOCK BootLock;\r
-  EFI_LEGACY_REGION_UNLOCK    UnLock;\r
+  EFI_LEGACY_REGION_DECODE    Decode;     ///< Specifies a region for the chipset to decode\r
+  EFI_LEGACY_REGION_LOCK      Lock;       ///< Makes the specified OpROM region read only or locked.\r
+  EFI_LEGACY_REGION_BOOT_LOCK BootLock;   ///< Sets a region to read only and ensures tat flash is locked from\r
+                                          ///< inadvertent modification.\r
+  EFI_LEGACY_REGION_UNLOCK    UnLock;     ///< Makes the specified OpROM region read-write or unlocked.\r
 };\r
 \r
 extern EFI_GUID gEfiLegacyRegionProtocolGuid;\r
index 4b51bdb..f086bf9 100644 (file)
@@ -3,7 +3,7 @@
   Provides the basic interfaces to abstract a PCI host bridge resource allocation. This protocol is\r
   mandatory if the system includes PCI devices.\r
   \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -35,19 +35,19 @@ typedef struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL EFI_PCI_HOST_BR
 // EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES\r
 //\r
 \r
-// If this bit is set, then the PCI Root Bridge does not\r
-// support separate windows for Non-prefetchable and Prefetchable\r
-// memory. A PCI bus driver needs to include requests for Prefetchable\r
-// memory in the Non-prefetchable memory pool.\r
-//\r
+/// If this bit is set, then the PCI Root Bridge does not\r
+/// support separate windows for Non-prefetchable and Prefetchable\r
+/// memory. A PCI bus driver needs to include requests for Prefetchable\r
+/// memory in the Non-prefetchable memory pool.\r
+///\r
 #define EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM  1\r
 \r
-//\r
-// If this bit is set, then the PCI Root Bridge supports\r
-// 64 bit memory windows.  If this bit is not set,\r
-// the PCI bus driver needs to include requests for 64 bit\r
-// memory address in the corresponding 32 bit memory pool.\r
-//\r
+///\r
+/// If this bit is set, then the PCI Root Bridge supports\r
+/// 64 bit memory windows.  If this bit is not set,\r
+/// the PCI bus driver needs to include requests for 64 bit\r
+/// memory address in the corresponding 32 bit memory pool.\r
+///\r
 #define EFI_PCI_HOST_BRIDGE_MEM64_DECODE   2\r
 \r
 typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS;\r
@@ -63,79 +63,81 @@ typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS;
 // EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE\r
 //\r
 typedef enum {\r
+  ///\r
+  /// Reset the host bridge PCI apertures and internal data structures.\r
+  /// PCI enumerator should issue this notification before starting fresh\r
+  /// enumeration process. Enumeration cannot be restarted after sending\r
+  /// any other notification such as EfiPciHostBridgeBeginBusAllocation.\r
+  ///\r
   EfiPciHostBridgeBeginEnumeration,\r
+\r
+  ///\r
+  /// The bus allocation phase is about to begin. No specific action\r
+  /// is required here. This notification can be used to perform any\r
+  /// chipset specific programming.  \r
+  ///\r
   EfiPciHostBridgeBeginBusAllocation,\r
+\r
+  ///\r
+  /// The bus allocation and bus programming phase is complete. No specific\r
+  /// action is required here. This notification can be used to perform any\r
+  /// chipset specific programming.  \r
+  ///\r
   EfiPciHostBridgeEndBusAllocation,\r
+  \r
+  ///\r
+  /// The resource allocation phase is about to begin.No specific action is\r
+  /// required here. This notification can be used to perform any chipset specific programming.  \r
+  ///\r
   EfiPciHostBridgeBeginResourceAllocation,\r
+  \r
+  ///\r
+  /// Allocate resources per previously submitted requests for all the PCI Root\r
+  /// Bridges. These resource settings are returned on the next call to\r
+  /// GetProposedResources().  \r
+  ///\r
   EfiPciHostBridgeAllocateResources,\r
+  \r
+  ///\r
+  /// Program the Host Bridge hardware to decode previously allocated resources\r
+  /// (proposed resources) for all the PCI Root Bridges.\r
+  ///\r
   EfiPciHostBridgeSetResources,\r
+  \r
+  ///\r
+  /// De-allocate previously allocated resources previously for all the PCI\r
+  /// Root Bridges and reset the I/O and memory apertures to initial state.  \r
+  ///\r
   EfiPciHostBridgeFreeResources,\r
+  \r
+  ///\r
+  /// The resource allocation phase is completed.  No specific action is required\r
+  /// here. This notification can be used to perform any chipset specific programming.  \r
+  ///\r
   EfiPciHostBridgeEndResourceAllocation\r
 } EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE;\r
 \r
-//\r
-// EfiPciHostBridgeBeginEnumeration\r
-// Reset the host bridge PCI apertures and internal data structures.\r
-// PCI enumerator should issue this notification before starting fresh\r
-// enumeration process. Enumeration cannot be restarted after sending\r
-// any other notification such as EfiPciHostBridgeBeginBusAllocation.\r
-//\r
-// EfiPciHostBridgeBeginBusAllocation\r
-// The bus allocation phase is about to begin. No specific action\r
-// is required here. This notification can be used to perform any\r
-// chipset specific programming.\r
-//\r
-// EfiPciHostBridgeEndBusAllocation\r
-// The bus allocation and bus programming phase is complete. No specific\r
-// action is required here. This notification can be used to perform any\r
-// chipset specific programming.\r
-//\r
-// EfiPciHostBridgeBeginResourceAllocation\r
-// The resource allocation phase is about to begin.No specific action is\r
-// required here. This notification can be used to perform any chipset specific programming.\r
-//\r
-// EfiPciHostBridgeAllocateResources\r
-// Allocate resources per previously submitted requests for all the PCI Root\r
-// Bridges. These resource settings are returned on the next call to\r
-// GetProposedResources().\r
-//\r
-// EfiPciHostBridgeSetResources\r
-// Program the Host Bridge hardware to decode previously allocated resources\r
-// (proposed resources) for all the PCI Root Bridges.\r
-//\r
-// EfiPciHostBridgeFreeResources\r
-// De-allocate previously allocated resources previously for all the PCI\r
-// Root Bridges and reset the I/O and memory apertures to initial state.\r
-//\r
-// EfiPciHostBridgeEndResourceAllocation\r
-// The resource allocation phase is completed.  No specific action is required\r
-// here. This notification can be used to perform any chipset specific programming.\r
-\r
-\r
-\r
-//\r
-// EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE\r
-//\r
+///\r
+/// EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE\r
+///\r
 typedef enum {\r
+  ///\r
+  /// This notification is only applicable to PCI-PCI bridges and\r
+  /// indicates that the PCI enumerator is about to begin enumerating\r
+  /// the bus behind the PCI-PCI Bridge. This notification is sent after\r
+  /// the primary bus number, the secondary bus number and the subordinate\r
+  /// bus number registers in the PCI-PCI Bridge are programmed to valid\r
+  /// (not necessary final) values\r
+  ///\r
   EfiPciBeforeChildBusEnumeration,\r
+\r
+  ///\r
+  /// This notification is sent before the PCI enumerator probes BAR registers\r
+  /// for every valid PCI function.  \r
+  ///\r
   EfiPciBeforeResourceCollection\r
 } EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE;\r
 \r
-//\r
-// EfiPciBeforeChildBusEnumeration\r
-// This notification is only applicable to PCI-PCI bridges and\r
-// indicates that the PCI enumerator is about to begin enumerating\r
-// the bus behind the PCI-PCI Bridge. This notification is sent after\r
-// the primary bus number, the secondary bus number and the subordinate\r
-// bus number registers in the PCI-PCI Bridge are programmed to valid\r
-// (not necessary final) values\r
-//\r
-// EfiPciBeforeResourceCollection\r
-// This notification is sent before the PCI enumerator probes BAR registers\r
-// for every valid PCI function.\r
-//\r
-\r
-\r
 /**\r
   Enter a certain phase of the PCI enumeration process\r
 \r
@@ -327,47 +329,52 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   Provides the basic interfaces to abstract a PCI host bridge resource allocation.\r
-\r
-  @param NotifyPhase\r
-  The notification from the PCI bus enumerator that it is about to enter\r
-  a certain phase during the enumeration process.\r
-\r
-  @param GetNextRootBridge\r
-  Retrieves the device handle for the next PCI root bridge that is produced by the\r
-  host bridge to which this instance of the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is attached.\r
-\r
-  @param GetAllocAttributes\r
-  Retrieves the allocation-related attributes of a PCI root bridge.\r
-\r
-  @param StartBusEnumeration\r
-  Sets up a PCI root bridge for bus enumeration.\r
-\r
-  @param SetBusNumbers\r
-  Sets up the PCI root bridge so that it decodes a specific range of bus numbers.\r
-\r
-  @param SubmitResources\r
-  Submits the resource requirements for the specified PCI root bridge.\r
-\r
-  @param GetProposedResources\r
-  Returns the proposed resource assignment for the specified PCI root bridges.\r
-\r
-  @param PreprocessController\r
-  Provides hooks from the PCI bus driver to every PCI controller\r
-  (device/function) at various stages of the PCI enumeration process that\r
-  allow the host bridge driver to preinitialize individual PCI controllers\r
-  before enumeration.\r
-\r
 **/\r
 struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL {\r
+  ///\r
+  /// The notification from the PCI bus enumerator that it is about to enter\r
+  /// a certain phase during the enumeration process.\r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_NOTIFY_PHASE           NotifyPhase;\r
+  \r
+  ///\r
+  /// Retrieves the device handle for the next PCI root bridge that is produced by the\r
+  /// host bridge to which this instance of the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is attached.  \r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_NEXT_ROOT_BRIDGE   GetNextRootBridge;\r
+  \r
+  ///\r
+  /// Retrieves the allocation-related attributes of a PCI root bridge.\r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_ATTRIBUTES         GetAllocAttributes;\r
+  \r
+  ///\r
+  /// Sets up a PCI root bridge for bus enumeration.\r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_START_BUS_ENUMERATION  StartBusEnumeration;\r
+  \r
+  ///\r
+  /// Sets up the PCI root bridge so that it decodes a specific range of bus numbers.\r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_SET_BUS_NUMBERS        SetBusNumbers;\r
+  \r
+  ///\r
+  /// Submits the resource requirements for the specified PCI root bridge.\r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_SUBMIT_RESOURCES       SubmitResources;\r
+  \r
+  ///\r
+  /// Returns the proposed resource assignment for the specified PCI root bridges.\r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_PROPOSED_RESOURCES GetProposedResources;\r
+  \r
+  ///\r
+  /// Provides hooks from the PCI bus driver to every PCI controller\r
+  /// (device/function) at various stages of the PCI enumeration process that\r
+  /// allow the host bridge driver to preinitialize individual PCI controllers\r
+  /// before enumeration.  \r
+  ///\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_PREPROCESS_CONTROLLER  PreprocessController;\r
 };\r
 \r
index c8c46e8..341acb7 100644 (file)
@@ -3,7 +3,7 @@
   This protocol provides the necessary functionality to initialize the Hot Plug Controllers (HPCs) and\r
   the buses that they control. This protocol also provides information regarding resource padding.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -143,24 +143,24 @@ EFI_STATUS
 //\r
 \r
 /**\r
-  @par Protocol Description:\r
   This protocol provides the necessary functionality to initialize the\r
   Hot Plug Controllers (HPCs) and the buses that they control. This protocol\r
   also provides information regarding resource padding.\r
-\r
-  @param GetRootHpcList\r
-  Returns a list of root HPCs and the buses that they control.\r
-\r
-  @param InitializeRootHpc\r
-  Initializes the specified root HPC.\r
-\r
-  @param GetResourcePadding\r
-  Returns the resource padding that is required by the HPC.\r
-\r
 **/\r
 struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL {\r
+  ///\r
+  /// Returns a list of root HPCs and the buses that they control.\r
+  ///\r
   EFI_GET_ROOT_HPC_LIST                                  GetRootHpcList;\r
+  \r
+  ///\r
+  /// Initializes the specified root HPC.\r
+  ///\r
   EFI_INITIALIZE_ROOT_HPC                                InitializeRootHpc;\r
+  \r
+  ///\r
+  /// Returns the resource padding that is required by the HPC.\r
+  ///\r
   EFI_GET_PCI_HOT_PLUG_PADDING                           GetResourcePadding;\r
 };\r
 \r
index a20f0df..7a8e755 100644 (file)
@@ -4,7 +4,7 @@
   This interface provides a means of decoding a set of sections into a linked list of\r
   leaf sections.  This provides for an extensible and flexible file format.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying\r
   materials are licensed and made available under the terms and\r
   conditions of the BSD License which accompanies this\r
@@ -140,18 +140,20 @@ EFI_STATUS
 // Protocol definition\r
 //\r
 struct _EFI_SECTION_EXTRACTION_PROTOCOL {\r
-///\r
-///  Takes a bounded stream of sections and returns a section stream handle.\r
-///\r
+  ///\r
+  ///  Takes a bounded stream of sections and returns a section stream handle.\r
+  ///\r
   EFI_OPEN_SECTION_STREAM   OpenSectionStream;\r
-///\r
-///  Given a section stream handle, retrieves the requested section and\r
-///  meta-data from the section stream.\r
-///\r
+\r
+  ///\r
+  ///  Given a section stream handle, retrieves the requested section and\r
+  ///  meta-data from the section stream.\r
+  ///\r
   EFI_GET_SECTION           GetSection;\r
-///\r
-///  Given a section stream handle, closes the section stream.\r
-///\r
+\r
+  ///\r
+  ///  Given a section stream handle, closes the section stream.\r
+  ///\r
   EFI_CLOSE_SECTION_STREAM  CloseSectionStream;\r
 };\r
 \r
index d7719e4..6b6db22 100644 (file)
@@ -6,7 +6,7 @@
   type of control. Because of the protected, distinguished class of memory for IA-32 \r
   systems, the expectation is that this protocol would be supported only on IA-32 systems.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -128,35 +128,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   This protocol is used to control the visibility of the SMRAM on the platform.\r
-\r
-  @param Open\r
-  Opens the SMRAM.\r
-\r
-  @param Close\r
-  Closes the SMRAM.\r
-\r
-  @param Lock\r
-  Locks the SMRAM.\r
-\r
-  @param GetCapabilities\r
-  Gets information on possible SMRAM regions.\r
-\r
-  @param LockState\r
-  Indicates the current state of the SMRAM. Set to TRUE if any region is locked.\r
-\r
-  @param OpenState\r
-  Indicates the current state of the SMRAM. Set to TRUE if any region is open.\r
-\r
 **/\r
 struct _EFI_SMM_ACCESS_PROTOCOL {\r
-  EFI_SMM_OPEN          Open;\r
-  EFI_SMM_CLOSE         Close;\r
-  EFI_SMM_LOCK          Lock;\r
-  EFI_SMM_CAPABILITIES  GetCapabilities;\r
-  BOOLEAN               LockState;\r
-  BOOLEAN               OpenState;\r
+  EFI_SMM_OPEN          Open;             ///< Opens the SMRAM.\r
+  EFI_SMM_CLOSE         Close;            ///< Closes the SMRAM.\r
+  EFI_SMM_LOCK          Lock;             ///< Locks the SMRAM.\r
+  EFI_SMM_CAPABILITIES  GetCapabilities;  ///< Gets information on possible SMRAM regions.\r
+  BOOLEAN               LockState;        ///< Indicates the current state of the SMRAM. Set to TRUE if any region is locked.\r
+  BOOLEAN               OpenState;        ///< Indicates the current state of the SMRAM. Set to TRUE if any region is open.\r
 };\r
 \r
 extern EFI_GUID gEfiSmmAccessProtocolGuid;\r
index 0b7b5dc..1719371 100644 (file)
@@ -3,7 +3,7 @@
   The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for\r
   the given event types.\r
 \r
-  Copyright (c) 2008, Intel Corporation\r
+  Copyright (c) 2008 - 2009, Intel Corporation\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
@@ -180,19 +180,11 @@ EFI_STATUS
 // Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for a given SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
 **/\r
 struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
-  EFI_SMM_ICHN_REGISTER   Register;\r
-  EFI_SMM_ICHN_UNREGISTER UnRegister;\r
+  EFI_SMM_ICHN_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.\r
+  EFI_SMM_ICHN_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.\r
 };\r
 \r
 extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r
index 283f6be..8e3ed4f 100644 (file)
@@ -156,22 +156,22 @@ EFI_STATUS
 // Interface structure for the SMM Periodic Timer Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for the periodical timer SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
-  @param GetNextShorterInterval\r
-  Returns the next SMI tick period that is supported by the chipset.\r
-\r
 **/\r
 struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
+  ///\r
+  /// Installs a child service to be dispatched by this protocol.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_REGISTER   Register;\r
+  \r
+  ///\r
+  /// Removes a child service dispatched by this protocol.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
+  \r
+  ///\r
+  /// Returns the next SMI tick period that is supported by the chipset.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_INTERVAL   GetNextShorterInterval;\r
 };\r
 \r
index 9bcd093..6d229a8 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provides the parent dispatch service for a given SMI source generator.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -123,23 +123,24 @@ EFI_STATUS
 // Interface structure for the SMM Software SMI Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for a given SMI source generator.\r
 **/\r
 struct _EFI_SMM_SW_DISPATCH_PROTOCOL {\r
-///\r
-/// Installs a child service to be dispatched by this protocol.\r
-///\r
+  ///\r
+  /// Installs a child service to be dispatched by this protocol.\r
+  ///\r
   EFI_SMM_SW_REGISTER   Register;\r
-///\r
-/// Removes a child service dispatched by this protocol.\r
-///\r
+\r
+  ///\r
+  /// Removes a child service dispatched by this protocol.\r
+  ///\r
   EFI_SMM_SW_UNREGISTER UnRegister;\r
-///\r
-/// A read-only field that describes the maximum value that can be used\r
-/// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
-///\r
-UINTN                 MaximumSwiValue;\r
+\r
+  ///\r
+  /// A read-only field that describes the maximum value that can be used\r
+  /// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.\r
+  ///\r
+  UINTN                 MaximumSwiValue;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmSwDispatchProtocolGuid;\r
index 9c3c077..9f3e990 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provides the parent dispatch service for a given Sx-state source generator.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -140,19 +140,11 @@ EFI_STATUS
 // Interface structure for the SMM Child Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for a given Sx-state source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
 **/\r
 struct _EFI_SMM_SX_DISPATCH_PROTOCOL {\r
-  EFI_SMM_SX_REGISTER   Register;\r
-  EFI_SMM_SX_UNREGISTER UnRegister;\r
+  EFI_SMM_SX_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.\r
+  EFI_SMM_SX_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.\r
 };\r
 \r
 extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;\r