ConfigurationManagerObject.h

Go to the documentation of this file.

 
#ifndef CONFIGURATION_MANAGER_OBJECT_H_
#define CONFIGURATION_MANAGER_OBJECT_H_
 
#include <ArchCommonNameSpaceObjects.h>
#include <ArmNameSpaceObjects.h>
#include <StandardNameSpaceObjects.h>
#include <X64NameSpaceObjects.h>
 
#pragma pack(1)
 
typedef UINT32 CM_OBJECT_ID;
 
//
// Helper macro to format a CM_OBJECT_ID.
//
#define FMT_CM_OBJECT_ID  "0x%lx"
 
#define OBJECT_ID_MASK  0xFF
 
#define NAMESPACE_ID_MASK  0xF
 
#define NAMESPACE_ID_BIT_SHIFT  28
 
typedef enum ObjectNameSpaceID {
  EObjNameSpaceStandard,          
  EObjNameSpaceArchCommon,        
  EObjNameSpaceArm,               
  EObjNameSpaceX64,               
  EObjNameSpaceOem = 0xF,         
  EObjNameSpaceMax,
} EOBJECT_NAMESPACE_ID;
 
typedef struct CmObjDescriptor {
  CM_OBJECT_ID    ObjectId;
 
  UINT32          Size;
 
  VOID            *Data;
 
  UINT32          Count;
} CM_OBJ_DESCRIPTOR;
 
#pragma pack()
 
#define GET_CM_NAMESPACE_ID(CmObjectId)               \
          (((CmObjectId) >> NAMESPACE_ID_BIT_SHIFT) & \
            NAMESPACE_ID_MASK)
 
#define GET_CM_OBJECT_ID(CmObjectId)  ((CmObjectId) & OBJECT_ID_MASK)
 
#define CREATE_CM_OBJECT_ID(NameSpaceId, ObjectId)                           \
          ((((NameSpaceId) & NAMESPACE_ID_MASK) << NAMESPACE_ID_BIT_SHIFT) | \
            ((ObjectId) & OBJECT_ID_MASK))
 
#define CREATE_CM_STD_OBJECT_ID(ObjectId) \
          (CREATE_CM_OBJECT_ID (EObjNameSpaceStandard, ObjectId))
 
#define CREATE_CM_ARM_OBJECT_ID(ObjectId) \
          (CREATE_CM_OBJECT_ID (EObjNameSpaceArm, ObjectId))
 
#define CREATE_CM_ARCH_COMMON_OBJECT_ID(ObjectId) \
          (CREATE_CM_OBJECT_ID (EObjNameSpaceArchCommon, ObjectId))
 
#define CREATE_CM_OEM_OBJECT_ID(ObjectId) \
          (CREATE_CM_OBJECT_ID (EObjNameSpaceOem, ObjectId))
 
#define CREATE_CM_X64_OBJECT_ID(ObjectId) \
          (CREATE_CM_OBJECT_ID (EObjNameSpaceX64, ObjectId))
 
#endif // CONFIGURATION_MANAGER_OBJECT_H_