5b39832e18
Current MM communicate2 function definition described input arguments `CommBufferPhysical`, `CommBufferVirtual` and `CommSize` as input only, which mismatches with the "input and output type" as in PI specification. This change updated function descriptions of MM communite2 definition to match input argument types. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Zhiguang Liu <zhiguang.liu@intel.com> Signed-off-by: Kun Qin <kuqin12@gmail.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
70 lines
2.8 KiB
C
70 lines
2.8 KiB
C
/** @file
|
|
EFI MM Communication Protocol 2 as defined in the PI 1.7 errata A 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.<BR>
|
|
Copyright (c) 2019, Arm Limited. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef _MM_COMMUNICATION2_H_
|
|
#define _MM_COMMUNICATION2_H_
|
|
|
|
#include <Protocol/MmCommunication.h>
|
|
|
|
#define EFI_MM_COMMUNICATION2_PROTOCOL_GUID \
|
|
{ \
|
|
0x378daedc, 0xf06b, 0x4446, { 0x83, 0x14, 0x40, 0xab, 0x93, 0x3c, 0x87, 0xa3 } \
|
|
}
|
|
|
|
typedef struct _EFI_MM_COMMUNICATION2_PROTOCOL EFI_MM_COMMUNICATION2_PROTOCOL;
|
|
|
|
/**
|
|
Communicates with a registered handler.
|
|
|
|
This function provides a service to send and receive messages from a registered UEFI service.
|
|
|
|
@param[in] This The EFI_MM_COMMUNICATION_PROTOCOL instance.
|
|
@param[in, out] CommBufferPhysical Physical address of the MM communication buffer
|
|
@param[in, out] CommBufferVirtual Virtual address of the MM communication buffer
|
|
@param[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.
|
|
|
|
@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.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_MM_COMMUNICATE2)(
|
|
IN CONST EFI_MM_COMMUNICATION2_PROTOCOL *This,
|
|
IN OUT VOID *CommBufferPhysical,
|
|
IN OUT VOID *CommBufferVirtual,
|
|
IN OUT UINTN *CommSize OPTIONAL
|
|
);
|
|
|
|
///
|
|
/// EFI MM Communication Protocol provides runtime services for communicating
|
|
/// between DXE drivers and a registered MMI handler.
|
|
///
|
|
struct _EFI_MM_COMMUNICATION2_PROTOCOL {
|
|
EFI_MM_COMMUNICATE2 Communicate;
|
|
};
|
|
|
|
extern EFI_GUID gEfiMmCommunication2ProtocolGuid;
|
|
|
|
#endif
|