edk2/MdeModulePkg/Library/ArmFfaLib/ArmFfaRxTxMap.h
Levi Yun b336d9b87a MdeModulePkg/Library: fix memory leak Rx/Tx Buffer in ArmFfaPeiLib
The commit e15fe06603
("MdeModulePkg/Library: make ArmFfaPeiLib available early PEIM stage")
uses ArmFfaPeiLib in the early PEIM stage.

However, the Rx/Tx buffer allocated in the early PEIM stage uses
temporary memory. This results in a memory leak when the temporary
memory's heap is relocated to permanent memory.

For example, if the Rx/Tx buffer memory is allocated at 0x20006000
in temporary memory, and if offset between temporary memory and
permanent is 0x40000000, then:

 - Once permanent memory installed the temporary memory at 0x20006000
   is migrated to 0x60006000.
 - However, ArmFfaPeiLib allocates new Rx/Tx buffer without freeing
   the migrated Rx/Tx buffers, i.e. the buffers at 0x60006000.

This results in a memory leak as the migrated Rx/Tx buffer area is
lost.
To address this memory leak, use the MemoryAllocationHob's name, so
that the migrated memory area will be reused as Rx/Tx buffer.

This patch also includes rename ArmFfaRxTxStmm.c to
ArmFfaStandaloneMmRxTxMap.c to keep the file name convention in
ArmFfaLib with ArmFfa{Phase}{...}.c

Fixes: e15fe06603 ("MdeModulePkg/Library: ...")
Signed-off-by: Yeoreum Yun <yeoreum.yun@arm.com>
Continuous-integration-options: PatchCheck.ignore-multi-package
2025-07-14 11:59:38 +00:00

99 lines
2.3 KiB
C

/** @file
Arm FF-A ns common library Header file
Copyright (c) 2024, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Glossary:
- FF-A - Firmware Framework for Arm A-profile
- spmc - Secure Partition Manager Core
- spmd - Secure Partition Manager Dispatcher
@par Reference(s):
- Arm Firmware Framework for Arm A-Profile [https://developer.arm.com/documentation/den0077/latest]
**/
#ifndef ARM_FFA_RX_TX_MAP_LIB_H_
#define ARM_FFA_RX_TX_MAP_LIB_H_
#include <Guid/ArmFfaRxTxBufferInfo.h>
/**
Mapping Rx/Tx buffers.
This function is only called in ArmFfaLibConstructor because
Rx/Tx buffer is registered only once per partition.
@retval EFI_SUCCESS
@retval EFI_ALREADY_STARTED Rx/Tx buffer already mapped in PEI phase
@retval EFI_OUT_OF_RESOURCE Out of memory
@retval EFI_INVALID_PARAMETER Invalid alignment of Rx/Tx buffer
@retval Others Error
**/
EFI_STATUS
EFIAPI
ArmFfaLibRxTxMap (
IN VOID
);
/**
Unmap Rx/Tx buffer.
This function is only called in Exit boot service because
Rx/Tx buffer is registered only once per partition.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETERS Already unregistered
@retval EFI_UNSUPPORTED Not supported
**/
EFI_STATUS
EFIAPI
ArmFfaLibRxTxUnmap (
IN VOID
);
/**
Update Rx/TX buffer information.
@param BufferInfo Rx/Tx buffer information.
**/
VOID
EFIAPI
UpdateRxTxBufferInfo (
OUT ARM_FFA_RX_TX_BUFFER_INFO *BufferInfo
);
/**
Find Rx/TX buffer memory allocation hob.
@param UseGuid Find MemoryAllocationHob using Guid.
@retval MemoryAllocationHob
@retval NULL No memory allocation hob related to Rx/Tx buffer
**/
EFI_HOB_MEMORY_ALLOCATION *
EFIAPI
FindRxTxBufferAllocationHob (
IN BOOLEAN UseGuid
);
/**
Remap Rx/TX buffer with converted Rx/Tx Buffer address after
using permanent memory.
@param[out] BufferInfo BufferInfo
@retval EFI_SUCCESS Success
@retval EFI_NOT_FOUND No memory allocation hob related to Rx/Tx buffer
**/
EFI_STATUS
EFIAPI
RemapFfaRxTxBuffer (
IN OUT ARM_FFA_RX_TX_BUFFER_INFO *BufferInfo
);
#endif