diff options
| author | darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-07-10 21:55:33 +0000 |
|---|---|---|
| committer | darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-07-10 21:55:33 +0000 |
| commit | ab6fc27acd9b6269440b18cb39e7115546551753 (patch) | |
| tree | 5a1d608f534d565216f69e25cbdf12a643dc027d /IntelFrameworkPkg | |
| parent | 0158294b9b91d349d6842012cf00c9e03213c6f2 (diff) | |
| download | edk2-ab6fc27acd9b6269440b18cb39e7115546551753.tar.gz edk2-ab6fc27acd9b6269440b18cb39e7115546551753.tar.bz2 edk2-ab6fc27acd9b6269440b18cb39e7115546551753.zip | |
Add Doxygen comment block to SMRAM state macro definitions.
Clean up comment for the EFI_SMRAM_HOB_DESCRIPTOR_BLOCK structure type to combine the orphan comment about the specification inconsistency with the comment for the type.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8888 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg')
| -rw-r--r-- | IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h index 8dece94a94..870622a63f 100644 --- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h +++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h @@ -41,24 +41,23 @@ typedef struct { UINT64 RegionState; ///< Describes the accessibility attributes of the SMRAM.
} EFI_SMRAM_DESCRIPTOR;
-//
-// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.
-//
+///
+/// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.
+///@{
#define EFI_SMRAM_OPEN 0x00000001
#define EFI_SMRAM_CLOSED 0x00000002
#define EFI_SMRAM_LOCKED 0x00000004
#define EFI_CACHEABLE 0x00000008
#define EFI_ALLOCATED 0x00000010
+///@}
-///
-/// Inconsistent with specification here:
-/// EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.
-/// This inconsistency is kept in code in order for backward compatibility.
-///
-
-///
-/// GUID specific data structure of HOB for reserving SMRAM regions.
-///
+/**
+* GUID specific data structure of HOB for reserving SMRAM regions.
+*
+* Inconsistent with specification here:
+* EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.
+* This inconsistency is kept in code in order for backward compatibility.
+**/
typedef struct {
///
/// Designates the number of possible regions in the system
@@ -75,3 +74,4 @@ typedef struct { extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;
#endif
+
|