9fba8e7d |
1 | /** @file\r |
2 | EFI SMM Communication PPI definition.\r |
3 | \r |
4 | This Ppi provides a means of communicating between PEIM and SMI \r |
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 |
9 | Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r |
10 | \r |
11 | This program and the accompanying materials\r |
12 | are licensed and made available under the terms and conditions\r |
13 | of the BSD License which accompanies this distribution. The\r |
14 | full text of the license may be found at\r |
15 | http://opensource.org/licenses/bsd-license.php\r |
16 | \r |
17 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
18 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
19 | \r |
20 | **/\r |
21 | \r |
22 | \r |
23 | #ifndef _SMM_COMMUNICATION_PPI_H_\r |
24 | #define _SMM_COMMUNICATION_PPI_H_\r |
25 | \r |
26 | #define EFI_PEI_SMM_COMMUNICATION_PPI_GUID \\r |
27 | { \\r |
28 | 0xae933e1c, 0xcc47, 0x4e38, { 0x8f, 0xe, 0xe2, 0xf6, 0x1d, 0x26, 0x5, 0xdf } \\r |
29 | }\r |
30 | \r |
31 | typedef struct _EFI_PEI_SMM_COMMUNICATION_PPI EFI_PEI_SMM_COMMUNICATION_PPI;\r |
32 | \r |
33 | /**\r |
34 | Communicates with a registered handler.\r |
35 | \r |
36 | This function provides a service to send and receive messages from a registered UEFI service.\r |
37 | \r |
38 | @param[in] This The EFI_PEI_SMM_COMMUNICATION_PPI instance.\r |
39 | @param[in] CommBuffer A pointer to the buffer to convey into SMRAM.\r |
40 | @param[in] CommSize The size of the data buffer being passed in.On exit, the size of data\r |
41 | being returned. Zero if the handler does not wish to reply with any data.\r |
42 | \r |
43 | @retval EFI_SUCCESS The message was successfully posted.\r |
44 | @retval EFI_INVALID_PARAMETER The CommBuffer was NULL.\r |
45 | **/\r |
46 | typedef\r |
47 | EFI_STATUS\r |
48 | (EFIAPI *EFI_PEI_SMM_COMMUNICATE)(\r |
49 | IN CONST EFI_PEI_SMM_COMMUNICATION_PPI *This,\r |
50 | IN OUT VOID *CommBuffer,\r |
51 | IN OUT UINTN *CommSize\r |
52 | );\r |
53 | \r |
54 | ///\r |
55 | /// EFI SMM Communication Protocol provides runtime services for communicating\r |
56 | /// between DXE drivers and a registered SMI handler.\r |
57 | ///\r |
58 | struct _EFI_PEI_SMM_COMMUNICATION_PPI {\r |
59 | EFI_PEI_SMM_COMMUNICATE Communicate;\r |
60 | };\r |
61 | \r |
62 | extern EFI_GUID gEfiPeiSmmCommunicationPpiGuid;\r |
63 | \r |
64 | #endif\r |