MdePkg/Include/Protocol/SmmCommunication.h

   1 /** @file
   2   EFI SMM Communication Protocol as defined in the PI 1.2 specification.
   3
   4   This protocol provides a means of communicating between drivers outside of SMM and SMI
   5   handlers inside of SMM.
   6
   7   Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
   8   This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef _SMM_COMMUNICATION_H_
  19 #define _SMM_COMMUNICATION_H_
  20
  21 //
  22 // Need include this header file for EFI_SMM_COMMUNICATE_HEADER data structure.
  23 //
  24 #include <Uefi/UefiAcpiDataTable.h>
  25
  26 #define EFI_SMM_COMMUNICATION_PROTOCOL_GUID \
  27   { \
  28     0xc68ed8e2, 0x9dc6, 0x4cbd, { 0x9d, 0x94, 0xdb, 0x65, 0xac, 0xc5, 0xc3, 0x32 } \
  29   }
  30
  31 typedef struct _EFI_SMM_COMMUNICATION_PROTOCOL  EFI_SMM_COMMUNICATION_PROTOCOL;
  32
  33 /**
  34   Communicates with a registered handler.
  35
  36   This function provides a service to send and receive messages from a registered UEFI service.
  37
  38   @param[in] This                The EFI_SMM_COMMUNICATION_PROTOCOL instance.
  39   @param[in] CommBuffer          A pointer to the buffer to convey into SMRAM.
  40   @param[in] CommSize            The size of the data buffer being passed in.On exit, the size of data
  41                                  being returned. Zero if the handler does not wish to reply with any data.
  42
  43   @retval EFI_SUCCESS            The message was successfully posted.
  44   @retval EFI_INVALID_PARAMETER  The CommBuffer was NULL.
  45 **/
  46 typedef
  47 EFI_STATUS
  48 (EFIAPI *EFI_SMM_COMMUNICATE2)(
  49   IN CONST EFI_SMM_COMMUNICATION_PROTOCOL  *This,
  50   IN OUT VOID                              *CommBuffer,
  51   IN OUT UINTN                             *CommSize
  52   );
  53
  54 ///
  55 /// EFI SMM Communication Protocol provides runtime services for communicating
  56 /// between DXE drivers and a registered SMI handler.
  57 ///
  58 struct _EFI_SMM_COMMUNICATION_PROTOCOL {
  59   EFI_SMM_COMMUNICATE2  Communicate;
  60 };
  61
  62 extern EFI_GUID gEfiSmmCommunicationProtocolGuid;
  63
  64 #endif
  65