MdePkg/Include/IndustryStandard/HighPrecisionEventTimerTable.h

   1 /** @file
   2   ACPI high precision event timer table definition, at www.intel.com
   3   Specification name is IA-PC HPET (High Precision Event Timers) Specification.
   4
   5   Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7 **/
   8
   9 #ifndef _HIGH_PRECISION_EVENT_TIMER_TABLE_H_
  10 #define _HIGH_PRECISION_EVENT_TIMER_TABLE_H_
  11
  12 #include <IndustryStandard/Acpi.h>
  13
  14 //
  15 // Ensure proper structure formats
  16 //
  17 #pragma pack(1)
  18
  19 ///
  20 /// HPET Event Timer Block ID described in IA-PC HPET Specification, 3.2.4.
  21 ///
  22 typedef union {
  23   struct {
  24     UINT32 Revision       : 8;
  25     UINT32 NumberOfTimers : 5;
  26     UINT32 CounterSize    : 1;
  27     UINT32 Reserved       : 1;
  28     UINT32 LegacyRoute    : 1;
  29     UINT32 VendorId       : 16;
  30   }      Bits;
  31   UINT32 Uint32;
  32 } EFI_ACPI_HIGH_PRECISION_EVENT_TIMER_BLOCK_ID;
  33
  34
  35 ///
  36 /// High Precision Event Timer Table header definition.
  37 ///
  38 typedef struct {
  39   EFI_ACPI_DESCRIPTION_HEADER             Header;
  40   UINT32                                  EventTimerBlockId;
  41   EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  BaseAddressLower32Bit;
  42   UINT8                                   HpetNumber;
  43   UINT16                                  MainCounterMinimumClockTickInPeriodicMode;
  44   UINT8                                   PageProtectionAndOemAttribute;
  45 } EFI_ACPI_HIGH_PRECISION_EVENT_TIMER_TABLE_HEADER;
  46
  47 ///
  48 /// HPET Revision (defined in spec)
  49 ///
  50 #define EFI_ACPI_HIGH_PRECISION_EVENT_TIMER_TABLE_REVISION  0x01
  51
  52 //
  53 // Page protection setting
  54 // Values 3 through 15 are reserved for use by the specification
  55 //
  56 #define EFI_ACPI_NO_PAGE_PROTECTION   0
  57 #define EFI_ACPI_4KB_PAGE_PROTECTION  1
  58 #define EFI_ACPI_64KB_PAGE_PROTECTION 2
  59
  60 #pragma pack()
  61
  62 #endif