SmmCommunication.h File Reference

Data Structures
struct	_EFI_PEI_SMM_COMMUNICATION_PPI

Macros
#define	EFI_PEI_SMM_COMMUNICATION_PPI_GUID

Typedefs
typedef struct _EFI_PEI_SMM_COMMUNICATION_PPI	EFI_PEI_SMM_COMMUNICATION_PPI
typedef EFI_STATUS(EFIAPI *	EFI_PEI_SMM_COMMUNICATE )(IN CONST EFI_PEI_SMM_COMMUNICATION_PPI *This, IN OUT VOID *CommBuffer, IN OUT UINTN *CommSize)

Variables
EFI_GUID	gEfiPeiSmmCommunicationPpiGuid

Detailed Description

EFI SMM Communication PPI definition.

This Ppi provides a means of communicating between PEIM and SMI handlers inside of SMM. This Ppi is produced and consumed only in S3 resume boot path. It is NOT available in normal boot path.

Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_PEI_SMM_COMMUNICATION_PPI_GUID

Value:

{ \
    0xae933e1c, 0xcc47, 0x4e38, { 0x8f, 0xe, 0xe2, 0xf6, 0x1d, 0x26, 0x5, 0xdf } \
  }

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_PEI_SMM_COMMUNICATE)(IN CONST EFI_PEI_SMM_COMMUNICATION_PPI *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]	This	The EFI_PEI_SMM_COMMUNICATION_PPI instance.
[in]	CommBuffer	A pointer to the buffer to convey into SMRAM.
[in]	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.

Return values

EFI_SUCCESS	The message was successfully posted.
EFI_INVALID_PARAMETER	The CommBuffer was NULL.

typedef struct _EFI_PEI_SMM_COMMUNICATION_PPI EFI_PEI_SMM_COMMUNICATION_PPI

Variable Documentation

EFI_GUID gEfiPeiSmmCommunicationPpiGuid