MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
MmCommunication.h File Reference

Data Structures

struct  EFI_MM_COMMUNICATE_HEADER
 
struct  _EFI_MM_COMMUNICATION_PROTOCOL
 

Macros

#define EFI_MM_COMMUNICATION_PROTOCOL_GUID
 

Typedefs

typedef struct
_EFI_MM_COMMUNICATION_PROTOCOL 
EFI_MM_COMMUNICATION_PROTOCOL
 
typedef EFI_STATUS(EFIAPIEFI_MM_COMMUNICATE )(IN CONST EFI_MM_COMMUNICATION_PROTOCOL *This, IN OUT VOID *CommBuffer, IN OUT UINTN *CommSize)
 

Variables

EFI_GUID gEfiMmCommunicationProtocolGuid
 

Detailed Description

EFI MM Communication Protocol as defined in the PI 1.5 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.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_MM_COMMUNICATION_PROTOCOL_GUID
Value:
{ \
0xc68ed8e2, 0x9dc6, 0x4cbd, { 0x9d, 0x94, 0xdb, 0x65, 0xac, 0xc5, 0xc3, 0x32 } \
}

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_MM_COMMUNICATE)(IN CONST EFI_MM_COMMUNICATION_PROTOCOL *This, IN OUT VOID *CommBuffer, IN OUT UINTN *CommSize)

Communicates with a registered handler.

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

Parameters
[in]ThisThe EFI_MM_COMMUNICATION_PROTOCOL instance.
[in]CommBufferA pointer to the buffer to convey into MMRAM.
[in]CommSizeThe 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_SUCCESSThe message was successfully posted.
EFI_INVALID_PARAMETERThe CommBuffer was NULL.
EFI_BAD_BUFFER_SIZEThe 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_DENIEDThe CommunicateBuffer parameter or CommSize parameter, if not omitted, are in address range that cannot be accessed by the MM environment.

Variable Documentation

EFI_GUID gEfiMmCommunicationProtocolGuid