TianoCore EDK2 master
Loading...
Searching...
No Matches
FdtHwInfoParser.h File Reference

Go to the source code of this file.

Data Structures

struct  FdtHwInfoParser
 

Typedefs

typedef struct FdtHwInfoParser FDT_HW_INFO_PARSER
 
typedef FDT_HW_INFO_PARSERFDT_HW_INFO_PARSER_HANDLE
 
typedef EFI_STATUS(EFIAPI * FDT_HW_INFO_PARSER_FUNC) (IN CONST FDT_HW_INFO_PARSER_HANDLE ParserHandle, IN INT32 FdtBranch)
 

Functions

EFI_STATUS EFIAPI ArchFdtHwInfoMainDispatcher (IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle, IN INT32 FdtBranch)
 

Detailed Description

Flattened Device Tree parser definitions.

Copyright (c) 2021, ARM Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file FdtHwInfoParser.h.

Typedef Documentation

◆ FDT_HW_INFO_PARSER

A structure describing the instance of the FdtHwInfoParser.

◆ FDT_HW_INFO_PARSER_FUNC

typedef EFI_STATUS(EFIAPI * FDT_HW_INFO_PARSER_FUNC) (IN CONST FDT_HW_INFO_PARSER_HANDLE ParserHandle, IN INT32 FdtBranch)

Function pointer to a parser function.

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.

Parameters
[in]ParserHandleHandle to the parser instance.
[in]FdtBranchWhen searching for DT node name, restrict the search to this Device Tree branch.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_ABORTEDAn error occurred.
EFI_INVALID_PARAMETERInvalid parameter.
EFI_NOT_FOUNDNot found.
EFI_UNSUPPORTEDUnsupported.

Definition at line 57 of file FdtHwInfoParser.h.

◆ FDT_HW_INFO_PARSER_HANDLE

A pointer type for FDT_HW_INFO_PARSER.

Definition at line 35 of file FdtHwInfoParser.h.

Function Documentation

◆ ArchFdtHwInfoMainDispatcher()

EFI_STATUS EFIAPI ArchFdtHwInfoMainDispatcher ( IN CONST FDT_HW_INFO_PARSER_HANDLE  FdtParserHandle,
IN INT32  FdtBranch 
)

Main dispatcher: sequentially call the parsers/dispatchers of the HwInfoParserTable.

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.

Parameters
[in]FdtParserHandleA handle to the parser instance.
[in]FdtBranchWhen searching for DT node name, restrict the search to this Device Tree branch.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_ABORTEDAn error occurred.
EFI_INVALID_PARAMETERInvalid parameter.
EFI_NOT_FOUNDNot found.
EFI_UNSUPPORTEDUnsupported.

Definition at line 54 of file ArmFdtHwInfoParser.c.