diff options
Diffstat (limited to 'MdePkg/Include/IndustryStandard')
| -rw-r--r-- | MdePkg/Include/IndustryStandard/Acpi10.h | 70 | ||||
| -rw-r--r-- | MdePkg/Include/IndustryStandard/Atapi.h | 86 | ||||
| -rw-r--r-- | MdePkg/Include/IndustryStandard/Pci.h | 13 | ||||
| -rw-r--r-- | MdePkg/Include/IndustryStandard/Pci23.h | 14 | ||||
| -rw-r--r-- | MdePkg/Include/IndustryStandard/PeImage.h | 144 | ||||
| -rw-r--r-- | MdePkg/Include/IndustryStandard/Sal.h | 122 | ||||
| -rw-r--r-- | MdePkg/Include/IndustryStandard/SmBios.h | 316 |
7 files changed, 384 insertions, 381 deletions
diff --git a/MdePkg/Include/IndustryStandard/Acpi10.h b/MdePkg/Include/IndustryStandard/Acpi10.h index b463d6ff28..f05346a50d 100644 --- a/MdePkg/Include/IndustryStandard/Acpi10.h +++ b/MdePkg/Include/IndustryStandard/Acpi10.h @@ -1,14 +1,14 @@ /** @file
ACPI 1.0b definitions from the ACPI Specification, revision 1.0b
- Copyright (c) 2006 - 2008, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _ACPI_1_0_H_
@@ -16,7 +16,7 @@ ///
/// Common table header, this prefaces all ACPI tables, including FACS, but
-/// excluding the RSD PTR structure
+/// excluding the RSD PTR structure.
///
typedef struct {
UINT32 Signature;
@@ -25,7 +25,7 @@ typedef struct { #pragma pack(1)
///
-/// Common ACPI description table header. This structure prefaces most ACPI tables.
+/// The common ACPI description table header. This structure prefaces most ACPI tables.
///
typedef struct {
UINT32 Signature;
@@ -54,7 +54,7 @@ typedef struct { #define ACPI_ADDRESS_SPACE_TYPE_BUS 0x02
///
-/// Power Management Timer frequency is fixed at 3.579545MHz
+/// Power Management Timer frequency is fixed at 3.579545MHz.
///
#define ACPI_TIMER_FREQUENCY 3579545
@@ -65,7 +65,7 @@ typedef struct { ///
/// The commond definition of QWORD, DWORD, and WORD
-/// Address Space Descriptors
+/// Address Space Descriptors.
///
typedef PACKED struct {
UINT8 Desc;
@@ -83,7 +83,7 @@ typedef PACKED struct { #pragma pack()
///
-/// the End tag identifies an end of resource data.
+/// The End tag identifies an end of resource data.
///
typedef struct {
UINT8 Desc;
@@ -135,7 +135,7 @@ typedef struct { //
///
-/// Root System Description Pointer Structure
+/// Root System Description Pointer Structure.
///
typedef struct {
UINT64 Signature;
@@ -152,12 +152,12 @@ typedef struct { //
///
-/// RSDT Revision (as defined in ACPI 1.0b spec.)
+/// RSDT Revision (as defined in ACPI 1.0b specification).
///
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
///
-/// Fixed ACPI Description Table Structure (FADT)
+/// Fixed ACPI Description Table Structure (FADT).
///
typedef struct {
EFI_ACPI_DESCRIPTION_HEADER Header;
@@ -203,7 +203,7 @@ typedef struct { } EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;
///
-/// FADT Version (as defined in ACPI 1.0b spec.)
+/// FADT Version (as defined in ACPI 1.0b specification).
///
#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x01
@@ -223,7 +223,7 @@ typedef struct { #define EFI_ACPI_1_0_DCK_CAP BIT9
///
-/// Firmware ACPI Control Structure
+/// Firmware ACPI Control Structure.
///
typedef struct {
UINT32 Signature;
@@ -236,14 +236,14 @@ typedef struct { } EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;
///
-/// Firmware Control Structure Feature Flags
+/// Firmware Control Structure Feature Flags.
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_1_0_S4BIOS_F BIT0
///
/// Multiple APIC Description Table header definition. The rest of the table
-/// must be defined in a platform specific manner.
+/// must be defined in a platform-specific manner.
///
typedef struct {
EFI_ACPI_DESCRIPTION_HEADER Header;
@@ -252,7 +252,7 @@ typedef struct { } EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
///
-/// MADT Revision (as defined in ACPI 1.0b spec.)
+/// MADT Revision (as defined in ACPI 1.0b specification).
///
#define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01
@@ -278,7 +278,7 @@ typedef struct { //
///
-/// Processor Local APIC Structure Definition
+/// Processor Local APIC Structure Definition.
///
typedef struct {
UINT8 Type;
@@ -294,7 +294,7 @@ typedef struct { #define EFI_ACPI_1_0_LOCAL_APIC_ENABLED BIT0
///
-/// IO APIC Structure
+/// IO APIC Structure.
///
typedef struct {
UINT8 Type;
@@ -306,7 +306,7 @@ typedef struct { } EFI_ACPI_1_0_IO_APIC_STRUCTURE;
///
-/// Interrupt Source Override Structure
+/// Interrupt Source Override Structure.
///
typedef struct {
UINT8 Type;
@@ -318,7 +318,7 @@ typedef struct { } EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
///
-/// Non-Maskable Interrupt Source Structure
+/// Non-Maskable Interrupt Source Structure.
///
typedef struct {
UINT8 Type;
@@ -328,7 +328,7 @@ typedef struct { } EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
///
-/// Local APIC NMI Structure
+/// Local APIC NMI Structure.
///
typedef struct {
UINT8 Type;
@@ -353,47 +353,47 @@ typedef struct { //
///
-/// "RSD PTR " Root System Description Pointer
+/// "RSD PTR " Root System Description Pointer.
///
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')
///
-/// "APIC" Multiple APIC Description Table
+/// "APIC" Multiple APIC Description Table.
///
#define EFI_ACPI_1_0_APIC_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')
///
-/// "DSDT" Differentiated System Description Table
+/// "DSDT" Differentiated System Description Table.
///
#define EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')
///
-/// "FACS" Firmware ACPI Control Structure
+/// "FACS" Firmware ACPI Control Structure.
///
#define EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')
///
-/// "FACP" Fixed ACPI Description Table
+/// "FACP" Fixed ACPI Description Table.
///
#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')
///
-/// "PSDT" Persistent System Description Table
+/// "PSDT" Persistent System Description Table.
///
#define EFI_ACPI_1_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')
///
-/// "RSDT" Root System Description Table
+/// "RSDT" Root System Description Table.
///
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')
///
-/// "SBST" Smart Battery Specification Table
+/// "SBST" Smart Battery Specification Table.
///
#define EFI_ACPI_1_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')
///
-/// "SSDT" Secondary System Description Table
+/// "SSDT" Secondary System Description Table.
///
#define EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')
diff --git a/MdePkg/Include/IndustryStandard/Atapi.h b/MdePkg/Include/IndustryStandard/Atapi.h index 276d364e67..4c4588042a 100644 --- a/MdePkg/Include/IndustryStandard/Atapi.h +++ b/MdePkg/Include/IndustryStandard/Atapi.h @@ -2,13 +2,13 @@ This file contains just some basic definitions that are needed by drivers
that dealing with ATA/ATAPI interface.
-Copyright (c) 2007 - 2010, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -19,16 +19,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #pragma pack(1)
///
-/// ATA5_IDENTIFY_DATA is defined in ATA-5
-/// (This structure is provided here mainly for backward-compatibility support.
-/// Old drivers may reference some field that is marked "obsolete" in
-/// ATA_IDENTIFY_DATA, which current conforms to ATA-8)
+/// ATA5_IDENTIFY_DATA is defined in ATA-5.
+/// (This structure is provided mainly for backward-compatibility support.
+/// Old drivers may reference fields that are marked "obsolete" in
+/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.)
///
typedef struct {
- UINT16 config; ///< General Configuration
- UINT16 cylinders; ///< Number of Cylinders
+ UINT16 config; ///< General Configuration.
+ UINT16 cylinders; ///< Number of Cylinders.
UINT16 reserved_2;
- UINT16 heads; ///< Number of logical heads
+ UINT16 heads; ///< Number of logical heads.
UINT16 vendor_data1;
UINT16 vendor_data2;
UINT16 sectors_per_track;
@@ -77,14 +77,14 @@ typedef struct { } ATA5_IDENTIFY_DATA;
///
-/// ATA_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec
+/// ATA_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec
/// to define the data returned by an ATA device upon successful
-/// completion of the ATA IDENTIFY_DEVICE command
+/// completion of the ATA IDENTIFY_DEVICE command.
///
typedef struct {
- UINT16 config; ///< General Configuration
+ UINT16 config; ///< General Configuration.
UINT16 obsolete_1;
- UINT16 specific_config; ///< Specific Configuration
+ UINT16 specific_config; ///< Specific Configuration.
UINT16 obsolete_3;
UINT16 retired_4_5[2];
UINT16 obsolete_6;
@@ -114,7 +114,7 @@ typedef struct { UINT16 min_pio_cycle_time_with_flow_control;
UINT16 reserved_69_74[6];
UINT16 queue_depth;
- UINT16 reserved_76_79[4]; ///< reserved for Serial ATA
+ UINT16 reserved_76_79[4]; ///< Reserved for Serial ATA.
UINT16 major_version_no;
UINT16 minor_version_no;
UINT16 command_set_supported_82; ///< word 82
@@ -176,14 +176,14 @@ typedef struct { } ATA_IDENTIFY_DATA;
///
-/// ATAPI_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec
+/// ATAPI_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec
/// to define the data returned by an ATAPI device upon successful
-/// completion of the ATA IDENTIFY_PACKET_DEVICE command
+/// completion of the ATA IDENTIFY_PACKET_DEVICE command.
///
typedef struct {
- UINT16 config; ///< General Configuration
+ UINT16 config; ///< General Configuration.
UINT16 reserved_1;
- UINT16 specific_config; ///< Specific Configuration
+ UINT16 specific_config; ///< Specific Configuration.
UINT16 reserved_3_9[7];
CHAR8 SerialNo[20]; ///< word 10~19
UINT16 reserved_20_22[3];
@@ -239,14 +239,14 @@ typedef struct { ///
-/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 peripheral_type;
UINT8 RMB;
UINT8 version;
UINT8 response_data_format;
- UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one
+ UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one.
UINT8 reserved_5;
UINT8 reserved_6;
UINT8 reserved_7;
@@ -256,14 +256,14 @@ typedef struct { UINT8 vendor_specific_36_55[55 - 36 + 1];
UINT8 reserved_56_95[95 - 56 + 1];
///
- /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254
+ /// Vendor-specific parameters fields. The sizeof (ATAPI_INQUIRY_DATA) is 254
/// since allocation_length is one byte in ATAPI_INQUIRY_CMD.
///
UINT8 vendor_specific_96_253[253 - 96 + 1];
} ATAPI_INQUIRY_DATA;
///
-/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 error_code : 7;
@@ -291,7 +291,7 @@ typedef struct { } ATAPI_REQUEST_SENSE_DATA;
///
-/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 LastLba3;
@@ -306,7 +306,7 @@ typedef struct { ///
/// Capacity List Header + Current/Maximum Capacity Descriptor,
-/// defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 reserved_0;
@@ -325,7 +325,7 @@ typedef struct { } ATAPI_READ_FORMAT_CAPACITY_DATA;
///
-/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 opcode;
@@ -343,7 +343,7 @@ typedef struct { } ATAPI_TEST_UNIT_READY_CMD;
///
-/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 opcode;
@@ -362,7 +362,7 @@ typedef struct { } ATAPI_INQUIRY_CMD;
///
-/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 opcode;
@@ -381,7 +381,7 @@ typedef struct { } ATAPI_REQUEST_SENSE_CMD;
///
-/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 opcode;
@@ -400,7 +400,7 @@ typedef struct { } ATAPI_READ10_CMD;
///
-/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 opcode;
@@ -419,7 +419,7 @@ typedef struct { } ATAPI_READ_FORMAT_CAP_CMD;
///
-/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)
+/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).
///
typedef struct {
UINT8 opcode;
@@ -439,8 +439,8 @@ typedef struct { } ATAPI_MODE_SENSE_CMD;
///
-/// ATAPI_PACKET_COMMAND is not defined in ATA specification.
-/// We add it here for the convenience for ATA/ATAPI module writer.
+/// ATAPI_PACKET_COMMAND is not defined in the ATA specification.
+/// We add it here for the convenience of ATA/ATAPI module writers.
///
typedef union {
UINT16 Data16[6];
@@ -547,13 +547,13 @@ typedef union { #define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined from ATA-6
///
-/// default content of device control register, disable INT,
+/// Default content of device control register, disable INT,
/// Bit3 is set to 1 according ATA-1
///
#define ATA_DEFAULT_CTL (0x0a)
///
-/// default context of Device/Head Register,
-/// Bit7 and Bit5 are set to 1 for back-compatibilities
+/// Default context of Device/Head Register,
+/// Bit7 and Bit5 are set to 1 for back-compatibilities.
///
#define ATA_DEFAULT_CMD (0xa0)
@@ -598,7 +598,7 @@ typedef union { #define ATA_ASC_INVALID_FIELD (0x24)
#define ATA_ASC_WRITE_PROTECTED (0x27)
#define ATA_ASC_MEDIA_CHANGE (0x28)
-#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred
+#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred.
#define ATA_ASC_ILLEGAL_FIELD (0x26)
#define ATA_ASC_NO_MEDIA (0x3A)
#define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)
@@ -636,8 +636,8 @@ typedef union { //
// Device Control Register
//
-#define ATA_CTLREG_SRST BIT2 ///< Software Reset
-#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #
+#define ATA_CTLREG_SRST BIT2 ///< Software Reset.
+#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #.
#endif
diff --git a/MdePkg/Include/IndustryStandard/Pci.h b/MdePkg/Include/IndustryStandard/Pci.h index 2fcc8b6c4f..1b2215d9fc 100644 --- a/MdePkg/Include/IndustryStandard/Pci.h +++ b/MdePkg/Include/IndustryStandard/Pci.h @@ -1,11 +1,14 @@ /** @file
Support for the latest PCI standard.
- Copyright (c) 2006 - 2008, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
diff --git a/MdePkg/Include/IndustryStandard/Pci23.h b/MdePkg/Include/IndustryStandard/Pci23.h index 52d90e8fa6..d9ad8ea017 100644 --- a/MdePkg/Include/IndustryStandard/Pci23.h +++ b/MdePkg/Include/IndustryStandard/Pci23.h @@ -1,11 +1,11 @@ /** @file
Support for PCI 2.3 standard.
- Copyright (c) 2006 - 2009, Intel Corporation
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+ http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -18,7 +18,7 @@ #include <IndustryStandard/Pci22.h>
///
-/// PCI_CLASS_MASS_STORAGE, Base Class 01h
+/// PCI_CLASS_MASS_STORAGE, Base Class 01h.
///
///@{
#define PCI_CLASS_MASS_STORAGE_ATA 0x05
@@ -27,7 +27,7 @@ ///@}
///
-/// PCI_CLASS_SERIAL, Base Class 0Ch
+/// PCI_CLASS_SERIAL, Base Class 0Ch.
///
///@{
#define PCI_IF_EHCI 0x20
@@ -40,14 +40,14 @@ #define PCI_EXP_MAX_CONFIG_OFFSET 0x1000
///
-/// PCI Capability List IDs and records
+/// PCI Capability List IDs and records.
///
#define EFI_PCI_CAPABILITY_ID_PCIX 0x07
#pragma pack(1)
///
/// PCI-X Capabilities List,
-/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b
+/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b.
///
typedef struct {
EFI_PCI_CAPABILITY_HDR Hdr;
@@ -57,7 +57,7 @@ typedef struct { ///
/// PCI-X Bridge Capabilities List,
-/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b
+/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b.
///
typedef struct {
EFI_PCI_CAPABILITY_HDR Hdr;
diff --git a/MdePkg/Include/IndustryStandard/PeImage.h b/MdePkg/Include/IndustryStandard/PeImage.h index 22f9149f18..eb0ef97681 100644 --- a/MdePkg/Include/IndustryStandard/PeImage.h +++ b/MdePkg/Include/IndustryStandard/PeImage.h @@ -7,15 +7,15 @@ Common Object File Format Specification, Revision 8.0 - May 16, 2006.
This file also includes some definitions in PI Specification, Revision 1.0.
- Copyright (c) 2006 - 2009, Intel Corporation<BR>
- Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution. The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -53,29 +53,29 @@ /// under DOS it can print an error message.
///
typedef struct {
- UINT16 e_magic; ///< Magic number
- UINT16 e_cblp; ///< Bytes on last page of file
- UINT16 e_cp; ///< Pages in file
- UINT16 e_crlc; ///< Relocations
- UINT16 e_cparhdr; ///< Size of header in paragraphs
- UINT16 e_minalloc; ///< Minimum extra paragraphs needed
- UINT16 e_maxalloc; ///< Maximum extra paragraphs needed
- UINT16 e_ss; ///< Initial (relative) SS value
- UINT16 e_sp; ///< Initial SP value
- UINT16 e_csum; ///< Checksum
- UINT16 e_ip; ///< Initial IP value
- UINT16 e_cs; ///< Initial (relative) CS value
- UINT16 e_lfarlc; ///< File address of relocation table
- UINT16 e_ovno; ///< Overlay number
- UINT16 e_res[4]; ///< Reserved words
- UINT16 e_oemid; ///< OEM identifier (for e_oeminfo)
- UINT16 e_oeminfo; ///< OEM information; e_oemid specific
- UINT16 e_res2[10]; ///< Reserved words
- UINT32 e_lfanew; ///< File address of new exe header
+ UINT16 e_magic; ///< Magic number.
+ UINT16 e_cblp; ///< Bytes on last page of file.
+ UINT16 e_cp; ///< Pages in file.
+ UINT16 e_crlc; ///< Relocations.
+ UINT16 e_cparhdr; ///< Size of header in paragraphs.
+ UINT16 e_minalloc; ///< Minimum extra paragraphs needed.
+ UINT16 e_maxalloc; ///< Maximum extra paragraphs needed.
+ UINT16 e_ss; ///< Initial (relative) SS value.
+ UINT16 e_sp; ///< Initial SP value.
+ UINT16 e_csum; ///< Checksum.
+ UINT16 e_ip; ///< Initial IP value.
+ UINT16 e_cs; ///< Initial (relative) CS value.
+ UINT16 e_lfarlc; ///< File address of relocation table.
+ UINT16 e_ovno; ///< Overlay number.
+ UINT16 e_res[4]; ///< Reserved words.
+ UINT16 e_oemid; ///< OEM identifier (for e_oeminfo).
+ UINT16 e_oeminfo; ///< OEM information; e_oemid specific.
+ UINT16 e_res2[10]; ///< Reserved words.
+ UINT32 e_lfanew; ///< File address of new exe header.
} EFI_IMAGE_DOS_HEADER;
///
-/// COFF File Header (Object and Image)
+/// COFF File Header (Object and Image).
///
typedef struct {
UINT16 Machine;
@@ -88,7 +88,7 @@ typedef struct { } EFI_IMAGE_FILE_HEADER;
///
-/// Size of EFI_IMAGE_FILE_HEADER
+/// Size of EFI_IMAGE_FILE_HEADER.
///
#define EFI_IMAGE_SIZEOF_FILE_HEADER 20
@@ -101,13 +101,13 @@ typedef struct { #define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED BIT3 ///< 0x0008 Local symbols stripped from file.
#define EFI_IMAGE_FILE_BYTES_REVERSED_LO BIT7 ///< 0x0080 Bytes of machine word are reversed.
#define EFI_IMAGE_FILE_32BIT_MACHINE BIT8 ///< 0x0100 32 bit word machine.
-#define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file
+#define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file.
#define EFI_IMAGE_FILE_SYSTEM BIT12 ///< 0x1000 System File.
#define EFI_IMAGE_FILE_DLL BIT13 ///< 0x2000 File is a DLL.
#define EFI_IMAGE_FILE_BYTES_REVERSED_HI BIT15 ///< 0x8000 Bytes of machine word are reversed.
///
-/// Header Data Directories
+/// Header Data Directories.
///
typedef struct {
UINT32 VirtualAddress;
@@ -140,7 +140,7 @@ typedef struct { #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b
///
-/// Optional Header Standard Fields for PE32
+/// Optional Header Standard Fields for PE32.
///
typedef struct {
///
@@ -154,7 +154,7 @@ typedef struct { UINT32 SizeOfUninitializedData;
UINT32 AddressOfEntryPoint;
UINT32 BaseOfCode;
- UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+
+ UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.
///
/// Optional Header Windows-Specific Fields.
///
@@ -191,7 +191,7 @@ typedef struct { #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b
///
-/// Optional Header Standard Fields for PE32+
+/// Optional Header Standard Fields for PE32+.
///
typedef struct {
///
@@ -273,7 +273,7 @@ typedef struct { #define EFI_IMAGE_SIZEOF_SHORT_NAME 8
///
-/// Section Table, this table immediately follows the optional header
+/// Section Table. This table immediately follows the optional header.
///
typedef struct {
UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];
@@ -292,7 +292,7 @@ typedef struct { } EFI_IMAGE_SECTION_HEADER;
///
-/// Size of EFI_IMAGE_SECTION_HEADER
+/// Size of EFI_IMAGE_SECTION_HEADER.
///
#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40
@@ -326,7 +326,7 @@ typedef struct { #define EFI_IMAGE_SCN_MEM_WRITE BIT31 ///< 0x80000000
///
-/// Size of a Symbol Table Record
+/// Size of a Symbol Table Record.
///
#define EFI_IMAGE_SIZEOF_SYMBOL 18
@@ -439,15 +439,15 @@ typedef struct { //
// I386 relocation types.
//
-#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary
-#define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address
-#define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address
-#define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address
-#define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included
-#define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address
+#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary.
+#define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address.
+#define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address.
+#define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address.
+#define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included.
+#define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.
#define EFI_IMAGE_REL_I386_SECTION 0x000A
#define EFI_IMAGE_REL_I386_SECREL 0x000B
-#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address
+#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.
//
// x64 processor relocation types.
@@ -479,7 +479,7 @@ typedef struct { } EFI_IMAGE_BASE_RELOCATION;
///
-/// Size of EFI_IMAGE_BASE_RELOCATION
+/// Size of EFI_IMAGE_BASE_RELOCATION.
///
#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8
@@ -508,7 +508,7 @@ typedef struct { } EFI_IMAGE_LINENUMBER;
///
-/// Size of EFI_IMAGE_LINENUMBER
+/// Size of EFI_IMAGE_LINENUMBER.
///
#define EFI_IMAGE_SIZEOF_LINENUMBER 6
@@ -532,11 +532,11 @@ typedef struct { UINT8 GroupID[6]; ///< File member group id - decimal.
UINT8 Mode[8]; ///< File member mode - octal.
UINT8 Size[10]; ///< File member size - decimal.
- UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A)
+ UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).
} EFI_IMAGE_ARCHIVE_MEMBER_HEADER;
///
-/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER
+/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.
///
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60
@@ -546,7 +546,7 @@ typedef struct { //
///
-/// Export Directory Table
+/// Export Directory Table.
///
typedef struct {
UINT32 Characteristics;
@@ -563,7 +563,7 @@ typedef struct { } EFI_IMAGE_EXPORT_DIRECTORY;
///
-/// Hint/Name Table
+/// Hint/Name Table.
///
typedef struct {
UINT16 Hint;
@@ -571,7 +571,7 @@ typedef struct { } EFI_IMAGE_IMPORT_BY_NAME;
///
-/// Import Address Table RVA (Thunk Table)
+/// Import Address Table RVA (Thunk Table).
///
typedef struct {
union {
@@ -581,7 +581,7 @@ typedef struct { } u1;
} EFI_IMAGE_THUNK_DATA;
-#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32
+#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32.
#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
#define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
@@ -598,7 +598,7 @@ typedef struct { ///
-/// Debug Directory Format
+/// Debug Directory Format.
///
typedef struct {
UINT32 Characteristics;
@@ -607,14 +607,14 @@ typedef struct { UINT16 MinorVersion;
UINT32 Type;
UINT32 SizeOfData;
- UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base
- UINT32 FileOffset; ///< The file pointer to the debug data
+ UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base.
+ UINT32 FileOffset; ///< The file pointer to the debug data.
} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;
-#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information
+#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information.
///
-/// Debug Data Structure defined in Microsoft C++
+/// Debug Data Structure defined in Microsoft C++.
///
#define CODEVIEW_SIGNATURE_NB10 SIGNATURE_32('N', 'B', '1', '0')
typedef struct {
@@ -628,11 +628,11 @@ typedef struct { } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
///
-/// Debug Data Structure defined in Microsoft C++
+/// Debug Data Structure defined in Microsoft C++.
///
#define CODEVIEW_SIGNATURE_RSDS SIGNATURE_32('R', 'S', 'D', 'S')
typedef struct {
- UINT32 Signature; ///< "RSDS"
+ UINT32 Signature; ///< "RSDS".
UINT32 Unknown;
UINT32 Unknown2;
UINT32 Unknown3;
@@ -645,11 +645,11 @@ typedef struct { ///
-/// Debug Data Structure defined by Apple Mach-O to Coff utility
+/// Debug Data Structure defined by Apple Mach-O to Coff utility.
///
#define CODEVIEW_SIGNATURE_MTOC SIGNATURE_32('M', 'T', 'O', 'C')
typedef struct {
- UINT32 Signature; ///< "MTOC"
+ UINT32 Signature; ///< "MTOC".
GUID MachOUuid;
//
// Filename of .DLL (Mach-O with debug info) goes here
@@ -710,18 +710,18 @@ typedef struct { } EFI_IMAGE_RESOURCE_DATA_ENTRY;
///
-/// Header format for TE images, defined in PI Specification, 1.0
+/// Header format for TE images, defined in the PI Specification, 1.0.
///
typedef struct {
- UINT16 Signature; ///< signature for TE format = "VZ"
- UINT16 Machine; ///< from the original file header
- UINT8 NumberOfSections; ///< from the original file header
- UINT8 Subsystem; ///< from original optional header
- UINT16 StrippedSize; ///< how many bytes we removed from the header
- UINT32 AddressOfEntryPoint; ///< offset to entry point -- from original optional header
- UINT32 BaseOfCode; ///< from original image -- required for ITP debug
- UINT64 ImageBase; ///< from original file header
- EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< only base relocation and debug directory
+ UINT16 Signature; ///< The signature for TE format = "VZ".
+ UINT16 Machine; ///< From the original file header.
+ UINT8 NumberOfSections; ///< From the original file header.
+ UINT8 Subsystem; ///< From original optional header.
+ UINT16 StrippedSize; ///< Number of bytes we removed from the header.
+ UINT32 AddressOfEntryPoint; ///< Offset to entry point -- from original optional header.
+ UINT32 BaseOfCode; ///< From original image -- required for ITP debug.
+ UINT64 ImageBase; ///< From original file header.
+ EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< Only base relocation and debug directory.
} EFI_TE_IMAGE_HEADER;
@@ -735,7 +735,7 @@ typedef struct { ///
-/// Union of PE32, PE32+, and TE headers
+/// Union of PE32, PE32+, and TE headers.
///
typedef union {
EFI_IMAGE_NT_HEADERS32 Pe32;
diff --git a/MdePkg/Include/IndustryStandard/Sal.h b/MdePkg/Include/IndustryStandard/Sal.h index cdc547a4e6..093a681315 100644 --- a/MdePkg/Include/IndustryStandard/Sal.h +++ b/MdePkg/Include/IndustryStandard/Sal.h @@ -2,14 +2,14 @@ Main SAL API's defined in Intel Itanium Processor Family System Abstraction
Layer Specification Revision 3.2 (December 2003)
- Copyright (c) 2006 - 2008, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -26,7 +26,7 @@ typedef INTN EFI_SAL_STATUS; ///
#define EFI_SAL_SUCCESS ((EFI_SAL_STATUS) 0)
///
-/// Call completed without error but some information was lost due to overflow.
+/// Call completed without error, but some information was lost due to overflow.
///
#define EFI_SAL_OVERFLOW ((EFI_SAL_STATUS) 1)
///
@@ -63,23 +63,23 @@ typedef INTN EFI_SAL_STATUS; #define EFI_SAL_NOT_ENOUGH_SCRATCH ((EFI_SAL_STATUS) - 9)
///
-/// Return registers from SAL
+/// Return registers from SAL.
///
typedef struct {
///
- /// SAL return status value in r8
+ /// SAL return status value in r8.
///
EFI_SAL_STATUS Status;
///
- /// SAL returned value in r9
+ /// SAL returned value in r9.
///
UINTN r9;
///
- /// SAL returned value in r10
+ /// SAL returned value in r10.
///
UINTN r10;
///
- /// SAL returned value in r11
+ /// SAL returned value in r11.
///
UINTN r11;
} SAL_RETURN_REGS;
@@ -96,11 +96,11 @@ typedef struct { 0x04XXXXXX to 0xFFFFFFFF - Reserved.
@param Arg1 The first parameter of the architected/OEM specific SAL functions.
@param Arg2 The second parameter of the architected/OEM specific SAL functions.
- @param Arg3 The third parameter passed to the ESAL function based
- @param Arg4 The fourth parameter passed to the ESAL function based
- @param Arg5 The fifth parameter passed to the ESAL function based
- @param Arg6 The sixth parameter passed to the ESAL function
- @param Arg7 The seventh parameter passed to the ESAL function based
+ @param Arg3 The third parameter passed to the ESAL function based.
+ @param Arg4 The fourth parameter passed to the ESAL function based.
+ @param Arg5 The fifth parameter passed to the ESAL function based.
+ @param Arg6 The sixth parameter passed to the ESAL function.
+ @param Arg7 The seventh parameter passed to the ESAL function based.
@return r8 Return status: positive number indicates successful,
negative number indicates failure.
@@ -201,7 +201,7 @@ SAL_RETURN_REGS #define EFI_SAL_SET_INIT_VECTOR 0x1
#define EFI_SAL_SET_BOOT_RENDEZ_VECTOR 0x2
///
-/// Format of length_cs_n argument.
+/// The format of a length_cs_n argument.
///
typedef struct {
UINT64 Length : 32;
@@ -267,7 +267,7 @@ typedef struct { #define EFI_SAL_PCI_COMPATIBLE_ADDRESS 0x0
#define EFI_SAL_PCI_EXTENDED_REGISTER_ADDRESS 0x1
///
-/// Format of PCI Compatible Address
+/// The format of PCI Compatible Address.
///
typedef struct {
UINT64 Register : 8;
@@ -278,7 +278,7 @@ typedef struct { UINT64 Reserved : 32;
} SAL_PCI_ADDRESS;
///
-/// Format of Extended Register Address
+/// The format of Extended Register Address.
///
typedef struct {
UINT64 Register : 8;
@@ -327,7 +327,7 @@ typedef struct { UINT8 Reserved2[40];
} SAL_UPDATE_PAL_DATA_BLOCK;
///
-/// Data structure pointed by parameter param_buf.
+/// Data structure pointed by the parameter param_buf.
/// It is a 16-byte aligned data structure in memory with a length of 32 bytes
/// that describes the new firmware. This information is organized in the form
/// of a linked list with each element describing one firmware component.
@@ -340,12 +340,12 @@ typedef struct _SAL_UPDATE_PAL_INFO_BLOCK { } SAL_UPDATE_PAL_INFO_BLOCK;
///
-/// SAL System Table Definitions
+/// SAL System Table Definitions.
///
#pragma pack(1)
typedef struct {
///
- /// The ASCII string representation of "SST_" which confirms the presence of the table.
+ /// The ASCII string representation of "SST_" that confirms the presence of the table.
///
UINT32 Signature;
///
@@ -355,7 +355,7 @@ typedef struct { UINT32 Length;
///
/// The revision number of the Itanium Processor Family System Abstraction Layer
- /// Specification supported by the SAL implementation in binary coded decimal (BCD) format.
+ /// Specification supported by the SAL implementation, in binary coded decimal (BCD) format.
///
UINT16 SalRevision;
///
@@ -417,10 +417,10 @@ typedef struct { #define EFI_SAL_ST_AP_WAKEUP_SIZE 16
///
-/// Format of Entrypoint Descriptor Entry
+/// Format of Entrypoint Descriptor Entry.
///
typedef struct {
- UINT8 Type; ///< Type here should be 0
+ UINT8 Type; ///< Type here should be 0.
UINT8 Reserved[7];
UINT64 PalProcEntry;
UINT64 SalProcEntry;
@@ -429,10 +429,10 @@ typedef struct { } SAL_ST_ENTRY_POINT_DESCRIPTOR;
///
-/// Format of Platform Features Descriptor Entry
+/// Format of Platform Features Descriptor Entry.
///
typedef struct {
- UINT8 Type; ///< Type here should be 2
+ UINT8 Type; ///< Type here should be 2.
UINT8 PlatformFeatures;
UINT8 Reserved[14];
} SAL_ST_PLATFORM_FEATURES;
@@ -445,10 +445,10 @@ typedef struct { #define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04
///
-/// Format of Translation Register Descriptor Entry
+/// Format of Translation Register Descriptor Entry.
///
typedef struct {
- UINT8 Type; ///< Type here should be 3
+ UINT8 Type; ///< Type here should be 3.
UINT8 TRType;
UINT8 TRNumber;
UINT8 Reserved[5];
@@ -464,7 +464,7 @@ typedef struct { #define EFI_SAL_ST_TR_USAGE_DATA 01
///
-/// Definition of Coherence Domain Information
+/// Definition of Coherence Domain Information.
///
typedef struct {
UINT64 NumberOfProcessors;
@@ -472,27 +472,27 @@ typedef struct { } SAL_COHERENCE_DOMAIN_INFO;
///
-/// Format of Purge Translation Cache Coherence Domain Entry
+/// Format of Purge Translation Cache Coherence Domain Entry.
///
typedef struct {
- UINT8 Type; ///< Type here should be 4
+ UINT8 Type; ///< Type here should be 4.
UINT8 Reserved[3];
UINT32 NumberOfDomains;
SAL_COHERENCE_DOMAIN_INFO *DomainInformation;
} SAL_ST_CACHE_COHERENCE_DECRIPTOR;
///
-/// Format of Application Processor Wake-Up Descriptor Entry
+/// Format of Application Processor Wake-Up Descriptor Entry.
///
typedef struct {
- UINT8 Type; ///< Type here should be 5
+ UINT8 Type; ///< Type here should be 5.
UINT8 WakeUpType;
UINT8 Reserved[6];
UINT64 ExternalInterruptVector;
} SAL_ST_AP_WAKEUP_DECRIPTOR;
///
-/// Format of Firmware Interface Table (FIT) Entry
+/// Format of Firmware Interface Table (FIT) Entry.
///
typedef struct {
UINT64 Address;
@@ -532,7 +532,7 @@ typedef struct { //
///
-/// Format of TimeStamp field in Record Header
+/// Format of TimeStamp field in Record Header.
///
typedef struct {
UINT8 Seconds;
@@ -545,7 +545,7 @@ typedef struct { UINT8 Century;
} SAL_TIME_STAMP;
///
-/// Definition of Record Header
+/// Definition of Record Header.
///
typedef struct {
UINT64 RecordId;
@@ -557,7 +557,7 @@ typedef struct { UINT8 OemPlatformId[16];
} SAL_RECORD_HEADER;
///
-/// Definition of Section Header
+/// Definition of Section Header.
///
typedef struct {
GUID Guid;
@@ -568,7 +568,7 @@ typedef struct { } SAL_SEC_HEADER;
///
-/// GUID of Processor Machine Check Errors
+/// GUID of Processor Machine Check Errors.
///
#define SAL_PROCESSOR_ERROR_RECORD_INFO \
{ \
@@ -583,7 +583,7 @@ typedef struct { #define TARGER_ID_VALID_BIT_MASK 0x8
#define PRECISE_IP_VALID_BIT_MASK 0x10
///
-/// Definition of MOD_ERROR_INFO_STRUCT
+/// Definition of MOD_ERROR_INFO_STRUCT.
///
typedef struct {
UINT64 InfoValid : 1;
@@ -599,7 +599,7 @@ typedef struct { UINT64 Ip;
} MOD_ERROR_INFO;
///
-/// Definition of CPUID_INFO_STRUCT
+/// Definition of CPUID_INFO_STRUCT.
///
typedef struct {
UINT8 CpuidInfo[40];
@@ -620,7 +620,7 @@ typedef struct { #define RR_VALID_BIT_MASK 0x10
#define FR_VALID_BIT_MASK 0x20
///
-/// Definition of PSI_STATIC_STRUCT
+/// Definition of PSI_STATIC_STRUCT.
///
typedef struct {
UINT64 ValidFieldBits;
@@ -640,7 +640,7 @@ typedef struct { #define PROC_STATIC_STRUCT_VALID_BIT_MASK 0x8
#define CPU_INFO_VALID_BIT_MASK 0x1000000
///
-/// Definition of Processor Machine Check Error Record
+/// Definition of Processor Machine Check Error Record.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -658,7 +658,7 @@ typedef struct { } SAL_PROCESSOR_ERROR_RECORD;
///
-/// GUID of Platform Memory Device Error Info
+/// GUID of Platform Memory Device Error Info.
///
#define SAL_MEMORY_ERROR_RECORD_INFO \
{ \
@@ -685,7 +685,7 @@ typedef struct { #define MEMORY_PLATFORM_OEM_ID_VALID_BIT_MASK 0x8000
#define MEMORY_PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x10000
///
-/// Definition of Platform Memory Device Error Info Record
+/// Definition of Platform Memory Device Error Info Record.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -709,7 +709,7 @@ typedef struct { } SAL_MEMORY_ERROR_RECORD;
///
-/// GUID of Platform PCI Bus Error Info
+/// GUID of Platform PCI Bus Error Info.
///
#define SAL_PCI_BUS_ERROR_RECORD_INFO \
{ \
@@ -731,7 +731,7 @@ typedef struct { #define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK 0x400
///
-/// Designated PCI Bus identifier
+/// Designated PCI Bus identifier.
///
typedef struct {
UINT8 BusNumber;
@@ -739,7 +739,7 @@ typedef struct { } PCI_BUS_ID;
///
-/// Definition of Platform PCI Bus Error Info Record
+/// Definition of Platform PCI Bus Error Info Record.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -758,7 +758,7 @@ typedef struct { } SAL_PCI_BUS_ERROR_RECORD;
///
-/// GUID of Platform PCI Component Error Info
+/// GUID of Platform PCI Component Error Info.
///
#define SAL_PCI_COMP_ERROR_RECORD_INFO \
{ \
@@ -774,7 +774,7 @@ typedef struct { #define PCI_COMP_REG_DATA_PAIR_VALID_BIT_MASK 0x10
#define PCI_COMP_OEM_DATA_STRUCT_VALID_BIT_MASK 0x20
///
-/// Format of PCI Component Information to identify the device
+/// Format of PCI Component Information to identify the device.
///
typedef struct {
UINT16 VendorId;
@@ -787,7 +787,7 @@ typedef struct { UINT8 Reserved[5];
} PCI_COMP_INFO;
///
-/// Definition of Platform PCI Component Error Info
+/// Definition of Platform PCI Component Error Info.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -800,7 +800,7 @@ typedef struct { } SAL_PCI_COMPONENT_ERROR_RECORD;
///
-/// Platform SEL Device Error Info
+/// Platform SEL Device Error Info.
///
#define SAL_SEL_DEVICE_ERROR_RECORD_INFO \
{ \
@@ -820,7 +820,7 @@ typedef struct { #define SEL_EVENT_DATA2_VALID_BIT_MASK 0x100;
#define SEL_EVENT_DATA3_VALID_BIT_MASK 0x200;
///
-/// Definition of Platform SEL Device Error Info Record
+/// Definition of Platform SEL Device Error Info Record.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -839,7 +839,7 @@ typedef struct { } SAL_SEL_DEVICE_ERROR_RECORD;
///
-/// GUID of Platform SMBIOS Device Error Info
+/// GUID of Platform SMBIOS Device Error Info.
///
#define SAL_SMBIOS_ERROR_RECORD_INFO \
{ \
@@ -853,7 +853,7 @@ typedef struct { #define SMBIOS_TIME_STAMP_VALID_BIT_MASK 0x4
#define SMBIOS_DATA_VALID_BIT_MASK 0x8
///
-/// Definition of Platform SMBIOS Device Error Info Record
+/// Definition of Platform SMBIOS Device Error Info Record.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -864,7 +864,7 @@ typedef struct { } SAL_SMBIOS_DEVICE_ERROR_RECORD;
///
-/// GUID of Platform Specific Error Info
+/// GUID of Platform Specific Error Info.
///
#define SAL_PLATFORM_ERROR_RECORD_INFO \
{ \
@@ -882,7 +882,7 @@ typedef struct { #define PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x40
#define PLATFORM_OEM_DEVICE_PATH_VALID_BIT_MASK 0x80
///
-/// Definition of Platform Specific Error Info Record
+/// Definition of Platform Specific Error Info Record.
///
typedef struct {
SAL_SEC_HEADER SectionHeader;
@@ -896,7 +896,7 @@ typedef struct { } SAL_PLATFORM_SPECIFIC_ERROR_RECORD;
///
-/// Union of all the possible SAL Error Record Types
+/// Union of all the possible SAL Error Record Types.
///
typedef union {
SAL_RECORD_HEADER *RecordHeader;
diff --git a/MdePkg/Include/IndustryStandard/SmBios.h b/MdePkg/Include/IndustryStandard/SmBios.h index 3799492368..9768e9c253 100644 --- a/MdePkg/Include/IndustryStandard/SmBios.h +++ b/MdePkg/Include/IndustryStandard/SmBios.h @@ -1,14 +1,14 @@ /** @file
Industry Standard Definitions of SMBIOS Table Specification v2.6.1
- Copyright (c) 2006 - 2010, Intel Corporation All rights
- reserved. This program and the accompanying materials are
- licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -23,8 +23,8 @@ #define SMBIOS_HANDLE_RESERVED_BEGIN 0xFF00
///
-/// Reference SMBIOS 2.6, chapter 3.1.3
-/// Each text string is limited to 64 significant characters due to system MIF limitations
+/// Reference SMBIOS 2.6, chapter 3.1.3.
+/// Each text string is limited to 64 significant characters due to system MIF limitations.
///
#define SMBIOS_STRING_MAX_LENGTH 64
@@ -42,7 +42,7 @@ #define SMBIOS_TYPE_END_OF_TABLE 0x007F
///
-/// Smbios Table Entry Point Structure
+/// Smbios Table Entry Point Structure.
///
#pragma pack(1)
typedef struct {
@@ -63,7 +63,7 @@ typedef struct { } SMBIOS_TABLE_ENTRY_POINT;
///
-/// The Smbios structure header
+/// The Smbios structure header.
///
typedef struct {
UINT8 Type;
@@ -81,7 +81,7 @@ typedef UINT8 SMBIOS_TABLE_STRING; /// Defines which functions the BIOS supports. PCI, PCMCIA, Flash, etc.
///
typedef struct {
- UINT32 Reserved :2; ///< Bits 0-1
+ UINT32 Reserved :2; ///< Bits 0-1.
UINT32 Unknown :1;
UINT32 BiosCharacteristicsNotSupported :1;
UINT32 IsaIsSupported :1;
@@ -117,7 +117,7 @@ typedef struct { } MISC_BIOS_CHARACTERISTICS;
///
-/// BIOS Characteristics Extension Byte 1
+/// BIOS Characteristics Extension Byte 1 .
/// This information, available for SMBIOS version 2.1 and later, appears at offset 12h
/// within the BIOS Information structure.
///
@@ -133,7 +133,7 @@ typedef struct { } MBCE_BIOS_RESERVED;
///
-/// BIOS Characteristics Extension Byte 2
+/// BIOS Characteristics Extension Byte 2.
/// This information, available for SMBIOS version 2.3 and later, appears at offset 13h
/// within the BIOS Information structure.
///
@@ -145,7 +145,7 @@ typedef struct { } MBCE_SYSTEM_RESERVED;
///
-/// BIOS Characteristics Extension Bytes
+/// BIOS Characteristics Extension Bytes.
///
typedef struct {
MBCE_BIOS_RESERVED BiosReserved;
@@ -154,7 +154,7 @@ typedef struct { } MISC_BIOS_CHARACTERISTICS_EXTENSION;
///
-/// BIOS Information (Type 0)
+/// BIOS Information (Type 0).
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
@@ -172,7 +172,7 @@ typedef struct { } SMBIOS_TABLE_TYPE0;
///
-/// System Wake-up Type
+/// System Wake-up Type.
///
typedef enum {
SystemWakeupTypeReserved = 0x00,
@@ -187,7 +187,7 @@ typedef enum { } MISC_SYSTEM_WAKEUP_TYPE;
///
-/// System Information (Type 1)
+/// System Information (Type 1).
///
/// The information in this structure defines attributes of the overall system and is
/// intended to be associated with the Component ID group of the system's MIF.
@@ -201,13 +201,13 @@ typedef struct { SMBIOS_TABLE_STRING Version;
SMBIOS_TABLE_STRING SerialNumber;
GUID Uuid;
- UINT8 WakeUpType; ///< enumeration value from MISC_SYSTEM_WAKEUP_TYPE
+ UINT8 WakeUpType; ///< The enumeration value from MISC_SYSTEM_WAKEUP_TYPE.
SMBIOS_TABLE_STRING SKUNumber;
SMBIOS_TABLE_STRING Family;
} SMBIOS_TABLE_TYPE1;
///
-/// Base Board - Feature Flags
+/// Base Board - Feature Flags.
///
typedef struct {
UINT8 Motherboard :1;
@@ -219,7 +219,7 @@ typedef struct { } BASE_BOARD_FEATURE_FLAGS;
///
-/// Base Board - Board Type
+/// Base Board - Board Type.
///
typedef enum {
BaseBoardTypeUnknown = 0x1,
@@ -238,7 +238,7 @@ typedef enum { } BASE_BOARD_TYPE;
///
-/// Base Board (or Module) Information (Type 2)
+/// Base Board (or Module) Information (Type 2).
///
/// The information in this structure defines attributes of a system baseboard -
/// for example a motherboard, planar, or server blade or other standard system module.
@@ -253,7 +253,7 @@ typedef struct { BASE_BOARD_FEATURE_FLAGS FeatureFlag;
SMBIOS_TABLE_STRING LocationInChassis;
UINT16 ChassisHandle;
- UINT8 BoardType; ///< enumeration value from BASE_BOARD_TYPE
+ UINT8 BoardType; ///< The enumeration value from BASE_BOARD_TYPE.
UINT8 NumberOfContainedObjectHandles;
UINT16 ContainedObjectHandles[1];
} SMBIOS_TABLE_TYPE2;
@@ -294,7 +294,7 @@ typedef enum { } MISC_CHASSIS_TYPE;
///
-/// System Enclosure or Chassis States
+/// System Enclosure or Chassis States .
///
typedef enum {
ChassisStateOther = 0x01,
@@ -306,7 +306,7 @@ typedef enum { } MISC_CHASSIS_STATE;
///
-/// System Enclosure or Chassis Security Status
+/// System Enclosure or Chassis Security Status.
///
typedef enum {
ChassisSecurityStatusOther = 0x01,
@@ -327,7 +327,7 @@ typedef struct { ///
-/// System Enclosure or Chassis (Type 3)
+/// System Enclosure or Chassis (Type 3).
///
/// The information in this structure defines attributes of the system's mechanical enclosure(s).
/// For example, if a system included a separate enclosure for its peripheral devices,
@@ -342,10 +342,10 @@ typedef struct { SMBIOS_TABLE_STRING Version;
SMBIOS_TABLE_STRING SerialNumber;
SMBIOS_TABLE_STRING AssetTag;
- UINT8 BootupState; ///< enumeration value from MISC_CHASSIS_STATE
- UINT8 PowerSupplyState; ///< enumeration value from MISC_CHASSIS_STATE
- UINT8 ThermalState; ///< enumeration value from MISC_CHASSIS_STATE
- UINT8 SecurityStatus; ///< enumeration value from MISC_CHASSIS_SECURITY_STATE
+ UINT8 BootupState; ///< The enumeration value from MISC_CHASSIS_STATE.
+ UINT8 PowerSupplyState; ///< The enumeration value from MISC_CHASSIS_STATE.
+ UINT8 ThermalState; ///< The enumeration value from MISC_CHASSIS_STATE.
+ UINT8 SecurityStatus; ///< The enumeration value from MISC_CHASSIS_SECURITY_STATE.
UINT8 OemDefined[4];
UINT8 Height;
UINT8 NumberofPowerCords;
@@ -355,7 +355,7 @@ typedef struct { } SMBIOS_TABLE_TYPE3;
///
-/// Processor Information - Processor Type
+/// Processor Information - Processor Type.
///
typedef enum {
ProcessorOther = 0x01,
@@ -367,7 +367,7 @@ typedef enum { } PROCESSOR_TYPE_DATA;
///
-/// Processor Information - Processor Family
+/// Processor Information - Processor Family.
///
typedef enum {
ProcessorFamilyOther = 0x01,
@@ -538,7 +538,7 @@ typedef enum { } PROCESSOR_FAMILY_DATA;
///
-/// Processor Information - Voltage
+/// Processor Information - Voltage.
///
typedef struct {
UINT8 ProcessorVoltageCapability5V :1;
@@ -550,14 +550,14 @@ typedef struct { } PROCESSOR_VOLTAGE;
///
-/// Processor Information - Processor Upgrade
+/// Processor Information - Processor Upgrade.
///
typedef enum {
ProcessorUpgradeOther = 0x01,
ProcessorUpgradeUnknown = 0x02,
ProcessorUpgradeDaughterBoard = 0x03,
ProcessorUpgradeZIFSocket = 0x04,
- ProcessorUpgradePiggyBack = 0x05, ///< Replaceable
+ ProcessorUpgradePiggyBack = 0x05, ///< Replaceable.
ProcessorUpgradeNone = 0x06,
ProcessorUpgradeLIFSocket = 0x07,
ProcessorUpgradeSlot1 = 0x08,
@@ -566,7 +566,7 @@ typedef enum { ProcessorUpgradeSlotA = 0x0B,
ProcessorUpgradeSlotM = 0x0C,
ProcessorUpgradeSocket423 = 0x0D,
- ProcessorUpgradeSocketA = 0x0E, ///< Socket 462
+ ProcessorUpgradeSocketA = 0x0E, ///< Socket 462.
ProcessorUpgradeSocket478 = 0x0F,
ProcessorUpgradeSocket754 = 0x10,
ProcessorUpgradeSocket940 = 0x11,
@@ -634,19 +634,19 @@ typedef struct { } PROCESSOR_ID_DATA;
///
-/// Processor Information (Type 4)
+/// Processor Information (Type 4).
///
/// The information in this structure defines the attributes of a single processor;
/// a separate structure instance is provided for each system processor socket/slot.
/// For example, a system with an IntelDX2 processor would have a single
-/// structure instance while a system with an IntelSX2 processor would have a structure
-/// to describe the main CPU and a second structure to describe the 80487 co-processor.
+/// structure instance, while a system with an IntelSX2 processor would have a structure
+/// to describe the main CPU, and a second structure to describe the 80487 co-processor.
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
SMBIOS_TABLE_STRING Socket;
- UINT8 ProcessorType; ///< enumeration value from PROCESSOR_TYPE_DATA
- UINT8 ProcessorFamily; ///< enumeration value from PROCESSOR_FAMILY_DATA
+ UINT8 ProcessorType; ///< The enumeration value from PROCESSOR_TYPE_DATA.
+ UINT8 ProcessorFamily; ///< The enumeration value from PROCESSOR_FAMILY_DATA.
SMBIOS_TABLE_STRING ProcessorManufacture;
PROCESSOR_ID_DATA ProcessorId;
SMBIOS_TABLE_STRING ProcessorVersion;
@@ -655,7 +655,7 @@ typedef struct { UINT16 MaxSpeed;
UINT16 CurrentSpeed;
UINT8 Status;
- UINT8 ProcessorUpgrade; ///< enumeration value from PROCESSOR_UPGRADE
+ UINT8 ProcessorUpgrade; ///< The enumeration value from PROCESSOR_UPGRADE.
UINT16 L1CacheHandle;
UINT16 L2CacheHandle;
UINT16 L3CacheHandle;
@@ -676,7 +676,7 @@ typedef struct { } SMBIOS_TABLE_TYPE4;
///
-/// Memory Controller Error Detecting Method
+/// Memory Controller Error Detecting Method.
///
typedef enum {
ErrorDetectingMethodOther = 0x01,
@@ -690,7 +690,7 @@ typedef enum { } MEMORY_ERROR_DETECT_METHOD;
///
-/// Memory Controller Error Correcting Capability
+/// Memory Controller Error Correcting Capability.
///
typedef struct {
UINT8 Other :1;
@@ -703,7 +703,7 @@ typedef struct { } MEMORY_ERROR_CORRECT_CAPABILITY;
///
-/// Memory Controller Information - Interleave Support
+/// Memory Controller Information - Interleave Support.
///
typedef enum {
MemoryInterleaveOther = 0x01,
@@ -716,7 +716,7 @@ typedef enum { } MEMORY_SUPPORT_INTERLEAVE_TYPE;
///
-/// Memory Controller Information - Memory Speeds
+/// Memory Controller Information - Memory Speeds.
///
typedef struct {
UINT16 Other :1;
@@ -728,23 +728,23 @@ typedef struct { } MEMORY_SPEED_TYPE;
///
-/// Memory Controller Information (Type 5, Obsolete)
+/// Memory Controller Information (Type 5, Obsolete).
///
/// The information in this structure defines the attributes of the system's memory controller(s)
/// and the supported attributes of any memory-modules present in the sockets controlled by
/// this controller.
/// Note: This structure, and its companion Memory Module Information (Type 6, Obsolete),
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)
/// and Memory Device (Type 17) structures should be used instead. BIOS providers might
/// choose to implement both memory description types to allow existing DMI browsers
/// to properly display the system's memory attributes.
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
- UINT8 ErrDetectMethod; ///< enumeration value from MEMORY_ERROR_DETECT_METHOD
+ UINT8 ErrDetectMethod; ///< The enumeration value from MEMORY_ERROR_DETECT_METHOD.
MEMORY_ERROR_CORRECT_CAPABILITY ErrCorrectCapability;
- UINT8 SupportInterleave; ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE
- UINT8 CurrentInterleave; ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE
+ UINT8 SupportInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE.
+ UINT8 CurrentInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE .
UINT8 MaxMemoryModuleSize;
MEMORY_SPEED_TYPE SupportSpeed;
UINT16 SupportMemoryType;
@@ -772,7 +772,7 @@ typedef struct { } MEMORY_CURRENT_TYPE;
///
-/// Memory Module Information - Memory Size
+/// Memory Module Information - Memory Size.
///
typedef struct {
UINT8 InstalledOrEnabledSize :7; ///< Size (n), where 2**n is the size in MB.
@@ -787,7 +787,7 @@ typedef struct { /// of each system memory module. The supported attributes of each module are described
/// by the "owning" Memory Controller Information structure.
/// Note: This structure, and its companion Memory Controller Information (Type 5, Obsolete),
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)
/// and Memory Device (Type 17) structures should be used instead.
///
typedef struct {
@@ -802,7 +802,7 @@ typedef struct { } SMBIOS_TABLE_TYPE6;
///
-/// Cache Information - SRAM Type
+/// Cache Information - SRAM Type.
///
typedef struct {
UINT16 Other :1;
@@ -816,7 +816,7 @@ typedef struct { } CACHE_SRAM_TYPE_DATA;
///
-/// Cache Information - Error Correction Type
+/// Cache Information - Error Correction Type.
///
typedef enum {
CacheErrorOther = 0x01,
@@ -828,7 +828,7 @@ typedef enum { } CACHE_ERROR_TYPE_DATA;
///
-/// Cache Information - System Cache Type
+/// Cache Information - System Cache Type.
///
typedef enum {
CacheTypeOther = 0x01,
@@ -839,7 +839,7 @@ typedef enum { } CACHE_TYPE_DATA;
///
-/// Cache Information - Associativity
+/// Cache Information - Associativity.
///
typedef enum {
CacheAssociativityOther = 0x01,
@@ -858,12 +858,12 @@ typedef enum { } CACHE_ASSOCIATIVITY_DATA;
///
-/// Cache Information (Type 7)
+/// Cache Information (Type 7).
///
-/// he information in this structure defines the attributes of CPU cache device in the system.
+/// The information in this structure defines the attributes of CPU cache device in the system.
/// One structure is specified for each such device, whether the device is internal to
/// or external to the CPU module. Cache modules can be associated with a processor structure
-/// in one or two ways depending on the SMBIOS version.
+/// in one or two ways, depending on the SMBIOS version.
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
@@ -874,13 +874,13 @@ typedef struct { CACHE_SRAM_TYPE_DATA SupportedSRAMType;
CACHE_SRAM_TYPE_DATA CurrentSRAMType;
UINT8 CacheSpeed;
- UINT8 ErrorCorrectionType; ///< enumeration value from CACHE_ERROR_TYPE_DATA
- UINT8 SystemCacheType; ///< enumeration value from CACHE_TYPE_DATA
- UINT8 Associativity; ///< enumeration value from CACHE_ASSOCIATIVITY_DATA
+ UINT8 ErrorCorrectionType; ///< The enumeration value from CACHE_ERROR_TYPE_DATA.
+ UINT8 SystemCacheType; ///< The enumeration value from CACHE_TYPE_DATA.
+ UINT8 Associativity; ///< The enumeration value from CACHE_ASSOCIATIVITY_DATA.
} SMBIOS_TABLE_TYPE7;
///
-/// Port Connector Information - Connector Types
+/// Port Connector Information - Connector Types.
///
typedef enum {
PortConnectorTypeNone = 0x00,
@@ -967,7 +967,7 @@ typedef enum { } MISC_PORT_TYPE;
///
-/// Port Connector Information (Type 8)
+/// Port Connector Information (Type 8).
///
/// The information in this structure defines the attributes of a system port connector,
/// e.g. parallel, serial, keyboard, or mouse ports. The port's type and connector information
@@ -976,10 +976,10 @@ typedef enum { typedef struct {
SMBIOS_STRUCTURE Hdr;
SMBIOS_TABLE_STRING InternalReferenceDesignator;
- UINT8 InternalConnectorType; ///< enumeration value from MISC_PORT_CONNECTOR_TYPE
+ UINT8 InternalConnectorType; ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.
SMBIOS_TABLE_STRING ExternalReferenceDesignator;
- UINT8 ExternalConnectorType; ///< enumeration value from MISC_PORT_CONNECTOR_TYPE
- UINT8 PortType; ///< enumeration value from MISC_PORT_TYPE
+ UINT8 ExternalConnectorType; ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.
+ UINT8 PortType; ///< The enumeration value from MISC_PORT_TYPE.
} SMBIOS_TABLE_TYPE8;
///
@@ -1025,7 +1025,7 @@ typedef enum { } MISC_SLOT_TYPE;
///
-/// System Slots - Slot Data Bus Width
+/// System Slots - Slot Data Bus Width.
///
typedef enum {
SlotDataBusWidthOther = 0x01,
@@ -1045,7 +1045,7 @@ typedef enum { } MISC_SLOT_DATA_BUS_WIDTH;
///
-/// System Slots - Current Usage
+/// System Slots - Current Usage.
///
typedef enum {
SlotUsageOther = 0x01,
@@ -1055,7 +1055,7 @@ typedef enum { } MISC_SLOT_USAGE;
///
-/// System Slots - Slot Length
+/// System Slots - Slot Length.
///
typedef enum {
SlotLengthOther = 0x01,
@@ -1065,7 +1065,7 @@ typedef enum { } MISC_SLOT_LENGTH;
///
-/// System Slots - Slot Characteristics 1
+/// System Slots - Slot Characteristics 1.
///
typedef struct {
UINT8 CharacteristicsUnknown :1;
@@ -1078,7 +1078,7 @@ typedef struct { UINT8 ModemRingResumeSupported:1;
} MISC_SLOT_CHARACTERISTICS1;
///
-/// System Slots - Slot Characteristics 2
+/// System Slots - Slot Characteristics 2.
///
typedef struct {
UINT8 PmeSignalSupported :1;
@@ -1097,10 +1097,10 @@ typedef struct { typedef struct {
SMBIOS_STRUCTURE Hdr;
SMBIOS_TABLE_STRING SlotDesignation;
- UINT8 SlotType; ///< enumeration value from MISC_SLOT_TYPE
- UINT8 SlotDataBusWidth; ///< enumeration value from MISC_SLOT_DATA_BUS_WIDTH
- UINT8 CurrentUsage; ///< enumeration value from MISC_SLOT_USAGE
- UINT8 SlotLength; ///< enumeration value from MISC_SLOT_LENGTH
+ UINT8 SlotType; ///< The enumeration value from MISC_SLOT_TYPE.
+ UINT8 SlotDataBusWidth; ///< The enumeration value from MISC_SLOT_DATA_BUS_WIDTH.
+ UINT8 CurrentUsage; ///< The enumeration value from MISC_SLOT_USAGE.
+ UINT8 SlotLength; ///< The enumeration value from MISC_SLOT_LENGTH.
UINT16 SlotID;
MISC_SLOT_CHARACTERISTICS1 SlotCharacteristics1;
MISC_SLOT_CHARACTERISTICS2 SlotCharacteristics2;
@@ -1113,7 +1113,7 @@ typedef struct { } SMBIOS_TABLE_TYPE9;
///
-/// On Board Devices Information - Device Types
+/// On Board Devices Information - Device Types.
///
typedef enum {
OnBoardDeviceTypeOther = 0x01,
@@ -1129,13 +1129,13 @@ typedef enum { /// Device Item Entry
///
typedef struct {
- UINT8 DeviceType; ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE
- ///< Bit 7 - 1 : device enabled, 0 : device disabled
+ UINT8 DeviceType; ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE.
+ ///< Bit 7 - 1 : device enabled, 0 : device disabled.
SMBIOS_TABLE_STRING DescriptionString;
} DEVICE_STRUCT;
///
-/// On Board Devices Information (Type 10, obsolete)
+/// On Board Devices Information (Type 10, obsolete).
///
/// Note: This structure is obsolete starting with version 2.6 specification; the Onboard Devices Extended
/// Information (Type 41) structure should be used instead . BIOS providers can choose to implement both
@@ -1150,7 +1150,7 @@ typedef struct { } SMBIOS_TABLE_TYPE10;
///
-/// OEM Strings (Type 11)
+/// OEM Strings (Type 11).
/// This structure contains free form strings defined by the OEM. Examples of this are:
/// Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc.
///
@@ -1160,7 +1160,7 @@ typedef struct { } SMBIOS_TABLE_TYPE11;
///
-/// System Configuration Options (Type 12)
+/// System Configuration Options (Type 12).
///
/// This structure contains information required to configure the base board's Jumpers and Switches.
///
@@ -1171,7 +1171,7 @@ typedef struct { ///
-/// BIOS Language Information (Type 13)
+/// BIOS Language Information (Type 13).
///
/// The information in this structure defines the installable language attributes of the BIOS.
///
@@ -1184,7 +1184,7 @@ typedef struct { } SMBIOS_TABLE_TYPE13;
///
-/// System Event Log - Event Log Types
+/// System Event Log - Event Log Types.
///
typedef enum {
EventLogTypeReserved = 0x00,
@@ -1216,7 +1216,7 @@ typedef enum { } EVENT_LOG_TYPE_DATA;
///
-/// System Event Log - Variable Data Format Types
+/// System Event Log - Variable Data Format Types.
///
typedef enum {
EventLogVariableNone = 0x00,
@@ -1242,12 +1242,12 @@ typedef struct { /// Event Log Type Descriptors
///
typedef struct {
- UINT8 LogType; ///< enumeration value from EVENT_LOG_TYPE_DATA
+ UINT8 LogType; ///< The enumeration value from EVENT_LOG_TYPE_DATA.
UINT8 DataFormatType;
} EVENT_LOG_TYPE;
///
-/// Group Associations (Type 14)
+/// Group Associations (Type 14).
///
/// The Group Associations structure is provided for OEMs who want to specify
/// the arrangement or hierarchy of certain components (including other Group Associations)
@@ -1260,7 +1260,7 @@ typedef struct { } SMBIOS_TABLE_TYPE14;
///
-/// System Event Log (Type 15)
+/// System Event Log (Type 15).
///
/// The presence of this structure within the SMBIOS data returned for a system indicates
/// that the system supports an event log. An event log is a fixed-length area within a
@@ -1283,7 +1283,7 @@ typedef struct { } SMBIOS_TABLE_TYPE15;
///
-/// Physical Memory Array - Location
+/// Physical Memory Array - Location.
///
typedef enum {
MemoryArrayLocationOther = 0x01,
@@ -1303,7 +1303,7 @@ typedef enum { } MEMORY_ARRAY_LOCATION;
///
-/// Physical Memory Array - Use
+/// Physical Memory Array - Use.
///
typedef enum {
MemoryArrayUseOther = 0x01,
@@ -1316,7 +1316,7 @@ typedef enum { } MEMORY_ARRAY_USE;
///
-/// Physical Memory Array - Error Correction Types
+/// Physical Memory Array - Error Correction Types.
///
typedef enum {
MemoryErrorCorrectionOther = 0x01,
@@ -1329,23 +1329,23 @@ typedef enum { } MEMORY_ERROR_CORRECTION;
///
-/// Physical Memory Array (Type 16)
+/// Physical Memory Array (Type 16).
///
/// This structure describes a collection of memory devices that operate
/// together to form a memory address space.
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
- UINT8 Location; ///< enumeration value from MEMORY_ARRAY_LOCATION
- UINT8 Use; ///< enumeration value from MEMORY_ARRAY_USE
- UINT8 MemoryErrorCorrection; ///< enumeration value from MEMORY_ERROR_CORRECTION
+ UINT8 Location; ///< The enumeration value from MEMORY_ARRAY_LOCATION.
+ UINT8 Use; ///< The enumeration value from MEMORY_ARRAY_USE.
+ UINT8 MemoryErrorCorrection; ///< The enumeration value from MEMORY_ERROR_CORRECTION.
UINT32 MaximumCapacity;
UINT16 MemoryErrorInformationHandle;
UINT16 NumberOfMemoryDevices;
} SMBIOS_TABLE_TYPE16;
///
-/// Memory Device - Form Factor
+/// Memory Device - Form Factor.
///
typedef enum {
MemoryFormFactorOther = 0x01,
@@ -1411,12 +1411,12 @@ typedef struct { } MEMORY_DEVICE_TYPE_DETAIL;
///
-/// Memory Device (Type 17)
+/// Memory Device (Type 17).
///
/// This structure describes a single memory device that is part of
/// a larger Physical Memory Array (Type 16).
/// Note: If a system includes memory-device sockets, the SMBIOS implementation
-/// includes a Memory Device structure instance for each slot whether or not the
+/// includes a Memory Device structure instance for each slot, whether or not the
/// socket is currently populated.
///
typedef struct {
@@ -1426,11 +1426,11 @@ typedef struct { UINT16 TotalWidth;
UINT16 DataWidth;
UINT16 Size;
- UINT8 FormFactor; ///< enumeration value from MEMORY_FORM_FACTOR
+ UINT8 FormFactor; ///< The enumeration value from MEMORY_FORM_FACTOR.
UINT8 DeviceSet;
SMBIOS_TABLE_STRING DeviceLocator;
SMBIOS_TABLE_STRING BankLocator;
- UINT8 MemoryType; ///< enumeration value from MEMORY_DEVICE_TYPE
+ UINT8 MemoryType; ///< The enumeration value from MEMORY_DEVICE_TYPE.
MEMORY_DEVICE_TYPE_DETAIL TypeDetail;
UINT16 Speed;
SMBIOS_TABLE_STRING Manufacturer;
@@ -1444,7 +1444,7 @@ typedef struct { } SMBIOS_TABLE_TYPE17;
///
-/// 32-bit Memory Error Information - Error Type
+/// 32-bit Memory Error Information - Error Type.
///
typedef enum {
MemoryErrorOther = 0x01,
@@ -1464,7 +1464,7 @@ typedef enum { } MEMORY_ERROR_TYPE;
///
-/// 32-bit Memory Error Information - Error Granularity
+/// 32-bit Memory Error Information - Error Granularity.
///
typedef enum {
MemoryGranularityOther = 0x01,
@@ -1474,7 +1474,7 @@ typedef enum { } MEMORY_ERROR_GRANULARITY;
///
-/// 32-bit Memory Error Information - Error Operation
+/// 32-bit Memory Error Information - Error Operation.
///
typedef enum {
MemoryErrorOperationOther = 0x01,
@@ -1485,16 +1485,16 @@ typedef enum { } MEMORY_ERROR_OPERATION;
///
-/// 32-bit Memory Error Information (Type 18)
+/// 32-bit Memory Error Information (Type 18).
///
/// This structure identifies the specifics of an error that might be detected
/// within a Physical Memory Array.
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
- UINT8 ErrorType; ///< enumeration value from MEMORY_ERROR_TYPE
- UINT8 ErrorGranularity; ///< enumeration value from MEMORY_ERROR_GRANULARITY
- UINT8 ErrorOperation; ///< enumeration value from MEMORY_ERROR_OPERATION
+ UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE.
+ UINT8 ErrorGranularity; ///< The enumeration value from MEMORY_ERROR_GRANULARITY.
+ UINT8 ErrorOperation; ///< The enumeration value from MEMORY_ERROR_OPERATION.
UINT32 VendorSyndrome;
UINT32 MemoryArrayErrorAddress;
UINT32 DeviceErrorAddress;
@@ -1502,7 +1502,7 @@ typedef struct { } SMBIOS_TABLE_TYPE18;
///
-/// Memory Array Mapped Address (Type 19)
+/// Memory Array Mapped Address (Type 19).
///
/// This structure provides the address mapping for a Physical Memory Array.
/// One structure is present for each contiguous address range described.
@@ -1516,7 +1516,7 @@ typedef struct { } SMBIOS_TABLE_TYPE19;
///
-/// Memory Device Mapped Address (Type 20)
+/// Memory Device Mapped Address (Type 20).
///
/// This structure maps memory address space usually to a device-level granularity.
/// One structure is present for each contiguous address range described.
@@ -1548,7 +1548,7 @@ typedef enum { } BUILTIN_POINTING_DEVICE_TYPE;
///
-/// Built-in Pointing Device - Interface
+/// Built-in Pointing Device - Interface.
///
typedef enum {
PointingDeviceInterfaceOther = 0x01,
@@ -1565,16 +1565,16 @@ typedef enum { } BUILTIN_POINTING_DEVICE_INTERFACE;
///
-/// Built-in Pointing Device (Type 21)
+/// Built-in Pointing Device (Type 21).
///
/// This structure describes the attributes of the built-in pointing device for the
-/// system - the presence of this structure does not imply that the built-in
+/// system. The presence of this structure does not imply that the built-in
/// pointing device is active for the system's use!
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
- UINT8 Type; ///< enumeration value from BUILTIN_POINTING_DEVICE_TYPE
- UINT8 Interface; ///< enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE
+ UINT8 Type; ///< The enumeration value from BUILTIN_POINTING_DEVICE_TYPE.
+ UINT8 Interface; ///< The enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE.
UINT8 NumberOfButtons;
} SMBIOS_TABLE_TYPE21;
@@ -1593,7 +1593,7 @@ typedef enum { } PORTABLE_BATTERY_DEVICE_CHEMISTRY;
///
-/// Portable Battery (Type 22)
+/// Portable Battery (Type 22).
///
/// This structure describes the attributes of the portable battery(s) for the system.
/// The structure contains the static attributes for the group. Each structure describes
@@ -1606,7 +1606,7 @@ typedef struct { SMBIOS_TABLE_STRING ManufactureDate;
SMBIOS_TABLE_STRING SerialNumber;
SMBIOS_TABLE_STRING DeviceName;
- UINT8 DeviceChemistry; ///< enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY
+ UINT8 DeviceChemistry; ///< The enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY.
UINT16 DeviceCapacity;
UINT16 DesignVoltage;
SMBIOS_TABLE_STRING SBDSVersionNumber;
@@ -1637,7 +1637,7 @@ typedef struct { } SMBIOS_TABLE_TYPE23;
///
-/// Hardware Security (Type 24)
+/// Hardware Security (Type 24).
///
/// This structure describes the system-wide hardware security settings.
///
@@ -1647,7 +1647,7 @@ typedef struct { } SMBIOS_TABLE_TYPE24;
///
-/// System Power Controls (Type 25)
+/// System Power Controls (Type 25).
///
/// This structure describes the attributes for controlling the main power supply to the system.
/// Software that interprets this structure uses the month, day, hour, minute, and second values
@@ -1664,7 +1664,7 @@ typedef struct { } SMBIOS_TABLE_TYPE25;
///
-/// Voltage Probe - Location and Status
+/// Voltage Probe - Location and Status.
///
typedef struct {
UINT8 VoltageProbeSite :5;
@@ -1691,7 +1691,7 @@ typedef struct { } SMBIOS_TABLE_TYPE26;
///
-/// Cooling Device - Device Type and Status
+/// Cooling Device - Device Type and Status.
///
typedef struct {
UINT8 CoolingDevice :5;
@@ -1714,7 +1714,7 @@ typedef struct { } SMBIOS_TABLE_TYPE27;
///
-/// Temperature Probe - Location and Status
+/// Temperature Probe - Location and Status.
///
typedef struct {
UINT8 TemperatureProbeSite :5;
@@ -1722,7 +1722,7 @@ typedef struct { } MISC_TEMPERATURE_PROBE_LOCATION;
///
-/// Temperature Probe (Type 28)
+/// Temperature Probe (Type 28).
///
/// This structure describes the attributes for a temperature probe in the system.
/// Each structure describes a single temperature probe.
@@ -1741,7 +1741,7 @@ typedef struct { } SMBIOS_TABLE_TYPE28;
///
-/// Electrical Current Probe - Location and Status
+/// Electrical Current Probe - Location and Status.
///
typedef struct {
UINT8 ElectricalCurrentProbeSite :5;
@@ -1749,7 +1749,7 @@ typedef struct { } MISC_ELECTRICAL_CURRENT_PROBE_LOCATION;
///
-/// Electrical Current Probe (Type 29)
+/// Electrical Current Probe (Type 29).
///
/// This structure describes the attributes for an electrical current probe in the system.
/// Each structure describes a single electrical current probe.
@@ -1768,7 +1768,7 @@ typedef struct { } SMBIOS_TABLE_TYPE29;
///
-/// Out-of-Band Remote Access (Type 30)
+/// Out-of-Band Remote Access (Type 30).
///
/// This structure describes the attributes and policy settings of a hardware facility
/// that may be used to gain remote access to a hardware system when the operating system
@@ -1781,7 +1781,7 @@ typedef struct { } SMBIOS_TABLE_TYPE30;
///
-/// Boot Integrity Services (BIS) Entry Point (Type 31)
+/// Boot Integrity Services (BIS) Entry Point (Type 31).
///
/// Structure type 31 (decimal) is reserved for use by the Boot Integrity Services (BIS).
///
@@ -1797,7 +1797,7 @@ typedef struct { } SMBIOS_TABLE_TYPE31;
///
-/// System Boot Information - System Boot Status
+/// System Boot Information - System Boot Status.
///
typedef enum {
BootInformationStatusNoError = 0x00,
@@ -1815,7 +1815,7 @@ typedef enum { } MISC_BOOT_INFORMATION_STATUS_DATA_TYPE;
///
-/// System Boot Information (Type 32)
+/// System Boot Information (Type 32).
///
/// The client system firmware, e.g. BIOS, communicates the System Boot Status to the
/// client's Pre-boot Execution Environment (PXE) boot image or OS-present management
@@ -1828,20 +1828,20 @@ typedef enum { typedef struct {
SMBIOS_STRUCTURE Hdr;
UINT8 Reserved[6];
- UINT8 BootStatus; ///< enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE
+ UINT8 BootStatus; ///< The enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE.
} SMBIOS_TABLE_TYPE32;
///
-/// 64-bit Memory Error Information (Type 33)
+/// 64-bit Memory Error Information (Type 33).
///
/// This structure describes an error within a Physical Memory Array,
/// when the error address is above 4G (0xFFFFFFFF).
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
- UINT8 ErrorType; ///< enumeration value from MEMORY_ERROR_TYPE
- UINT8 ErrorGranularity; ///< enumeration value from MEMORY_ERROR_GRANULARITY
- UINT8 ErrorOperation; ///< enumeration value from MEMORY_ERROR_OPERATION
+ UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE.
+ UINT8 ErrorGranularity; ///< The enumeration value from MEMORY_ERROR_GRANULARITY.
+ UINT8 ErrorOperation; ///< The enumeration value from MEMORY_ERROR_OPERATION.
UINT32 VendorSyndrome;
UINT64 MemoryArrayErrorAddress;
UINT64 DeviceErrorAddress;
@@ -1849,7 +1849,7 @@ typedef struct { } SMBIOS_TABLE_TYPE33;
///
-/// Management Device - Type
+/// Management Device - Type.
///
typedef enum {
ManagementDeviceTypeOther = 0x01,
@@ -1868,7 +1868,7 @@ typedef enum { } MISC_MANAGEMENT_DEVICE_TYPE;
///
-/// Management Device - Address Type
+/// Management Device - Address Type.
///
typedef enum {
ManagementDeviceAddressTypeOther = 0x01,
@@ -1879,7 +1879,7 @@ typedef enum { } MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE;
///
-/// Management Device (Type 34)
+/// Management Device (Type 34).
///
/// The information in this structure defines the attributes of a Management Device.
/// A Management Device might control one or more fans or voltage, current, or temperature
@@ -1888,9 +1888,9 @@ typedef enum { typedef struct {
SMBIOS_STRUCTURE Hdr;
SMBIOS_TABLE_STRING Description;
- UINT8 Type; ///< enumeration value from MISC_MANAGEMENT_DEVICE_TYPE
+ UINT8 Type; ///< The enumeration value from MISC_MANAGEMENT_DEVICE_TYPE.
UINT32 Address;
- UINT8 AddressType; ///< enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE
+ UINT8 AddressType; ///< The enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE.
} SMBIOS_TABLE_TYPE34;
///
@@ -1908,7 +1908,7 @@ typedef struct { } SMBIOS_TABLE_TYPE35;
///
-/// Management Device Threshold Data (Type 36)
+/// Management Device Threshold Data (Type 36).
///
/// The information in this structure defines threshold information for
/// a component (probe or cooling-unit) contained within a Management Device.
@@ -1924,7 +1924,7 @@ typedef struct { } SMBIOS_TABLE_TYPE36;
///
-/// Memory Channel Entry
+/// Memory Channel Entry.
///
typedef struct {
UINT8 DeviceLoad;
@@ -1932,7 +1932,7 @@ typedef struct { } MEMORY_DEVICE;
///
-/// Memory Channel - Channel Type
+/// Memory Channel - Channel Type.
///
typedef enum {
MemoryChannelTypeOther = 0x01,
@@ -1945,8 +1945,8 @@ typedef enum { /// Memory Channel (Type 37)
///
/// The information in this structure provides the correlation between a Memory Channel
-/// and its associated Memory Devices. Each device presents one or more loads to the channel;
-/// the sum of all device loads cannot exceed the channel's defined maximum.
+/// and its associated Memory Devices. Each device presents one or more loads to the channel.
+/// The sum of all device loads cannot exceed the channel's defined maximum.
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
@@ -1961,21 +1961,21 @@ typedef struct { ///
typedef enum {
IPMIDeviceInfoInterfaceTypeUnknown = 0x00,
- IPMIDeviceInfoInterfaceTypeKCS = 0x01, ///< Keyboard Controller Style
- IPMIDeviceInfoInterfaceTypeSMIC = 0x02, ///< Server Management Interface Chip
- IPMIDeviceInfoInterfaceTypeBT = 0x03, ///< Block Transfer
+ IPMIDeviceInfoInterfaceTypeKCS = 0x01, ///< The Keyboard Controller Style.
+ IPMIDeviceInfoInterfaceTypeSMIC = 0x02, ///< The Server Management Interface Chip.
+ IPMIDeviceInfoInterfaceTypeBT = 0x03, ///< The Block Transfer
IPMIDeviceInfoInterfaceTypeReserved = 0x04
} BMC_INTERFACE_TYPE;
///
-/// IPMI Device Information (Type 38)
+/// IPMI Device Information (Type 38).
///
/// The information in this structure defines the attributes of an
/// Intelligent Platform Management Interface (IPMI) Baseboard Management Controller (BMC).
///
typedef struct {
SMBIOS_STRUCTURE Hdr;
- UINT8 InterfaceType; ///< enumeration value from BMC_INTERFACE_TYPE
+ UINT8 InterfaceType; ///< The enumeration value from BMC_INTERFACE_TYPE.
UINT8 IPMISpecificationRevision;
UINT8 I2CSlaveAddress;
UINT8 NVStorageDeviceAddress;
@@ -1985,7 +1985,7 @@ typedef struct { } SMBIOS_TABLE_TYPE38;
///
-/// System Power Supply - Power Supply Characteristics
+/// System Power Supply - Power Supply Characteristics.
///
typedef struct {
UINT16 PowerSupplyHotReplaceable:1;
@@ -1998,7 +1998,7 @@ typedef struct { } SYS_POWER_SUPPLY_CHARACTERISTICS;
///
-/// System Power Supply (Type 39)
+/// System Power Supply (Type 39).
///
/// This structure identifies attributes of a system power supply. One instance
/// of this record is present for each possible power supply in a system.
@@ -2021,7 +2021,7 @@ typedef struct { } SMBIOS_TABLE_TYPE39;
///
-/// Additional Information Entry Format
+/// Additional Information Entry Format.
///
typedef struct {
UINT8 EntryLength;
@@ -2032,7 +2032,7 @@ typedef struct { }ADDITIONAL_INFORMATION_ENTRY;
///
-/// Additional Information (Type 40)
+/// Additional Information (Type 40).
///
/// This structure is intended to provide additional information for handling unspecified
/// enumerated values and interim field updates in another structure.
@@ -2044,7 +2044,7 @@ typedef struct { } SMBIOS_TABLE_TYPE40;
///
-/// Onboard Devices Extended Information - Onboard Device Types
+/// Onboard Devices Extended Information - Onboard Device Types.
///
typedef enum{
OnBoardDeviceExtendedTypeOther = 0x01,
@@ -2060,7 +2060,7 @@ typedef enum{ } ONBOARD_DEVICE_EXTENDED_INFO_TYPE;
///
-/// Onboard Devices Extended Information (Type 41)
+/// Onboard Devices Extended Information (Type 41).
///
/// The information in this structure defines the attributes of devices that
/// are onboard (soldered onto) a system element, usually the baseboard.
@@ -2070,7 +2070,7 @@ typedef enum{ typedef struct {
SMBIOS_STRUCTURE Hdr;
SMBIOS_TABLE_STRING ReferenceDesignation;
- UINT8 DeviceType; ///< enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE
+ UINT8 DeviceType; ///< The enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE
UINT8 DeviceTypeInstance;
UINT16 SegmentGroupNum;
UINT8 BusNum;
@@ -2092,7 +2092,7 @@ typedef struct { } SMBIOS_TABLE_TYPE127;
///
-/// Union of all the possible SMBIOS record types
+/// Union of all the possible SMBIOS record types.
///
typedef union {
SMBIOS_STRUCTURE *Hdr;
|