MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Protocol / MmCommunication.h

/** @file\r
  EFI MM Communication Protocol as defined in the PI 1.5 specification.\r
\r
  This protocol provides a means of communicating between drivers outside of MM and MMI\r
  handlers inside of MM.\r
\r
  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _MM_COMMUNICATION_H_\r
#define _MM_COMMUNICATION_H_\r
\r
#pragma pack(1)\r
\r
///\r
/// To avoid confusion in interpreting frames, the communication buffer should always\r
/// begin with EFI_MM_COMMUNICATE_HEADER\r
///\r
typedef struct {\r
  ///\r
  /// Allows for disambiguation of the message format.\r
  ///\r
  EFI_GUID  HeaderGuid;\r
  ///\r
  /// Describes the size of Data (in bytes) and does not include the size of the header.\r
  ///\r
  UINTN     MessageLength;\r
  ///\r
  /// Designates an array of bytes that is MessageLength in size.\r
  ///\r
  UINT8     Data[1];\r
} EFI_MM_COMMUNICATE_HEADER;\r
\r
#pragma pack()\r
\r
#define EFI_MM_COMMUNICATION_PROTOCOL_GUID \\r
  { \\r
    0xc68ed8e2, 0x9dc6, 0x4cbd, { 0x9d, 0x94, 0xdb, 0x65, 0xac, 0xc5, 0xc3, 0x32 } \\r
  }\r
\r
typedef struct _EFI_MM_COMMUNICATION_PROTOCOL  EFI_MM_COMMUNICATION_PROTOCOL;\r
\r
/**\r
  Communicates with a registered handler.\r
\r
  This function provides a service to send and receive messages from a registered UEFI service.\r
\r
  @param[in] This                The EFI_MM_COMMUNICATION_PROTOCOL instance.\r
  @param[in] CommBuffer          A pointer to the buffer to convey into MMRAM.\r
  @param[in] CommSize            The size of the data buffer being passed in. On exit, the size of data\r
                                 being returned. Zero if the handler does not wish to reply with any data.\r
                                 This parameter is optional and may be NULL.\r
\r
  @retval EFI_SUCCESS            The message was successfully posted.\r
  @retval EFI_INVALID_PARAMETER  The CommBuffer was NULL.\r
  @retval EFI_BAD_BUFFER_SIZE    The buffer is too large for the MM implementation.\r
                                 If this error is returned, the MessageLength field\r
                                 in the CommBuffer header or the integer pointed by\r
                                 CommSize, are updated to reflect the maximum payload\r
                                 size the implementation can accommodate.\r
  @retval EFI_ACCESS_DENIED      The CommunicateBuffer parameter or CommSize parameter,\r
                                 if not omitted, are in address range that cannot be\r
                                 accessed by the MM environment.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MM_COMMUNICATE)(\r
  IN CONST EFI_MM_COMMUNICATION_PROTOCOL   *This,\r
  IN OUT VOID                              *CommBuffer,\r
  IN OUT UINTN                             *CommSize OPTIONAL\r
  );\r
\r
///\r
/// EFI MM Communication Protocol provides runtime services for communicating\r
/// between DXE drivers and a registered MMI handler.\r
///\r
struct _EFI_MM_COMMUNICATION_PROTOCOL {\r
  EFI_MM_COMMUNICATE  Communicate;\r
};\r
\r
extern EFI_GUID gEfiMmCommunicationProtocolGuid;\r
\r
#endif\r
\r