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

/** \r
	@file   \r
  ACPI Watchdog Resource Table as defined at\r
  Microsoft Hardware Watchdog Timer Specification.\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation\r
  All rights reserved. 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 _WATCHDOG_RESOURCE_TABLE_H_\r
#define _WATCHDOG_RESOURCE_TABLE_H_\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
//\r
// Ensure proper structure formats\r
//\r
#pragma pack(1)\r
//\r
// Watchdog Resource Table definition.\r
//\r
typedef struct {\r
  EFI_ACPI_DESCRIPTION_HEADER             Header;\r
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  ControlRegisterAddress;\r
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  CountRegisterAddress;\r
  UINT16                                  PCIDeviceID;\r
  UINT16                                  PCIVendorID;\r
  UINT8                                   PCIBusNumber;\r
  UINT8                                   PCIDeviceNumber;\r
  UINT8                                   PCIFunctionNumber;\r
  UINT8                                   PCISegment;\r
  UINT16                                  MaxCount;\r
  UINT8                                   Units;\r
} EFI_ACPI_WATCHDOG_RESOURCE_1_0_TABLE;\r
\r
typedef struct {\r
  EFI_ACPI_DESCRIPTION_HEADER             Header;\r
  UINT32                                  WatchdogHeaderLength;\r
  UINT8                                   PCISegment;\r
  UINT8                                   PCIBusNumber;\r
  UINT8                                   PCIDeviceNumber;\r
  UINT8                                   PCIFunctionNumber;\r
  UINT32                                  TimerPeriod;\r
  UINT32                                  MaxCount;\r
  UINT32                                  MinCount;\r
  UINT8                                   WatchdogFlags;  \r
  UINT8                                   Reserved_57[3];  \r
  UINT32                                  NumberWatchdogInstructionEntries;\r
} EFI_ACPI_WATCHDOG_RESOURCE_2_0_TABLE;\r
\r
typedef struct {\r
  UINT8                                   WatchdogAction;\r
  UINT8                                   InstructionFlags;\r
  UINT8                                   Reserved_2;\r
  UINT8                                   RegisterSize;\r
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  RegisterRegion;\r
  UINT32                                  Value;\r
  UINT32                                  Mask;\r
} EFI_ACPI_WATCHDOG_RESOURCE_2_0_WATCHDOG_ACTION_INSTRUCTION_ENTRY;\r
\r
#pragma pack()\r
\r
//\r
// WDRT Revision (defined in spec)\r
//\r
#define EFI_ACPI_WATCHDOG_RESOURCE_1_0_TABLE_REVISION  0x01\r
#define EFI_ACPI_WATCHDOG_RESOURCE_2_0_TABLE_REVISION  0x02\r
\r
//\r
// WDRT 1.0 Count Unit\r
//\r
#define EFI_ACPI_WDRT_1_0_COUNT_UNIT_1_SEC_PER_COUNT        1\r
#define EFI_ACPI_WDRT_1_0_COUNT_UNIT_100_MILLISEC_PER_COUNT 2\r
#define EFI_ACPI_WDRT_1_0_COUNT_UNIT_10_MILLISEC_PER_COUNT  3\r
\r
//\r
// WDRT 2.0 Flags\r
//\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ENABLED                0x1\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_STOPPED_IN_SLEEP_STATE 0x80\r
\r
//\r
// WDRT 2.0 Watchdog Actions\r
//\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_RESET                          0x1\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_CURRENT_COUNTDOWN_PERIOD 0x4\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_COUNTDOWN_PERIOD         0x5\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_COUNTDOWN_PERIOD           0x6\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_RUNNING_STATE            0x8\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_RUNNING_STATE              0x9\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_STOPPED_STATE            0xA\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_STOPPED_STATE              0xB\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_REBOOT                   0x10\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_REBOOT                     0x11\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_SHUTDOWN                 0x12\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_SHUTDOWN                   0x13\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_WATCHDOG_STATUS          0x20\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_WATCHDOG_STATUS            0x21\r
\r
//\r
// WDRT 2.0 Watchdog Action Entry Instruction Flags\r
//\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_READ_VALUE        0x0\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_READ_COUNTDOWN    0x1\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_WRITE_VALUE       0x2\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_WRITE_COUNTDOWN   0x3\r
#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_PRESERVE_REGISTER 0x80\r
\r
#endif\r
Commit	Line	Data
568eb0cb	1	/** \r
	2	@file \r
	3	ACPI Watchdog Resource Table as defined at\r
	4	Microsoft Hardware Watchdog Timer Specification.\r
	5	\r
	6	Copyright (c) 2006 - 2007, Intel Corporation\r
	7	All rights reserved. This program and the accompanying materials \r
	8	are licensed and made available under the terms and conditions of the BSD License \r
	9	which accompanies this distribution. The full text of the license may be found at \r
	10	http://opensource.org/licenses/bsd-license.php \r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	14	**/\r
	15	\r
	16	#ifndef _WATCHDOG_RESOURCE_TABLE_H_\r
	17	#define _WATCHDOG_RESOURCE_TABLE_H_\r
	18	\r
ecc40942	19	#include <IndustryStandard/Acpi.h>\r
568eb0cb	20	\r
	21	//\r
	22	// Ensure proper structure formats\r
	23	//\r
	24	#pragma pack(1)\r
	25	//\r
	26	// Watchdog Resource Table definition.\r
	27	//\r
	28	typedef struct {\r
	29	EFI_ACPI_DESCRIPTION_HEADER Header;\r
	30	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ControlRegisterAddress;\r
	31	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE CountRegisterAddress;\r
	32	UINT16 PCIDeviceID;\r
	33	UINT16 PCIVendorID;\r
	34	UINT8 PCIBusNumber;\r
	35	UINT8 PCIDeviceNumber;\r
	36	UINT8 PCIFunctionNumber;\r
	37	UINT8 PCISegment;\r
	38	UINT16 MaxCount;\r
	39	UINT8 Units;\r
	40	} EFI_ACPI_WATCHDOG_RESOURCE_1_0_TABLE;\r
	41	\r
	42	typedef struct {\r
	43	EFI_ACPI_DESCRIPTION_HEADER Header;\r
	44	UINT32 WatchdogHeaderLength;\r
	45	UINT8 PCISegment;\r
	46	UINT8 PCIBusNumber;\r
	47	UINT8 PCIDeviceNumber;\r
	48	UINT8 PCIFunctionNumber;\r
	49	UINT32 TimerPeriod;\r
	50	UINT32 MaxCount;\r
	51	UINT32 MinCount;\r
	52	UINT8 WatchdogFlags; \r
	53	UINT8 Reserved_57[3]; \r
	54	UINT32 NumberWatchdogInstructionEntries;\r
	55	} EFI_ACPI_WATCHDOG_RESOURCE_2_0_TABLE;\r
	56	\r
	57	typedef struct {\r
	58	UINT8 WatchdogAction;\r
	59	UINT8 InstructionFlags;\r
	60	UINT8 Reserved_2;\r
	61	UINT8 RegisterSize;\r
	62	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;\r
	63	UINT32 Value;\r
	64	UINT32 Mask;\r
	65	} EFI_ACPI_WATCHDOG_RESOURCE_2_0_WATCHDOG_ACTION_INSTRUCTION_ENTRY;\r
	66	\r
	67	#pragma pack()\r
	68	\r
	69	//\r
	70	// WDRT Revision (defined in spec)\r
	71	//\r
	72	#define EFI_ACPI_WATCHDOG_RESOURCE_1_0_TABLE_REVISION 0x01\r
	73	#define EFI_ACPI_WATCHDOG_RESOURCE_2_0_TABLE_REVISION 0x02\r
	74	\r
	75	//\r
	76	// WDRT 1.0 Count Unit\r
	77	//\r
	78	#define EFI_ACPI_WDRT_1_0_COUNT_UNIT_1_SEC_PER_COUNT 1\r
	79	#define EFI_ACPI_WDRT_1_0_COUNT_UNIT_100_MILLISEC_PER_COUNT 2\r
	80	#define EFI_ACPI_WDRT_1_0_COUNT_UNIT_10_MILLISEC_PER_COUNT 3\r
	81	\r
	82	//\r
	83	// WDRT 2.0 Flags\r
84	//\r
85	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ENABLED 0x1\r
86	#define EFI_ACPI_WDRT_2_0_WATCHDOG_STOPPED_IN_SLEEP_STATE 0x80\r
87	\r
88	//\r
89	// WDRT 2.0 Watchdog Actions\r
90	//\r
91	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_RESET 0x1\r
92	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_CURRENT_COUNTDOWN_PERIOD 0x4\r
93	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_COUNTDOWN_PERIOD 0x5\r
94	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_COUNTDOWN_PERIOD 0x6\r
95	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_RUNNING_STATE 0x8\r
96	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_RUNNING_STATE 0x9\r
97	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_STOPPED_STATE 0xA\r
98	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_STOPPED_STATE 0xB\r
f4118ff0	99	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_REBOOT 0x10\r
568eb0cb	100	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_REBOOT 0x11\r
	101	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_SHUTDOWN 0x12\r
	102	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_SHUTDOWN 0x13\r
	103	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_QUERY_WATCHDOG_STATUS 0x20\r
	104	#define EFI_ACPI_WDRT_2_0_WATCHDOG_ACTION_SET_WATCHDOG_STATUS 0x21\r
	105	\r
	106	//\r
	107	// WDRT 2.0 Watchdog Action Entry Instruction Flags\r
	108	//\r
	109	#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_READ_VALUE 0x0\r
	110	#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_READ_COUNTDOWN 0x1\r
	111	#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_WRITE_VALUE 0x2\r
	112	#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_WRITE_COUNTDOWN 0x3\r
	113	#define EFI_ACPI_WDRT_2_0_WATCHDOG_INSTRUCTION_PRESERVE_REGISTER 0x80\r
	114	\r
	115	#endif\r