MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / HighPrecisionEventTimerTable.h

/** @file\r
  ACPI high precision event timer table definition, at www.intel.com\r
  Specification name is IA-PC HPET (High Precision Event Timers) Specification.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef _HIGH_PRECISION_EVENT_TIMER_TABLE_H_\r
#define _HIGH_PRECISION_EVENT_TIMER_TABLE_H_\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
//\r
// Ensure proper structure formats\r
//\r
#pragma pack(1)\r
\r
///\r
/// HPET Event Timer Block ID described in IA-PC HPET Specification, 3.2.4.\r
///\r
typedef union {\r
  struct {\r
    UINT32 Revision       : 8;\r
    UINT32 NumberOfTimers : 5;\r
    UINT32 CounterSize    : 1;\r
    UINT32 Reserved       : 1;\r
    UINT32 LegacyRoute    : 1;\r
    UINT32 VendorId       : 16;\r
  }      Bits;\r
  UINT32 Uint32;\r
} EFI_ACPI_HIGH_PRECISION_EVENT_TIMER_BLOCK_ID;\r
\r
\r
///\r
/// High Precision Event Timer Table header definition.\r
///\r
typedef struct {\r
  EFI_ACPI_DESCRIPTION_HEADER             Header;\r
  UINT32                                  EventTimerBlockId;\r
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE  BaseAddressLower32Bit;\r
  UINT8                                   HpetNumber;\r
  UINT16                                  MainCounterMinimumClockTickInPeriodicMode;\r
  UINT8                                   PageProtectionAndOemAttribute;\r
} EFI_ACPI_HIGH_PRECISION_EVENT_TIMER_TABLE_HEADER;\r
\r
///\r
/// HPET Revision (defined in spec)\r
///\r
#define EFI_ACPI_HIGH_PRECISION_EVENT_TIMER_TABLE_REVISION  0x01\r
\r
//\r
// Page protection setting\r
// Values 3 through 15 are reserved for use by the specification\r
//\r
#define EFI_ACPI_NO_PAGE_PROTECTION   0\r
#define EFI_ACPI_4KB_PAGE_PROTECTION  1\r
#define EFI_ACPI_64KB_PAGE_PROTECTION 2\r
\r
#pragma pack()\r
\r
#endif\r