]>
Commit | Line | Data |
---|---|---|
6f33f7a2 MC |
1 | /** @file\r |
2 | EFI MM Control PPI definition.\r | |
3 | \r | |
4 | This PPI is used initiate synchronous MMI activations. This PPI could be published by a processor\r | |
5 | driver to abstract the MMI IPI or a driver which abstracts the ASIC that is supporting the APM port.\r | |
6 | Because of the possibility of performing MMI IPI transactions, the ability to generate this event\r | |
7 | from a platform chipset agent is an optional capability for both IA-32 and x64-based systems.\r | |
8 | \r | |
9 | Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r | |
10 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
11 | \r | |
12 | @par Revision Reference:\r | |
13 | This PPI is introduced in PI Version 1.5.\r | |
14 | \r | |
15 | **/\r | |
16 | \r | |
17 | \r | |
18 | #ifndef _MM_CONTROL_PPI_H_\r | |
19 | #define _MM_CONTROL_PPI_H_\r | |
20 | \r | |
21 | #define EFI_PEI_MM_CONTROL_PPI_GUID \\r | |
22 | { 0x61c68702, 0x4d7e, 0x4f43, 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }\r | |
23 | \r | |
24 | typedef struct _EFI_PEI_MM_CONTROL_PPI EFI_PEI_MM_CONTROL_PPI;\r | |
25 | \r | |
26 | /**\r | |
27 | Invokes PPI activation from the PI PEI environment.\r | |
28 | \r | |
29 | @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r | |
30 | @param This The PEI_MM_CONTROL_PPI instance.\r | |
31 | @param ArgumentBuffer The value passed to the MMI handler. This value corresponds to the\r | |
32 | SwMmiInputValue in the RegisterContext parameter for the Register()\r | |
33 | function in the EFI_MM_SW_DISPATCH_PROTOCOL and in the Context parameter\r | |
34 | in the call to the DispatchFunction\r | |
35 | @param ArgumentBufferSize The size of the data passed in ArgumentBuffer or NULL if ArgumentBuffer is NULL.\r | |
36 | @param Periodic An optional mechanism to periodically repeat activation.\r | |
37 | @param ActivationInterval An optional parameter to repeat at this period one\r | |
38 | time or, if the Periodic Boolean is set, periodically.\r | |
39 | \r | |
40 | @retval EFI_SUCCESS The MMI has been engendered.\r | |
41 | @retval EFI_DEVICE_ERROR The timing is unsupported.\r | |
42 | @retval EFI_INVALID_PARAMETER The activation period is unsupported.\r | |
43 | @retval EFI_NOT_STARTED The MM base service has not been initialized.\r | |
44 | \r | |
45 | **/\r | |
46 | typedef\r | |
47 | EFI_STATUS\r | |
48 | (EFIAPI *EFI_PEI_MM_ACTIVATE) (\r | |
49 | IN EFI_PEI_SERVICES **PeiServices,\r | |
50 | IN EFI_PEI_MM_CONTROL_PPI * This,\r | |
51 | IN OUT INT8 *ArgumentBuffer OPTIONAL,\r | |
52 | IN OUT UINTN *ArgumentBufferSize OPTIONAL,\r | |
53 | IN BOOLEAN Periodic OPTIONAL,\r | |
54 | IN UINTN ActivationInterval OPTIONAL\r | |
55 | );\r | |
56 | \r | |
57 | /**\r | |
58 | Clears any system state that was created in response to the Trigger() call.\r | |
59 | \r | |
60 | @param PeiServices General purpose services available to every PEIM.\r | |
61 | @param This The PEI_MM_CONTROL_PPI instance.\r | |
62 | @param Periodic Optional parameter to repeat at this period one\r | |
63 | time or, if the Periodic Boolean is set, periodically.\r | |
64 | \r | |
65 | @retval EFI_SUCCESS The MMI has been engendered.\r | |
66 | @retval EFI_DEVICE_ERROR The source could not be cleared.\r | |
67 | @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.\r | |
68 | \r | |
69 | **/\r | |
70 | typedef\r | |
71 | EFI_STATUS\r | |
72 | (EFIAPI *PEI_MM_DEACTIVATE) (\r | |
73 | IN EFI_PEI_SERVICES **PeiServices,\r | |
74 | IN EFI_PEI_MM_CONTROL_PPI * This,\r | |
75 | IN BOOLEAN Periodic OPTIONAL\r | |
76 | );\r | |
77 | \r | |
78 | ///\r | |
79 | /// The EFI_PEI_MM_CONTROL_PPI is produced by a PEIM. It provides an abstraction of the\r | |
80 | /// platform hardware that generates an MMI. There are often I/O ports that, when accessed, will\r | |
81 | /// generate the MMI. Also, the hardware optionally supports the periodic generation of these signals.\r | |
82 | ///\r | |
83 | struct _PEI_MM_CONTROL_PPI {\r | |
84 | PEI_MM_ACTIVATE Trigger;\r | |
85 | PEI_MM_DEACTIVATE Clear;\r | |
86 | };\r | |
87 | \r | |
88 | extern EFI_GUID gEfiPeiMmControlPpiGuid;\r | |
89 | \r | |
90 | #endif\r |