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 - 2018, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7 **/
   8
   9 #ifndef _WATCHDOG_ACTION_TABLE_H_
  10 #define _WATCHDOG_ACTION_TABLE_H_
  11
  12 #include <IndustryStandard/Acpi.h>
  13
  14 //
  15 // Ensure proper structure formats
  16 //
  17 #pragma pack(1)
  18 ///
  19 /// Watchdog Action Table definition.
  20 ///
  21 typedef struct {
  22   EFI_ACPI_DESCRIPTION_HEADER    Header;
  23   UINT32                         WatchdogHeaderLength;
  24   UINT16                         PCISegment;
  25   UINT8                          PCIBusNumber;
  26   UINT8                          PCIDeviceNumber;
  27   UINT8                          PCIFunctionNumber;
  28   UINT8                          Reserved_45[3];
  29   UINT32                         TimerPeriod;
  30   UINT32                         MaxCount;
  31   UINT32                         MinCount;
  32   UINT8                          WatchdogFlags;
  33   UINT8                          Reserved_61[3];
  34   UINT32                         NumberWatchdogInstructionEntries;
  35 } EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE;
  36
  37 ///
  38 /// Watchdog Instruction Entries
  39 ///
  40 typedef struct {
  41   UINT8                                     WatchdogAction;
  42   UINT8                                     InstructionFlags;
  43   UINT8                                     Reserved_2[2];
  44   EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    RegisterRegion;
  45   UINT32                                    Value;
  46   UINT32                                    Mask;
  47 } EFI_ACPI_WATCHDOG_ACTION_1_0_WATCHDOG_ACTION_INSTRUCTION_ENTRY;
  48
  49 #pragma pack()
  50
  51 ///
  52 /// WDAT Revision (defined in spec)
  53 ///
  54 #define EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE_REVISION  0x01
  55
  56 //
  57 // WDAT 1.0 Flags
  58 //
  59 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ENABLED                 0x1
  60 #define EFI_ACPI_WDAT_1_0_WATCHDOG_STOPPED_IN_SLEEP_STATE  0x80
  61
  62 //
  63 // WDAT 1.0 Watchdog Actions
  64 //
  65 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_RESET                           0x1
  66 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_CURRENT_COUNTDOWN_PERIOD  0x4
  67 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_COUNTDOWN_PERIOD          0x5
  68 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_COUNTDOWN_PERIOD            0x6
  69 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_RUNNING_STATE             0x8
  70 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_RUNNING_STATE               0x9
  71 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_STOPPED_STATE             0xA
  72 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_STOPPED_STATE               0xB
  73 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_REBOOT                    0x10
  74 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_REBOOT                      0x11
  75 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_SHUTDOWN                  0x12
  76 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_SHUTDOWN                    0x13
  77 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_QUERY_WATCHDOG_STATUS           0x20
  78 #define EFI_ACPI_WDAT_1_0_WATCHDOG_ACTION_SET_WATCHDOG_STATUS             0x21
  79
  80 //
  81 // WDAT 1.0 Watchdog Action Entry Instruction Flags
  82 //
  83 #define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_READ_VALUE         0x0
  84 #define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_READ_COUNTDOWN     0x1
  85 #define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_WRITE_VALUE        0x2
  86 #define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_WRITE_COUNTDOWN    0x3
  87 #define EFI_ACPI_WDAT_1_0_WATCHDOG_INSTRUCTION_PRESERVE_REGISTER  0x80
  88
  89 #endif