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

/** @file   \r
  ACPI Watchdog Action Table (WADT) as defined at\r
  Microsoft Hardware Watchdog Timers Design Specification.\r
\r
  Copyright (c) 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
\r
#ifndef _WATCHDOG_ACTION_TABLE_H_\r
#define _WATCHDOG_ACTION_TABLE_H_\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
//\r
// Ensure proper structure formats\r
//\r
#pragma pack(1)\r
///\r
/// Watchdog Action Table definition.\r
///\r
typedef struct {\r
  EFI_ACPI_DESCRIPTION_HEADER             Header;\r
  UINT32                                  WatchdogHeaderLength;\r
  UINT16                                  PCISegment;\r
  UINT8                                   PCIBusNumber;\r
  UINT8                                   PCIDeviceNumber;\r
  UINT8                                   PCIFunctionNumber;\r
  UINT8                                   Reserved_45[3];\r
  UINT32                                  TimerPeriod;\r
  UINT32                                  MaxCount;\r
  UINT32                                  MinCount;\r
  UINT8                                   WatchdogFlags;  \r
  UINT8                                   Reserved_61[3];  \r
  UINT32                                  NumberWatchdogInstructionEntries;\r
} EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE;\r
\r
///\r
/// Watchdog Instruction Entries\r
///\r
typedef struct {\r
  UINT8                                   WatchdogAction;\r
  UINT8                                   InstructionFlags;\r
  UINT8                                   Reserved_2[2];\r
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  RegisterRegion;\r
  UINT32                                  Value;\r
  UINT32                                  Mask;\r
} EFI_ACPI_WATCHDOG_ACTION_1_0_WATCHDOG_ACTION_INSTRUCTION_ENTRY;\r
\r
#pragma pack()\r
\r
///\r
/// WDAT Revision (defined in spec)\r
///\r
#define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION       0x01\r
\r
//\r
// WDAT 1.0 Flags\r
//\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ENABLED                0x1\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_STOPPED_IN_SLEEP_STATE 0x80\r
\r
//\r
// WDAT 1.0 Watchdog Actions\r
//\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_RESET                          0x1\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_CURRENT_COUNTDOWN_PERIOD 0x4\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_COUNTDOWN_PERIOD         0x5\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_COUNTDOWN_PERIOD           0x6\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_RUNNING_STATE            0x8\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_RUNNING_STATE              0x9\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_STOPPED_STATE            0xA\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_STOPPED_STATE              0xB\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_REBOOT                   0x10\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_REBOOT                     0x11\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_SHUTDOWN                 0x12\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_SHUTDOWN                   0x13\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_WATCHDOG_STATUS          0x20\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_WATCHDOG_STATUS            0x21\r
\r
//\r
// WDAT 1.0 Watchdog Action Entry Instruction Flags\r
//\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_READ_VALUE        0x0\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_READ_COUNTDOWN    0x1\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_WRITE_VALUE       0x2\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_WRITE_COUNTDOWN   0x3\r
#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_PRESERVE_REGISTER 0x80\r
\r
#endif\r
Commit	Line	Data
42eedea9	1	/** @file \r
4135253b	2	ACPI Watchdog Action Table (WADT) as defined at\r
427987f5	3	Microsoft Hardware Watchdog Timers Design Specification.\r
c8c92c8d	4	\r
9df063a0 HT	5	Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>\r
9df063a0 HT	6	This program and the accompanying materials \r
c8c92c8d	7	are licensed and made available under the terms and conditions of the BSD License \r
	8	which accompanies this distribution. The full text of the license may be found at \r
	9	http://opensource.org/licenses/bsd-license.php \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	13	**/\r
	14	\r
	15	\r
	16	#ifndef _WATCHDOG_ACTION_TABLE_H_\r
	17	#define _WATCHDOG_ACTION_TABLE_H_\r
	18	\r
	19	#include <IndustryStandard/Acpi.h>\r
	20	\r
766f4bc1	21	//\r
	22	// Ensure proper structure formats\r
	23	//\r
	24	#pragma pack(1)\r
1bc5d021	25	///\r
	26	/// Watchdog Action Table definition.\r
	27	///\r
c8c92c8d	28	typedef struct {\r
	29	EFI_ACPI_DESCRIPTION_HEADER Header;\r
	30	UINT32 WatchdogHeaderLength;\r
	31	UINT16 PCISegment;\r
	32	UINT8 PCIBusNumber;\r
	33	UINT8 PCIDeviceNumber;\r
	34	UINT8 PCIFunctionNumber;\r
	35	UINT8 Reserved_45[3];\r
	36	UINT32 TimerPeriod;\r
	37	UINT32 MaxCount;\r
	38	UINT32 MinCount;\r
	39	UINT8 WatchdogFlags; \r
	40	UINT8 Reserved_61[3]; \r
	41	UINT32 NumberWatchdogInstructionEntries;\r
	42	} EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE;\r
	43	\r
4135253b	44	///\r
	45	/// Watchdog Instruction Entries\r
	46	///\r
c8c92c8d	47	typedef struct {\r
	48	UINT8 WatchdogAction;\r
	49	UINT8 InstructionFlags;\r
	50	UINT8 Reserved_2[2];\r
	51	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;\r
	52	UINT32 Value;\r
	53	UINT32 Mask;\r
	54	} EFI_ACPI_WATCHDOG_ACTION_1_0_WATCHDOG_ACTION_INSTRUCTION_ENTRY;\r
	55	\r
766f4bc1	56	#pragma pack()\r
766f4bc1	57	\r
1bc5d021	58	///\r
	59	/// WDAT Revision (defined in spec)\r
	60	///\r
373b5cf9	61	#define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION 0x01\r
c8c92c8d	62	\r
4135253b	63	//\r
	64	// WDAT 1.0 Flags\r
	65	//\r
c8c92c8d	66	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ENABLED 0x1\r
	67	#define EFI_ACPI_WDAT_1_0_WATCHDOG_STOPPED_IN_SLEEP_STATE 0x80\r
	68	\r
	69	//\r
	70	// WDAT 1.0 Watchdog Actions\r
	71	//\r
	72	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_RESET 0x1\r
	73	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_CURRENT_COUNTDOWN_PERIOD 0x4\r
	74	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_COUNTDOWN_PERIOD 0x5\r
	75	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_COUNTDOWN_PERIOD 0x6\r
	76	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_RUNNING_STATE 0x8\r
	77	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_RUNNING_STATE 0x9\r
	78	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_STOPPED_STATE 0xA\r
	79	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_STOPPED_STATE 0xB\r
	80	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_REBOOT 0x10\r
	81	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_REBOOT 0x11\r
	82	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_SHUTDOWN 0x12\r
	83	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_SHUTDOWN 0x13\r
	84	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_WATCHDOG_STATUS 0x20\r
	85	#define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_WATCHDOG_STATUS 0x21\r
	86	\r
	87	//\r
	88	// WDAT 1.0 Watchdog Action Entry Instruction Flags\r
	89	//\r
	90	#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_READ_VALUE 0x0\r
	91	#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_READ_COUNTDOWN 0x1\r
	92	#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_WRITE_VALUE 0x2\r
	93	#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_WRITE_COUNTDOWN 0x3\r
	94	#define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_PRESERVE_REGISTER 0x80\r
	95	\r
	96	#endif\r