MdePkg/Include/IndustryStandard/WatchdogActionTable.h

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