SerialPortParser.h File Reference

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	SerialPortDispatcher (IN CONST FDT_HW_INFO_PARSER_HANDLE FdtParserHandle, IN INT32 FdtBranch)

Detailed Description

Serial Port Parser.

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

Reference(s):

• linux/Documentation/devicetree/bindings/serial/serial.yaml
• linux/Documentation/devicetree/bindings/serial/8250.txt

Definition in file SerialPortParser.h.

Function Documentation

SerialPortDispatcher()

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

SerialPort dispatcher.

This disptacher populates the CM_ARCH_COMMON_SERIAL_PORT_INFO structure for the following CM_OBJ_ID:

• EArchCommonObjConsolePortInfo
• EArchCommonObjSerialDebugPortInfo
• EArchCommonObjSerialPortInfo

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]	FdtParserHandle	A handle to the parser instance.
[in]	FdtBranch	When searching for DT node name, restrict the search to this Device Tree branch.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_ABORTED	An error occurred.
EFI_INVALID_PARAMETER	Invalid parameter.
EFI_NOT_FOUND	Not found.
EFI_UNSUPPORTED	Unsupported.

Definition at line 478 of file SerialPortParser.c.