projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| d2998af2 MK |
1 | /** @file\r |
| 2 | \r | |
| 3 | Common definitions needed for Platform Runtime Mechanism (PRM) modules.\r | |
| 4 | \r | |
| 5 | Copyright (c) Microsoft Corporation\r | |
| 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
| 7 | \r | |
| 8 | **/\r | |
| 9 | \r | |
| 10 | #ifndef PRM_MODULE_H_\r | |
| 11 | #define PRM_MODULE_H_\r | |
| 12 | \r | |
| 13 | #include <Prm.h>\r | |
| 14 | #include <PrmContextBuffer.h>\r | |
| 15 | #include <PrmDataBuffer.h>\r | |
| 16 | #include <PrmExportDescriptor.h>\r | |
| 17 | #include <PrmMmio.h>\r | |
| d2998af2 MK |
18 | \r |
| 19 | /**\r | |
| 20 | Macro that provides a condensed form of a PRM Handler.\r | |
| 21 | \r | |
| 22 | This macro can be used to define a PRM Handler that uses the standard PRM Handle\r | |
| 23 | signature. It is simply provided for convenience.\r | |
| 24 | \r | |
| 25 | **/\r | |
| 26 | #define PRM_HANDLER_EXPORT(Name) \\r | |
| 27 | STATIC_ASSERT (sizeof (PRM_STRING_(Name)) <= PRM_HANDLER_NAME_MAXIMUM_LENGTH, "The PRM handler exceeds the maximum allowed size of 128."); \\r | |
| 28 | \\r | |
| a298a844 MK |
29 | /** \\r |
| 30 | A Platform Runtime Mechanism (PRM) handler. \\r | |
| 31 | \\r | |
| 32 | @param[in] ParameterBuffer A pointer to the PRM handler parameter buffer \\r | |
| 33 | @param[in] ContextBUffer A pointer to the PRM handler context buffer \\r | |
| 34 | \\r | |
| 35 | @retval EFI_STATUS The PRM handler executed successfully. \\r | |
| 36 | @retval Others An error occurred in the PRM handler. \\r | |
| 37 | \\r | |
| 38 | **/ \\r | |
| d2998af2 MK |
39 | EFI_STATUS \\r |
| 40 | PRM_EXPORT_API \\r | |
| 41 | EFIAPI \\r | |
| 42 | Name ( \\r | |
| 43 | IN VOID *ParameterBuffer, \\r | |
| 44 | IN PRM_CONTEXT_BUFFER *ContextBuffer \\r | |
| 45 | ) \\r | |
| 46 | \r | |
| d2998af2 | 47 | #endif\r |