#include <PiDxe.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/PcdLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiRuntimeLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Protocol/SmmControl2.h>
#include <Protocol/MmCommunication2.h>
#include <Protocol/MmCommunication.h>
#include <Protocol/DxeMmReadyToLock.h>
#include <Protocol/SmmAccess2.h>
#include <Guid/MmCommBuffer.h>
#include <Guid/EventGroup.h>

Data Structures
struct	MM_EVENT_NOTIFICATION

Enumerations
enum	NOTIFICATION_TYPE { EventNotify , ProtocolNotify , EndNotify }

Functions
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 CommBufferPhysical, IN OUT UINTN *CommSize OPTIONAL)

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

VOID EFIAPI	MmGuidedEventNotify (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)

Detailed Description

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

Definition in file MmCommunicationDxe.h.

Enumeration Type Documentation

◆ NOTIFICATION_TYPE

enum NOTIFICATION_TYPE

Definition at line 33 of file MmCommunicationDxe.h.

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]	CommBufferPhysical	Physical 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.

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.

◆ 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 305 of file MmCommunication.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.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ NOTIFICATION_TYPE

Function Documentation

◆ MmCommunicate()

◆ MmCommunicate2()

◆ MmEndOfDxeEventNotify()

◆ MmGuidedEventNotify()

◆ MmReadyToLockEventNotify()

◆ MmVirtualAddressChangeEvent()