OcDeviceTreeLib.h

Go to the documentation of this file.

 
#ifndef OC_DEVICE_TREE_LIB_H
#define OC_DEVICE_TREE_LIB_H
 
//
// Device tree property name prefixes for loaded kexts or mkext.
//
#define DT_BOOTER_KEXT_PREFIX   "Driver-"
#define DT_BOOTER_MKEXT_PREFIX  "DriversPackage-"
 
//
// Struct at the beginning of every loaded kext (10.4 and 10.5).
// Pointers to every loaded kext (to this struct) are
// properties Driver-<hex addr of DriverInfo> in DevTree /chosen/memory-map.
//
typedef struct DTBootxDriverInfo_ {
  UINT32    PlistPhysAddr;
  UINT32    PlistLength;
  UINT32    ModuleAddress;
  UINT32    ModuleLength;
} DTBootxDriverInfo;
typedef struct DTBootxDriverInfo_ {…};
 
//
// Struct at the beginning of every loaded kext (10.6 and newer).
// Pointers to every loaded kext (to this struct) are
// properties Driver-<hex addr of DriverInfo> in DevTree /chosen/memory-map.
//
typedef struct DTBooterKextFileInfo_ {
  UINT32    InfoDictPhysAddr;
  UINT32    InfoDictLength;
  UINT32    ExecutablePhysAddr;
  UINT32    ExecutableLength;
  UINT32    BundlePathPhysAddr;
  UINT32    BundlePathLength;
} DTBooterKextFileInfo;
typedef struct DTBooterKextFileInfo_ {…};
 
//
// DeviceTree MemoryMap entry structure.
//
typedef struct DTMemMapEntry_ {
  UINT32    Address;
  UINT32    Length;
} DTMemMapEntry;
typedef struct DTMemMapEntry_ {…};
 
//
// Foundation Types.
//
 
#define DT_PATH_NAME_SEPERATOR  '/'        
 
#define DT_MAX_PROPERTY_NAME_LENGTH  31    
#define DT_MAX_ENTRY_NAME_LENGTH     31    
#define DT_PROPERTY_NAME_LENGTH      32
 
typedef CHAR8 DTEntryNameBuf[DT_PROPERTY_NAME_LENGTH];        
 
typedef struct OpaqueDTEntry_ DeviceTreeNode;
typedef DeviceTreeNode        *DTEntry;                       
 
typedef struct OpaqueDTProperty_ DTProperty;
 
typedef struct DTSavedScope_ DTSavedScope;
typedef DTSavedScope         *DTSavedScopePtr;
 
typedef struct OpaqueDTEntryIterator_ OpaqueDTEntryIterator;
typedef OpaqueDTEntryIterator         *DTEntryIterator;
 
typedef struct OpaqueDTPropertyIterator_ OpaqueDTPropertyIterator;
typedef OpaqueDTPropertyIterator         *DTPropertyIterator;
 
//
// Structures for a Flattened Device Tree.
//
 
struct OpaqueDTProperty_ {
  CHAR8     Name[DT_PROPERTY_NAME_LENGTH]; 
  UINT32    Length;                        
};
struct OpaqueDTProperty_ {…};
 
struct OpaqueDTEntry_ {
  UINT32    NumProperties;        // Number of props[] elements (0 => end)
  UINT32    NumChildren;          // Number of children[] elements
};
struct OpaqueDTEntry_ {…};
 
//
// Entry.
//
 
struct DTSavedScope_ {
  DTSavedScopePtr    NextScope;
  DTEntry            Scope;
  DTEntry            Entry;
  UINT32             Index;
};
struct DTSavedScope_ {…};
 
//
// Entry Iterator.
//
struct OpaqueDTEntryIterator_ {
  DTEntry            OuterScope;
  DTEntry            CurrentScope;
  DTEntry            CurrentEntry;
  DTSavedScopePtr    SavedScope;
  UINT32             CurrentIndex;
};
struct OpaqueDTEntryIterator_ {…};
 
//
// Property Iterator.
//
struct OpaqueDTPropertyIterator_ {
  DTEntry       Entry;
  DTProperty    *CurrentProperty;
  UINT32        CurrentIndex;
};
struct OpaqueDTPropertyIterator_ {…};
 
EFI_STATUS
DTLookupEntry (
  IN CONST DTEntry  SearchPoint,
  IN CONST CHAR8    *PathName,
  IN DTEntry        *FoundEntry
  );
 
EFI_STATUS
DTCreateEntryIterator (
  IN CONST DTEntry    StartEntry,
  IN DTEntryIterator  *Iterator
  );
 
EFI_STATUS
DTDisposeEntryIterator (
  IN DTEntryIterator  Iterator
  );
 
EFI_STATUS
DTEnterEntry (
  IN DTEntryIterator  Iterator,
  IN DTEntry          ChildEntry
  );
 
EFI_STATUS
DTExitEntry (
  IN DTEntryIterator  Iterator,
  IN DTEntry          *CurrentPosition
  );
 
EFI_STATUS
DTIterateEntries (
  IN DTEntryIterator  Iterator,
  IN DTEntry          *NextEntry
  );
 
EFI_STATUS
DTRestartEntryIteration (
  IN DTEntryIterator  Iterator
  );
 
EFI_STATUS
DTGetProperty (
  IN CONST DTEntry  Entry,
  IN CHAR8          *PropertyName,
  IN VOID           **PropertyValue,
  IN UINT32         *PropertySize
  );
 
EFI_STATUS
DTCreatePropertyIterator (
  IN CONST DTEntry       Entry,
  IN DTPropertyIterator  Iterator
  );
 
EFI_STATUS
DTIterateProperties (
  IN DTPropertyIterator  Iterator,
  IN CHAR8               **FoundProperty
  );
 
EFI_STATUS
DTRestartPropertyIteration (
  IN DTPropertyIterator  Iterator
  );
 
//
// Exported Functions
//
 
VOID
DTInit (
  IN VOID    *Base,
  IN UINT32  *Length
  );
 
VOID
DumpDeviceTree (
  VOID
  );
 
UINT32
DTDeleteProperty (
  IN CHAR8  *NodeName,
  IN CHAR8  *DeletePropertyName
  );
 
VOID
DTInsertProperty (
  IN CHAR8    *NodeName,
  IN CHAR8    *InsertPropertyName,
  IN CHAR8    *AddPropertyName,
  IN VOID     *AddPropertyValue,
  IN UINT32   ValueLength,
  IN BOOLEAN  InsertAfter OPTIONAL
  );
 
#endif // OC_DEVICE_TREE_LIB_H