/** @file\r
Industry Standard Definitions of SMBIOS Table Specification v2.6.1\r
\r
- Copyright (c) 2006 - 2010, Intel Corporation All rights\r
- reserved. This program and the accompanying materials are\r
- licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
**/\r
\r
#define SMBIOS_HANDLE_RESERVED_BEGIN 0xFF00\r
\r
///\r
-/// Reference SMBIOS 2.6, chapter 3.1.3\r
-/// Each text string is limited to 64 significant characters due to system MIF limitations\r
+/// Reference SMBIOS 2.6, chapter 3.1.3.\r
+/// Each text string is limited to 64 significant characters due to system MIF limitations.\r
///\r
#define SMBIOS_STRING_MAX_LENGTH 64\r
\r
#define SMBIOS_TYPE_END_OF_TABLE 0x007F\r
\r
///\r
-/// Smbios Table Entry Point Structure\r
+/// Smbios Table Entry Point Structure.\r
///\r
#pragma pack(1)\r
typedef struct {\r
} SMBIOS_TABLE_ENTRY_POINT;\r
\r
///\r
-/// The Smbios structure header\r
+/// The Smbios structure header.\r
///\r
typedef struct {\r
UINT8 Type;\r
/// Defines which functions the BIOS supports. PCI, PCMCIA, Flash, etc. \r
///\r
typedef struct {\r
- UINT32 Reserved :2; ///< Bits 0-1\r
+ UINT32 Reserved :2; ///< Bits 0-1.\r
UINT32 Unknown :1; \r
UINT32 BiosCharacteristicsNotSupported :1; \r
UINT32 IsaIsSupported :1; \r
} MISC_BIOS_CHARACTERISTICS;\r
\r
///\r
-/// BIOS Characteristics Extension Byte 1 \r
+/// BIOS Characteristics Extension Byte 1 .\r
/// This information, available for SMBIOS version 2.1 and later, appears at offset 12h \r
/// within the BIOS Information structure.\r
///\r
} MBCE_BIOS_RESERVED;\r
\r
///\r
-/// BIOS Characteristics Extension Byte 2\r
+/// BIOS Characteristics Extension Byte 2.\r
/// This information, available for SMBIOS version 2.3 and later, appears at offset 13h \r
/// within the BIOS Information structure.\r
///\r
} MBCE_SYSTEM_RESERVED;\r
\r
///\r
-/// BIOS Characteristics Extension Bytes\r
+/// BIOS Characteristics Extension Bytes.\r
///\r
typedef struct {\r
MBCE_BIOS_RESERVED BiosReserved;\r
} MISC_BIOS_CHARACTERISTICS_EXTENSION;\r
\r
///\r
-/// BIOS Information (Type 0)\r
+/// BIOS Information (Type 0).\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
} SMBIOS_TABLE_TYPE0;\r
\r
///\r
-/// System Wake-up Type \r
+/// System Wake-up Type.\r
///\r
typedef enum { \r
SystemWakeupTypeReserved = 0x00,\r
} MISC_SYSTEM_WAKEUP_TYPE;\r
\r
///\r
-/// System Information (Type 1)\r
+/// System Information (Type 1).\r
/// \r
/// The information in this structure defines attributes of the overall system and is \r
/// intended to be associated with the Component ID group of the system's MIF.\r
SMBIOS_TABLE_STRING Version;\r
SMBIOS_TABLE_STRING SerialNumber;\r
GUID Uuid;\r
- UINT8 WakeUpType; ///< enumeration value from MISC_SYSTEM_WAKEUP_TYPE\r
+ UINT8 WakeUpType; ///< The enumeration value from MISC_SYSTEM_WAKEUP_TYPE.\r
SMBIOS_TABLE_STRING SKUNumber;\r
SMBIOS_TABLE_STRING Family;\r
} SMBIOS_TABLE_TYPE1;\r
\r
///\r
-/// Base Board - Feature Flags \r
+/// Base Board - Feature Flags. \r
///\r
typedef struct {\r
UINT8 Motherboard :1;\r
} BASE_BOARD_FEATURE_FLAGS;\r
\r
///\r
-/// Base Board - Board Type\r
+/// Base Board - Board Type.\r
///\r
typedef enum { \r
BaseBoardTypeUnknown = 0x1,\r
} BASE_BOARD_TYPE;\r
\r
///\r
-/// Base Board (or Module) Information (Type 2)\r
+/// Base Board (or Module) Information (Type 2).\r
///\r
/// The information in this structure defines attributes of a system baseboard - \r
/// for example a motherboard, planar, or server blade or other standard system module.\r
BASE_BOARD_FEATURE_FLAGS FeatureFlag;\r
SMBIOS_TABLE_STRING LocationInChassis;\r
UINT16 ChassisHandle;\r
- UINT8 BoardType; ///< enumeration value from BASE_BOARD_TYPE\r
+ UINT8 BoardType; ///< The enumeration value from BASE_BOARD_TYPE.\r
UINT8 NumberOfContainedObjectHandles;\r
UINT16 ContainedObjectHandles[1];\r
} SMBIOS_TABLE_TYPE2;\r
} MISC_CHASSIS_TYPE;\r
\r
///\r
-/// System Enclosure or Chassis States \r
+/// System Enclosure or Chassis States .\r
///\r
typedef enum { \r
ChassisStateOther = 0x01,\r
} MISC_CHASSIS_STATE;\r
\r
///\r
-/// System Enclosure or Chassis Security Status \r
+/// System Enclosure or Chassis Security Status.\r
///\r
typedef enum { \r
ChassisSecurityStatusOther = 0x01,\r
\r
\r
///\r
-/// System Enclosure or Chassis (Type 3)\r
+/// System Enclosure or Chassis (Type 3).\r
///\r
/// The information in this structure defines attributes of the system's mechanical enclosure(s). \r
/// For example, if a system included a separate enclosure for its peripheral devices, \r
SMBIOS_TABLE_STRING Version;\r
SMBIOS_TABLE_STRING SerialNumber;\r
SMBIOS_TABLE_STRING AssetTag;\r
- UINT8 BootupState; ///< enumeration value from MISC_CHASSIS_STATE\r
- UINT8 PowerSupplyState; ///< enumeration value from MISC_CHASSIS_STATE\r
- UINT8 ThermalState; ///< enumeration value from MISC_CHASSIS_STATE\r
- UINT8 SecurityStatus; ///< enumeration value from MISC_CHASSIS_SECURITY_STATE\r
+ UINT8 BootupState; ///< The enumeration value from MISC_CHASSIS_STATE.\r
+ UINT8 PowerSupplyState; ///< The enumeration value from MISC_CHASSIS_STATE.\r
+ UINT8 ThermalState; ///< The enumeration value from MISC_CHASSIS_STATE.\r
+ UINT8 SecurityStatus; ///< The enumeration value from MISC_CHASSIS_SECURITY_STATE.\r
UINT8 OemDefined[4];\r
UINT8 Height;\r
UINT8 NumberofPowerCords;\r
} SMBIOS_TABLE_TYPE3;\r
\r
///\r
-/// Processor Information - Processor Type\r
+/// Processor Information - Processor Type.\r
///\r
typedef enum {\r
ProcessorOther = 0x01,\r
} PROCESSOR_TYPE_DATA;\r
\r
///\r
-/// Processor Information - Processor Family\r
+/// Processor Information - Processor Family.\r
///\r
typedef enum {\r
ProcessorFamilyOther = 0x01, \r
} PROCESSOR_FAMILY_DATA;\r
\r
///\r
-/// Processor Information - Voltage \r
+/// Processor Information - Voltage. \r
///\r
typedef struct {\r
UINT8 ProcessorVoltageCapability5V :1; \r
} PROCESSOR_VOLTAGE;\r
\r
///\r
-/// Processor Information - Processor Upgrade \r
+/// Processor Information - Processor Upgrade.\r
///\r
typedef enum {\r
ProcessorUpgradeOther = 0x01,\r
ProcessorUpgradeUnknown = 0x02,\r
ProcessorUpgradeDaughterBoard = 0x03,\r
ProcessorUpgradeZIFSocket = 0x04,\r
- ProcessorUpgradePiggyBack = 0x05, ///< Replaceable\r
+ ProcessorUpgradePiggyBack = 0x05, ///< Replaceable.\r
ProcessorUpgradeNone = 0x06,\r
ProcessorUpgradeLIFSocket = 0x07,\r
ProcessorUpgradeSlot1 = 0x08,\r
ProcessorUpgradeSlotA = 0x0B,\r
ProcessorUpgradeSlotM = 0x0C,\r
ProcessorUpgradeSocket423 = 0x0D,\r
- ProcessorUpgradeSocketA = 0x0E, ///< Socket 462\r
+ ProcessorUpgradeSocketA = 0x0E, ///< Socket 462.\r
ProcessorUpgradeSocket478 = 0x0F,\r
ProcessorUpgradeSocket754 = 0x10,\r
ProcessorUpgradeSocket940 = 0x11,\r
} PROCESSOR_ID_DATA;\r
\r
///\r
-/// Processor Information (Type 4)\r
+/// Processor Information (Type 4).\r
///\r
/// The information in this structure defines the attributes of a single processor; \r
/// a separate structure instance is provided for each system processor socket/slot. \r
/// For example, a system with an IntelDX2 processor would have a single \r
-/// structure instance while a system with an IntelSX2 processor would have a structure\r
-/// to describe the main CPU and a second structure to describe the 80487 co-processor. \r
+/// structure instance, while a system with an IntelSX2 processor would have a structure\r
+/// to describe the main CPU, and a second structure to describe the 80487 co-processor. \r
///\r
typedef struct { \r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING Socket;\r
- UINT8 ProcessorType; ///< enumeration value from PROCESSOR_TYPE_DATA\r
- UINT8 ProcessorFamily; ///< enumeration value from PROCESSOR_FAMILY_DATA\r
+ UINT8 ProcessorType; ///< The enumeration value from PROCESSOR_TYPE_DATA.\r
+ UINT8 ProcessorFamily; ///< The enumeration value from PROCESSOR_FAMILY_DATA.\r
SMBIOS_TABLE_STRING ProcessorManufacture;\r
PROCESSOR_ID_DATA ProcessorId;\r
SMBIOS_TABLE_STRING ProcessorVersion;\r
UINT16 MaxSpeed;\r
UINT16 CurrentSpeed;\r
UINT8 Status;\r
- UINT8 ProcessorUpgrade; ///< enumeration value from PROCESSOR_UPGRADE\r
+ UINT8 ProcessorUpgrade; ///< The enumeration value from PROCESSOR_UPGRADE.\r
UINT16 L1CacheHandle;\r
UINT16 L2CacheHandle;\r
UINT16 L3CacheHandle;\r
} SMBIOS_TABLE_TYPE4;\r
\r
///\r
-/// Memory Controller Error Detecting Method \r
+/// Memory Controller Error Detecting Method.\r
///\r
typedef enum { \r
ErrorDetectingMethodOther = 0x01,\r
} MEMORY_ERROR_DETECT_METHOD;\r
\r
///\r
-/// Memory Controller Error Correcting Capability\r
+/// Memory Controller Error Correcting Capability.\r
///\r
typedef struct {\r
UINT8 Other :1;\r
} MEMORY_ERROR_CORRECT_CAPABILITY;\r
\r
///\r
-/// Memory Controller Information - Interleave Support\r
+/// Memory Controller Information - Interleave Support.\r
///\r
typedef enum { \r
MemoryInterleaveOther = 0x01,\r
} MEMORY_SUPPORT_INTERLEAVE_TYPE;\r
\r
///\r
-/// Memory Controller Information - Memory Speeds\r
+/// Memory Controller Information - Memory Speeds.\r
///\r
typedef struct {\r
UINT16 Other :1;\r
} MEMORY_SPEED_TYPE;\r
\r
///\r
-/// Memory Controller Information (Type 5, Obsolete)\r
+/// Memory Controller Information (Type 5, Obsolete).\r
///\r
/// The information in this structure defines the attributes of the system's memory controller(s) \r
/// and the supported attributes of any memory-modules present in the sockets controlled by \r
/// this controller. \r
/// Note: This structure, and its companion Memory Module Information (Type 6, Obsolete), \r
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)\r
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)\r
/// and Memory Device (Type 17) structures should be used instead. BIOS providers might\r
/// choose to implement both memory description types to allow existing DMI browsers\r
/// to properly display the system's memory attributes.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 ErrDetectMethod; ///< enumeration value from MEMORY_ERROR_DETECT_METHOD\r
+ UINT8 ErrDetectMethod; ///< The enumeration value from MEMORY_ERROR_DETECT_METHOD.\r
MEMORY_ERROR_CORRECT_CAPABILITY ErrCorrectCapability;\r
- UINT8 SupportInterleave; ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE\r
- UINT8 CurrentInterleave; ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE \r
+ UINT8 SupportInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE.\r
+ UINT8 CurrentInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE . \r
UINT8 MaxMemoryModuleSize;\r
MEMORY_SPEED_TYPE SupportSpeed;\r
UINT16 SupportMemoryType;\r
} MEMORY_CURRENT_TYPE;\r
\r
///\r
-/// Memory Module Information - Memory Size\r
+/// Memory Module Information - Memory Size.\r
///\r
typedef struct {\r
UINT8 InstalledOrEnabledSize :7; ///< Size (n), where 2**n is the size in MB.\r
/// of each system memory module. The supported attributes of each module are described \r
/// by the "owning" Memory Controller Information structure. \r
/// Note: This structure, and its companion Memory Controller Information (Type 5, Obsolete), \r
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)\r
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)\r
/// and Memory Device (Type 17) structures should be used instead.\r
///\r
typedef struct {\r
} SMBIOS_TABLE_TYPE6;\r
\r
///\r
-/// Cache Information - SRAM Type\r
+/// Cache Information - SRAM Type.\r
///\r
typedef struct {\r
UINT16 Other :1;\r
} CACHE_SRAM_TYPE_DATA;\r
\r
///\r
-/// Cache Information - Error Correction Type \r
+/// Cache Information - Error Correction Type.\r
///\r
typedef enum {\r
CacheErrorOther = 0x01,\r
} CACHE_ERROR_TYPE_DATA;\r
\r
///\r
-/// Cache Information - System Cache Type \r
+/// Cache Information - System Cache Type. \r
///\r
typedef enum {\r
CacheTypeOther = 0x01,\r
} CACHE_TYPE_DATA;\r
\r
///\r
-/// Cache Information - Associativity \r
+/// Cache Information - Associativity. \r
///\r
typedef enum {\r
CacheAssociativityOther = 0x01,\r
} CACHE_ASSOCIATIVITY_DATA;\r
\r
///\r
-/// Cache Information (Type 7)\r
+/// Cache Information (Type 7).\r
///\r
-/// he information in this structure defines the attributes of CPU cache device in the system. \r
+/// The information in this structure defines the attributes of CPU cache device in the system. \r
/// One structure is specified for each such device, whether the device is internal to\r
/// or external to the CPU module. Cache modules can be associated with a processor structure\r
-/// in one or two ways depending on the SMBIOS version.\r
+/// in one or two ways, depending on the SMBIOS version.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
CACHE_SRAM_TYPE_DATA SupportedSRAMType;\r
CACHE_SRAM_TYPE_DATA CurrentSRAMType;\r
UINT8 CacheSpeed;\r
- UINT8 ErrorCorrectionType; ///< enumeration value from CACHE_ERROR_TYPE_DATA\r
- UINT8 SystemCacheType; ///< enumeration value from CACHE_TYPE_DATA\r
- UINT8 Associativity; ///< enumeration value from CACHE_ASSOCIATIVITY_DATA\r
+ UINT8 ErrorCorrectionType; ///< The enumeration value from CACHE_ERROR_TYPE_DATA.\r
+ UINT8 SystemCacheType; ///< The enumeration value from CACHE_TYPE_DATA.\r
+ UINT8 Associativity; ///< The enumeration value from CACHE_ASSOCIATIVITY_DATA.\r
} SMBIOS_TABLE_TYPE7;\r
\r
///\r
-/// Port Connector Information - Connector Types \r
+/// Port Connector Information - Connector Types. \r
///\r
typedef enum {\r
PortConnectorTypeNone = 0x00,\r
} MISC_PORT_TYPE;\r
\r
///\r
-/// Port Connector Information (Type 8)\r
+/// Port Connector Information (Type 8).\r
///\r
/// The information in this structure defines the attributes of a system port connector, \r
/// e.g. parallel, serial, keyboard, or mouse ports. The port's type and connector information \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING InternalReferenceDesignator;\r
- UINT8 InternalConnectorType; ///< enumeration value from MISC_PORT_CONNECTOR_TYPE\r
+ UINT8 InternalConnectorType; ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.\r
SMBIOS_TABLE_STRING ExternalReferenceDesignator;\r
- UINT8 ExternalConnectorType; ///< enumeration value from MISC_PORT_CONNECTOR_TYPE\r
- UINT8 PortType; ///< enumeration value from MISC_PORT_TYPE\r
+ UINT8 ExternalConnectorType; ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.\r
+ UINT8 PortType; ///< The enumeration value from MISC_PORT_TYPE.\r
} SMBIOS_TABLE_TYPE8;\r
\r
///\r
} MISC_SLOT_TYPE;\r
\r
///\r
-/// System Slots - Slot Data Bus Width\r
+/// System Slots - Slot Data Bus Width.\r
///\r
typedef enum {\r
SlotDataBusWidthOther = 0x01,\r
} MISC_SLOT_DATA_BUS_WIDTH;\r
\r
///\r
-/// System Slots - Current Usage\r
+/// System Slots - Current Usage.\r
///\r
typedef enum {\r
SlotUsageOther = 0x01,\r
} MISC_SLOT_USAGE;\r
\r
///\r
-/// System Slots - Slot Length \r
+/// System Slots - Slot Length. \r
///\r
typedef enum {\r
SlotLengthOther = 0x01,\r
} MISC_SLOT_LENGTH;\r
\r
///\r
-/// System Slots - Slot Characteristics 1 \r
+/// System Slots - Slot Characteristics 1. \r
///\r
typedef struct {\r
UINT8 CharacteristicsUnknown :1;\r
UINT8 ModemRingResumeSupported:1;\r
} MISC_SLOT_CHARACTERISTICS1;\r
///\r
-/// System Slots - Slot Characteristics 2 \r
+/// System Slots - Slot Characteristics 2. \r
///\r
typedef struct {\r
UINT8 PmeSignalSupported :1;\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING SlotDesignation;\r
- UINT8 SlotType; ///< enumeration value from MISC_SLOT_TYPE\r
- UINT8 SlotDataBusWidth; ///< enumeration value from MISC_SLOT_DATA_BUS_WIDTH\r
- UINT8 CurrentUsage; ///< enumeration value from MISC_SLOT_USAGE\r
- UINT8 SlotLength; ///< enumeration value from MISC_SLOT_LENGTH\r
+ UINT8 SlotType; ///< The enumeration value from MISC_SLOT_TYPE.\r
+ UINT8 SlotDataBusWidth; ///< The enumeration value from MISC_SLOT_DATA_BUS_WIDTH.\r
+ UINT8 CurrentUsage; ///< The enumeration value from MISC_SLOT_USAGE.\r
+ UINT8 SlotLength; ///< The enumeration value from MISC_SLOT_LENGTH.\r
UINT16 SlotID;\r
MISC_SLOT_CHARACTERISTICS1 SlotCharacteristics1;\r
MISC_SLOT_CHARACTERISTICS2 SlotCharacteristics2;\r
} SMBIOS_TABLE_TYPE9;\r
\r
///\r
-/// On Board Devices Information - Device Types \r
+/// On Board Devices Information - Device Types. \r
///\r
typedef enum {\r
OnBoardDeviceTypeOther = 0x01,\r
/// Device Item Entry\r
///\r
typedef struct {\r
- UINT8 DeviceType; ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE\r
- ///< Bit 7 - 1 : device enabled, 0 : device disabled\r
+ UINT8 DeviceType; ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE.\r
+ ///< Bit 7 - 1 : device enabled, 0 : device disabled.\r
SMBIOS_TABLE_STRING DescriptionString;\r
} DEVICE_STRUCT;\r
\r
///\r
-/// On Board Devices Information (Type 10, obsolete)\r
+/// On Board Devices Information (Type 10, obsolete).\r
///\r
/// Note: This structure is obsolete starting with version 2.6 specification; the Onboard Devices Extended \r
/// Information (Type 41) structure should be used instead . BIOS providers can choose to implement both \r
} SMBIOS_TABLE_TYPE10;\r
\r
///\r
-/// OEM Strings (Type 11)\r
+/// OEM Strings (Type 11).\r
/// This structure contains free form strings defined by the OEM. Examples of this are: \r
/// Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc. \r
///\r
} SMBIOS_TABLE_TYPE11;\r
\r
///\r
-/// System Configuration Options (Type 12)\r
+/// System Configuration Options (Type 12).\r
///\r
/// This structure contains information required to configure the base board's Jumpers and Switches. \r
///\r
\r
\r
///\r
-/// BIOS Language Information (Type 13)\r
+/// BIOS Language Information (Type 13).\r
///\r
/// The information in this structure defines the installable language attributes of the BIOS. \r
/// \r
} SMBIOS_TABLE_TYPE13;\r
\r
///\r
-/// System Event Log - Event Log Types \r
+/// System Event Log - Event Log Types.\r
/// \r
typedef enum {\r
EventLogTypeReserved = 0x00,\r
} EVENT_LOG_TYPE_DATA;\r
\r
///\r
-/// System Event Log - Variable Data Format Types \r
+/// System Event Log - Variable Data Format Types. \r
/// \r
typedef enum {\r
EventLogVariableNone = 0x00,\r
/// Event Log Type Descriptors\r
///\r
typedef struct {\r
- UINT8 LogType; ///< enumeration value from EVENT_LOG_TYPE_DATA\r
+ UINT8 LogType; ///< The enumeration value from EVENT_LOG_TYPE_DATA.\r
UINT8 DataFormatType;\r
} EVENT_LOG_TYPE;\r
\r
///\r
-/// Group Associations (Type 14)\r
+/// Group Associations (Type 14).\r
///\r
/// The Group Associations structure is provided for OEMs who want to specify \r
/// the arrangement or hierarchy of certain components (including other Group Associations) \r
} SMBIOS_TABLE_TYPE14;\r
\r
///\r
-/// System Event Log (Type 15)\r
+/// System Event Log (Type 15).\r
///\r
/// The presence of this structure within the SMBIOS data returned for a system indicates \r
/// that the system supports an event log. An event log is a fixed-length area within a \r
} SMBIOS_TABLE_TYPE15;\r
\r
///\r
-/// Physical Memory Array - Location\r
+/// Physical Memory Array - Location.\r
///\r
typedef enum {\r
MemoryArrayLocationOther = 0x01,\r
} MEMORY_ARRAY_LOCATION;\r
\r
///\r
-/// Physical Memory Array - Use\r
+/// Physical Memory Array - Use.\r
///\r
typedef enum {\r
MemoryArrayUseOther = 0x01,\r
} MEMORY_ARRAY_USE;\r
\r
///\r
-/// Physical Memory Array - Error Correction Types \r
+/// Physical Memory Array - Error Correction Types. \r
///\r
typedef enum {\r
MemoryErrorCorrectionOther = 0x01,\r
} MEMORY_ERROR_CORRECTION;\r
\r
///\r
-/// Physical Memory Array (Type 16)\r
+/// Physical Memory Array (Type 16).\r
///\r
/// This structure describes a collection of memory devices that operate \r
/// together to form a memory address space. \r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 Location; ///< enumeration value from MEMORY_ARRAY_LOCATION\r
- UINT8 Use; ///< enumeration value from MEMORY_ARRAY_USE\r
- UINT8 MemoryErrorCorrection; ///< enumeration value from MEMORY_ERROR_CORRECTION\r
+ UINT8 Location; ///< The enumeration value from MEMORY_ARRAY_LOCATION.\r
+ UINT8 Use; ///< The enumeration value from MEMORY_ARRAY_USE.\r
+ UINT8 MemoryErrorCorrection; ///< The enumeration value from MEMORY_ERROR_CORRECTION.\r
UINT32 MaximumCapacity;\r
UINT16 MemoryErrorInformationHandle;\r
UINT16 NumberOfMemoryDevices;\r
} SMBIOS_TABLE_TYPE16;\r
\r
///\r
-/// Memory Device - Form Factor\r
+/// Memory Device - Form Factor.\r
///\r
typedef enum {\r
MemoryFormFactorOther = 0x01,\r
} MEMORY_DEVICE_TYPE_DETAIL;\r
\r
///\r
-/// Memory Device (Type 17)\r
+/// Memory Device (Type 17).\r
///\r
/// This structure describes a single memory device that is part of \r
/// a larger Physical Memory Array (Type 16).\r
/// Note: If a system includes memory-device sockets, the SMBIOS implementation \r
-/// includes a Memory Device structure instance for each slot whether or not the \r
+/// includes a Memory Device structure instance for each slot, whether or not the \r
/// socket is currently populated.\r
///\r
typedef struct {\r
UINT16 TotalWidth;\r
UINT16 DataWidth;\r
UINT16 Size;\r
- UINT8 FormFactor; ///< enumeration value from MEMORY_FORM_FACTOR\r
+ UINT8 FormFactor; ///< The enumeration value from MEMORY_FORM_FACTOR.\r
UINT8 DeviceSet;\r
SMBIOS_TABLE_STRING DeviceLocator;\r
SMBIOS_TABLE_STRING BankLocator;\r
- UINT8 MemoryType; ///< enumeration value from MEMORY_DEVICE_TYPE\r
+ UINT8 MemoryType; ///< The enumeration value from MEMORY_DEVICE_TYPE.\r
MEMORY_DEVICE_TYPE_DETAIL TypeDetail;\r
UINT16 Speed;\r
SMBIOS_TABLE_STRING Manufacturer;\r
} SMBIOS_TABLE_TYPE17;\r
\r
///\r
-/// 32-bit Memory Error Information - Error Type \r
+/// 32-bit Memory Error Information - Error Type. \r
///\r
typedef enum { \r
MemoryErrorOther = 0x01,\r
} MEMORY_ERROR_TYPE;\r
\r
///\r
-/// 32-bit Memory Error Information - Error Granularity \r
+/// 32-bit Memory Error Information - Error Granularity. \r
///\r
typedef enum { \r
MemoryGranularityOther = 0x01,\r
} MEMORY_ERROR_GRANULARITY;\r
\r
///\r
-/// 32-bit Memory Error Information - Error Operation \r
+/// 32-bit Memory Error Information - Error Operation. \r
///\r
typedef enum { \r
MemoryErrorOperationOther = 0x01,\r
} MEMORY_ERROR_OPERATION;\r
\r
///\r
-/// 32-bit Memory Error Information (Type 18)\r
+/// 32-bit Memory Error Information (Type 18).\r
/// \r
/// This structure identifies the specifics of an error that might be detected \r
/// within a Physical Memory Array.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 ErrorType; ///< enumeration value from MEMORY_ERROR_TYPE\r
- UINT8 ErrorGranularity; ///< enumeration value from MEMORY_ERROR_GRANULARITY\r
- UINT8 ErrorOperation; ///< enumeration value from MEMORY_ERROR_OPERATION\r
+ UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE.\r
+ UINT8 ErrorGranularity; ///< The enumeration value from MEMORY_ERROR_GRANULARITY.\r
+ UINT8 ErrorOperation; ///< The enumeration value from MEMORY_ERROR_OPERATION.\r
UINT32 VendorSyndrome;\r
UINT32 MemoryArrayErrorAddress;\r
UINT32 DeviceErrorAddress;\r
} SMBIOS_TABLE_TYPE18;\r
\r
///\r
-/// Memory Array Mapped Address (Type 19)\r
+/// Memory Array Mapped Address (Type 19).\r
///\r
/// This structure provides the address mapping for a Physical Memory Array. \r
/// One structure is present for each contiguous address range described.\r
} SMBIOS_TABLE_TYPE19;\r
\r
///\r
-/// Memory Device Mapped Address (Type 20)\r
+/// Memory Device Mapped Address (Type 20).\r
///\r
/// This structure maps memory address space usually to a device-level granularity. \r
/// One structure is present for each contiguous address range described. \r
} BUILTIN_POINTING_DEVICE_TYPE;\r
\r
///\r
-/// Built-in Pointing Device - Interface\r
+/// Built-in Pointing Device - Interface.\r
///\r
typedef enum {\r
PointingDeviceInterfaceOther = 0x01,\r
} BUILTIN_POINTING_DEVICE_INTERFACE;\r
\r
///\r
-/// Built-in Pointing Device (Type 21)\r
+/// Built-in Pointing Device (Type 21).\r
///\r
/// This structure describes the attributes of the built-in pointing device for the \r
-/// system - the presence of this structure does not imply that the built-in\r
+/// system. The presence of this structure does not imply that the built-in\r
/// pointing device is active for the system's use! \r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 Type; ///< enumeration value from BUILTIN_POINTING_DEVICE_TYPE\r
- UINT8 Interface; ///< enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE\r
+ UINT8 Type; ///< The enumeration value from BUILTIN_POINTING_DEVICE_TYPE.\r
+ UINT8 Interface; ///< The enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE.\r
UINT8 NumberOfButtons;\r
} SMBIOS_TABLE_TYPE21;\r
\r
} PORTABLE_BATTERY_DEVICE_CHEMISTRY;\r
\r
///\r
-/// Portable Battery (Type 22)\r
+/// Portable Battery (Type 22).\r
///\r
/// This structure describes the attributes of the portable battery(s) for the system. \r
/// The structure contains the static attributes for the group. Each structure describes \r
SMBIOS_TABLE_STRING ManufactureDate;\r
SMBIOS_TABLE_STRING SerialNumber;\r
SMBIOS_TABLE_STRING DeviceName;\r
- UINT8 DeviceChemistry; ///< enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY\r
+ UINT8 DeviceChemistry; ///< The enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY.\r
UINT16 DeviceCapacity;\r
UINT16 DesignVoltage;\r
SMBIOS_TABLE_STRING SBDSVersionNumber;\r
} SMBIOS_TABLE_TYPE23;\r
\r
///\r
-/// Hardware Security (Type 24)\r
+/// Hardware Security (Type 24).\r
///\r
/// This structure describes the system-wide hardware security settings. \r
///\r
} SMBIOS_TABLE_TYPE24;\r
\r
///\r
-/// System Power Controls (Type 25)\r
+/// System Power Controls (Type 25).\r
///\r
/// This structure describes the attributes for controlling the main power supply to the system. \r
/// Software that interprets this structure uses the month, day, hour, minute, and second values \r
} SMBIOS_TABLE_TYPE25;\r
\r
///\r
-/// Voltage Probe - Location and Status\r
+/// Voltage Probe - Location and Status.\r
///\r
typedef struct {\r
UINT8 VoltageProbeSite :5;\r
} SMBIOS_TABLE_TYPE26;\r
\r
///\r
-/// Cooling Device - Device Type and Status\r
+/// Cooling Device - Device Type and Status.\r
///\r
typedef struct {\r
UINT8 CoolingDevice :5;\r
} SMBIOS_TABLE_TYPE27;\r
\r
///\r
-/// Temperature Probe - Location and Status\r
+/// Temperature Probe - Location and Status.\r
///\r
typedef struct {\r
UINT8 TemperatureProbeSite :5;\r
} MISC_TEMPERATURE_PROBE_LOCATION;\r
\r
///\r
-/// Temperature Probe (Type 28)\r
+/// Temperature Probe (Type 28).\r
///\r
/// This structure describes the attributes for a temperature probe in the system. \r
/// Each structure describes a single temperature probe. \r
} SMBIOS_TABLE_TYPE28;\r
\r
///\r
-/// Electrical Current Probe - Location and Status\r
+/// Electrical Current Probe - Location and Status.\r
///\r
typedef struct {\r
UINT8 ElectricalCurrentProbeSite :5;\r
} MISC_ELECTRICAL_CURRENT_PROBE_LOCATION;\r
\r
///\r
-/// Electrical Current Probe (Type 29)\r
+/// Electrical Current Probe (Type 29).\r
///\r
/// This structure describes the attributes for an electrical current probe in the system.\r
/// Each structure describes a single electrical current probe. \r
} SMBIOS_TABLE_TYPE29;\r
\r
///\r
-/// Out-of-Band Remote Access (Type 30)\r
+/// Out-of-Band Remote Access (Type 30).\r
///\r
/// This structure describes the attributes and policy settings of a hardware facility \r
/// that may be used to gain remote access to a hardware system when the operating system \r
} SMBIOS_TABLE_TYPE30;\r
\r
///\r
-/// Boot Integrity Services (BIS) Entry Point (Type 31)\r
+/// Boot Integrity Services (BIS) Entry Point (Type 31).\r
///\r
/// Structure type 31 (decimal) is reserved for use by the Boot Integrity Services (BIS). \r
/// \r
} SMBIOS_TABLE_TYPE31;\r
\r
///\r
-/// System Boot Information - System Boot Status\r
+/// System Boot Information - System Boot Status.\r
///\r
typedef enum {\r
BootInformationStatusNoError = 0x00,\r
} MISC_BOOT_INFORMATION_STATUS_DATA_TYPE;\r
\r
///\r
-/// System Boot Information (Type 32)\r
+/// System Boot Information (Type 32).\r
///\r
/// The client system firmware, e.g. BIOS, communicates the System Boot Status to the \r
/// client's Pre-boot Execution Environment (PXE) boot image or OS-present management \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
UINT8 Reserved[6];\r
- UINT8 BootStatus; ///< enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE\r
+ UINT8 BootStatus; ///< The enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE.\r
} SMBIOS_TABLE_TYPE32;\r
\r
///\r
-/// 64-bit Memory Error Information (Type 33)\r
+/// 64-bit Memory Error Information (Type 33).\r
///\r
/// This structure describes an error within a Physical Memory Array, \r
/// when the error address is above 4G (0xFFFFFFFF).\r
/// \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 ErrorType; ///< enumeration value from MEMORY_ERROR_TYPE\r
- UINT8 ErrorGranularity; ///< enumeration value from MEMORY_ERROR_GRANULARITY\r
- UINT8 ErrorOperation; ///< enumeration value from MEMORY_ERROR_OPERATION\r
+ UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE.\r
+ UINT8 ErrorGranularity; ///< The enumeration value from MEMORY_ERROR_GRANULARITY.\r
+ UINT8 ErrorOperation; ///< The enumeration value from MEMORY_ERROR_OPERATION.\r
UINT32 VendorSyndrome;\r
UINT64 MemoryArrayErrorAddress;\r
UINT64 DeviceErrorAddress;\r
} SMBIOS_TABLE_TYPE33;\r
\r
///\r
-/// Management Device - Type \r
+/// Management Device - Type. \r
///\r
typedef enum {\r
ManagementDeviceTypeOther = 0x01,\r
} MISC_MANAGEMENT_DEVICE_TYPE;\r
\r
///\r
-/// Management Device - Address Type \r
+/// Management Device - Address Type. \r
///\r
typedef enum {\r
ManagementDeviceAddressTypeOther = 0x01,\r
} MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE;\r
\r
///\r
-/// Management Device (Type 34)\r
+/// Management Device (Type 34).\r
///\r
/// The information in this structure defines the attributes of a Management Device. \r
/// A Management Device might control one or more fans or voltage, current, or temperature\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING Description;\r
- UINT8 Type; ///< enumeration value from MISC_MANAGEMENT_DEVICE_TYPE\r
+ UINT8 Type; ///< The enumeration value from MISC_MANAGEMENT_DEVICE_TYPE.\r
UINT32 Address;\r
- UINT8 AddressType; ///< enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE\r
+ UINT8 AddressType; ///< The enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE.\r
} SMBIOS_TABLE_TYPE34;\r
\r
///\r
} SMBIOS_TABLE_TYPE35;\r
\r
///\r
-/// Management Device Threshold Data (Type 36)\r
+/// Management Device Threshold Data (Type 36).\r
///\r
/// The information in this structure defines threshold information for \r
/// a component (probe or cooling-unit) contained within a Management Device. \r
} SMBIOS_TABLE_TYPE36;\r
\r
///\r
-/// Memory Channel Entry\r
+/// Memory Channel Entry.\r
///\r
typedef struct {\r
UINT8 DeviceLoad;\r
} MEMORY_DEVICE;\r
\r
///\r
-/// Memory Channel - Channel Type\r
+/// Memory Channel - Channel Type.\r
///\r
typedef enum {\r
MemoryChannelTypeOther = 0x01,\r
/// Memory Channel (Type 37)\r
///\r
/// The information in this structure provides the correlation between a Memory Channel\r
-/// and its associated Memory Devices. Each device presents one or more loads to the channel; \r
-/// the sum of all device loads cannot exceed the channel's defined maximum.\r
+/// and its associated Memory Devices. Each device presents one or more loads to the channel. \r
+/// The sum of all device loads cannot exceed the channel's defined maximum.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
///\r
typedef enum {\r
IPMIDeviceInfoInterfaceTypeUnknown = 0x00,\r
- IPMIDeviceInfoInterfaceTypeKCS = 0x01, ///< Keyboard Controller Style\r
- IPMIDeviceInfoInterfaceTypeSMIC = 0x02, ///< Server Management Interface Chip\r
- IPMIDeviceInfoInterfaceTypeBT = 0x03, ///< Block Transfer\r
+ IPMIDeviceInfoInterfaceTypeKCS = 0x01, ///< The Keyboard Controller Style.\r
+ IPMIDeviceInfoInterfaceTypeSMIC = 0x02, ///< The Server Management Interface Chip.\r
+ IPMIDeviceInfoInterfaceTypeBT = 0x03, ///< The Block Transfer\r
IPMIDeviceInfoInterfaceTypeReserved = 0x04\r
} BMC_INTERFACE_TYPE;\r
\r
///\r
-/// IPMI Device Information (Type 38)\r
+/// IPMI Device Information (Type 38).\r
///\r
/// The information in this structure defines the attributes of an \r
/// Intelligent Platform Management Interface (IPMI) Baseboard Management Controller (BMC).\r
/// \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 InterfaceType; ///< enumeration value from BMC_INTERFACE_TYPE\r
+ UINT8 InterfaceType; ///< The enumeration value from BMC_INTERFACE_TYPE.\r
UINT8 IPMISpecificationRevision;\r
UINT8 I2CSlaveAddress;\r
UINT8 NVStorageDeviceAddress;\r
} SMBIOS_TABLE_TYPE38;\r
\r
///\r
-/// System Power Supply - Power Supply Characteristics\r
+/// System Power Supply - Power Supply Characteristics.\r
///\r
typedef struct {\r
UINT16 PowerSupplyHotReplaceable:1;\r
} SYS_POWER_SUPPLY_CHARACTERISTICS;\r
\r
///\r
-/// System Power Supply (Type 39)\r
+/// System Power Supply (Type 39).\r
///\r
/// This structure identifies attributes of a system power supply. One instance\r
/// of this record is present for each possible power supply in a system. \r
} SMBIOS_TABLE_TYPE39;\r
\r
///\r
-/// Additional Information Entry Format \r
+/// Additional Information Entry Format. \r
///\r
typedef struct { \r
UINT8 EntryLength; \r
}ADDITIONAL_INFORMATION_ENTRY;\r
\r
///\r
-/// Additional Information (Type 40)\r
+/// Additional Information (Type 40).\r
///\r
/// This structure is intended to provide additional information for handling unspecified \r
/// enumerated values and interim field updates in another structure. \r
} SMBIOS_TABLE_TYPE40;\r
\r
///\r
-/// Onboard Devices Extended Information - Onboard Device Types\r
+/// Onboard Devices Extended Information - Onboard Device Types.\r
///\r
typedef enum{\r
OnBoardDeviceExtendedTypeOther = 0x01,\r
} ONBOARD_DEVICE_EXTENDED_INFO_TYPE;\r
\r
///\r
-/// Onboard Devices Extended Information (Type 41)\r
+/// Onboard Devices Extended Information (Type 41).\r
///\r
/// The information in this structure defines the attributes of devices that \r
/// are onboard (soldered onto) a system element, usually the baseboard. \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING ReferenceDesignation;\r
- UINT8 DeviceType; ///< enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE\r
+ UINT8 DeviceType; ///< The enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE\r
UINT8 DeviceTypeInstance;\r
UINT16 SegmentGroupNum;\r
UINT8 BusNum;\r
} SMBIOS_TABLE_TYPE127;\r
\r
///\r
-/// Union of all the possible SMBIOS record types\r
+/// Union of all the possible SMBIOS record types.\r
///\r
typedef union {\r
SMBIOS_STRUCTURE *Hdr;\r
projects / mirror_edk2.git / blobdiff