#include <ConfigurationManagerObject.h>

Data Structures
struct	ConfigurationManagerProtocol

Macros
#define	EDKII_CONFIGURATION_MANAGER_PROTOCOL_GUID

#define	EDKII_CONFIGURATION_MANAGER_PROTOCOL_REVISION CREATE_REVISION (1, 0)

Typedefs
typedef struct ConfigurationManagerProtocol	EDKII_CONFIGURATION_MANAGER_PROTOCOL

typedef struct PlatformRepositoryInfo	EDKII_PLATFORM_REPOSITORY_INFO

typedef EFI_STATUS(EFIAPI *	EDKII_CONFIGURATION_MANAGER_GET_OBJECT) (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL CONST This, IN CONST CM_OBJECT_ID CmObjectId, IN CONST CM_OBJECT_TOKEN Token OPTIONAL, IN OUT CM_OBJ_DESCRIPTOR CONST CmObject)

typedef EFI_STATUS(EFIAPI *	EDKII_CONFIGURATION_MANAGER_SET_OBJECT) (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL CONST This, IN CONST CM_OBJECT_ID CmObjectId, IN CONST CM_OBJECT_TOKEN Token OPTIONAL, IN CM_OBJ_DESCRIPTOR CONST CmObject)

Variables
EFI_GUID	gEdkiiConfigurationManagerProtocolGuid

Detailed Description

SPDX-License-Identifier: BSD-2-Clause-Patent

Glossary:

Cm or CM - Configuration Manager
Obj or OBJ - Object

Definition in file ConfigurationManagerProtocol.h.

Macro Definition Documentation

◆ EDKII_CONFIGURATION_MANAGER_PROTOCOL_GUID

#define EDKII_CONFIGURATION_MANAGER_PROTOCOL_GUID

Value:

  { 0xd85a4835, 0x5a82, 0x4894,                         \
    { 0xac, 0x2, 0x70, 0x6f, 0x43, 0xd5, 0x97, 0x8e }   \
  };

This macro defines the Configuration Manager Protocol GUID.

GUID: {D85A4835-5A82-4894-AC02-706F43D5978E}

Definition at line 21 of file ConfigurationManagerProtocol.h.

◆ EDKII_CONFIGURATION_MANAGER_PROTOCOL_REVISION

#define EDKII_CONFIGURATION_MANAGER_PROTOCOL_REVISION CREATE_REVISION (1, 0)

This macro defines the Configuration Manager Protocol Revision.

Definition at line 28 of file ConfigurationManagerProtocol.h.

Typedef Documentation

◆ EDKII_CONFIGURATION_MANAGER_GET_OBJECT

typedef EFI_STATUS(EFIAPI * EDKII_CONFIGURATION_MANAGER_GET_OBJECT) (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST This, IN CONST CM_OBJECT_ID CmObjectId, IN CONST CM_OBJECT_TOKEN Token OPTIONAL, IN OUT CM_OBJ_DESCRIPTOR *CONST CmObject)

The GetObject function defines the interface implemented by the Configuration Manager Protocol for returning the Configuration Manager Objects.

Parameters

[in]	This	Pointer to the Configuration Manager Protocol.
[in]	CmObjectId	The Configuration Manager Object ID.
[in]	Token	An optional token identifying the object. If unused this must be CM_NULL_TOKEN.
[out]	CmObject	Pointer to the Configuration Manager Object descriptor describing the requested Object.

Return values

EFI_SUCCESS	Success.
EFI_INVALID_PARAMETER	A parameter is invalid.
EFI_NOT_FOUND	The required object information is not found.
EFI_BAD_BUFFER_SIZE	The size returned by the Configuration Manager is less than the Object size for the requested object.

Definition at line 57 of file ConfigurationManagerProtocol.h.

◆ EDKII_CONFIGURATION_MANAGER_PROTOCOL

typedef struct ConfigurationManagerProtocol EDKII_CONFIGURATION_MANAGER_PROTOCOL

Forward declarations:

The EDKII_CONFIGURATION_MANAGER_PROTOCOL structure describes the Configuration Manager Protocol interface.

Definition at line 35 of file ConfigurationManagerProtocol.h.

◆ EDKII_CONFIGURATION_MANAGER_SET_OBJECT

typedef EFI_STATUS(EFIAPI * EDKII_CONFIGURATION_MANAGER_SET_OBJECT) (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST This, IN CONST CM_OBJECT_ID CmObjectId, IN CONST CM_OBJECT_TOKEN Token OPTIONAL, IN CM_OBJ_DESCRIPTOR *CONST CmObject)

The SetObject function defines the interface implemented by the Configuration Manager Protocol for updating the Configuration Manager Objects.

Parameters

[in]	This	Pointer to the Configuration Manager Protocol.
[in]	CmObjectId	The Configuration Manager Object ID.
[in]	Token	An optional token identifying the object. If unused this must be CM_NULL_TOKEN.
[out]	CmObject	Pointer to the Configuration Manager Object descriptor describing the Object.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	A parameter is invalid.
EFI_NOT_FOUND	The required object information is not found.
EFI_BAD_BUFFER_SIZE	The size returned by the Configuration Manager is less than the Object size for the requested object.
EFI_UNSUPPORTED	This operation is not supported.

Definition at line 85 of file ConfigurationManagerProtocol.h.

◆ EDKII_PLATFORM_REPOSITORY_INFO

typedef struct PlatformRepositoryInfo EDKII_PLATFORM_REPOSITORY_INFO

Definition at line 36 of file ConfigurationManagerProtocol.h.

Variable Documentation

◆ gEdkiiConfigurationManagerProtocolGuid

EFI_GUID gEdkiiConfigurationManagerProtocolGuid

extern

The Configuration Manager Protocol GUID.

Data Structures

Macros

Typedefs

Variables