]>
Commit | Line | Data |
---|---|---|
709f55c0 | 1 | /** @file\r |
2 | EFI SMM Communication Protocol as defined in the PI 1.2 specification.\r | |
3 | \r | |
4 | This protocol provides a means of communicating between drivers outside of SMM and SMI \r | |
5 | handlers inside of SMM. \r | |
6 | \r | |
96aace82 | 7 | Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 | 8 | This program and the accompanying materials \r |
709f55c0 | 9 | are licensed and made available under the terms and conditions of the BSD License \r |
10 | which accompanies this distribution. The full text of the license may be found at \r | |
11 | http://opensource.org/licenses/bsd-license.php \r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
15 | \r | |
16 | **/\r | |
17 | \r | |
18 | #ifndef _SMM_COMMUNICATION_H_\r | |
19 | #define _SMM_COMMUNICATION_H_\r | |
20 | \r | |
96aace82 JY |
21 | //\r |
22 | // Need include this header file for EFI_SMM_COMMUNICATE_HEADER data structure.\r | |
23 | //\r | |
24 | #include <Uefi/UefiAcpiDataTable.h>\r | |
25 | \r | |
709f55c0 | 26 | #define EFI_SMM_COMMUNICATION_PROTOCOL_GUID \\r |
27 | { \\r | |
28 | 0xc68ed8e2, 0x9dc6, 0x4cbd, { 0x9d, 0x94, 0xdb, 0x65, 0xac, 0xc5, 0xc3, 0x32 } \\r | |
29 | }\r | |
30 | \r | |
709f55c0 | 31 | typedef struct _EFI_SMM_COMMUNICATION_PROTOCOL EFI_SMM_COMMUNICATION_PROTOCOL;\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_SMM_COMMUNICATION_PROTOCOL 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 | |
d64527e5 | 48 | (EFIAPI *EFI_SMM_COMMUNICATE2)(\r |
709f55c0 | 49 | IN CONST EFI_SMM_COMMUNICATION_PROTOCOL *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_SMM_COMMUNICATION_PROTOCOL {\r | |
d64527e5 | 59 | EFI_SMM_COMMUNICATE2 Communicate;\r |
709f55c0 | 60 | };\r |
61 | \r | |
62 | extern EFI_GUID gEfiSmmCommunicationProtocolGuid;\r | |
63 | \r | |
64 | #endif\r | |
65 | \r |