tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-25 22:54:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

ArmPkg/MmCommunicationDxe: expose MM Communicate 2 protocol

Browse Source 
Implement the new MmCommunication2 protocol which supports the use
of standalone MM at runtime inside an address space that has been
virtually remapped by the OS.

Note that the implementation of the old MM Communicate protocol is
removed: it never worked correctly so there is no point in keeping it.

Signed-off-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
Reviewed-by: Leif Lindholm <leif@nuviainc.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
This commit is contained in:
Ard Biesheuvel 2020-04-18 18:45:21 +02:00 committed by mergify[bot]
parent 9ad2b981bd
commit 3e3acb3a27
2 changed files with 41 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
ArmPkg/Drivers/MmCommunicationDxe/MmCommunication.c
View File

@ -1,6 +1,6 @@
/** @file /** @file
Copyright (c) 2016-2018, ARM Limited. All rights reserved. Copyright (c) 2016-2019, ARM Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent SPDX-License-Identifier: BSD-2-Clause-Patent
@ -16,7 +16,7 @@
#include <Library/UefiBootServicesTableLib.h> #include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h> #include <Library/UefiRuntimeServicesTableLib.h>
#include <Protocol/MmCommunication.h> #include <Protocol/MmCommunication2.h>
#include <IndustryStandard/ArmStdSmc.h> #include <IndustryStandard/ArmStdSmc.h>
@ -39,39 +39,34 @@ STATIC EFI_HANDLE mMmCommunicateHandle;
/** /**
Communicates with a registered handler. Communicates with a registered handler.
This function provides an interface to send and receive messages to the This function provides a service to send and receive messages from a registered UEFI service.
Standalone MM environment on behalf of UEFI services. This function is part
of the MM Communication Protocol that may be called in physical mode prior to
SetVirtualAddressMap() and in virtual mode after SetVirtualAddressMap().
@param[in] This The EFI_MM_COMMUNICATION_PROTOCOL @param[in] This The EFI_MM_COMMUNICATION_PROTOCOL instance.
instance. @param[in] CommBufferPhysical Physical address of the MM communication buffer
@param[in, out] CommBuffer A pointer to the buffer to convey @param[in] CommBufferVirtual Virtual address of the MM communication buffer
into MMRAM. @param[in] CommSize The size of the data buffer being passed in. On exit, the size of data
@param[in, out] CommSize The size of the data buffer being being returned. Zero if the handler does not wish to reply with any data.
passed in. This is optional. This parameter is optional and may be NULL.
@retval EFI_SUCCESS The message was successfully posted.
@retval EFI_INVALID_PARAMETER CommBufferPhysical was NULL or CommBufferVirtual was NULL.
@retval EFI_BAD_BUFFER_SIZE The buffer is too large for the MM implementation.
If this error is returned, the MessageLength field
in the CommBuffer header or the integer pointed by
CommSize, are updated to reflect the maximum payload
size the implementation can accommodate.
@retval EFI_ACCESS_DENIED The CommunicateBuffer parameter or CommSize parameter,
if not omitted, are in address range that cannot be
accessed by the MM environment.
@retval EFI_SUCCESS The message was successfully posted.
@retval EFI_INVALID_PARAMETER The CommBuffer was NULL.
@retval EFI_BAD_BUFFER_SIZE The buffer size is incorrect for the MM
implementation. If this error is
returned, the MessageLength field in
the CommBuffer header or the integer
pointed by CommSize are updated to reflect
the maximum payload size the
implementation can accommodate.
@retval EFI_ACCESS_DENIED The CommunicateBuffer parameter
or CommSize parameter, if not omitted,
are in address range that cannot be
accessed by the MM environment
**/ **/
STATIC
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
MmCommunicationCommunicate ( MmCommunication2Communicate (
IN CONST EFI_MM_COMMUNICATION_PROTOCOL *This, IN CONST EFI_MM_COMMUNICATION2_PROTOCOL *This,
IN OUT VOID *CommBuffer, IN OUT VOID *CommBufferPhysical,
IN OUT UINTN *CommSize OPTIONAL IN OUT VOID *CommBufferVirtual,
IN OUT UINTN *CommSize OPTIONAL
) )
{ {
EFI_MM_COMMUNICATE_HEADER *CommunicateHeader; EFI_MM_COMMUNICATE_HEADER *CommunicateHeader;
@ -87,11 +82,11 @@ MmCommunicationCommunicate (
// //
// Check parameters // Check parameters
// //
if (CommBuffer == NULL) { if (CommBufferVirtual == NULL) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
CommunicateHeader = CommBuffer; CommunicateHeader = CommBufferVirtual;
// CommBuffer is a mandatory parameter. Hence, Rely on // CommBuffer is a mandatory parameter. Hence, Rely on
// MessageLength + Header to ascertain the // MessageLength + Header to ascertain the
// total size of the communication payload rather than // total size of the communication payload rather than
@ -136,7 +131,7 @@ MmCommunicationCommunicate (
CommunicateSmcArgs.Arg1 = 0; CommunicateSmcArgs.Arg1 = 0;
// Copy Communication Payload // Copy Communication Payload
CopyMem ((VOID *)mNsCommBuffMemRegion.VirtualBase, CommBuffer, BufferSize); CopyMem ((VOID *)mNsCommBuffMemRegion.VirtualBase, CommBufferVirtual, BufferSize);
// comm_buffer_address (64-bit physical address) // comm_buffer_address (64-bit physical address)
CommunicateSmcArgs.Arg2 = (UINTN)mNsCommBuffMemRegion.PhysicalBase; CommunicateSmcArgs.Arg2 = (UINTN)mNsCommBuffMemRegion.PhysicalBase;
@ -149,7 +144,7 @@ MmCommunicationCommunicate (
switch (CommunicateSmcArgs.Arg0) { switch (CommunicateSmcArgs.Arg0) {
case ARM_SMC_MM_RET_SUCCESS: case ARM_SMC_MM_RET_SUCCESS:
ZeroMem (CommBuffer, BufferSize); ZeroMem (CommBufferVirtual, BufferSize);
// On successful return, the size of data being returned is inferred from // On successful return, the size of data being returned is inferred from
// MessageLength + Header. // MessageLength + Header.
CommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *)mNsCommBuffMemRegion.VirtualBase; CommunicateHeader = (EFI_MM_COMMUNICATE_HEADER *)mNsCommBuffMemRegion.VirtualBase;
@ -158,7 +153,7 @@ MmCommunicationCommunicate (
sizeof (CommunicateHeader->MessageLength); sizeof (CommunicateHeader->MessageLength);
CopyMem ( CopyMem (
CommBuffer, CommBufferVirtual,
(VOID *)mNsCommBuffMemRegion.VirtualBase, (VOID *)mNsCommBuffMemRegion.VirtualBase,
BufferSize BufferSize
); );
@ -191,8 +186,8 @@ MmCommunicationCommunicate (
// //
// MM Communication Protocol instance // MM Communication Protocol instance
// //
EFI_MM_COMMUNICATION_PROTOCOL mMmCommunication = { STATIC EFI_MM_COMMUNICATION2_PROTOCOL mMmCommunication2 = {
MmCommunicationCommunicate MmCommunication2Communicate
}; };
/** /**
@ -293,7 +288,7 @@ MmGuidedEventNotify (
Header.Data[0] = 0; Header.Data[0] = 0;
Size = sizeof (Header); Size = sizeof (Header);
MmCommunicationCommunicate (&mMmCommunication, &Header, &Size); MmCommunication2Communicate (&mMmCommunication2, &Header, &Header, &Size);
} }
/** /**
@ -312,7 +307,7 @@ MmGuidedEventNotify (
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
MmCommunicationInitialize ( MmCommunication2Initialize (
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable IN EFI_SYSTEM_TABLE *SystemTable
) )
@ -363,9 +358,9 @@ MmCommunicationInitialize (
// Install the communication protocol // Install the communication protocol
Status = gBS->InstallProtocolInterface ( Status = gBS->InstallProtocolInterface (
&mMmCommunicateHandle, &mMmCommunicateHandle,
&gEfiMmCommunicationProtocolGuid, &gEfiMmCommunication2ProtocolGuid,
EFI_NATIVE_INTERFACE, EFI_NATIVE_INTERFACE,
&mMmCommunication &mMmCommunication2
); );
if (EFI_ERROR(Status)) { if (EFI_ERROR(Status)) {
DEBUG ((DEBUG_ERROR, "MmCommunicationInitialize: " DEBUG ((DEBUG_ERROR, "MmCommunicationInitialize: "
@ -402,8 +397,8 @@ MmCommunicationInitialize (
UninstallProtocol: UninstallProtocol:
gBS->UninstallProtocolInterface ( gBS->UninstallProtocolInterface (
mMmCommunicateHandle, mMmCommunicateHandle,
&gEfiMmCommunicationProtocolGuid, &gEfiMmCommunication2ProtocolGuid,
&mMmCommunication &mMmCommunication2
); );
CleanAddedMemorySpace: CleanAddedMemorySpace:

6
ArmPkg/Drivers/MmCommunicationDxe/MmCommunication.inf
View File

@ -2,7 +2,7 @@
# #
# DXE MM Communicate driver # DXE MM Communicate driver
# #
# Copyright (c) 2016 - 2018, ARM Limited. All rights reserved. # Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.
# #
# SPDX-License-Identifier: BSD-2-Clause-Patent # SPDX-License-Identifier: BSD-2-Clause-Patent
# #
@ -14,7 +14,7 @@
FILE_GUID = 09EE81D3-F15E-43F4-85B4-CB9873DA5D6B FILE_GUID = 09EE81D3-F15E-43F4-85B4-CB9873DA5D6B
MODULE_TYPE = DXE_RUNTIME_DRIVER MODULE_TYPE = DXE_RUNTIME_DRIVER
VERSION_STRING = 1.0 VERSION_STRING = 1.0
ENTRY_POINT = MmCommunicationInitialize ENTRY_POINT = MmCommunication2Initialize
# #
# The following is for reference only and not required by # The following is for reference only and not required by
@ -40,7 +40,7 @@
UefiDriverEntryPoint UefiDriverEntryPoint
[Protocols] [Protocols]
gEfiMmCommunicationProtocolGuid ## PRODUCES gEfiMmCommunication2ProtocolGuid ## PRODUCES
[Guids] [Guids]
gEfiEndOfDxeEventGroupGuid gEfiEndOfDxeEventGroupGuid