[mirror_edk2.git] / MdePkg / Include / IndustryStandard / AlertStandardFormatTable.h

/** @file\r
  ACPI Alert Standard Format Description Table ASF! as described in the ASF2.0 Specification\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef _ALERT_STANDARD_FORMAT_TABLE_H_\r
#define _ALERT_STANDARD_FORMAT_TABLE_H_\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
//\r
// Ensure proper structure formats\r
//\r
#pragma pack (1)\r
\r
///\r
/// Information Record header that appears at the beginning of each record\r
///\r
typedef struct {\r
  UINT8                                Type;\r
  UINT8                                Reserved;\r
  UINT16                               RecordLength;\r
} EFI_ACPI_ASF_RECORD_HEADER;\r
\r
///\r
/// This structure contains information that identifies the system's type\r
/// and configuration\r
///\r
typedef struct {\r
  EFI_ACPI_ASF_RECORD_HEADER           RecordHeader;\r
  UINT8                                MinWatchDogResetValue;\r
  UINT8                                MinPollingInterval;\r
  UINT16                               SystemID;\r
  UINT32                               IANAManufactureID;\r
  UINT8                                FeatureFlags;\r
  UINT8                                Reserved[3];\r
} EFI_ACPI_ASF_INFO;\r
\r
///\r
/// ASF Alert Data\r
///\r
typedef struct {\r
  UINT8                                DeviceAddress;\r
  UINT8                                Command;\r
  UINT8                                DataMask;\r
  UINT8                                CompareValue;\r
  UINT8                                EventSenseType;\r
  UINT8                                EventType;\r
  UINT8                                EventOffset;\r
  UINT8                                EventSourceType;\r
  UINT8                                EventSeverity;\r
  UINT8                                SensorNumber;\r
  UINT8                                Entity;\r
  UINT8                                EntityInstance;\r
} EFI_ACPI_ASF_ALERTDATA;\r
\r
///\r
/// Alert sensors definition\r
///\r
typedef struct {\r
  EFI_ACPI_ASF_RECORD_HEADER           RecordHeader;\r
  UINT8                                AssertionEventBitMask;\r
  UINT8                                DeassertionEventBitMask;\r
  UINT8                                NumberOfAlerts;\r
  UINT8                                ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x0C\r
  ///\r
  /// EFI_ACPI_ASF_ALERTDATA           DeviceArray[ANYSIZE_ARRAY];\r
  ///\r
} EFI_ACPI_ASF_ALRT;\r
\r
///\r
/// Alert Control Data\r
///\r
typedef struct {\r
  UINT8                                Function;\r
  UINT8                                DeviceAddress;\r
  UINT8                                Command;\r
  UINT8                                DataValue;\r
} EFI_ACPI_ASF_CONTROLDATA;\r
\r
///\r
/// Alert Remote Control System Actions\r
///\r
typedef struct {\r
  EFI_ACPI_ASF_RECORD_HEADER           RecordHeader;\r
  UINT8                                NumberOfControls;\r
  UINT8                                ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x4\r
  UINT16                               RctlReserved;\r
  ///\r
  /// EFI_ACPI_ASF_CONTROLDATA;        DeviceArray[ANYSIZE_ARRAY];\r
  ///\r
} EFI_ACPI_ASF_RCTL;\r
\r
\r
///\r
/// Remote Control Capabilities\r
///\r
typedef struct {\r
  EFI_ACPI_ASF_RECORD_HEADER           RecordHeader;\r
  UINT8                                RemoteControlCapabilities[7];\r
  UINT8                                RMCPCompletionCode;\r
  UINT32                               RMCPIANA;\r
  UINT8                                RMCPSpecialCommand;\r
  UINT8                                RMCPSpecialCommandParameter[2];\r
  UINT8                                RMCPBootOptions[2];\r
  UINT8                                RMCPOEMParameters[2];\r
} EFI_ACPI_ASF_RMCP;\r
\r
///\r
/// SMBus Devices with fixed addresses\r
///\r
typedef struct {\r
  EFI_ACPI_ASF_RECORD_HEADER           RecordHeader;\r
  UINT8                                SEEPROMAddress;\r
  UINT8                                NumberOfDevices;\r
  ///\r
  /// UINT8                            FixedSmbusAddresses[ANYSIZE_ARRAY];\r
  ///\r
} EFI_ACPI_ASF_ADDR;\r
\r
///\r
/// ASF! Description Table Header\r
///\r
typedef EFI_ACPI_DESCRIPTION_HEADER EFI_ACPI_ASF_DESCRIPTION_HEADER;\r
\r
///\r
/// The revision stored in ASF! DESCRIPTION TABLE as BCD value\r
///\r
#define EFI_ACPI_2_0_ASF_DESCRIPTION_TABLE_REVISION   0x20\r
\r
///\r
/// "ASF!" ASF Description Table Signature\r
///\r
#define EFI_ACPI_ASF_DESCRIPTION_TABLE_SIGNATURE  SIGNATURE_32 ('A', 'S', 'F', '!')\r
\r
#pragma pack ()\r
\r
#endif // _ALERT_STANDARD_FORMAT_TABLE_H\r
Commit	Line	Data
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
568eb0cb	7	\r
67e66cd5	8	#ifndef _ALERT_STANDARD_FORMAT_TABLE_H_\r
67e66cd5	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	21	typedef struct {\r
	22	UINT8 Type;\r
	23	UINT8 Reserved;\r
	24	UINT16 RecordLength;\r
	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
1bc5d021	30	///\r
568eb0cb	31	typedef struct {\r
	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
	39	} EFI_ACPI_ASF_INFO;\r
	40	\r
1bc5d021	41	///\r
6981c778	42	/// ASF Alert Data\r
1bc5d021	43	///\r
6981c778	44	typedef struct {\r
	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
	57	} EFI_ACPI_ASF_ALERTDATA;\r
568eb0cb	58	\r
6981c778	59	///\r
	60	/// Alert sensors definition\r
	61	///\r
568eb0cb	62	typedef struct {\r
	63	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	64	UINT8 AssertionEventBitMask;\r
	65	UINT8 DeassertionEventBitMask;\r
	66	UINT8 NumberOfAlerts;\r
6981c778	67	UINT8 ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x0C\r
	68	///\r
	69	/// EFI_ACPI_ASF_ALERTDATA DeviceArray[ANYSIZE_ARRAY];\r
	70	///\r
568eb0cb	71	} EFI_ACPI_ASF_ALRT;\r
568eb0cb	72	\r
6981c778	73	///\r
	74	/// Alert Control Data\r
	75	///\r
	76	typedef struct {\r
	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	86	typedef struct {\r
	87	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	88	UINT8 NumberOfControls;\r
6981c778	89	UINT8 ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x4\r
568eb0cb	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
568eb0cb	95	\r
6981c778	96	\r
1bc5d021	97	///\r
	98	/// Remote Control Capabilities\r
	99	///\r
568eb0cb	100	typedef struct {\r
	101	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	102	UINT8 RemoteControlCapabilities[7];\r
	103	UINT8 RMCPCompletionCode;\r
	104	UINT32 RMCPIANA;\r
	105	UINT8 RMCPSpecialCommand;\r
	106	UINT8 RMCPSpecialCommandParameter[2];\r
	107	UINT8 RMCPBootOptions[2];\r
	108	UINT8 RMCPOEMParameters[2];\r
	109	} EFI_ACPI_ASF_RMCP;\r
	110	\r
1bc5d021	111	///\r
	112	/// SMBus Devices with fixed addresses\r
	113	///\r
568eb0cb	114	typedef struct {\r
	115	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	116	UINT8 SEEPROMAddress;\r
	117	UINT8 NumberOfDevices;\r
6981c778	118	///\r
	119	/// UINT8 FixedSmbusAddresses[ANYSIZE_ARRAY];\r
	120	///\r
568eb0cb	121	} EFI_ACPI_ASF_ADDR;\r
568eb0cb	122	\r
6981c778	123	///\r
	124	/// ASF! Description Table Header\r
	125	///\r
	126	typedef EFI_ACPI_DESCRIPTION_HEADER EFI_ACPI_ASF_DESCRIPTION_HEADER;\r
	127	\r
	128	///\r
	129	/// The revision stored in ASF! DESCRIPTION TABLE as BCD value\r
	130	///\r
	131	#define EFI_ACPI_2_0_ASF_DESCRIPTION_TABLE_REVISION 0x20\r
568eb0cb	132	\r
1bc5d021	133	///\r
	134	/// "ASF!" ASF Description Table Signature\r
	135	///\r
13c31065	136	#define EFI_ACPI_ASF_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32 ('A', 'S', 'F', '!')\r
568eb0cb	137	\r
766f4bc1	138	#pragma pack ()\r
	139	\r
	140	#endif // _ALERT_STANDARD_FORMAT_TABLE_H\r