EdkCompatibilityPkg/Foundation/Include/IndustryStandard/WatchdogDescriptionTable.h

   1 /*++
   2
   3 Copyright (c) 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   WatchdogDescriptionTable.h
  15
  16 Abstract:
  17
  18   ACPI Watchdog Description Table as defined in Intel
  19   ICH Family Watchdog Timer (WDT) Application Note (AP-725)
  20
  21 --*/
  22
  23 #ifndef _WATCH_DOG_DESCRIPTION_TABLE_H_
  24 #define _WATCH_DOG_DESCRIPTION_TABLE_H_
  25
  26 //
  27 // Include files
  28 //
  29 #include "Acpi2_0.h"
  30
  31 //
  32 // Ensure proper structure formats
  33 //
  34 #pragma pack(1)
  35 //
  36 // WDDT structure
  37 //
  38 typedef struct {
  39   EFI_ACPI_DESCRIPTION_HEADER             Header;
  40   UINT16                                  SpecVersion;
  41   UINT16                                  TableVersion;
  42   UINT16                                  Vid;
  43   EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  BaseAddress;
  44   UINT16                                  TimerMaxCount;
  45   UINT16                                  TimerMinCount;
  46   UINT16                                  TimerCountPeriod;
  47   UINT16                                  Status;
  48   UINT16                                  Capability;
  49 } EFI_ACPI_1_0_WATCH_DOG_DESCRIPTION_TABLE;
  50
  51 //
  52 // "WDDT" Watchdog Description Table signatures
  53 //
  54 #define EFI_ACPI_1_0_WDDT_SIGNATURE 0x54444457
  55
  56 #pragma pack()
  57
  58 //
  59 // WDDT Revision
  60 //
  61 #define EFI_ACPI_WATCHDOG_DESCRIPTION_1_0_TABLE_REVISION  0x01
  62
  63 //
  64 // WDDT Spec Version
  65 //
  66 #define EFI_ACPI_WDDT_SPEC_1_0_VERSION                0x01
  67
  68 //
  69 // WDDT Description Table Version
  70 //
  71 #define EFI_ACPI_WDDT_TABLE_1_0_VERSION               0x01
  72
  73 //
  74 // WDT Status
  75 //
  76 #define EFI_ACPI_WDDT_STATUS_AVAILABLE             0x0001
  77 #define EFI_ACPI_WDDT_STATUS_ACTIVE                0x0002
  78 #define EFI_ACPI_WDDT_STATUS_OWNED_BY_BIOS         0x0000
  79 #define EFI_ACPI_WDDT_STATUS_OWNED_BY_OS           0x0004
  80 #define EFI_ACPI_WDDT_STATUS_USER_RESET_EVENT      0x0800
  81 #define EFI_ACPI_WDDT_STATUS_WDT_EVENT             0x1000
  82 #define EFI_ACPI_WDDT_STATUS_POWER_FAIL_EVENT      0x2000
  83 #define EFI_ACPI_WDDT_STATUS_UNKNOWN_RESET_EVENT   0x4000
  84
  85 //
  86 // WDT Capability
  87 //
  88 #define EFI_ACPI_WDDT_CAPABILITY_AUTO_RESET            0x0001
  89 #define EFI_ACPI_WDDT_CAPABILITY_ALERT_SUPPORT         0x0002
  90 #define EFI_ACPI_WDDT_CAPABILITY_PLATFORM_SHUTDOWN     0x0004
  91 #define EFI_ACPI_WDDT_CAPABILITY_IMMEDIATE_SHUTDOWN    0x0008
  92 #define EFI_ACPI_WDDT_CAPABILITY_BIOS_HANDOFF_SUPPORT  0x0010
  93
  94 #endif