edk2/MdeModulePkg/Include/Library/ArmCcaLib.h
Sami Mujawar 4fa63de5d2 ArmVirtPkg, MdeModulePkg: Move Arm CCA Library to MdeModulePkg
ArmCcaLib provides helper functions for detecting Realm execution state
and caching Realm IPA width. These helpers build on the architectural Arm
CCA RSI library and are not specific to ArmVirtPkg.

Therefore, move ArmCcaLib, ArmCcaLibNull, their public header, and related
GUID declarations to MdeModulePkg. Update ArmVirtPkg library mappings and
consumers to use the new MdeModulePkg library instances.

Continuous-integration-options: PatchCheck.ignore-multi-package
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
2026-08-25 18:05:23 +01:00

69 lines
2.1 KiB
C

/** @file
Library that implements the Arm CCA helper functions.
Copyright (c) 2022 - 2026, Arm Ltd. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
- Rsi or RSI - Realm Service Interface
- IPA - Intermediate Physical Address
- RIPAS - Realm IPA state
**/
#pragma once
#include <Base.h>
#include <Uefi/UefiBaseType.h>
/**
Check if running in a Realm.
@retval TRUE The execution is within the context of a Realm.
@retval FALSE The execution is not within the context of a Realm.
**/
BOOLEAN
EFIAPI
ArmCcaIsRealm (
VOID
);
/**
Return the IPA width of the Realm.
The IPA width of the Realm is used to configure the protection attribute
for memory regions, see ArmCcaSetMemoryProtectionAttribute().
@param [out] IpaWidth IPA width of the Realm.
@retval RETURN_SUCCESS Success.
@retval RETURN_INVALID_PARAMETER A parameter is invalid.
@retval RETURN_UNSUPPORTED The execution is not within the
context of a Realm.
@retval RETURN_OUT_OF_RESOURCES Out of resources.
**/
RETURN_STATUS
EFIAPI
ArmCcaGetIpaWidth (
OUT UINT64 *IpaWidth
);
/** Check if the address range is protected MMIO
@param [in] BaseAddress Base address of the device MMIO region.
@param [in] Length Length of the device MMIO region.
@param [out] IsProtectedMmio TRUE - if the RIPAS for the address range is
protected MMIO.
FALSE - if the RIPAS for the address range is
not protected MMIO.
@retval RETURN_SUCCESS Success.
@retval RETURN_INVALID_PARAMETER A parameter is invalid.
@retval RETURN_UNSUPPORTED The request is not initiated in a
Realm.
**/
RETURN_STATUS
EFIAPI
ArmCcaMemRangeIsProtectedMmio (
IN UINT64 BaseAddress,
IN UINT64 Length,
OUT BOOLEAN *IsProtectedMmio
);