MmCommunication3.h File Reference

#include <Pi/PiMultiPhase.h>

Go to the source code of this file.

Data Structures
struct	_EFI_MM_COMMUNICATION3_PROTOCOL

Macros
#define	EFI_MM_COMMUNICATION3_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MM_COMMUNICATION3_PROTOCOL	EFI_MM_COMMUNICATION3_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_MM_COMMUNICATE3) (IN CONST EFI_MM_COMMUNICATION3_PROTOCOL *This, IN OUT VOID *CommBufferPhysical, IN OUT VOID *CommBufferVirtual)

Variables
EFI_GUID	gEfiMmCommunication3ProtocolGuid

Detailed Description

EFI MM Communication Protocol 3 as defined in the PI 1.9 specification.

This protocol provides a means of communicating between drivers outside of MM and MMI handlers inside of MM.

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

Definition in file MmCommunication3.h.

Macro Definition Documentation

EFI_MM_COMMUNICATION3_PROTOCOL_GUID

#define EFI_MM_COMMUNICATION3_PROTOCOL_GUID

Value:

  { \
    0xf7234a14, 0xdf2, 0x46c0, { 0xad, 0x28, 0x90, 0xe6, 0xb8, 0x83, 0xa7, 0x2f } \
  }

Definition at line 18 of file MmCommunication3.h.

Typedef Documentation

EFI_MM_COMMUNICATE3

typedef EFI_STATUS(EFIAPI * EFI_MM_COMMUNICATE3) (IN CONST EFI_MM_COMMUNICATION3_PROTOCOL *This, IN OUT VOID *CommBufferPhysical, IN OUT VOID *CommBufferVirtual)

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_COMMUNICATION3_PROTOCOL instance.
[in,out]	CommBufferPhysical	Physical address of the MM communication buffer, of which content must start with EFI_MM_COMMUNICATE_HEADER_V3.
[in,out]	CommBufferVirtual	Virtual address of the MM communication buffer, of which content must start with EFI_MM_COMMUNICATE_HEADER_V3.

Return values

EFI_SUCCESS	The message was successfully posted.
EFI_INVALID_PARAMETER	CommBufferPhysical was NULL or CommBufferVirtual was NULL.
EFI_BAD_BUFFER_SIZE	The buffer is too large for the MM implementation. If this error is returned, the MessageSize field in the CommBuffer header, are updated to reflect the maximum payload size the implementation can accommodate.
EFI_ACCESS_DENIED	The CommunicateBuffer parameter are in address range that cannot be accessed by the MM environment.

Definition at line 47 of file MmCommunication3.h.

EFI_MM_COMMUNICATION3_PROTOCOL

typedef struct _EFI_MM_COMMUNICATION3_PROTOCOL EFI_MM_COMMUNICATION3_PROTOCOL

Definition at line 23 of file MmCommunication3.h.