Mac Dev Center Mac OS X Reference Library Drivers, Kernel, & Hardware: User-Space Device Access I/O Kit Framework Reference

IOFireWireConfigDirectoryInterface

Declared In:

IOFireWireLib.h

Overview

IOFireWireLib device config ROM browsing interface

Discussion

Represents an interface to the config ROM of a remote device. You can use the methods of this interface to browser the ROM and obtain key values. You can also create additional IOFireWireConfigDirectoryInterface's to represent subdirectories within the ROM.

Functions

GetIndexEntry
GetIndexKey
GetIndexOffset_FWAddress
GetIndexOffset_UInt32
GetIndexType
GetIndexValue_ConfigDirectory
GetIndexValue_Data
GetIndexValue_String
GetIndexValue_UInt32
GetKeyOffset_FWAddress
GetKeySubdirectories
GetKeyType
GetKeyValue_ConfigDirectory
GetKeyValue_Data
GetKeyValue_UInt32
GetNumEntries
GetSubdirectories
GetType
Update: Causes the ROM data to be updated through the specified byte offset. This function should not be called in normal usage.

GetIndexEntry

IOReturn ( *GetIndexEntry) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    UInt32 *outValue);

Discussion

Description forthcoming

GetIndexKey

IOReturn ( *GetIndexKey) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    int *key);

Discussion

Description forthcoming

GetIndexOffset_FWAddress

IOReturn ( *GetIndexOffset_FWAddress) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    FWAddress *outValue);

Discussion

Description forthcoming

GetIndexOffset_UInt32

IOReturn ( *GetIndexOffset_UInt32) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    UInt32 *outValue);

Discussion

Description forthcoming

GetIndexType

IOReturn ( *GetIndexType) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    IOConfigKeyType *type);

Discussion

Description forthcoming

GetIndexValue_ConfigDirectory

IOReturn ( *GetIndexValue_ConfigDirectory) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    IOFireWireLibConfigDirectoryRef *outValue,
    REFIID iid);

Discussion

Description forthcoming

GetIndexValue_Data

IOReturn ( *GetIndexValue_Data) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    CFDataRef *value);

Discussion

Description forthcoming

GetIndexValue_String

IOReturn ( *GetIndexValue_String) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    CFStringRef *outValue);

Discussion

Description forthcoming

GetIndexValue_UInt32

IOReturn ( *GetIndexValue_UInt32) (
    IOFireWireLibConfigDirectoryRef self,
    int inIndex,
    UInt32 *value);

Discussion

Description forthcoming

GetKeyOffset_FWAddress

IOReturn ( *GetKeyOffset_FWAddress) (
    IOFireWireLibConfigDirectoryRef self,
    int inKey,
    FWAddress *outValue,
    CFStringRef *text);

Discussion

Description forthcoming

GetKeySubdirectories

IOReturn ( *GetKeySubdirectories) (
    IOFireWireLibConfigDirectoryRef self,
    int inKey,
    io_iterator_t *outIterator);

Discussion

Description forthcoming

GetKeyType

IOReturn ( *GetKeyType) (
    IOFireWireLibConfigDirectoryRef self,
    int inKey,
    IOConfigKeyType *outType);

Discussion

Description forthcoming

GetKeyValue_ConfigDirectory

IOReturn ( *GetKeyValue_ConfigDirectory) (
    IOFireWireLibConfigDirectoryRef self,
    int inKey,
    IOFireWireLibConfigDirectoryRef *outValue,
    REFIID iid,
    CFStringRef *outText);

Discussion

Description forthcoming

GetKeyValue_Data

IOReturn ( *GetKeyValue_Data) (
    IOFireWireLibConfigDirectoryRef self,
    int inKey,
    CFDataRef *outValue,
    CFStringRef *outText);

Discussion

Description forthcoming

GetKeyValue_UInt32

IOReturn ( *GetKeyValue_UInt32) (
    IOFireWireLibConfigDirectoryRef self,
    int inKey,
    UInt32 *outValue,
    CFStringRef *outText);

Discussion

Description forthcoming

GetNumEntries

IOReturn ( *GetNumEntries) (
    IOFireWireLibConfigDirectoryRef self,
    int *outNumEntries);

Discussion

Description forthcoming

GetSubdirectories

IOReturn ( *GetSubdirectories) (
    IOFireWireLibConfigDirectoryRef self,
    io_iterator_t *outIterator);

Discussion

Description forthcoming

GetType

IOReturn ( *GetType) (
    IOFireWireLibConfigDirectoryRef self,
    int *outType);

Discussion

Description forthcoming

Update

Causes the ROM data to be updated through the specified byte offset. This function should not be called in normal usage.

IOReturn ( *Update) (
    IOFireWireLibConfigDirectoryRef self,
    UInt32 inOffset);

Parameters

self: The config directory interface of interest
inOffset: Offset in bytes indicating length of ROM to be updated.

Return Value

An IOReturn result code

Member Data

revision
version

revision

UInt32 revision;

Discussion

Interface revision.

version

UInt32 version;

Discussion

Interface version.

Did this document help you?

Shop the Apple Online Store (1-800-MY-APPLE), visit an Apple Retail Store, or find a reseller.

Last Updated: 2009-10-15