MdeModulePkg/Include/Ppi/SmmCommunication.h

   1 /** @file
   2   EFI SMM Communication PPI definition.
   3
   4   This Ppi provides a means of communicating between PEIM and SMI
   5   handlers inside of SMM.
   6   This Ppi is produced and consumed only in S3 resume boot path.
   7   It is NOT available in normal boot path.
   8
   9 Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
  10
  11 SPDX-License-Identifier: BSD-2-Clause-Patent
  12
  13 **/
  14
  15
  16 #ifndef _SMM_COMMUNICATION_PPI_H_
  17 #define _SMM_COMMUNICATION_PPI_H_
  18
  19 #define EFI_PEI_SMM_COMMUNICATION_PPI_GUID \
  20   { \
  21     0xae933e1c, 0xcc47, 0x4e38, { 0x8f, 0xe, 0xe2, 0xf6, 0x1d, 0x26, 0x5, 0xdf } \
  22   }
  23
  24 typedef struct _EFI_PEI_SMM_COMMUNICATION_PPI  EFI_PEI_SMM_COMMUNICATION_PPI;
  25
  26 /**
  27   Communicates with a registered handler.
  28
  29   This function provides a service to send and receive messages from a registered UEFI service.
  30
  31   @param[in] This                The EFI_PEI_SMM_COMMUNICATION_PPI instance.
  32   @param[in] CommBuffer          A pointer to the buffer to convey into SMRAM.
  33   @param[in] CommSize            The size of the data buffer being passed in.On exit, the size of data
  34                                  being returned. Zero if the handler does not wish to reply with any data.
  35
  36   @retval EFI_SUCCESS            The message was successfully posted.
  37   @retval EFI_INVALID_PARAMETER  The CommBuffer was NULL.
  38 **/
  39 typedef
  40 EFI_STATUS
  41 (EFIAPI *EFI_PEI_SMM_COMMUNICATE)(
  42   IN CONST EFI_PEI_SMM_COMMUNICATION_PPI   *This,
  43   IN OUT VOID                              *CommBuffer,
  44   IN OUT UINTN                             *CommSize
  45   );
  46
  47 ///
  48 /// EFI SMM Communication Protocol provides runtime services for communicating
  49 /// between DXE drivers and a registered SMI handler.
  50 ///
  51 struct _EFI_PEI_SMM_COMMUNICATION_PPI {
  52   EFI_PEI_SMM_COMMUNICATE  Communicate;
  53 };
  54
  55 extern EFI_GUID gEfiPeiSmmCommunicationPpiGuid;
  56
  57 #endif