]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/AlertStandardFormatTable.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / AlertStandardFormatTable.h
CommitLineData
9095d37b 1/** @file\r
ee6c452c 2 ACPI Alert Standard Format Description Table ASF! as described in the ASF2.0 Specification\r
568eb0cb 3\r
9095d37b 4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9344f092 5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
568eb0cb 6**/\r
7\r
67e66cd5 8#ifndef _ALERT_STANDARD_FORMAT_TABLE_H_\r
9#define _ALERT_STANDARD_FORMAT_TABLE_H_\r
568eb0cb 10\r
ecc40942 11#include <IndustryStandard/Acpi.h>\r
568eb0cb 12\r
766f4bc1 13//\r
14// Ensure proper structure formats\r
15//\r
16#pragma pack (1)\r
17\r
1bc5d021 18///\r
19/// Information Record header that appears at the beginning of each record\r
20///\r
568eb0cb 21typedef struct {\r
2f88bd3a
MK
22 UINT8 Type;\r
23 UINT8 Reserved;\r
24 UINT16 RecordLength;\r
568eb0cb 25} EFI_ACPI_ASF_RECORD_HEADER;\r
26\r
1bc5d021 27///\r
9095d37b 28/// This structure contains information that identifies the system's type\r
1bc5d021 29/// and configuration\r
30///\r
568eb0cb 31typedef struct {\r
2f88bd3a
MK
32 EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
33 UINT8 MinWatchDogResetValue;\r
34 UINT8 MinPollingInterval;\r
35 UINT16 SystemID;\r
36 UINT32 IANAManufactureID;\r
37 UINT8 FeatureFlags;\r
38 UINT8 Reserved[3];\r
568eb0cb 39} EFI_ACPI_ASF_INFO;\r
40\r
1bc5d021 41///\r
6981c778 42/// ASF Alert Data\r
1bc5d021 43///\r
6981c778 44typedef struct {\r
2f88bd3a
MK
45 UINT8 DeviceAddress;\r
46 UINT8 Command;\r
47 UINT8 DataMask;\r
48 UINT8 CompareValue;\r
49 UINT8 EventSenseType;\r
50 UINT8 EventType;\r
51 UINT8 EventOffset;\r
52 UINT8 EventSourceType;\r
53 UINT8 EventSeverity;\r
54 UINT8 SensorNumber;\r
55 UINT8 Entity;\r
56 UINT8 EntityInstance;\r
6981c778 57} EFI_ACPI_ASF_ALERTDATA;\r
568eb0cb 58\r
6981c778 59///\r
60/// Alert sensors definition\r
61///\r
568eb0cb 62typedef struct {\r
2f88bd3a
MK
63 EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
64 UINT8 AssertionEventBitMask;\r
65 UINT8 DeassertionEventBitMask;\r
66 UINT8 NumberOfAlerts;\r
67 UINT8 ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x0C\r
6981c778 68 ///\r
69 /// EFI_ACPI_ASF_ALERTDATA DeviceArray[ANYSIZE_ARRAY];\r
70 ///\r
568eb0cb 71} EFI_ACPI_ASF_ALRT;\r
72\r
6981c778 73///\r
74/// Alert Control Data\r
75///\r
76typedef struct {\r
2f88bd3a
MK
77 UINT8 Function;\r
78 UINT8 DeviceAddress;\r
79 UINT8 Command;\r
80 UINT8 DataValue;\r
9095d37b 81} EFI_ACPI_ASF_CONTROLDATA;\r
6981c778 82\r
1bc5d021 83///\r
84/// Alert Remote Control System Actions\r
85///\r
568eb0cb 86typedef struct {\r
2f88bd3a
MK
87 EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
88 UINT8 NumberOfControls;\r
89 UINT8 ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x4\r
90 UINT16 RctlReserved;\r
6981c778 91 ///\r
92 /// EFI_ACPI_ASF_CONTROLDATA; DeviceArray[ANYSIZE_ARRAY];\r
93 ///\r
568eb0cb 94} EFI_ACPI_ASF_RCTL;\r
95\r
1bc5d021 96///\r
97/// Remote Control Capabilities\r
98///\r
568eb0cb 99typedef struct {\r
2f88bd3a
MK
100 EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
101 UINT8 RemoteControlCapabilities[7];\r
102 UINT8 RMCPCompletionCode;\r
103 UINT32 RMCPIANA;\r
104 UINT8 RMCPSpecialCommand;\r
105 UINT8 RMCPSpecialCommandParameter[2];\r
106 UINT8 RMCPBootOptions[2];\r
107 UINT8 RMCPOEMParameters[2];\r
568eb0cb 108} EFI_ACPI_ASF_RMCP;\r
109\r
1bc5d021 110///\r
111/// SMBus Devices with fixed addresses\r
112///\r
568eb0cb 113typedef struct {\r
2f88bd3a
MK
114 EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
115 UINT8 SEEPROMAddress;\r
116 UINT8 NumberOfDevices;\r
6981c778 117 ///\r
118 /// UINT8 FixedSmbusAddresses[ANYSIZE_ARRAY];\r
119 ///\r
568eb0cb 120} EFI_ACPI_ASF_ADDR;\r
121\r
6981c778 122///\r
123/// ASF! Description Table Header\r
124///\r
125typedef EFI_ACPI_DESCRIPTION_HEADER EFI_ACPI_ASF_DESCRIPTION_HEADER;\r
126\r
127///\r
128/// The revision stored in ASF! DESCRIPTION TABLE as BCD value\r
129///\r
2f88bd3a 130#define EFI_ACPI_2_0_ASF_DESCRIPTION_TABLE_REVISION 0x20\r
568eb0cb 131\r
1bc5d021 132///\r
133/// "ASF!" ASF Description Table Signature\r
134///\r
13c31065 135#define EFI_ACPI_ASF_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32 ('A', 'S', 'F', '!')\r
568eb0cb 136\r
766f4bc1 137#pragma pack ()\r
138\r
139#endif // _ALERT_STANDARD_FORMAT_TABLE_H\r