#include <Library/BaseMemoryLib.h>
#include "CmObjectDescUtility.h"
#include "FdtHwInfoParser.h"
#include "Arm/Gic/ArmGicDispatcher.h"
#include "Arm/Gic/ArmGicMsiFrameParser.h"

Functions
STATIC EFI_STATUS EFIAPI	MsiFrameNodeParser (IN CONST VOID Fdt, IN INT32 MsiFrameNode, IN UINT32 MsiFrameId, OUT CM_ARM_GIC_MSI_FRAME_INFO MsiFrameInfo)

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

Variables
STATIC CONST COMPATIBILITY_STR	MsiFrameCompatibleStr []

STATIC CONST COMPATIBILITY_INFO	MsiFrameCompatibleInfo

Detailed Description

Arm Gic Msi frame Parser.

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

Reference(s):

linux/Documentation/devicetree/bindings/interrupt-controller/arm,gic.yaml
linux/Documentation/devicetree/bindings/interrupt-controller/arm,gic-v3.yaml

Definition in file ArmGicMsiFrameParser.c.

Function Documentation

◆ ArmGicMsiFrameInfoParser()

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

CM_ARM_GIC_MSI_FRAME_INFO parser function.

The following structure is populated: typedef struct CmArmGicMsiFrameInfo { UINT32 GicMsiFrameId; // {Populated} UINT64 PhysicalBaseAddress; // {Populated} UINT32 Flags; // {default = 0} UINT16 SPICount; UINT16 SPIBase; } CM_ARM_GIC_MSI_FRAME_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.

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 128 of file ArmGicMsiFrameParser.c.

◆ MsiFrameNodeParser()

STATIC EFI_STATUS EFIAPI MsiFrameNodeParser	(	IN CONST VOID *	Fdt,
		IN INT32	MsiFrameNode,
		IN UINT32	MsiFrameId,
		OUT CM_ARM_GIC_MSI_FRAME_INFO *	MsiFrameInfo
	)

Parse a Msi frame node.

Parameters

[in]	Fdt	Pointer to a Flattened Device Tree (Fdt).
[in]	MsiFrameNode	Offset of a Msi frame node.
[in]	MsiFrameId	Frame ID.
[out]	MsiFrameInfo	The CM_ARM_GIC_MSI_FRAME_INFO to populate.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_ABORTED	An error occurred.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 47 of file ArmGicMsiFrameParser.c.

Variable Documentation

◆ MsiFrameCompatibleInfo

STATIC CONST COMPATIBILITY_INFO MsiFrameCompatibleInfo

Initial value:

= {
  ARRAY_SIZE (MsiFrameCompatibleStr),
  MsiFrameCompatibleStr
}

COMPATIBILITY_INFO structure for the MSI frame.

Definition at line 28 of file ArmGicMsiFrameParser.c.

◆ MsiFrameCompatibleStr

STATIC CONST COMPATIBILITY_STR MsiFrameCompatibleStr[]

Initial value:

= {
  { "arm,gic-v2m-frame" }
}

List of "compatible" property values for Msi-frame nodes.

Any other "compatible" value is not supported by this module.

Definition at line 22 of file ArmGicMsiFrameParser.c.

Functions