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