#include "MmCommunicationDxe.h"

Functions
VOID EFIAPI	MmGuidedEventNotify (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	MmReadyToLockEventNotify (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	MmEndOfDxeEventNotify (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	MmVirtualAddressChangeEvent (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	ProcessCommunicationBuffer (IN OUT VOID CommBuffer, IN OUT UINTN CommSize OPTIONAL)

EFI_STATUS EFIAPI	MmCommunicate2 (IN CONST EFI_MM_COMMUNICATION2_PROTOCOL This, IN OUT VOID CommBufferPhysical, IN OUT VOID CommBufferVirtual, IN OUT UINTN CommSize OPTIONAL)

EFI_STATUS EFIAPI	MmCommunicate (IN CONST EFI_MM_COMMUNICATION_PROTOCOL This, IN OUT VOID CommBuffer, IN OUT UINTN *CommSize OPTIONAL)

EFI_STATUS EFIAPI	MmCommunicationEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_MM_COMMUNICATION2_PROTOCOL	mMmCommunication2

EFI_MM_COMMUNICATION_PROTOCOL	mMmCommunication

MM_COMM_BUFFER	mMmCommonBuffer

EFI_SMM_CONTROL2_PROTOCOL *	mSmmControl2

EFI_SMM_ACCESS2_PROTOCOL *	mSmmAccess

BOOLEAN	mSmmLocked = FALSE

BOOLEAN	mEndOfDxe = FALSE

MM_EVENT_NOTIFICATION	mMmEvents []

Detailed Description

MmCommunicationDxe driver produces MmCommunication protocol and create the notifications of some protocols and event.

Copyright (c) 2024, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file MmCommunicationDxe.c.

Function Documentation

◆ MmCommunicate()

EFI_STATUS EFIAPI MmCommunicate	(	IN CONST EFI_MM_COMMUNICATION_PROTOCOL *	This,
		IN OUT VOID *	CommBuffer,
		IN OUT UINTN *CommSize	OPTIONAL
	)

Communicates with a registered handler.

This function provides a service to send and receive messages from a registered UEFI service.

Parameters

[in]	This	The EFI_MM_COMMUNICATION_PROTOCOL instance.
[in,out]	CommBuffer	Pointer to the MM communication buffer
[in,out]	CommSize	The size of the data buffer being passed in. On exit, the size of data being returned. Zero if the handler does not wish to reply with any data. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The message was successfully posted.
EFI_INVALID_PARAMETER	The CommBuffer was NULL.
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.
EFI_ACCESS_DENIED	The CommunicateBuffer parameter or CommSize parameter, if not omitted, are in address range that cannot be accessed by the MM environment.

Definition at line 382 of file MmCommunicationDxe.c.

◆ MmCommunicate2()

EFI_STATUS EFIAPI MmCommunicate2	(	IN CONST EFI_MM_COMMUNICATION2_PROTOCOL *	This,
		IN OUT VOID *	CommBufferPhysical,
		IN OUT VOID *	CommBufferVirtual,
		IN OUT UINTN *CommSize	OPTIONAL
	)

Communicates with a registered handler.

This function provides a service to send and receive messages from a registered UEFI service.

Parameters

[in]	This	The EFI_MM_COMMUNICATION_PROTOCOL instance.
[in,out]	CommBufferPhysical	Physical address of the MM communication buffer.
[in,out]	CommBufferVirtual	Virtual address of the MM communication buffer.
[in,out]	CommSize	The size of the data buffer being passed in. On exit, the size of data being returned. Zero if the handler does not wish to reply with any data. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The message was successfully posted.
EFI_INVALID_PARAMETER	The CommBuffer was NULL.
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.
EFI_ACCESS_DENIED	The CommunicateBuffer parameter or CommSize parameter, if not omitted, are in address range that cannot be accessed by the MM environment.

Definition at line 347 of file MmCommunicationDxe.c.

◆ MmCommunicationEntryPoint()

EFI_STATUS EFIAPI MmCommunicationEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The Entry Point for MmCommunicateDxe driver.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
Other	Some error occurred when executing this entry point.

Definition at line 403 of file MmCommunicationDxe.c.

◆ MmEndOfDxeEventNotify()

VOID EFIAPI MmEndOfDxeEventNotify	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Event notification that is fired when EndOfDxe Event Group is signaled.

Parameters

Event	The Event that is being processed, not used.
Context	Event Context, not used.

Definition at line 204 of file MmCommunicationDxe.c.

◆ MmGuidedEventNotify()

VOID EFIAPI MmGuidedEventNotify	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Event notification that is fired when GUIDed Event Group is signaled.

Parameters

Event	The Event that is being processed, not used.
Context	Event Context, not used.

Definition at line 87 of file MmCommunicationDxe.c.

◆ MmReadyToLockEventNotify()

VOID EFIAPI MmReadyToLockEventNotify	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Event notification that is fired every time a DxeSmmReadyToLock protocol is added or if gEfiEventReadyToBootGuid is signaled.

Parameters

Event	The Event that is being processed, not used.
Context	Event Context, not used.

Definition at line 121 of file MmCommunicationDxe.c.

◆ MmVirtualAddressChangeEvent()

VOID EFIAPI MmVirtualAddressChangeEvent	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.

This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event. It convers pointer to new virtual address.

Parameters

[in]	Event	Event whose notification function is being invoked.
[in]	Context	Pointer to the notification function's context.

Definition at line 224 of file MmCommunicationDxe.c.

◆ ProcessCommunicationBuffer()

EFI_STATUS EFIAPI ProcessCommunicationBuffer	(	IN OUT VOID *	CommBuffer,
		IN OUT UINTN *CommSize	OPTIONAL
	)

Processes the communication buffer for Mm communication protocols.

This function encapsulates the common logic for handling communication buffers used by MmCommunicate2 and MmCommunicate functions.

Parameters

[in,out]	CommBuffer	Pointer to the MM communication buffer
[in,out]	CommSize	The size of the data buffer being passed in. On exit, the size of data being returned. Zero if the handler does not wish to reply with any data. This parameter is optional and may be NULL.

Return values

EFI_SUCCESS	The message was successfully posted.
EFI_INVALID_PARAMETER	The CommBuffer was NULL.
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.
EFI_ACCESS_DENIED	The CommunicateBuffer parameter or CommSize parameter, if not omitted, are in address range that cannot be accessed by the MM environment.

Definition at line 258 of file MmCommunicationDxe.c.

Variable Documentation

◆ mEndOfDxe

BOOLEAN mEndOfDxe = FALSE

The flag to indicate whether the platform has left the DXE phase of execution.

Definition at line 30 of file MmCommunicationDxe.c.

◆ mMmCommonBuffer

MM_COMM_BUFFER mMmCommonBuffer

Definition at line 26 of file MmCommunicationDxe.c.

◆ mMmCommunication

EFI_MM_COMMUNICATION_PROTOCOL mMmCommunication

Initial value:

= {
  MmCommunicate
}

Definition at line 22 of file MmCommunicationDxe.c.

◆ mMmCommunication2

EFI_MM_COMMUNICATION2_PROTOCOL mMmCommunication2

Initial value:

= {
  MmCommunicate2
}

Definition at line 15 of file MmCommunicationDxe.c.

◆ mMmEvents

MM_EVENT_NOTIFICATION mMmEvents[]

Definition at line 35 of file MmCommunicationDxe.c.

◆ mSmmAccess

EFI_SMM_ACCESS2_PROTOCOL* mSmmAccess

Definition at line 28 of file MmCommunicationDxe.c.

◆ mSmmControl2

EFI_SMM_CONTROL2_PROTOCOL* mSmmControl2

Definition at line 27 of file MmCommunicationDxe.c.

◆ mSmmLocked

BOOLEAN mSmmLocked = FALSE

Definition at line 29 of file MmCommunicationDxe.c.

Functions

Variables

Detailed Description

Function Documentation

◆ MmCommunicate()

◆ MmCommunicate2()

◆ MmCommunicationEntryPoint()

◆ MmEndOfDxeEventNotify()

◆ MmGuidedEventNotify()

◆ MmReadyToLockEventNotify()

◆ MmVirtualAddressChangeEvent()

◆ ProcessCommunicationBuffer()

Variable Documentation

◆ mEndOfDxe

◆ mMmCommonBuffer

◆ mMmCommunication

◆ mMmCommunication2

◆ mMmEvents

◆ mSmmAccess

◆ mSmmControl2

◆ mSmmLocked