projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 6b085d3c SM |
1 | /** @file\r |
| 2 | \r | |
| 3 | Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.\r | |
| 4 | \r | |
| 9cd9bdc6 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 6b085d3c SM |
6 | \r |
| 7 | @par Glossary:\r | |
| 8 | - Cm or CM - Configuration Manager\r | |
| 9 | - Obj or OBJ - Object\r | |
| 10 | **/\r | |
| 11 | \r | |
| 12 | #ifndef CONFIGURATION_MANAGER_PROTOCOL_H_\r | |
| 13 | #define CONFIGURATION_MANAGER_PROTOCOL_H_\r | |
| 14 | \r | |
| 15 | #include <ConfigurationManagerObject.h>\r | |
| 16 | \r | |
| 17 | /** This macro defines the Configuration Manager Protocol GUID.\r | |
| 18 | \r | |
| 19 | GUID: {D85A4835-5A82-4894-AC02-706F43D5978E}\r | |
| 20 | */\r | |
| 21 | #define EDKII_CONFIGURATION_MANAGER_PROTOCOL_GUID \\r | |
| 22 | { 0xd85a4835, 0x5a82, 0x4894, \\r | |
| 23 | { 0xac, 0x2, 0x70, 0x6f, 0x43, 0xd5, 0x97, 0x8e } \\r | |
| 24 | };\r | |
| 25 | \r | |
| 26 | /** This macro defines the Configuration Manager Protocol Revision.\r | |
| 27 | */\r | |
| 28 | #define EDKII_CONFIGURATION_MANAGER_PROTOCOL_REVISION CREATE_REVISION (1, 0)\r | |
| 29 | \r | |
| 30 | #pragma pack(1)\r | |
| 31 | \r | |
| 32 | /**\r | |
| 33 | Forward declarations:\r | |
| 34 | */\r | |
| 35 | typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL;\r | |
| 36 | typedef struct PlatformRepositoryInfo EDKII_PLATFORM_REPOSITORY_INFO;\r | |
| 37 | \r | |
| 38 | /** The GetObject function defines the interface implemented by the\r | |
| 39 | Configuration Manager Protocol for returning the Configuration\r | |
| 40 | Manager Objects.\r | |
| 41 | \r | |
| 42 | @param [in] This Pointer to the Configuration Manager Protocol.\r | |
| 43 | @param [in] CmObjectId The Configuration Manager Object ID.\r | |
| 44 | @param [in] Token An optional token identifying the object. If\r | |
| 45 | unused this must be CM_NULL_TOKEN.\r | |
| 46 | @param [out] CmObject Pointer to the Configuration Manager Object\r | |
| 47 | descriptor describing the requested Object.\r | |
| 48 | \r | |
| 49 | @retval EFI_SUCCESS Success.\r | |
| 50 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
| 51 | @retval EFI_NOT_FOUND The required object information is not found.\r | |
| 52 | @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration Manager\r | |
| 53 | is less than the Object size for the requested\r | |
| 54 | object.\r | |
| 55 | **/\r | |
| 56 | typedef\r | |
| 57 | EFI_STATUS\r | |
| 58 | (EFIAPI * EDKII_CONFIGURATION_MANAGER_GET_OBJECT) (\r | |
| 59 | IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST This,\r | |
| 60 | IN CONST CM_OBJECT_ID CmObjectId,\r | |
| 61 | IN CONST CM_OBJECT_TOKEN Token OPTIONAL,\r | |
| 62 | IN OUT CM_OBJ_DESCRIPTOR * CONST CmObject\r | |
| 63 | );\r | |
| 64 | \r | |
| 65 | /** The SetObject function defines the interface implemented by the\r | |
| 66 | Configuration Manager Protocol for updating the Configuration\r | |
| 67 | Manager Objects.\r | |
| 68 | \r | |
| 69 | @param [in] This Pointer to the Configuration Manager Protocol.\r | |
| 70 | @param [in] CmObjectId The Configuration Manager Object ID.\r | |
| 71 | @param [in] Token An optional token identifying the object. If\r | |
| 72 | unused this must be CM_NULL_TOKEN.\r | |
| 73 | @param [out] CmObject Pointer to the Configuration Manager Object\r | |
| 74 | descriptor describing the Object.\r | |
| 75 | \r | |
| 76 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| 77 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
| 78 | @retval EFI_NOT_FOUND The required object information is not found.\r | |
| 79 | @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration Manager\r | |
| 80 | is less than the Object size for the requested\r | |
| 81 | object.\r | |
| 82 | @retval EFI_UNSUPPORTED This operation is not supported.\r | |
| 83 | **/\r | |
| 84 | typedef\r | |
| 85 | EFI_STATUS\r | |
| 86 | (EFIAPI * EDKII_CONFIGURATION_MANAGER_SET_OBJECT) (\r | |
| 87 | IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST This,\r | |
| 88 | IN CONST CM_OBJECT_ID CmObjectId,\r | |
| 89 | IN CONST CM_OBJECT_TOKEN Token OPTIONAL,\r | |
| 90 | IN CM_OBJ_DESCRIPTOR * CONST CmObject\r | |
| 91 | );\r | |
| 92 | \r | |
| 93 | /** The EDKII_CONFIGURATION_MANAGER_PROTOCOL structure describes the\r | |
| 94 | Configuration Manager Protocol interface.\r | |
| 95 | */\r | |
| 96 | typedef struct ConfigurationManagerProtocol {\r | |
| 97 | /// The Configuration Manager Protocol revision.\r | |
| 98 | UINT32 Revision;\r | |
| 99 | \r | |
| 100 | /** The interface used to request information about\r | |
| 101 | the Configuration Manager Objects.\r | |
| 102 | */\r | |
| 103 | EDKII_CONFIGURATION_MANAGER_GET_OBJECT GetObject;\r | |
| 104 | \r | |
| 105 | /** The interface used to update the information stored\r | |
| 106 | in the Configuration Manager repository.\r | |
| 107 | */\r | |
| 108 | EDKII_CONFIGURATION_MANAGER_SET_OBJECT SetObject;\r | |
| 109 | \r | |
| 110 | /** Pointer to an implementation defined abstract repository\r | |
| 111 | provisioned by the Configuration Manager.\r | |
| 112 | */\r | |
| 113 | EDKII_PLATFORM_REPOSITORY_INFO * PlatRepoInfo;\r | |
| 114 | } EDKII_CONFIGURATION_MANAGER_PROTOCOL;\r | |
| 115 | \r | |
| 116 | /** The Configuration Manager Protocol GUID.\r | |
| 117 | */\r | |
| 118 | extern EFI_GUID gEdkiiConfigurationManagerProtocolGuid;\r | |
| 119 | \r | |
| 120 | #pragma pack()\r | |
| 121 | \r | |
| 122 | #endif // CONFIGURATION_MANAGER_PROTOCOL_H_\r |