[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 - 2008, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
**/\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
42eedea9	1	/** @file \r
ee6c452c	2	ACPI Alert Standard Format Description Table ASF! as described in the ASF2.0 Specification\r
568eb0cb	3	\r
9df063a0 HT	4	Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
9df063a0 HT	5	This program and the accompanying materials \r
568eb0cb	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	**/\r
	13	\r
67e66cd5	14	#ifndef _ALERT_STANDARD_FORMAT_TABLE_H_\r
67e66cd5	15	#define _ALERT_STANDARD_FORMAT_TABLE_H_\r
568eb0cb	16	\r
ecc40942	17	#include <IndustryStandard/Acpi.h>\r
568eb0cb	18	\r
766f4bc1	19	//\r
	20	// Ensure proper structure formats\r
	21	//\r
	22	#pragma pack (1)\r
	23	\r
1bc5d021	24	///\r
	25	/// Information Record header that appears at the beginning of each record\r
	26	///\r
568eb0cb	27	typedef struct {\r
	28	UINT8 Type;\r
	29	UINT8 Reserved;\r
	30	UINT16 RecordLength;\r
	31	} EFI_ACPI_ASF_RECORD_HEADER;\r
	32	\r
1bc5d021	33	///\r
	34	/// This structure contains information that identifies the system's type \r
	35	/// and configuration\r
	36	///\r
568eb0cb	37	typedef struct {\r
	38	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	39	UINT8 MinWatchDogResetValue;\r
	40	UINT8 MinPollingInterval;\r
	41	UINT16 SystemID;\r
	42	UINT32 IANAManufactureID;\r
	43	UINT8 FeatureFlags;\r
	44	UINT8 Reserved[3];\r
	45	} EFI_ACPI_ASF_INFO;\r
	46	\r
1bc5d021	47	///\r
6981c778	48	/// ASF Alert Data\r
1bc5d021	49	///\r
6981c778	50	typedef struct {\r
	51	UINT8 DeviceAddress;\r
	52	UINT8 Command;\r
	53	UINT8 DataMask;\r
	54	UINT8 CompareValue;\r
	55	UINT8 EventSenseType;\r
	56	UINT8 EventType;\r
	57	UINT8 EventOffset;\r
	58	UINT8 EventSourceType;\r
	59	UINT8 EventSeverity;\r
	60	UINT8 SensorNumber;\r
	61	UINT8 Entity;\r
	62	UINT8 EntityInstance;\r
	63	} EFI_ACPI_ASF_ALERTDATA;\r
568eb0cb	64	\r
6981c778	65	///\r
	66	/// Alert sensors definition\r
	67	///\r
568eb0cb	68	typedef struct {\r
	69	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	70	UINT8 AssertionEventBitMask;\r
	71	UINT8 DeassertionEventBitMask;\r
	72	UINT8 NumberOfAlerts;\r
6981c778	73	UINT8 ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x0C\r
	74	///\r
	75	/// EFI_ACPI_ASF_ALERTDATA DeviceArray[ANYSIZE_ARRAY];\r
	76	///\r
568eb0cb	77	} EFI_ACPI_ASF_ALRT;\r
568eb0cb	78	\r
6981c778	79	///\r
	80	/// Alert Control Data\r
	81	///\r
	82	typedef struct {\r
	83	UINT8 Function;\r
	84	UINT8 DeviceAddress;\r
	85	UINT8 Command;\r
	86	UINT8 DataValue;\r
	87	} EFI_ACPI_ASF_CONTROLDATA; \r
	88	\r
1bc5d021	89	///\r
	90	/// Alert Remote Control System Actions\r
	91	///\r
568eb0cb	92	typedef struct {\r
	93	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	94	UINT8 NumberOfControls;\r
6981c778	95	UINT8 ArrayElementLength; ///< For ASF version 1.0 and later, this filed is set to 0x4\r
568eb0cb	96	UINT16 RctlReserved;\r
6981c778	97	///\r
	98	/// EFI_ACPI_ASF_CONTROLDATA; DeviceArray[ANYSIZE_ARRAY];\r
	99	///\r
568eb0cb	100	} EFI_ACPI_ASF_RCTL;\r
568eb0cb	101	\r
6981c778	102	\r
1bc5d021	103	///\r
	104	/// Remote Control Capabilities\r
	105	///\r
568eb0cb	106	typedef struct {\r
	107	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	108	UINT8 RemoteControlCapabilities[7];\r
	109	UINT8 RMCPCompletionCode;\r
	110	UINT32 RMCPIANA;\r
	111	UINT8 RMCPSpecialCommand;\r
	112	UINT8 RMCPSpecialCommandParameter[2];\r
	113	UINT8 RMCPBootOptions[2];\r
	114	UINT8 RMCPOEMParameters[2];\r
	115	} EFI_ACPI_ASF_RMCP;\r
	116	\r
1bc5d021	117	///\r
	118	/// SMBus Devices with fixed addresses\r
	119	///\r
568eb0cb	120	typedef struct {\r
	121	EFI_ACPI_ASF_RECORD_HEADER RecordHeader;\r
	122	UINT8 SEEPROMAddress;\r
	123	UINT8 NumberOfDevices;\r
6981c778	124	///\r
	125	/// UINT8 FixedSmbusAddresses[ANYSIZE_ARRAY];\r
	126	///\r
568eb0cb	127	} EFI_ACPI_ASF_ADDR;\r
568eb0cb	128	\r
6981c778	129	///\r
	130	/// ASF! Description Table Header\r
	131	///\r
	132	typedef EFI_ACPI_DESCRIPTION_HEADER EFI_ACPI_ASF_DESCRIPTION_HEADER;\r
	133	\r
	134	///\r
	135	/// The revision stored in ASF! DESCRIPTION TABLE as BCD value\r
	136	///\r
	137	#define EFI_ACPI_2_0_ASF_DESCRIPTION_TABLE_REVISION 0x20\r
568eb0cb	138	\r
1bc5d021	139	///\r
	140	/// "ASF!" ASF Description Table Signature\r
	141	///\r
13c31065	142	#define EFI_ACPI_ASF_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32 ('A', 'S', 'F', '!')\r
568eb0cb	143	\r
766f4bc1	144	#pragma pack ()\r
	145	\r
	146	#endif // _ALERT_STANDARD_FORMAT_TABLE_H\r