MdePkg/Include/IndustryStandard/WatchdogActionTable.h

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