sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DynamicTablesPkg: FdtHwInfoParser: Generic Timer Parser

Browse Source 
The Generic Timer Description Table (GTDT) is a mandatory table
required for booting a standards-based operating system. It
provides an OSPM with information about a system's Generic Timer
configuration. The Generic Timer (GT) is a standard timer interface
implemented on ARM processor-based systems. The GTDT provides OSPM
with information about a system's GT interrupt configurations, for
both per-processor timers, and platform (memory-mapped) timers.

The Generic Timer information is described in the platform Device
Tree. The Device Tree bindings for the Generic timers can be found
at:
 - linux/Documentation/devicetree/bindings/timer/arm,arch_timer.yaml

The FdtHwInfoParser implements a Generic Timer Parser that parses
the platform Device Tree to create a CM_ARM_GENERIC_TIMER_INFO
object. The CM_ARM_GENERIC_TIMER_INFO object is encapsulated in a
Configuration Manager descriptor object and added to the platform
information repository.

The platform Configuration Manager can then utilise this information
when generating the GTDT table.

Note: The Generic Timer Parser currently does not support parsing
of memory-mapped platform timers.

Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
This commit is contained in:
Pierre Gondois
2021-12-09 10:31:58 +01:00
committed by mergify[bot]
parent 8d2691c3d5
commit 3ebe1ff5c9
2 changed files with 324 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
DynamicTablesPkg/Library/FdtHwInfoParserLib/GenericTimer/ArmGenericTimerParser.h Normal file
View File

@ -0,0 +1,66 @@
/** @file
Arm generic timer parser.
Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- linux/Documentation/devicetree/bindings/timer/arm,arch_timer.yaml
**/
#ifndef ARM_GENERIC_TIMER_PARSER_H_
#define ARM_GENERIC_TIMER_PARSER_H_
/** An enum listing the FDT interrupt items.
*/
typedef enum FdtTimerInterruptItems {
FdtSecureTimerIrq, ///< Secure timer IRQ
FdtNonSecureTimerIrq, ///< Non-secure timer IRQ
FdtVirtualTimerIrq, ///< Virtual timer IRQ
FdtHypervisorTimerIrq, ///< Hypervisor timer IRQ
FdtMaxTimerItem ///< Max timer item
} FDT_TIMER_INTERRUPT_ITEMS;
/** CM_ARM_BOOT_ARCH_INFO parser function.
The following structure is populated:
typedef struct CmArmGenericTimerInfo {
UINT64 CounterControlBaseAddress; // {default}
UINT64 CounterReadBaseAddress; // {default}
UINT32 SecurePL1TimerGSIV; // {Populated}
UINT32 SecurePL1TimerFlags; // {Populated}
UINT32 NonSecurePL1TimerGSIV; // {Populated}
UINT32 NonSecurePL1TimerFlags; // {Populated}
UINT32 VirtualTimerGSIV; // {Populated}
UINT32 VirtualTimerFlags; // {Populated}
UINT32 NonSecurePL2TimerGSIV; // {Populated}
UINT32 NonSecurePL2TimerFlags; // {Populated}
UINT32 VirtualPL2TimerGSIV; // {default}
UINT32 VirtualPL2TimerFlags; // {default}
} CM_ARM_GENERIC_TIMER_INFO;
A parser parses a Device Tree to populate a specific CmObj type. None,
one or many CmObj can be created by the parser.
The created CmObj are then handed to the parser's caller through the
HW_INFO_ADD_OBJECT interface.
This can also be a dispatcher. I.e. a function that not parsing a
Device Tree but calling other parsers.
@param [in] FdtParserHandle A handle to the parser instance.
@param [in] FdtBranch When searching for DT node name, restrict
the search to this Device Tree branch.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED An error occurred.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_NOT_FOUND Not found.
@retval EFI_UNSUPPORTED Unsupported.
**/
EFI_STATUS
EFIAPI
ArmGenericTimerInfoParser (
IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle,
IN INT32 FdtBranch
);
#endif // ARM_GENERIC_TIMER_PARSER_H_