mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
963162cab0
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
105 lines
2.9 KiB
C
105 lines
2.9 KiB
C
/** @file
|
|
HPET register definitions from the IA-PC HPET (High Precision Event Timers)
|
|
Specification, Revision 1.0a, October 2004.
|
|
|
|
PRM Module Note:
|
|
This specific header was copied from PcAtChipsetPkg to avoid a module dependency on the package
|
|
just for this header. This is done for temporary testing purposes of the PRM module.
|
|
|
|
Copyright (c) Microsoft Corporation
|
|
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define HPET_BASE_ADDRESS 0xFED00000
|
|
#define HPET_RANGE_LENGTH 0x1000
|
|
|
|
///
|
|
/// HPET General Register Offsets
|
|
///
|
|
#define HPET_GENERAL_CAPABILITIES_ID_OFFSET 0x000
|
|
#define HPET_GENERAL_CONFIGURATION_OFFSET 0x010
|
|
#define HPET_GENERAL_INTERRUPT_STATUS_OFFSET 0x020
|
|
|
|
///
|
|
/// HPET Timer Register Offsets
|
|
///
|
|
#define HPET_MAIN_COUNTER_OFFSET 0x0F0
|
|
#define HPET_TIMER_CONFIGURATION_OFFSET 0x100
|
|
#define HPET_TIMER_COMPARATOR_OFFSET 0x108
|
|
#define HPET_TIMER_MSI_ROUTE_OFFSET 0x110
|
|
|
|
///
|
|
/// Stride between sets of HPET Timer Registers
|
|
///
|
|
#define HPET_TIMER_STRIDE 0x20
|
|
|
|
#pragma pack(1)
|
|
|
|
///
|
|
/// HPET General Capabilities and ID Register
|
|
///
|
|
typedef union {
|
|
struct {
|
|
UINT32 Revision : 8;
|
|
UINT32 NumberOfTimers : 5;
|
|
UINT32 CounterSize : 1;
|
|
UINT32 Reserved0 : 1;
|
|
UINT32 LegacyRoute : 1;
|
|
UINT32 VendorId : 16;
|
|
UINT32 CounterClockPeriod : 32;
|
|
} Bits;
|
|
UINT64 Uint64;
|
|
} HPET_GENERAL_CAPABILITIES_ID_REGISTER;
|
|
|
|
///
|
|
/// HPET General Configuration Register
|
|
///
|
|
typedef union {
|
|
struct {
|
|
UINT32 MainCounterEnable : 1;
|
|
UINT32 LegacyRouteEnable : 1;
|
|
UINT32 Reserved0 : 30;
|
|
UINT32 Reserved1 : 32;
|
|
} Bits;
|
|
UINT64 Uint64;
|
|
} HPET_GENERAL_CONFIGURATION_REGISTER;
|
|
|
|
///
|
|
/// HPET Timer Configuration Register
|
|
///
|
|
typedef union {
|
|
struct {
|
|
UINT32 Reserved0 : 1;
|
|
UINT32 LevelTriggeredInterrupt : 1;
|
|
UINT32 InterruptEnable : 1;
|
|
UINT32 PeriodicInterruptEnable : 1;
|
|
UINT32 PeriodicInterruptCapability : 1;
|
|
UINT32 CounterSizeCapability : 1;
|
|
UINT32 ValueSetEnable : 1;
|
|
UINT32 Reserved1 : 1;
|
|
UINT32 CounterSizeEnable : 1;
|
|
UINT32 InterruptRoute : 5;
|
|
UINT32 MsiInterruptEnable : 1;
|
|
UINT32 MsiInterruptCapability : 1;
|
|
UINT32 Reserved2 : 16;
|
|
UINT32 InterruptRouteCapability;
|
|
} Bits;
|
|
UINT64 Uint64;
|
|
} HPET_TIMER_CONFIGURATION_REGISTER;
|
|
|
|
///
|
|
/// HPET Timer MSI Route Register
|
|
///
|
|
typedef union {
|
|
struct {
|
|
UINT32 Value : 32;
|
|
UINT32 Address : 32;
|
|
} Bits;
|
|
UINT64 Uint64;
|
|
} HPET_TIMER_MSI_ROUTE_REGISTER;
|
|
|
|
#pragma pack()
|