tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-28 16:14:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add Doxygen comment block to SMRAM state macro definitions.

Browse Source 
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
This commit is contained in:
darylm503 2009-07-10 21:55:33 +00:00
parent 0158294b9b
commit ab6fc27acd
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
View File

@ -41,24 +41,23 @@ typedef struct {
UINT64 RegionState; ///< Describes the accessibility attributes of the SMRAM. UINT64 RegionState; ///< Describes the accessibility attributes of the SMRAM.
} EFI_SMRAM_DESCRIPTOR; } 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_OPEN 0x00000001
#define EFI_SMRAM_CLOSED 0x00000002 #define EFI_SMRAM_CLOSED 0x00000002
#define EFI_SMRAM_LOCKED 0x00000004 #define EFI_SMRAM_LOCKED 0x00000004
#define EFI_CACHEABLE 0x00000008 #define EFI_CACHEABLE 0x00000008
#define EFI_ALLOCATED 0x00000010 #define EFI_ALLOCATED 0x00000010
///@}
/// /**
/// Inconsistent with specification here: * GUID specific data structure of HOB for reserving SMRAM regions.
/// 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. * 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.
///
typedef struct { typedef struct {
/// ///
/// Designates the number of possible regions in the system /// Designates the number of possible regions in the system
@ -75,3 +74,4 @@ typedef struct {
extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid; extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;
#endif #endif