FrT;@1|>>0|$15|HeaderDoc::Test%26|$4|CODE$7|COMMENT$7|CPPCODE$15|EXPECTED_RESULT$23|EXPECTED_RESULT_ALLDECS$7|FAILMSG$8|FILENAME$4|LANG$4|NAME$6|RESULT$14|RESULT_ALLDECS$7|SUBLANG$4|TYPE$47989|typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS ; UInt32 version, revision ; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)(IOFireWireLibDeviceRef self) ; /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)(IOFireWireLibDeviceRef self) ; /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)(IOFireWireLibDeviceRef self) ; /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)(IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef) ; /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)(IOFireWireLibDeviceRef self) ; // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self) ; /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) ; /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self) ; /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self) ; /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)(IOFireWireLibDeviceRef self) ; /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler) ; /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler) ; /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)(IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status) ; // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) ; /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation) ; /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) ; /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation) ; /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation) ; // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) ; /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef.*/ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) ; /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef.*/ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) ; /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) ; /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) ; // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset @param self The device interface to use. */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self) ; /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result @result An IOReturn error code. */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime) ; /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID @result An IOReturn error code. */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID) ; /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID @result An IOReturn error code. */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID) ; /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. @result An IOReturn error code. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime) ; // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid) ; // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid) ; /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid) ; // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) ; /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid) ; // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg) ; // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @result An IOReturn error code. */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) ; /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid) ; /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid) ; /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ) ; /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ) ; // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. @result Returns the user's reference value set on this interface. */ void* (*GetRefCon)( IOFireWireLibDeviceRef self) ; /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. @param refCon The reference value to set. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon) ; // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType) ; /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found in the program. */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength) ; // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) ; /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source @result An IOReturn error code. */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) ; /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source @result An IOReturn error code. */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) ; /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self) ; /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ) ; /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ) ; /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time @result An IOReturn error code. */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime) ; // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) ; /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation) ; /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'.*/ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ) ; /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number.*/ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ) ; /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number.*/ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ) ; /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number.*/ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed) ; /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number.*/ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed) ; } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface ; $1723|/*! @interface IOFireWireDeviceInterface @abstract IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. @discussion You can use IOFireWireDeviceInterface to:
*/ $0|$1891704|-=: TOP LEVEL COMMENT PARSE VALUES :=- inHeader: 0 inClass: 1 inInterface: 1 inCPPHeader: 0 inOCCHeader: 0 inPerlScript: 0 inShellScript: 0 inPHPScript: 0 inJavaSource: 0 inFunctionGroup: 0 inGroup: 0 inFunction: 0 inPDefine: 0 inTypedef: 0 inUnion: 0 inStruct: 0 inConstant: 0 inVar: 0 inEnum: 0 inMethod: 0 inAvailabilityMacro: 0 inUnknown: 0 classType: unknown inputCounter: 0 blockOffset: 0 fullpath: /test_suite_bogus_path/COM_interface_1.test -=: BLOCKPARSE PARSER STATE KEYS :=- $parserState->{FULLPATH} => /test_suite_bogus_path/COM_interface_1.test $parserState->{NEXTTOKENNOCPP} => 0 $parserState->{availability} => $parserState->{backslashcount} => 0 $parserState->{basetype} => struct $parserState->{bracePending} => 0 $parserState->{callbackIsTypedef} => 1 $parserState->{callbackName} => $parserState->{callbackNamePending} => -1 $parserState->{categoryClass} => $parserState->{classtype} => $parserState->{freezeStack} => ARRAY(OBJID) $parserState->{freezereturn} => 1 $parserState->{frozensodname} => $parserState->{functionReturnsCallback} => 0 $parserState->{hollow} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{inBrackets} => 0 $parserState->{inChar} => 0 $parserState->{inClass} => 0 $parserState->{inComment} => 0 $parserState->{inEnum} => 0 $parserState->{inInlineComment} => 0 $parserState->{inMacro} => 0 $parserState->{inMacroLine} => 0 $parserState->{inOperator} => 0 $parserState->{inPrivateParamTypes} => 0 $parserState->{inString} => 0 $parserState->{inTemplate} => 0 $parserState->{inTypedef} => 1 $parserState->{inUnion} => 0 $parserState->{initbsCount} => 0 $parserState->{inputCounter} => 291 $parserState->{kr_c_function} => 0 $parserState->{kr_c_name} => $parserState->{lang} => C $parserState->{lastTreeNode} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{lastsymbol} => IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface; $parserState->{leavingComment} => 0 $parserState->{macroNoTrunc} => 1 $parserState->{name} => IOFireWireDeviceInterface_t $parserState->{namePending} => 0 $parserState->{noInsert} => 0 $parserState->{occmethod} => 0 $parserState->{occmethodname} => $parserState->{occparmlabelfound} => 3 $parserState->{onlyComments} => 0 $parserState->{parsedParamList} => ARRAY(OBJID) $parserState->{parsedParamParse} => 1 $parserState->{posstypes} => typedef struct $parserState->{posstypesPending} => 0 $parserState->{pplStack} => ARRAY(OBJID) $parserState->{preEqualsSymbol} => $parserState->{preTemplateSymbol} => $parserState->{returntype} => typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS $parserState->{seenBraces} => 0 $parserState->{seenMacroPart} => 0 $parserState->{seenTilde} => 0 $parserState->{simpleTDcontents} => $parserState->{simpleTypedef} => 0 $parserState->{sodclass} => $parserState->{sodname} => $parserState->{sodtype} => $parserState->{stackFrozen} => 0 $parserState->{startOfDec} => 1 $parserState->{temponlyComments} => 0 $parserState->{treePopTwo} => 0 $parserState->{typestring} => typedef $parserState->{value} => $parserState->{valuepending} => 0 -=: BLOCKPARSE RETURN VALUES :=- newcount: 291 typelist: typedef typedef typedef struct namelist: IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface,IOFireWireDeviceInterface_t posstypes: typedef struct value: returntype: typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS pridec: simpleTDcontents: bpavail: blockOffset: 606 conformsToList: functionContents: extendsClass: implementsClass: -=: LIST OF PARSED PARAMETERS :=- Parsed Param 0 => IUNKNOWN_C_GUTS Parsed Param 1 => UInt32 version, revision Parsed Param 2 => Boolean (*InterfaceIsInited)(IOFireWireLibDeviceRef self) Parsed Param 3 => io_object_t (*GetDevice)(IOFireWireLibDeviceRef self) Parsed Param 4 => IOReturn (*Open)(IOFireWireLibDeviceRef self) Parsed Param 5 => IOReturn (*OpenWithSessionRef)(IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef) Parsed Param 6 => void (*Close)(IOFireWireLibDeviceRef self) Parsed Param 7 => const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self) Parsed Param 8 => const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 9 => const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self) Parsed Param 10 => const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self) Parsed Param 11 => void (*TurnOffNotification)(IOFireWireLibDeviceRef self) Parsed Param 12 => const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler) Parsed Param 13 => const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler) Parsed Param 14 => void (*ClientCommandIsComplete)(IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status) Parsed Param 15 => IOReturn (*Read)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 16 => IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation) Parsed Param 17 => IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 18 => IOReturn (*WriteQuadlet)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation) Parsed Param 19 => IOReturn (*CompareSwap)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation) Parsed Param 20 => IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 21 => IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 22 => IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 23 => IOFireWireLibCommandRef (*CreateWriteQuadletCommand)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 24 => IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 25 => IOReturn (*BusReset)( IOFireWireLibDeviceRef self) Parsed Param 26 => IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime) Parsed Param 27 => IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID) Parsed Param 28 => IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID) Parsed Param 29 => IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime) Parsed Param 30 => IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 31 => IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 32 => IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid) Parsed Param 33 => IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 34 => IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 35 => IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg) Parsed Param 36 => IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 37 => IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid) Parsed Param 38 => UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid) Parsed Param 39 => IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ) Parsed Param 40 => IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ) Parsed Param 41 => void* (*GetRefCon)( IOFireWireLibDeviceRef self) Parsed Param 42 => void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon) Parsed Param 43 => CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType) Parsed Param 44 => void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength) Parsed Param 45 => IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 46 => IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 47 => IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 48 => void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self) Parsed Param 49 => IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ) Parsed Param 50 => IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ) Parsed Param 51 => IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime) Parsed Param 52 => IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 53 => IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation) Parsed Param 54 => IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ) Parsed Param 55 => IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ) Parsed Param 56 => IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ) Parsed Param 57 => IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed) Parsed Param 58 => IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed) -=: DUMP OF PARSE TREE :=- +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] -=: COMPUTED VALUE :=- SUCCESS: 0 VALUE: 0 -=: CPP CHANGES :=- NO CPP CHANGES -=: FOUND MATCH :=- 1 -=: NAMED OBJECTS :=- TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Header NAME: COM interface 1 APIUID: //test_ref/doc/header/COM_interface_1.test ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::Header" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: InterfaceIsInited APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/InterfaceIsInited ABSTRACT: "

Determine whether interface has been properly inited. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetDevice APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetDevice ABSTRACT: "

Get the IOKit service to which this interface is connected. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "io_object_t" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Open APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Open ABSTRACT: "

Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: OpenWithSessionRef APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/OpenWithSessionRef ABSTRACT: "

An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: sessionRef TYPE: IOFireWireSessionRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: IOFireWireSessionRef TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The sessionRef returned from the client who has the device open" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Close APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Close ABSTRACT: "

Release exclusive access to the device " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: NotificationIsOn APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/NotificationIsOn ABSTRACT: "

Determine whether callback notifications for this interface are currently active " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoop ABSTRACT: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveCallbackDispatcherFromRunLoop ABSTRACT: "

Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOnNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOnNotification ABSTRACT: "

Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOffNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOffNotification ABSTRACT: "

Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetHandler ABSTRACT: "

Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetDoneHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetDoneHandler ABSTRACT: "

Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetDoneHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetDoneHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ClientCommandIsComplete APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ClientCommandIsComplete ABSTRACT: "

This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: FWClientCommandID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: IOReturn APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The command ID passed to the callback function when it was called" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An IOReturn value indicating the completion status of the callback function" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Read APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Read ABSTRACT: "

Perform synchronous block read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ReadQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ReadQuadlet ABSTRACT: "

Perform synchronous quadlet read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: value TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to where to data should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Write APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Write ABSTRACT: "

Perform synchronous block write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: WriteQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/WriteQuadlet ABSTRACT: "

Perform synchronous quadlet write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: const UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The value to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The check/compare value" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Value to set" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadCommand ABSTRACT: "

Create a block read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadQuadletCommand ABSTRACT: "

Create a quadlet read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets where results should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: TYPE: APIUID: //test_ref/c/internal_temporary_object/CreateReadQuadletCommand ABSTRACT: "" DISCUSSION: " " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteCommand ABSTRACT: "

Create a block write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the buffer containing the data to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteQuadletCommand ABSTRACT: "

Create a quadlet write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets containing quadlets to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand ABSTRACT: "

Create a quadlet compare/swap command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: BusReset APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/BusReset ABSTRACT: "

Cause a bus reset " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetCycleTime ABSTRACT: "

Get bus cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetGenerationAndNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetGenerationAndNodeID ABSTRACT: "

(Obsolete) Get bus generation and remote device node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the generation result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the remote device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeID ABSTRACT: "

(Obsolete) Get local node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the local device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetResetTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetResetTime ABSTRACT: "

Get time since last bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: AbsoluteTime * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an AbsolutTime to hold the result." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalUnitDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalUnitDirectory ABSTRACT: "

Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalUnitDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetConfigDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetConfigDirectory ABSTRACT: "

Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateConfigDirectoryWithIOObject APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateConfigDirectoryWithIOObject ABSTRACT: "

This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inObject TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePseudoAddressSpace ABSTRACT: "

Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePhysicalAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePhysicalAddressSpace ABSTRACT: "

Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPhysicalAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop ABSTRACT: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateRemoteIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateRemoteIsochPort ABSTRACT: "

Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibRemoteIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalIsochPort ABSTRACT: "

Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start event bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start state bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start mask bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inBufferRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateIsochChannel APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateIsochChannel ABSTRACT: "

Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibIsochChannelRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIrm TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: IOFWSpeed APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIRM TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The preferred bus speed of this channel." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateDCLCommandPool APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateDCLCommandPool ABSTRACT: "

Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibDCLCommandPoolRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Starting size of command pool" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRefCon ABSTRACT: "

Get user reference value set on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void *" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetRefCon ABSTRACT: "

Set user reference value on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The reference value to set." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: PrintDCLProgram APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/PrintDCLProgram ABSTRACT: "

Walk a DCL program linked list and print its contents " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: const DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL of the program to print" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found in the program." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateInitialUnitsPseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateInitialUnitsPseudoAddressSpace ABSTRACT: "

Creates a pseudo address space in initial units space. " DISCUSSION: "

Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine.

Availablilty: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The lower 32 bits of the base address of the address space to be created. The address is always in initial units space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib callbacks to function. " DISCUSSION: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop_DONTLINK_1 ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveIsochCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveIsochCallbackDispatcherFromRunLoop ABSTRACT: "

Removes an IOFireWireLib-added run loop event source. " DISCUSSION: "

Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Seize APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Seize ABSTRACT: "

Seize control of device/unit " DISCUSSION: "

Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function.

Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked.

When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: IOOptionBits APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: reserved TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Reserved for future use. Set to NULL." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: FireLog APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/FireLog ABSTRACT: "

Logs string to in-kernel debug buffer " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: format TYPE: const char * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusCycleTime ABSTRACT: "

Get bus and cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the cycle time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand64 ABSTRACT: "

Create a quadlet compare/swap command object and initialize it with 64-bit values. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap64 ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported.

If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets expected at target." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to atomically set at target if compare is successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to hold value found at target address after transaction if completed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of compare swap transaction to perform. Value values are 4 and 8." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusGeneration ABSTRACT: "

Get bus generation number. " DISCUSSION: "

The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs.

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus generation number" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeIDWithGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeIDWithGeneration ABSTRACT: "

Get node ID of local machine. " DISCUSSION: "

Use this function instead of GetLocalNodeID().

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the local machine." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRemoteNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRemoteNodeID ABSTRACT: "

Get node ID of device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedToNode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedToNode ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum speed to the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedBetweenNodes APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedBetweenNodes ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireUnitInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireNubInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface_t APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

-=: NAMED OBJECT PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) +---Boolean +--- +---( | +---* | +---InterfaceIsInited | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) +---io_object_t +--- +---( | +---* | +---GetDevice | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Open (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Open | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---OpenWithSessionRef | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireSessionRef | +--- | +---sessionRef | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Close (HeaderDoc::Function) +---void +--- +---( | +---* | +---Close | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---NotificationIsOn | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) +---const +--- +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---const +--- +---void +--- +---( | +---* | +---RemoveCallbackDispatcherFromRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---TurnOnNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) +---void +--- +---( | +---* | +---TurnOffNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetDoneHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetDoneHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetDoneHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) +---void +--- +---( | +---* | +---ClientCommandIsComplete | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---FWClientCommandID | +--- | +---commandID | +---, | +--- | +---IOReturn | +--- | +---status | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Read (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Read | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---ReadQuadlet | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---val | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Write (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Write | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---WriteQuadlet | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---const | +--- | +---UInt32 | +--- | +---val | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadQuadletCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteQuadletCommand | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---BusReset | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetGenerationAndNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetResetTime | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---AbsoluteTime | +---* | +--- | +---outResetTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) +---IOFireWireLibLocalUnitDirectoryRef +--- +---( | +---* | +---CreateLocalUnitDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---GetConfigDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---CreateConfigDirectoryWithIOObject | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---inObject | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreatePseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) +---IOFireWireLibPhysicalAddressSpaceRef +--- +---( | +---* | +---CreatePhysicalAddressSpace | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---inSize | +---, | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +--- | +---UInt32 | +--- | +---inFlags | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) +---IOFireWireLibRemoteIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateRemoteIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) +---IOFireWireLibLocalIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateLocalIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---DCLCommandPtr | +--- | +---inDCLProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartEvent | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartState | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartMask | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inDCLProgramRanges | +---[ | | +---] | +---, | +--- | +---// | | +--- | | +---optional optimization parameters | | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inDCLProgramRangeCount | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inBufferRanges | +---[ | | +---] | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inBufferRangeCount | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) +---IOFireWireLibIsochChannelRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateIsochChannel | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---doIrm | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---packetSize | +---, | +---[ NEWLINE ] | +--- | +---IOFWSpeed | +--- | +---prefSpeed | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) +---IOFireWireLibDCLCommandPoolRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateDCLCommandPool | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) +---void +---* +--- +---( | +---* | +---GetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) +---void +--- +---( | +---* | +---SetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---refCon | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) +---void +--- +---( | +---* | +---PrintDCLProgram | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---DCLCommandPtr | +--- | +---inProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inLength | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreateInitialUnitsPseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inAddressLo | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---void +--- +---( | +---* | +---RemoveIsochCallbackDispatcherFromRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Seize (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Seize | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOOptionBits | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---FireLog | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---char | +---* | +--- | +---format | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outBusTime | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt64 | +--- | +---cmpVal | +---, | +--- | +---UInt64 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---expectedVal | +---, | +--- | +---UInt32 | +---* | +--- | +---newVal | +---, | +--- | +---UInt32 | +---* | +--- | +---oldVal | +---, | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeIDWithGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetRemoteNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outRemoteNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedToNode | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedBetweenNodes | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +--- | +---srcNodeID | +---, | +--- | +---UInt16 | +--- | +---destNodeID | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT -=: HTML OUTPUT OF PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) Boolean ( *InterfaceIsInited)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) io_object_t ( *GetDevice)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Open (HeaderDoc::Function) IOReturn ( *Open)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) IOReturn ( *OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); END OF OBJECT OBJECT: Close (HeaderDoc::Function) void ( *Close)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) void ( *TurnOffNotification)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) void ( *ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); END OF OBJECT OBJECT: Read (HeaderDoc::Function) IOReturn ( *Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) IOReturn ( *ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: Write (HeaderDoc::Function) IOReturn ( *Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) IOReturn ( *WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) IOReturn ( *CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) IOReturn ( *BusReset)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) IOReturn ( *GetCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outCycleTime); END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) IOReturn ( *GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32 *outGeneration, UInt16 *outNodeID); END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) IOReturn ( *GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16 *outLocalNodeID); END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) IOReturn ( *GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime *outResetTime); END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) IOFireWireLibLocalUnitDirectoryRef ( *CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) IOFireWireLibPhysicalAddressSpaceRef ( *CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) IOFireWireLibRemoteIsochPortRef ( *CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) IOFireWireLibLocalIsochPortRef ( *CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) IOFireWireLibIsochChannelRef ( *CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) IOFireWireLibDCLCommandPoolRef ( *CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) void* ( *GetRefCon)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) void ( *SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) void ( *PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) void ( *RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Seize (HeaderDoc::Function) IOReturn ( *Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) IOReturn ( *FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) IOReturn ( *GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outBusTime, UInt32 *outCycleTime); END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) IOReturn ( *CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) IOReturn ( *GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32 *outGeneration ); END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) IOReturn ( *GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outLocalNodeID ); END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) IOReturn ( *GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outRemoteNodeID ); END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) IOReturn ( *GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) IOReturn ( *GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT $1891704|-=: TOP LEVEL COMMENT PARSE VALUES :=- inHeader: 0 inClass: 1 inInterface: 1 inCPPHeader: 0 inOCCHeader: 0 inPerlScript: 0 inShellScript: 0 inPHPScript: 0 inJavaSource: 0 inFunctionGroup: 0 inGroup: 0 inFunction: 0 inPDefine: 0 inTypedef: 0 inUnion: 0 inStruct: 0 inConstant: 0 inVar: 0 inEnum: 0 inMethod: 0 inAvailabilityMacro: 0 inUnknown: 0 classType: unknown inputCounter: 0 blockOffset: 0 fullpath: /test_suite_bogus_path/COM_interface_1.test -=: BLOCKPARSE PARSER STATE KEYS :=- $parserState->{FULLPATH} => /test_suite_bogus_path/COM_interface_1.test $parserState->{NEXTTOKENNOCPP} => 0 $parserState->{availability} => $parserState->{backslashcount} => 0 $parserState->{basetype} => struct $parserState->{bracePending} => 0 $parserState->{callbackIsTypedef} => 1 $parserState->{callbackName} => $parserState->{callbackNamePending} => -1 $parserState->{categoryClass} => $parserState->{classtype} => $parserState->{freezeStack} => ARRAY(OBJID) $parserState->{freezereturn} => 1 $parserState->{frozensodname} => $parserState->{functionReturnsCallback} => 0 $parserState->{hollow} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{inBrackets} => 0 $parserState->{inChar} => 0 $parserState->{inClass} => 0 $parserState->{inComment} => 0 $parserState->{inEnum} => 0 $parserState->{inInlineComment} => 0 $parserState->{inMacro} => 0 $parserState->{inMacroLine} => 0 $parserState->{inOperator} => 0 $parserState->{inPrivateParamTypes} => 0 $parserState->{inString} => 0 $parserState->{inTemplate} => 0 $parserState->{inTypedef} => 1 $parserState->{inUnion} => 0 $parserState->{initbsCount} => 0 $parserState->{inputCounter} => 291 $parserState->{kr_c_function} => 0 $parserState->{kr_c_name} => $parserState->{lang} => C $parserState->{lastTreeNode} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{lastsymbol} => IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface; $parserState->{leavingComment} => 0 $parserState->{macroNoTrunc} => 1 $parserState->{name} => IOFireWireDeviceInterface_t $parserState->{namePending} => 0 $parserState->{noInsert} => 0 $parserState->{occmethod} => 0 $parserState->{occmethodname} => $parserState->{occparmlabelfound} => 3 $parserState->{onlyComments} => 0 $parserState->{parsedParamList} => ARRAY(OBJID) $parserState->{parsedParamParse} => 1 $parserState->{posstypes} => typedef struct $parserState->{posstypesPending} => 0 $parserState->{pplStack} => ARRAY(OBJID) $parserState->{preEqualsSymbol} => $parserState->{preTemplateSymbol} => $parserState->{returntype} => typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS $parserState->{seenBraces} => 0 $parserState->{seenMacroPart} => 0 $parserState->{seenTilde} => 0 $parserState->{simpleTDcontents} => $parserState->{simpleTypedef} => 0 $parserState->{sodclass} => $parserState->{sodname} => $parserState->{sodtype} => $parserState->{stackFrozen} => 0 $parserState->{startOfDec} => 1 $parserState->{temponlyComments} => 0 $parserState->{treePopTwo} => 0 $parserState->{typestring} => typedef $parserState->{value} => $parserState->{valuepending} => 0 -=: BLOCKPARSE RETURN VALUES :=- newcount: 291 typelist: typedef typedef typedef struct namelist: IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface,IOFireWireDeviceInterface_t posstypes: typedef struct value: returntype: typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS pridec: simpleTDcontents: bpavail: blockOffset: 606 conformsToList: functionContents: extendsClass: implementsClass: -=: LIST OF PARSED PARAMETERS :=- Parsed Param 0 => IUNKNOWN_C_GUTS Parsed Param 1 => UInt32 version, revision Parsed Param 2 => Boolean (*InterfaceIsInited)(IOFireWireLibDeviceRef self) Parsed Param 3 => io_object_t (*GetDevice)(IOFireWireLibDeviceRef self) Parsed Param 4 => IOReturn (*Open)(IOFireWireLibDeviceRef self) Parsed Param 5 => IOReturn (*OpenWithSessionRef)(IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef) Parsed Param 6 => void (*Close)(IOFireWireLibDeviceRef self) Parsed Param 7 => const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self) Parsed Param 8 => const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 9 => const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self) Parsed Param 10 => const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self) Parsed Param 11 => void (*TurnOffNotification)(IOFireWireLibDeviceRef self) Parsed Param 12 => const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler) Parsed Param 13 => const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler) Parsed Param 14 => void (*ClientCommandIsComplete)(IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status) Parsed Param 15 => IOReturn (*Read)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 16 => IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation) Parsed Param 17 => IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 18 => IOReturn (*WriteQuadlet)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation) Parsed Param 19 => IOReturn (*CompareSwap)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation) Parsed Param 20 => IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 21 => IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 22 => IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 23 => IOFireWireLibCommandRef (*CreateWriteQuadletCommand)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 24 => IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 25 => IOReturn (*BusReset)( IOFireWireLibDeviceRef self) Parsed Param 26 => IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime) Parsed Param 27 => IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID) Parsed Param 28 => IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID) Parsed Param 29 => IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime) Parsed Param 30 => IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 31 => IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 32 => IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid) Parsed Param 33 => IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 34 => IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 35 => IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg) Parsed Param 36 => IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 37 => IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid) Parsed Param 38 => UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid) Parsed Param 39 => IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ) Parsed Param 40 => IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ) Parsed Param 41 => void* (*GetRefCon)( IOFireWireLibDeviceRef self) Parsed Param 42 => void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon) Parsed Param 43 => CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType) Parsed Param 44 => void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength) Parsed Param 45 => IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 46 => IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 47 => IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 48 => void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self) Parsed Param 49 => IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ) Parsed Param 50 => IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ) Parsed Param 51 => IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime) Parsed Param 52 => IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 53 => IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation) Parsed Param 54 => IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ) Parsed Param 55 => IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ) Parsed Param 56 => IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ) Parsed Param 57 => IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed) Parsed Param 58 => IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed) -=: DUMP OF PARSE TREE :=- +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] -=: COMPUTED VALUE :=- SUCCESS: 0 VALUE: 0 -=: CPP CHANGES :=- NO CPP CHANGES -=: FOUND MATCH :=- 1 -=: NAMED OBJECTS :=- TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Header NAME: COM interface 1 APIUID: //test_ref/doc/header/COM_interface_1.test ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::Header" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: InterfaceIsInited APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/InterfaceIsInited ABSTRACT: "

Determine whether interface has been properly inited. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetDevice APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetDevice ABSTRACT: "

Get the IOKit service to which this interface is connected. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "io_object_t" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Open APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Open ABSTRACT: "

Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: OpenWithSessionRef APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/OpenWithSessionRef ABSTRACT: "

An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: sessionRef TYPE: IOFireWireSessionRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: IOFireWireSessionRef TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The sessionRef returned from the client who has the device open" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Close APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Close ABSTRACT: "

Release exclusive access to the device " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: NotificationIsOn APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/NotificationIsOn ABSTRACT: "

Determine whether callback notifications for this interface are currently active " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoop ABSTRACT: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveCallbackDispatcherFromRunLoop ABSTRACT: "

Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOnNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOnNotification ABSTRACT: "

Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOffNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOffNotification ABSTRACT: "

Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetHandler ABSTRACT: "

Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetDoneHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetDoneHandler ABSTRACT: "

Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetDoneHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetDoneHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ClientCommandIsComplete APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ClientCommandIsComplete ABSTRACT: "

This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: FWClientCommandID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: IOReturn APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The command ID passed to the callback function when it was called" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An IOReturn value indicating the completion status of the callback function" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Read APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Read ABSTRACT: "

Perform synchronous block read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ReadQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ReadQuadlet ABSTRACT: "

Perform synchronous quadlet read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: value TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to where to data should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Write APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Write ABSTRACT: "

Perform synchronous block write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: WriteQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/WriteQuadlet ABSTRACT: "

Perform synchronous quadlet write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: const UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The value to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The check/compare value" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Value to set" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadCommand ABSTRACT: "

Create a block read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadQuadletCommand ABSTRACT: "

Create a quadlet read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets where results should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: TYPE: APIUID: //test_ref/c/internal_temporary_object/CreateReadQuadletCommand ABSTRACT: "" DISCUSSION: " " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteCommand ABSTRACT: "

Create a block write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the buffer containing the data to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteQuadletCommand ABSTRACT: "

Create a quadlet write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets containing quadlets to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand ABSTRACT: "

Create a quadlet compare/swap command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: BusReset APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/BusReset ABSTRACT: "

Cause a bus reset " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetCycleTime ABSTRACT: "

Get bus cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetGenerationAndNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetGenerationAndNodeID ABSTRACT: "

(Obsolete) Get bus generation and remote device node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the generation result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the remote device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeID ABSTRACT: "

(Obsolete) Get local node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the local device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetResetTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetResetTime ABSTRACT: "

Get time since last bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: AbsoluteTime * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an AbsolutTime to hold the result." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalUnitDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalUnitDirectory ABSTRACT: "

Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalUnitDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetConfigDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetConfigDirectory ABSTRACT: "

Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateConfigDirectoryWithIOObject APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateConfigDirectoryWithIOObject ABSTRACT: "

This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inObject TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePseudoAddressSpace ABSTRACT: "

Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePhysicalAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePhysicalAddressSpace ABSTRACT: "

Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPhysicalAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop ABSTRACT: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateRemoteIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateRemoteIsochPort ABSTRACT: "

Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibRemoteIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalIsochPort ABSTRACT: "

Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start event bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start state bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start mask bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inBufferRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateIsochChannel APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateIsochChannel ABSTRACT: "

Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibIsochChannelRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIrm TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: IOFWSpeed APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIRM TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The preferred bus speed of this channel." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateDCLCommandPool APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateDCLCommandPool ABSTRACT: "

Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibDCLCommandPoolRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Starting size of command pool" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRefCon ABSTRACT: "

Get user reference value set on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void *" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetRefCon ABSTRACT: "

Set user reference value on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The reference value to set." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: PrintDCLProgram APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/PrintDCLProgram ABSTRACT: "

Walk a DCL program linked list and print its contents " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: const DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL of the program to print" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found in the program." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateInitialUnitsPseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateInitialUnitsPseudoAddressSpace ABSTRACT: "

Creates a pseudo address space in initial units space. " DISCUSSION: "

Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine.

Availablilty: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The lower 32 bits of the base address of the address space to be created. The address is always in initial units space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib callbacks to function. " DISCUSSION: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop_DONTLINK_1 ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveIsochCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveIsochCallbackDispatcherFromRunLoop ABSTRACT: "

Removes an IOFireWireLib-added run loop event source. " DISCUSSION: "

Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Seize APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Seize ABSTRACT: "

Seize control of device/unit " DISCUSSION: "

Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function.

Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked.

When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: IOOptionBits APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: reserved TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Reserved for future use. Set to NULL." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: FireLog APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/FireLog ABSTRACT: "

Logs string to in-kernel debug buffer " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: format TYPE: const char * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusCycleTime ABSTRACT: "

Get bus and cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the cycle time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand64 ABSTRACT: "

Create a quadlet compare/swap command object and initialize it with 64-bit values. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap64 ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported.

If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets expected at target." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to atomically set at target if compare is successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to hold value found at target address after transaction if completed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of compare swap transaction to perform. Value values are 4 and 8." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusGeneration ABSTRACT: "

Get bus generation number. " DISCUSSION: "

The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs.

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus generation number" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeIDWithGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeIDWithGeneration ABSTRACT: "

Get node ID of local machine. " DISCUSSION: "

Use this function instead of GetLocalNodeID().

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the local machine." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRemoteNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRemoteNodeID ABSTRACT: "

Get node ID of device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedToNode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedToNode ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum speed to the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedBetweenNodes APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedBetweenNodes ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireUnitInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireNubInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface_t APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

-=: NAMED OBJECT PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) +---Boolean +--- +---( | +---* | +---InterfaceIsInited | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) +---io_object_t +--- +---( | +---* | +---GetDevice | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Open (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Open | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---OpenWithSessionRef | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireSessionRef | +--- | +---sessionRef | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Close (HeaderDoc::Function) +---void +--- +---( | +---* | +---Close | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---NotificationIsOn | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) +---const +--- +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---const +--- +---void +--- +---( | +---* | +---RemoveCallbackDispatcherFromRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---TurnOnNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) +---void +--- +---( | +---* | +---TurnOffNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetDoneHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetDoneHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetDoneHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) +---void +--- +---( | +---* | +---ClientCommandIsComplete | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---FWClientCommandID | +--- | +---commandID | +---, | +--- | +---IOReturn | +--- | +---status | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Read (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Read | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---ReadQuadlet | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---val | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Write (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Write | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---WriteQuadlet | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---const | +--- | +---UInt32 | +--- | +---val | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadQuadletCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteQuadletCommand | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---BusReset | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetGenerationAndNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetResetTime | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---AbsoluteTime | +---* | +--- | +---outResetTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) +---IOFireWireLibLocalUnitDirectoryRef +--- +---( | +---* | +---CreateLocalUnitDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---GetConfigDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---CreateConfigDirectoryWithIOObject | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---inObject | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreatePseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) +---IOFireWireLibPhysicalAddressSpaceRef +--- +---( | +---* | +---CreatePhysicalAddressSpace | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---inSize | +---, | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +--- | +---UInt32 | +--- | +---inFlags | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) +---IOFireWireLibRemoteIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateRemoteIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) +---IOFireWireLibLocalIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateLocalIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---DCLCommandPtr | +--- | +---inDCLProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartEvent | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartState | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartMask | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inDCLProgramRanges | +---[ | | +---] | +---, | +--- | +---// | | +--- | | +---optional optimization parameters | | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inDCLProgramRangeCount | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inBufferRanges | +---[ | | +---] | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inBufferRangeCount | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) +---IOFireWireLibIsochChannelRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateIsochChannel | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---doIrm | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---packetSize | +---, | +---[ NEWLINE ] | +--- | +---IOFWSpeed | +--- | +---prefSpeed | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) +---IOFireWireLibDCLCommandPoolRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateDCLCommandPool | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) +---void +---* +--- +---( | +---* | +---GetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) +---void +--- +---( | +---* | +---SetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---refCon | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) +---void +--- +---( | +---* | +---PrintDCLProgram | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---DCLCommandPtr | +--- | +---inProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inLength | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreateInitialUnitsPseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inAddressLo | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---void +--- +---( | +---* | +---RemoveIsochCallbackDispatcherFromRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Seize (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Seize | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOOptionBits | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---FireLog | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---char | +---* | +--- | +---format | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outBusTime | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt64 | +--- | +---cmpVal | +---, | +--- | +---UInt64 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---expectedVal | +---, | +--- | +---UInt32 | +---* | +--- | +---newVal | +---, | +--- | +---UInt32 | +---* | +--- | +---oldVal | +---, | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeIDWithGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetRemoteNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outRemoteNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedToNode | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedBetweenNodes | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +--- | +---srcNodeID | +---, | +--- | +---UInt16 | +--- | +---destNodeID | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT -=: HTML OUTPUT OF PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) Boolean ( *InterfaceIsInited)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) io_object_t ( *GetDevice)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Open (HeaderDoc::Function) IOReturn ( *Open)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) IOReturn ( *OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); END OF OBJECT OBJECT: Close (HeaderDoc::Function) void ( *Close)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) void ( *TurnOffNotification)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) void ( *ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); END OF OBJECT OBJECT: Read (HeaderDoc::Function) IOReturn ( *Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) IOReturn ( *ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: Write (HeaderDoc::Function) IOReturn ( *Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) IOReturn ( *WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) IOReturn ( *CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) IOReturn ( *BusReset)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) IOReturn ( *GetCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outCycleTime); END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) IOReturn ( *GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32 *outGeneration, UInt16 *outNodeID); END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) IOReturn ( *GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16 *outLocalNodeID); END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) IOReturn ( *GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime *outResetTime); END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) IOFireWireLibLocalUnitDirectoryRef ( *CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) IOFireWireLibPhysicalAddressSpaceRef ( *CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) IOFireWireLibRemoteIsochPortRef ( *CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) IOFireWireLibLocalIsochPortRef ( *CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) IOFireWireLibIsochChannelRef ( *CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) IOFireWireLibDCLCommandPoolRef ( *CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) void* ( *GetRefCon)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) void ( *SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) void ( *PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) void ( *RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Seize (HeaderDoc::Function) IOReturn ( *Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) IOReturn ( *FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) IOReturn ( *GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outBusTime, UInt32 *outCycleTime); END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) IOReturn ( *CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) IOReturn ( *GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32 *outGeneration ); END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) IOReturn ( *GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outLocalNodeID ); END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) IOReturn ( *GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outRemoteNodeID ); END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) IOReturn ( *GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) IOReturn ( *GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT _$43|testsuite/parser_tests/COM_interface_1.test$1|C$15|COM interface 1$1891704|-=: TOP LEVEL COMMENT PARSE VALUES :=- inHeader: 0 inClass: 1 inInterface: 1 inCPPHeader: 0 inOCCHeader: 0 inPerlScript: 0 inShellScript: 0 inPHPScript: 0 inJavaSource: 0 inFunctionGroup: 0 inGroup: 0 inFunction: 0 inPDefine: 0 inTypedef: 0 inUnion: 0 inStruct: 0 inConstant: 0 inVar: 0 inEnum: 0 inMethod: 0 inAvailabilityMacro: 0 inUnknown: 0 classType: unknown inputCounter: 0 blockOffset: 0 fullpath: /test_suite_bogus_path/COM_interface_1.test -=: BLOCKPARSE PARSER STATE KEYS :=- $parserState->{FULLPATH} => /test_suite_bogus_path/COM_interface_1.test $parserState->{NEXTTOKENNOCPP} => 0 $parserState->{availability} => $parserState->{backslashcount} => 0 $parserState->{basetype} => struct $parserState->{bracePending} => 0 $parserState->{callbackIsTypedef} => 1 $parserState->{callbackName} => $parserState->{callbackNamePending} => -1 $parserState->{categoryClass} => $parserState->{classtype} => $parserState->{freezeStack} => ARRAY(OBJID) $parserState->{freezereturn} => 1 $parserState->{frozensodname} => $parserState->{functionReturnsCallback} => 0 $parserState->{hollow} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{inBrackets} => 0 $parserState->{inChar} => 0 $parserState->{inClass} => 0 $parserState->{inComment} => 0 $parserState->{inEnum} => 0 $parserState->{inInlineComment} => 0 $parserState->{inMacro} => 0 $parserState->{inMacroLine} => 0 $parserState->{inOperator} => 0 $parserState->{inPrivateParamTypes} => 0 $parserState->{inString} => 0 $parserState->{inTemplate} => 0 $parserState->{inTypedef} => 1 $parserState->{inUnion} => 0 $parserState->{initbsCount} => 0 $parserState->{inputCounter} => 291 $parserState->{kr_c_function} => 0 $parserState->{kr_c_name} => $parserState->{lang} => C $parserState->{lastTreeNode} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{lastsymbol} => IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface; $parserState->{leavingComment} => 0 $parserState->{macroNoTrunc} => 1 $parserState->{name} => IOFireWireDeviceInterface_t $parserState->{namePending} => 0 $parserState->{noInsert} => 0 $parserState->{occmethod} => 0 $parserState->{occmethodname} => $parserState->{occparmlabelfound} => 3 $parserState->{onlyComments} => 0 $parserState->{parsedParamList} => ARRAY(OBJID) $parserState->{parsedParamParse} => 1 $parserState->{posstypes} => typedef struct $parserState->{posstypesPending} => 0 $parserState->{pplStack} => ARRAY(OBJID) $parserState->{preEqualsSymbol} => $parserState->{preTemplateSymbol} => $parserState->{returntype} => typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS $parserState->{seenBraces} => 0 $parserState->{seenMacroPart} => 0 $parserState->{seenTilde} => 0 $parserState->{simpleTDcontents} => $parserState->{simpleTypedef} => 0 $parserState->{sodclass} => $parserState->{sodname} => $parserState->{sodtype} => $parserState->{stackFrozen} => 0 $parserState->{startOfDec} => 1 $parserState->{temponlyComments} => 0 $parserState->{treePopTwo} => 0 $parserState->{typestring} => typedef $parserState->{value} => $parserState->{valuepending} => 0 -=: BLOCKPARSE RETURN VALUES :=- newcount: 291 typelist: typedef typedef typedef struct namelist: IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface,IOFireWireDeviceInterface_t posstypes: typedef struct value: returntype: typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS pridec: simpleTDcontents: bpavail: blockOffset: 606 conformsToList: functionContents: extendsClass: implementsClass: -=: LIST OF PARSED PARAMETERS :=- Parsed Param 0 => IUNKNOWN_C_GUTS Parsed Param 1 => UInt32 version, revision Parsed Param 2 => Boolean (*InterfaceIsInited)(IOFireWireLibDeviceRef self) Parsed Param 3 => io_object_t (*GetDevice)(IOFireWireLibDeviceRef self) Parsed Param 4 => IOReturn (*Open)(IOFireWireLibDeviceRef self) Parsed Param 5 => IOReturn (*OpenWithSessionRef)(IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef) Parsed Param 6 => void (*Close)(IOFireWireLibDeviceRef self) Parsed Param 7 => const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self) Parsed Param 8 => const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 9 => const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self) Parsed Param 10 => const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self) Parsed Param 11 => void (*TurnOffNotification)(IOFireWireLibDeviceRef self) Parsed Param 12 => const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler) Parsed Param 13 => const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler) Parsed Param 14 => void (*ClientCommandIsComplete)(IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status) Parsed Param 15 => IOReturn (*Read)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 16 => IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation) Parsed Param 17 => IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 18 => IOReturn (*WriteQuadlet)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation) Parsed Param 19 => IOReturn (*CompareSwap)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation) Parsed Param 20 => IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 21 => IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 22 => IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 23 => IOFireWireLibCommandRef (*CreateWriteQuadletCommand)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 24 => IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 25 => IOReturn (*BusReset)( IOFireWireLibDeviceRef self) Parsed Param 26 => IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime) Parsed Param 27 => IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID) Parsed Param 28 => IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID) Parsed Param 29 => IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime) Parsed Param 30 => IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 31 => IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 32 => IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid) Parsed Param 33 => IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 34 => IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 35 => IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg) Parsed Param 36 => IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 37 => IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid) Parsed Param 38 => UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid) Parsed Param 39 => IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ) Parsed Param 40 => IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ) Parsed Param 41 => void* (*GetRefCon)( IOFireWireLibDeviceRef self) Parsed Param 42 => void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon) Parsed Param 43 => CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType) Parsed Param 44 => void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength) Parsed Param 45 => IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 46 => IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 47 => IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 48 => void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self) Parsed Param 49 => IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ) Parsed Param 50 => IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ) Parsed Param 51 => IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime) Parsed Param 52 => IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 53 => IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation) Parsed Param 54 => IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ) Parsed Param 55 => IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ) Parsed Param 56 => IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ) Parsed Param 57 => IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed) Parsed Param 58 => IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed) -=: DUMP OF PARSE TREE :=- +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] -=: COMPUTED VALUE :=- SUCCESS: 0 VALUE: 0 -=: CPP CHANGES :=- NO CPP CHANGES -=: FOUND MATCH :=- 1 -=: NAMED OBJECTS :=- TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Header NAME: COM interface 1 APIUID: //test_ref/doc/header/COM_interface_1.test ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::Header" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: InterfaceIsInited APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/InterfaceIsInited ABSTRACT: "

Determine whether interface has been properly inited. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetDevice APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetDevice ABSTRACT: "

Get the IOKit service to which this interface is connected. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "io_object_t" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Open APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Open ABSTRACT: "

Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: OpenWithSessionRef APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/OpenWithSessionRef ABSTRACT: "

An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: sessionRef TYPE: IOFireWireSessionRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: IOFireWireSessionRef TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The sessionRef returned from the client who has the device open" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Close APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Close ABSTRACT: "

Release exclusive access to the device " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: NotificationIsOn APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/NotificationIsOn ABSTRACT: "

Determine whether callback notifications for this interface are currently active " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoop ABSTRACT: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveCallbackDispatcherFromRunLoop ABSTRACT: "

Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOnNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOnNotification ABSTRACT: "

Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOffNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOffNotification ABSTRACT: "

Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetHandler ABSTRACT: "

Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetDoneHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetDoneHandler ABSTRACT: "

Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetDoneHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetDoneHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ClientCommandIsComplete APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ClientCommandIsComplete ABSTRACT: "

This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: FWClientCommandID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: IOReturn APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The command ID passed to the callback function when it was called" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An IOReturn value indicating the completion status of the callback function" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Read APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Read ABSTRACT: "

Perform synchronous block read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ReadQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ReadQuadlet ABSTRACT: "

Perform synchronous quadlet read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: value TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to where to data should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Write APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Write ABSTRACT: "

Perform synchronous block write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: WriteQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/WriteQuadlet ABSTRACT: "

Perform synchronous quadlet write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: const UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The value to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The check/compare value" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Value to set" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadCommand ABSTRACT: "

Create a block read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadQuadletCommand ABSTRACT: "

Create a quadlet read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets where results should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: TYPE: APIUID: //test_ref/c/internal_temporary_object/CreateReadQuadletCommand ABSTRACT: "" DISCUSSION: " " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteCommand ABSTRACT: "

Create a block write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the buffer containing the data to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteQuadletCommand ABSTRACT: "

Create a quadlet write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets containing quadlets to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand ABSTRACT: "

Create a quadlet compare/swap command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: BusReset APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/BusReset ABSTRACT: "

Cause a bus reset " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetCycleTime ABSTRACT: "

Get bus cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetGenerationAndNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetGenerationAndNodeID ABSTRACT: "

(Obsolete) Get bus generation and remote device node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the generation result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the remote device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeID ABSTRACT: "

(Obsolete) Get local node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the local device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetResetTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetResetTime ABSTRACT: "

Get time since last bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: AbsoluteTime * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an AbsolutTime to hold the result." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalUnitDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalUnitDirectory ABSTRACT: "

Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalUnitDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetConfigDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetConfigDirectory ABSTRACT: "

Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateConfigDirectoryWithIOObject APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateConfigDirectoryWithIOObject ABSTRACT: "

This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inObject TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePseudoAddressSpace ABSTRACT: "

Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePhysicalAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePhysicalAddressSpace ABSTRACT: "

Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPhysicalAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop ABSTRACT: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateRemoteIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateRemoteIsochPort ABSTRACT: "

Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibRemoteIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalIsochPort ABSTRACT: "

Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start event bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start state bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start mask bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inBufferRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateIsochChannel APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateIsochChannel ABSTRACT: "

Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibIsochChannelRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIrm TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: IOFWSpeed APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIRM TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The preferred bus speed of this channel." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateDCLCommandPool APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateDCLCommandPool ABSTRACT: "

Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibDCLCommandPoolRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Starting size of command pool" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRefCon ABSTRACT: "

Get user reference value set on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void *" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetRefCon ABSTRACT: "

Set user reference value on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The reference value to set." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: PrintDCLProgram APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/PrintDCLProgram ABSTRACT: "

Walk a DCL program linked list and print its contents " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: const DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL of the program to print" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found in the program." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateInitialUnitsPseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateInitialUnitsPseudoAddressSpace ABSTRACT: "

Creates a pseudo address space in initial units space. " DISCUSSION: "

Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine.

Availablilty: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The lower 32 bits of the base address of the address space to be created. The address is always in initial units space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib callbacks to function. " DISCUSSION: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop_DONTLINK_1 ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveIsochCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveIsochCallbackDispatcherFromRunLoop ABSTRACT: "

Removes an IOFireWireLib-added run loop event source. " DISCUSSION: "

Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Seize APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Seize ABSTRACT: "

Seize control of device/unit " DISCUSSION: "

Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function.

Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked.

When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: IOOptionBits APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: reserved TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Reserved for future use. Set to NULL." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: FireLog APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/FireLog ABSTRACT: "

Logs string to in-kernel debug buffer " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: format TYPE: const char * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusCycleTime ABSTRACT: "

Get bus and cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the cycle time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand64 ABSTRACT: "

Create a quadlet compare/swap command object and initialize it with 64-bit values. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap64 ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported.

If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets expected at target." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to atomically set at target if compare is successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to hold value found at target address after transaction if completed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of compare swap transaction to perform. Value values are 4 and 8." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusGeneration ABSTRACT: "

Get bus generation number. " DISCUSSION: "

The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs.

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus generation number" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeIDWithGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeIDWithGeneration ABSTRACT: "

Get node ID of local machine. " DISCUSSION: "

Use this function instead of GetLocalNodeID().

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the local machine." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRemoteNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRemoteNodeID ABSTRACT: "

Get node ID of device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedToNode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedToNode ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum speed to the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedBetweenNodes APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedBetweenNodes ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireUnitInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireNubInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface_t APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

-=: NAMED OBJECT PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) +---Boolean +--- +---( | +---* | +---InterfaceIsInited | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) +---io_object_t +--- +---( | +---* | +---GetDevice | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Open (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Open | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---OpenWithSessionRef | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireSessionRef | +--- | +---sessionRef | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Close (HeaderDoc::Function) +---void +--- +---( | +---* | +---Close | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---NotificationIsOn | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) +---const +--- +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---const +--- +---void +--- +---( | +---* | +---RemoveCallbackDispatcherFromRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---TurnOnNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) +---void +--- +---( | +---* | +---TurnOffNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetDoneHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetDoneHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetDoneHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) +---void +--- +---( | +---* | +---ClientCommandIsComplete | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---FWClientCommandID | +--- | +---commandID | +---, | +--- | +---IOReturn | +--- | +---status | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Read (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Read | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---ReadQuadlet | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---val | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Write (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Write | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---WriteQuadlet | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---const | +--- | +---UInt32 | +--- | +---val | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadQuadletCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteQuadletCommand | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---BusReset | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetGenerationAndNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetResetTime | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---AbsoluteTime | +---* | +--- | +---outResetTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) +---IOFireWireLibLocalUnitDirectoryRef +--- +---( | +---* | +---CreateLocalUnitDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---GetConfigDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---CreateConfigDirectoryWithIOObject | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---inObject | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreatePseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) +---IOFireWireLibPhysicalAddressSpaceRef +--- +---( | +---* | +---CreatePhysicalAddressSpace | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---inSize | +---, | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +--- | +---UInt32 | +--- | +---inFlags | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) +---IOFireWireLibRemoteIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateRemoteIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) +---IOFireWireLibLocalIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateLocalIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---DCLCommandPtr | +--- | +---inDCLProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartEvent | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartState | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartMask | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inDCLProgramRanges | +---[ | | +---] | +---, | +--- | +---// | | +--- | | +---optional optimization parameters | | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inDCLProgramRangeCount | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inBufferRanges | +---[ | | +---] | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inBufferRangeCount | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) +---IOFireWireLibIsochChannelRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateIsochChannel | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---doIrm | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---packetSize | +---, | +---[ NEWLINE ] | +--- | +---IOFWSpeed | +--- | +---prefSpeed | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) +---IOFireWireLibDCLCommandPoolRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateDCLCommandPool | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) +---void +---* +--- +---( | +---* | +---GetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) +---void +--- +---( | +---* | +---SetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---refCon | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) +---void +--- +---( | +---* | +---PrintDCLProgram | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---DCLCommandPtr | +--- | +---inProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inLength | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreateInitialUnitsPseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inAddressLo | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---void +--- +---( | +---* | +---RemoveIsochCallbackDispatcherFromRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Seize (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Seize | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOOptionBits | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---FireLog | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---char | +---* | +--- | +---format | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outBusTime | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt64 | +--- | +---cmpVal | +---, | +--- | +---UInt64 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---expectedVal | +---, | +--- | +---UInt32 | +---* | +--- | +---newVal | +---, | +--- | +---UInt32 | +---* | +--- | +---oldVal | +---, | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeIDWithGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetRemoteNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outRemoteNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedToNode | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedBetweenNodes | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +--- | +---srcNodeID | +---, | +--- | +---UInt16 | +--- | +---destNodeID | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT -=: HTML OUTPUT OF PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) Boolean ( *InterfaceIsInited)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) io_object_t ( *GetDevice)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Open (HeaderDoc::Function) IOReturn ( *Open)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) IOReturn ( *OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); END OF OBJECT OBJECT: Close (HeaderDoc::Function) void ( *Close)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) void ( *TurnOffNotification)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) void ( *ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); END OF OBJECT OBJECT: Read (HeaderDoc::Function) IOReturn ( *Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) IOReturn ( *ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: Write (HeaderDoc::Function) IOReturn ( *Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) IOReturn ( *WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) IOReturn ( *CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) IOReturn ( *BusReset)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) IOReturn ( *GetCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outCycleTime); END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) IOReturn ( *GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32 *outGeneration, UInt16 *outNodeID); END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) IOReturn ( *GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16 *outLocalNodeID); END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) IOReturn ( *GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime *outResetTime); END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) IOFireWireLibLocalUnitDirectoryRef ( *CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) IOFireWireLibPhysicalAddressSpaceRef ( *CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) IOFireWireLibRemoteIsochPortRef ( *CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) IOFireWireLibLocalIsochPortRef ( *CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) IOFireWireLibIsochChannelRef ( *CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) IOFireWireLibDCLCommandPoolRef ( *CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) void* ( *GetRefCon)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) void ( *SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) void ( *PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) void ( *RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Seize (HeaderDoc::Function) IOReturn ( *Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) IOReturn ( *FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) IOReturn ( *GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outBusTime, UInt32 *outCycleTime); END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) IOReturn ( *CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) IOReturn ( *GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32 *outGeneration ); END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) IOReturn ( *GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outLocalNodeID ); END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) IOReturn ( *GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outRemoteNodeID ); END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) IOReturn ( *GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) IOReturn ( *GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT $1891704|-=: TOP LEVEL COMMENT PARSE VALUES :=- inHeader: 0 inClass: 1 inInterface: 1 inCPPHeader: 0 inOCCHeader: 0 inPerlScript: 0 inShellScript: 0 inPHPScript: 0 inJavaSource: 0 inFunctionGroup: 0 inGroup: 0 inFunction: 0 inPDefine: 0 inTypedef: 0 inUnion: 0 inStruct: 0 inConstant: 0 inVar: 0 inEnum: 0 inMethod: 0 inAvailabilityMacro: 0 inUnknown: 0 classType: unknown inputCounter: 0 blockOffset: 0 fullpath: /test_suite_bogus_path/COM_interface_1.test -=: BLOCKPARSE PARSER STATE KEYS :=- $parserState->{FULLPATH} => /test_suite_bogus_path/COM_interface_1.test $parserState->{NEXTTOKENNOCPP} => 0 $parserState->{availability} => $parserState->{backslashcount} => 0 $parserState->{basetype} => struct $parserState->{bracePending} => 0 $parserState->{callbackIsTypedef} => 1 $parserState->{callbackName} => $parserState->{callbackNamePending} => -1 $parserState->{categoryClass} => $parserState->{classtype} => $parserState->{freezeStack} => ARRAY(OBJID) $parserState->{freezereturn} => 1 $parserState->{frozensodname} => $parserState->{functionReturnsCallback} => 0 $parserState->{hollow} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{inBrackets} => 0 $parserState->{inChar} => 0 $parserState->{inClass} => 0 $parserState->{inComment} => 0 $parserState->{inEnum} => 0 $parserState->{inInlineComment} => 0 $parserState->{inMacro} => 0 $parserState->{inMacroLine} => 0 $parserState->{inOperator} => 0 $parserState->{inPrivateParamTypes} => 0 $parserState->{inString} => 0 $parserState->{inTemplate} => 0 $parserState->{inTypedef} => 1 $parserState->{inUnion} => 0 $parserState->{initbsCount} => 0 $parserState->{inputCounter} => 291 $parserState->{kr_c_function} => 0 $parserState->{kr_c_name} => $parserState->{lang} => C $parserState->{lastTreeNode} => HeaderDoc::ParseTree=HASH(OBJID) $parserState->{lastsymbol} => IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface; $parserState->{leavingComment} => 0 $parserState->{macroNoTrunc} => 1 $parserState->{name} => IOFireWireDeviceInterface_t $parserState->{namePending} => 0 $parserState->{noInsert} => 0 $parserState->{occmethod} => 0 $parserState->{occmethodname} => $parserState->{occparmlabelfound} => 3 $parserState->{onlyComments} => 0 $parserState->{parsedParamList} => ARRAY(OBJID) $parserState->{parsedParamParse} => 1 $parserState->{posstypes} => typedef struct $parserState->{posstypesPending} => 0 $parserState->{pplStack} => ARRAY(OBJID) $parserState->{preEqualsSymbol} => $parserState->{preTemplateSymbol} => $parserState->{returntype} => typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS $parserState->{seenBraces} => 0 $parserState->{seenMacroPart} => 0 $parserState->{seenTilde} => 0 $parserState->{simpleTDcontents} => $parserState->{simpleTypedef} => 0 $parserState->{sodclass} => $parserState->{sodname} => $parserState->{sodtype} => $parserState->{stackFrozen} => 0 $parserState->{startOfDec} => 1 $parserState->{temponlyComments} => 0 $parserState->{treePopTwo} => 0 $parserState->{typestring} => typedef $parserState->{value} => $parserState->{valuepending} => 0 -=: BLOCKPARSE RETURN VALUES :=- newcount: 291 typelist: typedef typedef typedef struct namelist: IOFireWireDeviceInterface,IOFireWireUnitInterface,IOFireWireNubInterface,IOFireWireDeviceInterface_t posstypes: typedef struct value: returntype: typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS pridec: simpleTDcontents: bpavail: blockOffset: 606 conformsToList: functionContents: extendsClass: implementsClass: -=: LIST OF PARSED PARAMETERS :=- Parsed Param 0 => IUNKNOWN_C_GUTS Parsed Param 1 => UInt32 version, revision Parsed Param 2 => Boolean (*InterfaceIsInited)(IOFireWireLibDeviceRef self) Parsed Param 3 => io_object_t (*GetDevice)(IOFireWireLibDeviceRef self) Parsed Param 4 => IOReturn (*Open)(IOFireWireLibDeviceRef self) Parsed Param 5 => IOReturn (*OpenWithSessionRef)(IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef) Parsed Param 6 => void (*Close)(IOFireWireLibDeviceRef self) Parsed Param 7 => const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self) Parsed Param 8 => const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 9 => const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self) Parsed Param 10 => const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self) Parsed Param 11 => void (*TurnOffNotification)(IOFireWireLibDeviceRef self) Parsed Param 12 => const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler) Parsed Param 13 => const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler) Parsed Param 14 => void (*ClientCommandIsComplete)(IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status) Parsed Param 15 => IOReturn (*Read)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 16 => IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation) Parsed Param 17 => IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation) Parsed Param 18 => IOReturn (*WriteQuadlet)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation) Parsed Param 19 => IOReturn (*CompareSwap)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation) Parsed Param 20 => IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 21 => IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 22 => IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 23 => IOFireWireLibCommandRef (*CreateWriteQuadletCommand)(IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 24 => IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 25 => IOReturn (*BusReset)( IOFireWireLibDeviceRef self) Parsed Param 26 => IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime) Parsed Param 27 => IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID) Parsed Param 28 => IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID) Parsed Param 29 => IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime) Parsed Param 30 => IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 31 => IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid) Parsed Param 32 => IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid) Parsed Param 33 => IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 34 => IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 35 => IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg) Parsed Param 36 => IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop) Parsed Param 37 => IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid) Parsed Param 38 => UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid) Parsed Param 39 => IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ) Parsed Param 40 => IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ) Parsed Param 41 => void* (*GetRefCon)( IOFireWireLibDeviceRef self) Parsed Param 42 => void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon) Parsed Param 43 => CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType) Parsed Param 44 => void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength) Parsed Param 45 => IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid) Parsed Param 46 => IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 47 => IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ) Parsed Param 48 => void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self) Parsed Param 49 => IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ) Parsed Param 50 => IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ) Parsed Param 51 => IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime) Parsed Param 52 => IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid) Parsed Param 53 => IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation) Parsed Param 54 => IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ) Parsed Param 55 => IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ) Parsed Param 56 => IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ) Parsed Param 57 => IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed) Parsed Param 58 => IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed) -=: DUMP OF PARSE TREE :=- +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] -=: COMPUTED VALUE :=- SUCCESS: 0 VALUE: 0 -=: CPP CHANGES :=- NO CPP CHANGES -=: FOUND MATCH :=- 1 -=: NAMED OBJECTS :=- TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Header NAME: COM interface 1 APIUID: //test_ref/doc/header/COM_interface_1.test ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::Header" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: InterfaceIsInited APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/InterfaceIsInited ABSTRACT: "

Determine whether interface has been properly inited. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetDevice APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetDevice ABSTRACT: "

Get the IOKit service to which this interface is connected. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "io_object_t" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Open APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Open ABSTRACT: "

Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: OpenWithSessionRef APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/OpenWithSessionRef ABSTRACT: "

An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_2 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: sessionRef TYPE: IOFireWireSessionRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: IOFireWireSessionRef TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The sessionRef returned from the client who has the device open" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Close APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Close ABSTRACT: "

Release exclusive access to the device " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: NotificationIsOn APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/NotificationIsOn ABSTRACT: "

Determine whether callback notifications for this interface are currently active " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoop ABSTRACT: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveCallbackDispatcherFromRunLoop ABSTRACT: "

Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOnNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOnNotification ABSTRACT: "

Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const Boolean" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: TurnOffNotification APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/TurnOffNotification ABSTRACT: "

Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetHandler ABSTRACT: "

Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetBusResetDoneHandler APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetBusResetDoneHandler ABSTRACT: "

Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "const IOFireWireBusResetDoneHandler" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: IOFireWireBusResetDoneHandler APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: handler TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Function pointer to the handler to install" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ClientCommandIsComplete APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ClientCommandIsComplete ABSTRACT: "

This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: FWClientCommandID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: IOReturn APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: commandID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The command ID passed to the callback function when it was called" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: status TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An IOReturn value indicating the completion status of the callback function" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Read APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Read ABSTRACT: "

Perform synchronous block read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: ReadQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/ReadQuadlet ABSTRACT: "

Perform synchronous quadlet read " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: value TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to where to data should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Write APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Write ABSTRACT: "

Perform synchronous block write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: WriteQuadlet APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/WriteQuadlet ABSTRACT: "

Perform synchronous quadlet write " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: const UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: val TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The value to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The check/compare value" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Value to set" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadCommand ABSTRACT: "

Create a block read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a buffer where the results will be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateReadQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateReadQuadletCommand ABSTRACT: "

Create a quadlet read command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets where results should be stored" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to read" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: TYPE: APIUID: //test_ref/c/internal_temporary_object/CreateReadQuadletCommand ABSTRACT: "" DISCUSSION: " " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteCommand ABSTRACT: "

Create a block write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: buf TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the buffer containing the data to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of bytes to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateWriteQuadletCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateWriteQuadletCommand ABSTRACT: "

Create a quadlet write command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: quads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An array of quadlets containing quadlets to be written" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: numQuads TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of quadlets to write" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand ABSTRACT: "

Create a quadlet compare/swap command object. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

32-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: BusReset APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/BusReset ABSTRACT: "

Cause a bus reset " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetCycleTime ABSTRACT: "

Get bus cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetGenerationAndNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetGenerationAndNodeID ABSTRACT: "

(Obsolete) Get bus generation and remote device node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the generation result" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the remote device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeID ABSTRACT: "

(Obsolete) Get local node ID. " DISCUSSION: "

Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the local device node ID" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetResetTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetResetTime ABSTRACT: "

Get time since last bus reset. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: AbsoluteTime * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outResetTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an AbsolutTime to hold the result." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalUnitDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalUnitDirectory ABSTRACT: "

Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalUnitDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetConfigDirectory APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetConfigDirectory ABSTRACT: "

Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateConfigDirectoryWithIOObject APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateConfigDirectoryWithIOObject ABSTRACT: "

This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibConfigDirectoryRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inObject TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePseudoAddressSpace ABSTRACT: "

Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreatePhysicalAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreatePhysicalAddressSpace ABSTRACT: "

Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPhysicalAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop ABSTRACT: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateRemoteIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateRemoteIsochPort ABSTRACT: "

Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibRemoteIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateLocalIsochPort APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateLocalIsochPort ABSTRACT: "

Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibLocalIsochPortRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: IOVirtualRange APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inTalking TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartEvent TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start event bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartState TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start state bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inStartMask TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Start mask bits" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inDCLProgramRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRanges TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBufferRangeCount TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The number of virtual ranges passed to inBufferRanges. Pass 0 for none." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateIsochChannel APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateIsochChannel ABSTRACT: "

Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibIsochChannelRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIrm TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: IOFWSpeed APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: doIRM TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: packetSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: prefSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The preferred bus speed of this channel." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateDCLCommandPool APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateDCLCommandPool ABSTRACT: "

Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibDCLCommandPoolRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Starting size of command pool" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRefCon ABSTRACT: "

Get user reference value set on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void *" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: SetRefCon APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/SetRefCon ABSTRACT: "

Set user reference value on this interface " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: const void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: refCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The reference value to set." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: PrintDCLProgram APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/PrintDCLProgram ABSTRACT: "

Walk a DCL program linked list and print its contents " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: const DCLCommandPtr APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inProgram TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to the first DCL of the program to print" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inLength TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found in the program." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateInitialUnitsPseudoAddressSpace APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateInitialUnitsPseudoAddressSpace ABSTRACT: "

Creates a pseudo address space in initial units space. " DISCUSSION: "

Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine.

Availablilty: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibPseudoAddressSpaceRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inAddressLo TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The lower 32 bits of the base address of the address space to be created. The address is always in initial units space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size in bytes of this address space" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A user specified reference value. This will be passed to all callback functions." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inQueueBufferSize TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inBackingStore TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An optional block of allocated memory representing the contents of the address space." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A UInt32 with bits set corresponding to the flags that should be set for this address space.

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib callbacks to function. " DISCUSSION: "

Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop on which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoop_DONTLINK_1 ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: AddIsochCallbackDispatcherToRunLoopForMode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/AddIsochCallbackDispatcherToRunLoopForMode ABSTRACT: "

Add a run loop event source to allow IOFireWireLib isoch callbacks to function. " DISCUSSION: "

This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: CFRunLoopRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: CFStringRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoop TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A CFRunLoopRef for the run loop to which the event loop source should be added" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRunLoopMode TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The run loop mode(s) for which to install the event source" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: RemoveIsochCallbackDispatcherFromRunLoop APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/RemoveIsochCallbackDispatcherFromRunLoop ABSTRACT: "

Removes an IOFireWireLib-added run loop event source. " DISCUSSION: "

Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called.

Availability: IOFireWireDeviceInterface_v3, and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "void" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: Seize APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/Seize ABSTRACT: "

Seize control of device/unit " DISCUSSION: "

Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function.

Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked.

When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." " UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inFlags TYPE: IOOptionBits APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: reserved TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Reserved for future use. Set to NULL." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: FireLog APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/FireLog ABSTRACT: "

Logs string to in-kernel debug buffer " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: format TYPE: const char * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: ... TYPE: ... APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusCycleTime APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusCycleTime ABSTRACT: "

Get bus and cycle time. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outBusTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outCycleTime TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the cycle time" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CreateCompareSwapCommand64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CreateCompareSwapCommand64 ABSTRACT: "

Create a quadlet compare/swap command object and initialize it with 64-bit values. " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOFireWireLibCommandRef" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt64 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: IOFireWireLibCommandCallback APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: inRefCon TYPE: void * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: iid TYPE: REFIID APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: cmpVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value expected at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

64-bit value to be set at target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: callback TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command completion callback." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: CompareSwap64 APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/CompareSwap64 ABSTRACT: "

Perform synchronous lock operation " DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: io_object_t APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: const FWAddress * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: IOByteCount APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: Boolean APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: device TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported.

If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: addr TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Command target address" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: expectedVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets expected at target." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: newVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to atomically set at target if compare is successful." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: oldVal TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pointer to quadlets to hold value found at target address after transaction if completed." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: size TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Size in bytes of compare swap transaction to perform. Value values are 4 and 8." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: failOnReset TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: generation TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetBusGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetBusGeneration ABSTRACT: "

Get bus generation number. " DISCUSSION: "

The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs.

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: UInt32 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt32 to hold the bus generation number" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetLocalNodeIDWithGeneration APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetLocalNodeIDWithGeneration ABSTRACT: "

Get node ID of local machine. " DISCUSSION: "

Use this function instead of GetLocalNodeID().

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outLocalNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the local machine." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetRemoteNodeID APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetRemoteNodeID ABSTRACT: "

Get node ID of device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: UInt16 * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outRemoteNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to a UInt16 to hold the node ID of the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedToNode APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedToNode ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum speed to the remote device." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::Function NAME: GetSpeedBetweenNodes APIUID: //test_ref/doc/com/intfm/IOFireWireDeviceInterface/GetSpeedBetweenNodes ABSTRACT: "

Get maximum transfer speed to device to which this interface is attached. " DISCUSSION: "

Availability: IOFireWireDeviceInterface_v4 and newer

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "class_group_1 " INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "IOReturn" LINENUM: "" CLASS: "HeaderDoc::Function" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "0" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

PARSED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: IOFireWireLibDeviceRef APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: UInt32 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: UInt16 APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: IOFWSpeed * APIUID: ABSTRACT: "" DISCUSSION: "

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TAGGED PARAMETERS: TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: self TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

The device interface to use." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: checkGeneration TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A bus generation number obtained from GetBusGeneration()" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: srcNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: destNodeID TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A FireWire node ID." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 0 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::MinorAPIElement NAME: outSpeed TYPE: APIUID: ABSTRACT: "" DISCUSSION: "

A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'." UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::MinorAPIElement" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireUnitInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireNubInterface APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

TREE COUNT: 1 INDEX GROUP: IS BLOCK: OBJECT TYPE: HeaderDoc::CPPClass NAME: IOFireWireDeviceInterface_t APIUID: ABSTRACT: "

IOFireWireDeviceInterface is your primary gateway to the functionality contained in IOFireWireLib. " DISCUSSION: "

You can use IOFireWireDeviceInterface to:

" UPDATED: "" COPYRIGHT: "" HTMLMETA: "" PRIVATEDECLARATION: "" GROUP: "" INDEXGROUP: "" THROWS: "" XMLTHROWS: "" UPDATED: "" LINKAGESTATE: "" ACCESSCONTROL: "" AVAILABILITY: "" LINKUID: "" ORIGCLASS: "" ISDEFINE: "" ISTEMPLATE: "" VALUE: "UNKNOWN" RETURNTYPE: "" LINENUM: "" CLASS: "HeaderDoc::CPPClass" MASTERENUM: "" APIREFSETUPDONE: "1" TPCDONE: "" NOREGISTERUID: "" SUPPRESSCHILDREN: "1" NAMELINE_DISCUSSION: "" HIDEDOC: "" HIDESINGLETONS: "" HIDECONTENTS: "" MAINOBJECT: "" LIST ATTRIBUTES: SHORT ATTRIBUTES:

Declared In: COM interface 1

LONG ATTRIBUTES:

-=: NAMED OBJECT PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) +---Boolean +--- +---( | +---* | +---InterfaceIsInited | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) +---io_object_t +--- +---( | +---* | +---GetDevice | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Open (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Open | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---OpenWithSessionRef | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireSessionRef | +--- | +---sessionRef | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Close (HeaderDoc::Function) +---void +--- +---( | +---* | +---Close | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---NotificationIsOn | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) +---const +--- +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---const +--- +---void +--- +---( | +---* | +---RemoveCallbackDispatcherFromRunLoop | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) +---const +--- +---Boolean +--- +---( | +---* | +---TurnOnNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) +---void +--- +---( | +---* | +---TurnOffNotification | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) +---const +--- +---IOFireWireBusResetDoneHandler +---[ NEWLINE ] +--- +---( | +---* | +---SetBusResetDoneHandler | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---IOFireWireBusResetDoneHandler | +--- | +---handler | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) +---void +--- +---( | +---* | +---ClientCommandIsComplete | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---FWClientCommandID | +--- | +---commandID | +---, | +--- | +---IOReturn | +--- | +---status | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Read (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Read | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---ReadQuadlet | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---val | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Write (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Write | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---device | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---buf | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---WriteQuadlet | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---const | +--- | +---UInt32 | +--- | +---val | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateReadQuadletCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---void | +---* | +--- | +---buf | +---, | +--- | +---UInt32 | +--- | +---size | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateWriteQuadletCommand | +---) +---( | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---quads | +---[ | | +---] | +---, | +--- | +---UInt32 | +--- | +---numQuads | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +--- | +---* | +--- | +---addr | +---, | +--- | +---UInt32 | +--- | +---cmpVal | +---, | +--- | +---UInt32 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---BusReset | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetGenerationAndNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetResetTime | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---AbsoluteTime | +---* | +--- | +---outResetTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) +---IOFireWireLibLocalUnitDirectoryRef +--- +---( | +---* | +---CreateLocalUnitDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---GetConfigDirectory | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) +---IOFireWireLibConfigDirectoryRef +--- +---( | +---* | +---CreateConfigDirectoryWithIOObject | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---inObject | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreatePseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) +---IOFireWireLibPhysicalAddressSpaceRef +--- +---( | +---* | +---CreatePhysicalAddressSpace | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---inSize | +---, | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +--- | +---UInt32 | +--- | +---inFlags | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) +---IOFireWireLibRemoteIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateRemoteIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) +---IOFireWireLibLocalIsochPortRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateLocalIsochPort | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---inTalking | +---, | +---[ NEWLINE ] | +--- | +---DCLCommandPtr | +--- | +---inDCLProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartEvent | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartState | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inStartMask | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inDCLProgramRanges | +---[ | | +---] | +---, | +--- | +---// | | +--- | | +---optional optimization parameters | | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inDCLProgramRangeCount | +---, | +---[ NEWLINE ] | +--- | +---IOVirtualRange | +--- | +---inBufferRanges | +---[ | | +---] | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inBufferRangeCount | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) +---IOFireWireLibIsochChannelRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateIsochChannel | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---doIrm | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---packetSize | +---, | +---[ NEWLINE ] | +--- | +---IOFWSpeed | +--- | +---prefSpeed | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) +---IOFireWireLibDCLCommandPoolRef +---[ NEWLINE ] +--- +---( | +---* | +---CreateDCLCommandPool | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) +---void +---* +--- +---( | +---* | +---GetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) +---void +--- +---( | +---* | +---SetRefCon | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +---* | +--- | +---refCon | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) +---void +--- +---( | +---* | +---PrintDCLProgram | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---DCLCommandPtr | +--- | +---inProgram | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inLength | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) +---IOFireWireLibPseudoAddressSpaceRef +--- +---( | +---* | +---CreateInitialUnitsPseudoAddressSpace | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inAddressLo | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inQueueBufferSize | +---, | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---inBackingStore | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---AddIsochCallbackDispatcherToRunLoopForMode | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---CFRunLoopRef | +--- | +---inRunLoop | +---, | +---[ NEWLINE ] | +--- | +---CFStringRef | +--- | +---inRunLoopMode | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) +---void +--- +---( | +---* | +---RemoveIsochCallbackDispatcherFromRunLoop | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: Seize (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---Seize | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---IOOptionBits | +--- | +---inFlags | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---FireLog | +---) +---( | +---[ NEWLINE ] | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +---[ NEWLINE ] | +--- | +---const | +--- | +---char | +---* | +--- | +---format | +---, | +---[ NEWLINE ] | +--- | +---. | +---. | +---. | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusCycleTime | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outBusTime | +---, | +--- | +---UInt32 | +---* | +--- | +---outCycleTime | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) +---IOFireWireLibCommandRef +--- +---( | +---* | +---CreateCompareSwapCommand64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt64 | +--- | +---cmpVal | +---, | +--- | +---UInt64 | +--- | +---newVal | +---, | +--- | +---IOFireWireLibCommandCallback | +--- | +---callback | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---, | +--- | +---void | +---* | +--- | +---inRefCon | +---, | +--- | +---REFIID | +--- | +---iid | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---CompareSwap64 | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---io_object_t | +--- | +---device | +---, | +--- | +---const | +--- | +---FWAddress | +---* | +--- | +---addr | +---, | +---[ NEWLINE ] | +--- | +---UInt32 | +---* | +--- | +---expectedVal | +---, | +--- | +---UInt32 | +---* | +--- | +---newVal | +---, | +--- | +---UInt32 | +---* | +--- | +---oldVal | +---, | +--- | +---IOByteCount | +--- | +---size | +---, | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---failOnReset | +---, | +--- | +---UInt32 | +--- | +---generation | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetBusGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +---* | +--- | +---outGeneration | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetLocalNodeIDWithGeneration | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outLocalNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetRemoteNodeID | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +---* | +--- | +---outRemoteNodeID | +--- | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedToNode | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) +---IOReturn +--- +---( | +---* | +---GetSpeedBetweenNodes | +---) +---( | +--- | +---IOFireWireLibDeviceRef | +--- | +---self | +---, | +--- | +---UInt32 | +--- | +---checkGeneration | +---, | +--- | +---UInt16 | +--- | +---srcNodeID | +---, | +--- | +---UInt16 | +--- | +---destNodeID | +---, | +--- | +---IOFWSpeed | +---* | +--- | +---outSpeed | +---) +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) +---typedef +--- +---struct +--- +---IOFireWireDeviceInterface_t +---[ NEWLINE ] +---{ | +---[ NEWLINE ] | +--- | +---IUNKNOWN_C_GUTS | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---UInt32 | +--- | +---version | +---, | +--- | +---revision | +--- | +---; | +--- | +---// | | +--- | | +---version/revision | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ maintenance methods ------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function InterfaceIsInited | | +--- @abstract Determine whether interface has been properly inited. | | +--- @param self The device interface to use. | | +--- @result Returns true if interface is inited and false if is it not. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---Boolean | +--- | +---( | | +---* | | +---InterfaceIsInited | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetDevice | | +--- @abstract Get the IOKit service to which this interface is connected. | | +--- @param self The device interface to use. | | +--- @result Returns an io_object_t corresponding to the device the interface is | | +--- using | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---io_object_t | +--- | +---( | | +---* | | +---GetDevice | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_2 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Open | | +--- @abstract Open the connected device for exclusive access. When you have | | +--- the device open using this method, all accesses by other clients of | | +--- this device will be denied until Close() is called. | | +--- @param self The device interface to use. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Open | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function OpenWithSessionRef | | +--- @abstract An open function which allows this interface to have access | | +--- to the device when already opened. The service which has already opened | | +--- the device must be able to provide an IOFireWireSessionRef. | | +--- @param self The device interface to use | | +--- @param IOFireWireSessionRef The sessionRef returned from the client who has | | +--- the device open | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---OpenWithSessionRef | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireSessionRef | | +--- | | +---sessionRef | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @functiongroup class_group_1 | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Close | | +--- @abstract Release exclusive access to the device | | +--- @param self The device interface to use | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---Close | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ notification -------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function NotificationIsOn | | +--- @abstract Determine whether callback notifications for this interface are currently active | | +--- @param self The device interface to use | | +--- @result A Boolean value where true indicates notifications are active | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---NotificationIsOn | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoop | | +--- @abstract Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveCallbackDispatcherFromRunLoop | | +--- @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---void | +--- | +---( | | +---* | | +---RemoveCallbackDispatcherFromRunLoop | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOnNotification | | +--- @abstract Activates any callbacks specified for this device interface. Only works after | | +--- AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). | | +--- @param self The device interface to use. | | +--- @result A Boolean value. Returns true on success. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---Boolean | +--- | +---( | | +---* | | +---TurnOnNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function TurnOffNotification | | +--- @abstract Deactivates and callbacks specified for this device interface. Reverses the | | +--- effects of TurnOnNotification() | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---TurnOffNotification | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetHandler | | +--- @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback | | +--- can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus | | +--- resets might occur before bus reconfiguration has completed.) | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns an IOFireWireBusResetHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetBusResetDoneHandler | | +--- @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration | | +--- of the bus has been completed. This function will only be called once per bus reset. | | +--- @param self The device interface to use. | | +--- @param handler Function pointer to the handler to install | | +--- @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed | | +--- bus reset handler. Returns 0 if none was set. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---const | +--- | +---IOFireWireBusResetDoneHandler | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---SetBusResetDoneHandler | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---IOFireWireBusResetDoneHandler | | +--- | | +---handler | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ClientCommandIsComplete | | +--- @abstract This function must be called from callback routines once they have completed processing | | +--- a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), | | +--- parameter. | | +--- @param commandID The command ID passed to the callback function when it was called | | +--- @param status An IOReturn value indicating the completion status of the callback function | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---ClientCommandIsComplete | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---FWClientCommandID | | +--- | | +---commandID | | +---, | | +--- | | +---IOReturn | | +--- | | +---status | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ read/write/lock operations ------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Read | | +--- @abstract Perform synchronous block read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Read | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function ReadQuadlet | | +--- @abstract Perform synchronous quadlet read | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to read. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param value A pointer to where to data should be stored | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in generation. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---ReadQuadlet | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---val | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Write | | +--- @abstract Perform synchronous block write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Write | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function WriteQuadlet | | +--- @abstract Perform synchronous quadlet write | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param val The value to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---WriteQuadlet | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---const | | +--- | | +---UInt32 | | +--- | | +---val | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +--- @param addr Command target address | | +--- @param cmpVal The check/compare value | | +--- @param newVal Value to set | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ FireWire command object methods --------- | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadCommand | | +--- @abstract Create a block read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to a buffer where the results will be stored | | +--- @param size Number of bytes to read | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateReadQuadletCommand | | +--- @abstract Create a quadlet read command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets where results should be stored | | +--- @param numQuads Number of quadlets to read | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @param | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateReadQuadletCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteCommand | | +--- @abstract Create a block write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param buf A pointer to the buffer containing the data to be written | | +--- @param size Number of bytes to write | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---void | | +---* | | +--- | | +---buf | | +---, | | +--- | | +---UInt32 | | +--- | | +---size | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateWriteQuadletCommand | | +--- @abstract Create a quadlet write command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param quads An array of quadlets containing quadlets to be written | | +--- @param numQuads Number of quadlets to write | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateWriteQuadletCommand | | +---) | +---( | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---quads | | +---[ | | | +---] | | +---, | | +--- | | +---UInt32 | | +--- | | +---numQuads | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand | | +--- @abstract Create a quadlet compare/swap command object. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 32-bit value expected at target address | | +--- @param newVal 32-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +--- | | +---* | | +--- | | +---addr | | +---, | | +--- | | +---UInt32 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt32 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ other methods --------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function BusReset | | +--- @abstract Cause a bus reset | | +--- @param self The device interface to use. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---BusReset | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetCycleTime | | +--- @abstract Get bus cycle time. | | +--- @param self The device interface to use. | | +--- @param outCycleTime A pointer to a UInt32 to hold the result | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetGenerationAndNodeID | | +--- @abstract (Obsolete) Get bus generation and remote device node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the generation result | | +--- @param outNodeID A pointer to a UInt16 to hold the remote device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetGenerationAndNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeID | | +--- @abstract (Obsolete) Get local node ID. | | +--- @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in | | +--- interface v4. | | +--- @param self The device interface to use. | | +--- @param outNodeID A pointer to a UInt16 to hold the local device node ID | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetResetTime | | +--- @abstract Get time since last bus reset. | | +--- @param self The device interface to use. | | +--- @param outResetTime A pointer to an AbsolutTime to hold the result. | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetResetTime | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---AbsoluteTime | | +---* | | +--- | | +---outResetTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ unit directory support ------------------ | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalUnitDirectory | | +--- @abstract Creates a local unit directory object and returns an interface to it. An | | +--- instance of a unit directory object corresponds to an instance of a unit | | +--- directory in the local machine's configuration ROM. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created unit directory object. | | +--- @result An IOFireWireLibLocalUnitDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalUnitDirectoryRef | +--- | +---( | | +---* | | +---CreateLocalUnitDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ config directory support ---------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetConfigDirectory | | +--- @abstract Creates a config directory object and returns an interface to it. The | | +--- created config directory object represents the config directory in the remote | | +--- device or unit to which the creating device interface is attached. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---GetConfigDirectory | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateConfigDirectoryWithIOObject | | +--- @abstract This function can be used to create a config directory object and a | | +--- corresponding interface from an opaque IOObject reference. Some configuration | | +--- directory interface methods may return an io_object_t instead of an | | +--- IOFireWireLibConfigDirectoryRef. Use this function to obtain an | | +--- IOFireWireLibConfigDirectoryRef from an io_object_t. | | +--- @param self The device interface to use. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created config directory object. | | +--- @result An IOFireWireLibConfigDirectoryRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibConfigDirectoryRef | +--- | +---( | | +---* | | +---CreateConfigDirectoryWithIOObject | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---inObject | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ address space support ------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePseudoAddressSpace | | +--- @abstract Creates a pseudo address space object and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +--- @param self The device interface to use. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreatePhysicalAddressSpace | | +--- @abstract Creates a physical address space object and returns an interface to it. This | | +--- will create a physical address space on the local machine. | | +--- @param self The device interface to use. | | +--- @param inBackingStore An block of allocated memory representing the contents of the address space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. For future use -- always pass 0. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created physical address space object. | | +--- @result An IOFireWireLibPhysicalAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPhysicalAddressSpaceRef | +--- | +---( | | +---* | | +---CreatePhysicalAddressSpace | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireBugMsg | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---msg | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v2 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ eye-sock-run-U.S. ----------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not function | | +--- before this function is called. This functions is similar to | | +--- AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different | | +--- from that passed to AddCallbackDispatcherToRunLoop. | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateRemoteIsochPort | | +--- @abstract Creates a remote isochronous port object and returns an interface to it. A | | +--- remote isochronous port object is an abstract entity used to represent a remote | | +--- talker or listener device on an isochronous channel. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created remote isochronous port object. | | +--- @result An IOFireWireLibRemoteIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibRemoteIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateRemoteIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateLocalIsochPort | | +--- @abstract Creates a local isochronous port object and returns an interface to it. A | | +--- local isochronous port object is an abstract entity used to represent a | | +--- talking or listening endpoint in the local machine. | | +--- @param self The device interface to use. | | +--- @param inTalking Pass true if this port represents an isochronous talker. Pass | | +--- false if this port represents an isochronous listener. | | +--- @param inDCLProgram A pointer to the first DCL command struct of the DCL program | | +--- to be compiled and used to send or receive data on this port. | | +--- @param inStartEvent Start event bits | | +--- @param inStartState Start state bits | | +--- @param inStartMask Start mask bits | | +--- @param inDCLProgramRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange | | +--- structs or nil to ignore this parameter. | | +--- @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. | | +--- Pass 0 for none. | | +--- @param inBufferRanges This is an optional optimization parameter which can be used | | +--- to decrease the time the local port object spends determining which set of virtual | | +--- ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer | | +--- to an array of IOVirtualRange structs or nil to ignore this parameter. | | +--- @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. | | +--- Pass 0 for none. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibLocalIsochPortRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibLocalIsochPortRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateLocalIsochPort | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---inTalking | | +---, | | +---[ NEWLINE ] | | +--- | | +---DCLCommandPtr | | +--- | | +---inDCLProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartEvent | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartState | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inStartMask | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inDCLProgramRanges | | +---[ | | | +---] | | +---, | | +--- | | +---// | | | +--- | | | +---optional optimization parameters | | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inDCLProgramRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOVirtualRange | | +--- | | +---inBufferRanges | | +---[ | | | +---] | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inBufferRangeCount | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateIsochChannel | | +--- @abstract Creates an isochronous channel object and returns an interface to it. An | | +--- isochronous channel object is an abstract entity used to represent a | | +--- FireWire isochronous channel. | | +--- @param self The device interface to use. | | +--- @param doIRM Controls whether the channel automatically performs IRM operations. | | +--- Pass true if the channel should allocate its channel and bandwidth with | | +--- the IRM. Pass false to ignore the IRM. | | +--- @param packetSize Size in bytes of packets being sent or received with this channel. | | +--- This is automatically translated into a bandwidth allocation appropriate | | +--- for the speed passed in prefSpeed. | | +--- @param prefSpeed The preferred bus speed of this channel. | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibIsochChannelRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibIsochChannelRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateIsochChannel | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---doIrm | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---packetSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOFWSpeed | | +--- | | +---prefSpeed | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateDCLCommandPool | | +--- @abstract Creates a command pool object and returns an interface to it. The command | | +--- pool can be used to build DCL programs. | | +--- @param self The device interface to use. | | +--- @param size Starting size of command pool | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created object. | | +--- @result An IOFireWireLibDCLCommandPoolRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibDCLCommandPoolRef | +---[ NEWLINE ] | +--- | +---( | | +---* | | +---CreateDCLCommandPool | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ refcons --------------------------------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRefCon | | +--- @abstract Get user reference value set on this interface | | +--- @param self The device interface to use. | | +--- @result Returns the user's reference value set on this interface. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +---* | +--- | +---( | | +---* | | +---GetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function SetRefCon | | +--- @abstract Set user reference value on this interface | | +--- @param self The device interface to use. | | +--- @param refCon The reference value to set. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---SetRefCon | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---void | | +---* | | +--- | | +---refCon | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ debugging ------------------------------- | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---do not use this function | | +---[ NEWLINE ] | +--- | +---CFTypeRef | +--- | +---( | | +---* | | +---GetDebugProperty | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---interface | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inPropertyName | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFTypeID | | +---* | | +--- | | +---outPropertyType | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function PrintDCLProgram | | +--- @abstract Walk a DCL program linked list and print its contents | | +--- @param self The device interface to use. | | +--- @param inProgram A pointer to the first DCL of the program to print | | +--- @param inLength Number of DCLs expected in the program. PrintDCLProgram() will | | +--- report an error if this number does not match the number of DCLs found | | +--- in the program. | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---PrintDCLProgram | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---DCLCommandPtr | | +--- | | +---inProgram | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inLength | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---NOTE: the following methods available only in interface v3 and later | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +--- | | +------ v3 functions ---------- | | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateInitialUnitsPseudoAddressSpace | | +--- @abstract Creates a pseudo address space in initial units space. | | +--- @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This | | +--- will create a pseudo address space (software-backed) on the local machine. | | +---[ NEWLINE ] | | +--- Availablilty: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always | | +--- in initial units space. | | +--- @param inSize The size in bytes of this address space | | +--- @param inRefCon A user specified reference value. This will be passed to all callback functions. | | +--- @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to | | +--- the client and/or put in the backing store. A larger queue can help eliminate dropped packets | | +--- when receiving large bursts of data. When a packet is received which can not fit into the queue, | | +--- the packet dropped callback will be called. | | +--- @param inBackingStore An optional block of allocated memory representing the contents of the address space. | | +--- @param inFlags A UInt32 with bits set corresponding to the flags that should be set | | +--- for this address space. | | +--- | | +--- @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the | | +--- type of interface to be returned for the created pseudo address space object. | | +--- @result An IOFireWireLibPseudoAddressSpaceRef. Returns 0 upon failure | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibPseudoAddressSpaceRef | +--- | +---( | | +---* | | +---CreateInitialUnitsPseudoAddressSpace | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inAddressLo | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inQueueBufferSize | | +---, | | +---[ NEWLINE ] | | +--- | | +---void | | +---* | | +--- | | +---inBackingStore | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddCallbackDispatcherToRunLoopForMode | | +--- @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. | | +--- @discussion Installs the proper run loop event source to allow callbacks to function. This method | | +--- must be called before callback notifications for this interface or any interfaces | | +--- created using this interface can function. With this function, you can additionally specify | | +--- for which run loop modes this source should be added. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop The run loop on which to install the event source | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function AddIsochCallbackDispatcherToRunLoop | | +--- @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. | | +--- @discussion This function adds an event source for the isochronous callback dispatcher | | +--- to the specified CFRunLoop. Isochronous related callbacks will not be called unless | | +--- this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. | | +--- The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source | | +--- should be added | | +--- @param inRunLoopMode The run loop mode(s) for which to install the event source | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---AddIsochCallbackDispatcherToRunLoopForMode | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFRunLoopRef | | +--- | | +---inRunLoop | | +---, | | +---[ NEWLINE ] | | +--- | | +---CFStringRef | | +--- | | +---inRunLoopMode | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function RemoveIsochCallbackDispatcherFromRunLoop | | +--- @abstract Removes an IOFireWireLib-added run loop event source. | | +--- @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes | | +--- the run loop event source that was added to the specified run loop preventing any | | +--- future callbacks from being called. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v3, and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---void | +--- | +---( | | +---* | | +---RemoveIsochCallbackDispatcherFromRunLoop | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function Seize | | +--- @abstract Seize control of device/unit | | +--- @discussion Allows a user space client to seize control of an in-kernel service even if | | +--- that service has been Opened() by another client or in-kernel driver. This function should be | | +--- used with care. Admin rights are required to use this function. | | +---[ NEWLINE ] | | +--- Calling this method makes it appear to all other drivers that the device has been unplugged. | | +--- Open() should be called after this method has been invoked. | | +---[ NEWLINE ] | | +--- When access is complete, Close() and then IOServiceRequestProbe() should be called to restore | | +--- normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." | | +--- @param self The device interface to use. | | +--- @param reserved Reserved for future use. Set to NULL. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---Seize | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---IOOptionBits | | +--- | | +---inFlags | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function FireLog | | +--- @abstract Logs string to in-kernel debug buffer | | +--- @param self The device interface to use. | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---FireLog | | +---) | +---( | | +---[ NEWLINE ] | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +---[ NEWLINE ] | | +--- | | +---const | | +--- | | +---char | | +---* | | +--- | | +---format | | +---, | | +---[ NEWLINE ] | | +--- | | +---. | | +---. | | +---. | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusCycleTime | | +--- @abstract Get bus and cycle time. | | +--- @param self The device interface to use. | | +--- @param outBusTime A pointer to a UInt32 to hold the bus time | | +--- @param outCycleTime A pointer to a UInt32 to hold the cycle time | | +--- @result An IOReturn error code. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusCycleTime | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outBusTime | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outCycleTime | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +--- | +---// | | +--- | | +---v4 | | +---[ NEWLINE ] | +--- | +---// | | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CreateCompareSwapCommand64 | | +--- @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. Setting the callback value to nil defaults to synchronous execution. | | +--- @param addr Command target address | | +--- @param cmpVal 64-bit value expected at target address | | +--- @param newVal 64-bit value to be set at target address | | +--- @param callback Command completion callback. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOFireWireLibCommandRef | +--- | +---( | | +---* | | +---CreateCompareSwapCommand64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt64 | | +--- | | +---cmpVal | | +---, | | +--- | | +---UInt64 | | +--- | | +---newVal | | +---, | | +--- | | +---IOFireWireLibCommandCallback | | +--- | | +---callback | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---, | | +--- | | +---void | | +---* | | +--- | | +---inRefCon | | +---, | | +--- | | +---REFIID | | +--- | | +---iid | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function CompareSwap64 | | +--- @abstract Perform synchronous lock operation | | +--- @param self The device interface to use. | | +--- @param device The service (representing an attached FireWire device) to which to write. | | +--- For 48-bit, device relative addressing, pass the service used to create the device interface. This | | +--- can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are | | +--- unsupported. | | +---[ NEWLINE ] | | +--- If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was | | +--- successful. | | +--- @param addr Command target address | | +--- @param expectedVal Pointer to quadlets expected at target. | | +--- @param newVal Pointer to quadlets to atomically set at target if compare is successful. | | +--- @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. | | +--- @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. | | +--- @param failOnReset Pass true if the command should only be executed during the FireWire bus generation | | +--- specified in 'generation'. Pass false to ignore the generation parameter. The generation can be | | +--- obtained by calling GetGenerationAndNodeID() | | +--- @param generation The FireWire bus generation during which the command should be executed. Ignored | | +--- if failOnReset is false. | | +--- @result An IOReturn error code | | +---[ NEWLINE ] | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---CompareSwap64 | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---io_object_t | | +--- | | +---device | | +---, | | +--- | | +---const | | +--- | | +---FWAddress | | +---* | | +--- | | +---addr | | +---, | | +---[ NEWLINE ] | | +--- | | +---UInt32 | | +---* | | +--- | | +---expectedVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---newVal | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---oldVal | | +---, | | +--- | | +---IOByteCount | | +--- | | +---size | | +---, | | +---[ NEWLINE ] | | +--- | | +---Boolean | | +--- | | +---failOnReset | | +---, | | +--- | | +---UInt32 | | +--- | | +---generation | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetBusGeneration | | +--- @abstract Get bus generation number. | | +--- @discussion The bus generation number stays constant between bus resets and can be | | +--- used in combination with a FireWire node ID to uniquely identify nodes on the bus. | | +--- Pass the generation number to functions that take or return FireWire node IDs. | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param outGeneration A pointer to a UInt32 to hold the bus generation number | | +--- @result Returns kIOReturnSuccess if a valid bus generation has been returned in 'outGeneration'. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetBusGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +---* | | +--- | | +---outGeneration | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetLocalNodeIDWithGeneration | | +--- @abstract Get node ID of local machine. | | +--- @discussion Use this function instead of GetLocalNodeID(). | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetLocalNodeIDWithGeneration | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outLocalNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetRemoteNodeID | | +--- @abstract Get node ID of device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. | | +--- @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetRemoteNodeID | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +---* | | +--- | | +---outRemoteNodeID | | +--- | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedToNode | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedToNode | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---/* | | +---! | | +--- @function GetSpeedBetweenNodes | | +--- @abstract Get maximum transfer speed to device to which this interface is attached. | | +--- @discussion | | +---[ NEWLINE ] | | +--- Availability: IOFireWireDeviceInterface_v4 and newer | | +---[ NEWLINE ] | | +--- @param self The device interface to use. | | +--- @param checkGeneration A bus generation number obtained from GetBusGeneration() | | +--- @param srcNodeID A FireWire node ID. | | +--- @param destNodeID A FireWire node ID. | | +--- @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. | | +--- @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns | | +--- kIOFireWireBusReset if 'checkGeneration' does not match the current bus generation number. | | +---*/ | +---[ NEWLINE ] | +--- | +---IOReturn | +--- | +---( | | +---* | | +---GetSpeedBetweenNodes | | +---) | +---( | | +--- | | +---IOFireWireLibDeviceRef | | +--- | | +---self | | +---, | | +--- | | +---UInt32 | | +--- | | +---checkGeneration | | +---, | | +--- | | +---UInt16 | | +--- | | +---srcNodeID | | +---, | | +--- | | +---UInt16 | | +--- | | +---destNodeID | | +---, | | +--- | | +---IOFWSpeed | | +---* | | +--- | | +---outSpeed | | +---) | +--- | +---; | +---[ NEWLINE ] | +---[ NEWLINE ] | +---} +--- +---IOFireWireDeviceInterface +---, +--- +---IOFireWireUnitInterface +---, +--- +---IOFireWireNubInterface +--- +---; +--- +---[ NEWLINE ] END OF OBJECT -=: HTML OUTPUT OF PARSE TREES :=- OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: InterfaceIsInited (HeaderDoc::Function) Boolean ( *InterfaceIsInited)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetDevice (HeaderDoc::Function) io_object_t ( *GetDevice)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Open (HeaderDoc::Function) IOReturn ( *Open)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: OpenWithSessionRef (HeaderDoc::Function) IOReturn ( *OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); END OF OBJECT OBJECT: Close (HeaderDoc::Function) void ( *Close)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: NotificationIsOn (HeaderDoc::Function) const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoop (HeaderDoc::Function) const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: RemoveCallbackDispatcherFromRunLoop (HeaderDoc::Function) const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOnNotification (HeaderDoc::Function) const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: TurnOffNotification (HeaderDoc::Function) void ( *TurnOffNotification)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetBusResetHandler (HeaderDoc::Function) const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); END OF OBJECT OBJECT: SetBusResetDoneHandler (HeaderDoc::Function) const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); END OF OBJECT OBJECT: ClientCommandIsComplete (HeaderDoc::Function) void ( *ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); END OF OBJECT OBJECT: Read (HeaderDoc::Function) IOReturn ( *Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: ReadQuadlet (HeaderDoc::Function) IOReturn ( *ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: Write (HeaderDoc::Function) IOReturn ( *Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: WriteQuadlet (HeaderDoc::Function) IOReturn ( *WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CompareSwap (HeaderDoc::Function) IOReturn ( *CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: CreateReadCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateReadQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateWriteQuadletCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CreateCompareSwapCommand (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: BusReset (HeaderDoc::Function) IOReturn ( *BusReset)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: GetCycleTime (HeaderDoc::Function) IOReturn ( *GetCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outCycleTime); END OF OBJECT OBJECT: GetGenerationAndNodeID (HeaderDoc::Function) IOReturn ( *GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32 *outGeneration, UInt16 *outNodeID); END OF OBJECT OBJECT: GetLocalNodeID (HeaderDoc::Function) IOReturn ( *GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16 *outLocalNodeID); END OF OBJECT OBJECT: GetResetTime (HeaderDoc::Function) IOReturn ( *GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime *outResetTime); END OF OBJECT OBJECT: CreateLocalUnitDirectory (HeaderDoc::Function) IOFireWireLibLocalUnitDirectoryRef ( *CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: GetConfigDirectory (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); END OF OBJECT OBJECT: CreateConfigDirectoryWithIOObject (HeaderDoc::Function) IOFireWireLibConfigDirectoryRef ( *CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); END OF OBJECT OBJECT: CreatePseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: CreatePhysicalAddressSpace (HeaderDoc::Function) IOFireWireLibPhysicalAddressSpaceRef ( *CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoop (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); END OF OBJECT OBJECT: CreateRemoteIsochPort (HeaderDoc::Function) IOFireWireLibRemoteIsochPortRef ( *CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); END OF OBJECT OBJECT: CreateLocalIsochPort (HeaderDoc::Function) IOFireWireLibLocalIsochPortRef ( *CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); END OF OBJECT OBJECT: CreateIsochChannel (HeaderDoc::Function) IOFireWireLibIsochChannelRef ( *CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); END OF OBJECT OBJECT: CreateDCLCommandPool (HeaderDoc::Function) IOFireWireLibDCLCommandPoolRef ( *CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); END OF OBJECT OBJECT: GetRefCon (HeaderDoc::Function) void* ( *GetRefCon)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: SetRefCon (HeaderDoc::Function) void ( *SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); END OF OBJECT OBJECT: PrintDCLProgram (HeaderDoc::Function) void ( *PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); END OF OBJECT OBJECT: CreateInitialUnitsPseudoAddressSpace (HeaderDoc::Function) IOFireWireLibPseudoAddressSpaceRef ( *CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void *inRefCon, UInt32 inQueueBufferSize, void *inBackingStore, UInt32 inFlags, REFIID iid); END OF OBJECT OBJECT: AddCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: AddIsochCallbackDispatcherToRunLoopForMode (HeaderDoc::Function) IOReturn ( *AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); END OF OBJECT OBJECT: RemoveIsochCallbackDispatcherFromRunLoop (HeaderDoc::Function) void ( *RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); END OF OBJECT OBJECT: Seize (HeaderDoc::Function) IOReturn ( *Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); END OF OBJECT OBJECT: FireLog (HeaderDoc::Function) IOReturn ( *FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); END OF OBJECT OBJECT: GetBusCycleTime (HeaderDoc::Function) IOReturn ( *GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32 *outBusTime, UInt32 *outCycleTime); END OF OBJECT OBJECT: CreateCompareSwapCommand64 (HeaderDoc::Function) IOFireWireLibCommandRef ( *CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); END OF OBJECT OBJECT: CompareSwap64 (HeaderDoc::Function) IOReturn ( *CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); END OF OBJECT OBJECT: GetBusGeneration (HeaderDoc::Function) IOReturn ( *GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32 *outGeneration ); END OF OBJECT OBJECT: GetLocalNodeIDWithGeneration (HeaderDoc::Function) IOReturn ( *GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outLocalNodeID ); END OF OBJECT OBJECT: GetRemoteNodeID (HeaderDoc::Function) IOReturn ( *GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 *outRemoteNodeID ); END OF OBJECT OBJECT: GetSpeedToNode (HeaderDoc::Function) IOReturn ( *GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: GetSpeedBetweenNodes (HeaderDoc::Function) IOReturn ( *GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed *outSpeed); END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT OBJECT: IOFireWireDeviceInterface_t (HeaderDoc::CPPClass) typedef struct IOFireWireDeviceInterface_t { IUNKNOWN_C_GUTS; UInt32 version, revision; // version/revision // --- maintenance methods ------------- /*! @functiongroup class_group_1 */ /*! @function InterfaceIsInited @abstract Determine whether interface has been properly inited. @param self The device interface to use. @result Returns true if interface is inited and false if is it not. */ Boolean (*InterfaceIsInited)( IOFireWireLibDeviceRef self); /*! @function GetDevice @abstract Get the IOKit service to which this interface is connected. @param self The device interface to use. @result Returns an io_object_t corresponding to the device the interface is using */ io_object_t (*GetDevice)( IOFireWireLibDeviceRef self); /*! @functiongroup class_group_2 */ /*! @function Open @abstract Open the connected device for exclusive access. When you have the device open using this method, all accesses by other clients of this device will be denied until Close() is called. @param self The device interface to use. @result An IOReturn error code */ IOReturn (*Open)( IOFireWireLibDeviceRef self); /*! @function OpenWithSessionRef @abstract An open function which allows this interface to have access to the device when already opened. The service which has already opened the device must be able to provide an IOFireWireSessionRef. @param self The device interface to use @param IOFireWireSessionRef The sessionRef returned from the client who has the device open @result An IOReturn error code */ IOReturn (*OpenWithSessionRef)( IOFireWireLibDeviceRef self, IOFireWireSessionRef sessionRef); /*! @functiongroup class_group_1 */ /*! @function Close @abstract Release exclusive access to the device @param self The device interface to use */ void (*Close)( IOFireWireLibDeviceRef self); // --- notification -------------------- /*! @function NotificationIsOn @abstract Determine whether callback notifications for this interface are currently active @param self The device interface to use @result A Boolean value where true indicates notifications are active */ const Boolean (*NotificationIsOn)(IOFireWireLibDeviceRef self); /*! @function AddCallbackDispatcherToRunLoop @abstract Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. @param self The device interface to use. @param inRunLoop The run loop on which to install the event source */ const IOReturn (*AddCallbackDispatcherToRunLoop)(IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function RemoveCallbackDispatcherFromRunLoop @abstract Reverses the effects of AddCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called @param self The device interface to use. */ const void (*RemoveCallbackDispatcherFromRunLoop)(IOFireWireLibDeviceRef self); /*! @function TurnOnNotification @abstract Activates any callbacks specified for this device interface. Only works after AddCallbackDispatcherToRunLoop has been called. See also AddIsochCallbackDispatcherToRunLoop(). @param self The device interface to use. @result A Boolean value. Returns true on success. */ const Boolean (*TurnOnNotification)(IOFireWireLibDeviceRef self); /*! @function TurnOffNotification @abstract Deactivates and callbacks specified for this device interface. Reverses the effects of TurnOnNotification() @param self The device interface to use. */ void (*TurnOffNotification)( IOFireWireLibDeviceRef self); /*! @function SetBusResetHandler @abstract Sets the callback that should be called when a bus reset occurs. Note that this callback can be called multiple times before the bus reset done handler is called. (f.ex., multiple bus resets might occur before bus reconfiguration has completed.) @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns an IOFireWireBusResetHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetHandler (*SetBusResetHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetHandler handler); /*! @function SetBusResetDoneHandler @abstract Sets the callback that should be called after a bus reset has occurred and reconfiguration of the bus has been completed. This function will only be called once per bus reset. @param self The device interface to use. @param handler Function pointer to the handler to install @result Returns on IOFireWireBusResetDoneHandler function pointer to the previously installed bus reset handler. Returns 0 if none was set. */ const IOFireWireBusResetDoneHandler (*SetBusResetDoneHandler)(IOFireWireLibDeviceRef self, IOFireWireBusResetDoneHandler handler); /*! @function ClientCommandIsComplete @abstract This function must be called from callback routines once they have completed processing a callback. This function only applies to callbacks which take an IOFireWireLibDeviceRef (i.e. bus reset), parameter. @param commandID The command ID passed to the callback function when it was called @param status An IOReturn value indicating the completion status of the callback function */ void (*ClientCommandIsComplete)( IOFireWireLibDeviceRef self, FWClientCommandID commandID, IOReturn status); // --- read/write/lock operations ------- /*! @function Read @abstract Perform synchronous block read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Read)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function ReadQuadlet @abstract Perform synchronous quadlet read @param self The device interface to use. @param device The service (representing an attached FireWire device) to read. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param value A pointer to where to data should be stored @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in generation. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*ReadQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* val, Boolean failOnReset, UInt32 generation); /*! @function Write @abstract Perform synchronous block write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*Write)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const void* buf, UInt32* size, Boolean failOnReset, UInt32 generation); /*! @function WriteQuadlet @abstract Perform synchronous quadlet write @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param val The value to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*WriteQuadlet)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, const UInt32 val, Boolean failOnReset, UInt32 generation); /*! @function CompareSwap @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. @param addr Command target address @param cmpVal The check/compare value @param newVal Value to set @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32 cmpVal, UInt32 newVal, Boolean failOnReset, UInt32 generation); // --- FireWire command object methods --------- /*! @function CreateReadCommand @abstract Create a block read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to a buffer where the results will be stored @param size Number of bytes to read @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateReadCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateReadQuadletCommand @abstract Create a quadlet read command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets where results should be stored @param numQuads Number of quadlets to read @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @param */ IOFireWireLibCommandRef (*CreateReadQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteCommand @abstract Create a block write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param buf A pointer to the buffer containing the data to be written @param size Number of bytes to write @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateWriteCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, void* buf, UInt32 size, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateWriteQuadletCommand @abstract Create a quadlet write command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param quads An array of quadlets containing quadlets to be written @param numQuads Number of quadlets to write @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOFireWireLibCommandRef interface. See IOFireWireLibCommandRef. */ IOFireWireLibCommandRef (*CreateWriteQuadletCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 quads[], UInt32 numQuads, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CreateCompareSwapCommand @abstract Create a quadlet compare/swap command object. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 32-bit value expected at target address @param newVal 32-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress * addr, UInt32 cmpVal, UInt32 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); // --- other methods --------------------------- /*! @function BusReset @abstract Cause a bus reset */ IOReturn (*BusReset)( IOFireWireLibDeviceRef self); /*! @function GetCycleTime @abstract Get bus cycle time. @param self The device interface to use. @param outCycleTime A pointer to a UInt32 to hold the result */ IOReturn (*GetCycleTime)( IOFireWireLibDeviceRef self, UInt32* outCycleTime); /*! @function GetGenerationAndNodeID @abstract (Obsolete) Get bus generation and remote device node ID. @discussion Obsolete -- Please use GetBusGeneration() and/or GetRemoteNodeID() in interface v4. @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the generation result @param outNodeID A pointer to a UInt16 to hold the remote device node ID */ IOReturn (*GetGenerationAndNodeID)( IOFireWireLibDeviceRef self, UInt32* outGeneration, UInt16* outNodeID); /*! @function GetLocalNodeID @abstract (Obsolete) Get local node ID. @discussion Obsolete -- Please use GetBusGeneration() and GetLocalNodeIDWithGeneration() in interface v4. @param self The device interface to use. @param outNodeID A pointer to a UInt16 to hold the local device node ID */ IOReturn (*GetLocalNodeID)( IOFireWireLibDeviceRef self, UInt16* outLocalNodeID); /*! @function GetResetTime @abstract Get time since last bus reset. @param self The device interface to use. @param outResetTime A pointer to an AbsolutTime to hold the result. */ IOReturn (*GetResetTime)( IOFireWireLibDeviceRef self, AbsoluteTime* outResetTime); // --- unit directory support ------------------ /*! @function CreateLocalUnitDirectory @abstract Creates a local unit directory object and returns an interface to it. An instance of a unit directory object corresponds to an instance of a unit directory in the local machine's configuration ROM. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created unit directory object. */ IOFireWireLibLocalUnitDirectoryRef (*CreateLocalUnitDirectory)( IOFireWireLibDeviceRef self, REFIID iid); // --- config directory support ---------------- /*! @function GetConfigDirectory @abstract Creates a config directory object and returns an interface to it. The created config directory object represents the config directory in the remote device or unit to which the creating device interface is attached. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*GetConfigDirectory)( IOFireWireLibDeviceRef self, REFIID iid); /*! @function CreateConfigDirectoryWithIOObject @abstract This function can be used to create a config directory object and a corresponding interface from an opaque IOObject reference. Some configuration directory interface methods may return an io_object_t instead of an IOFireWireLibConfigDirectoryRef. Use this function to obtain an IOFireWireLibConfigDirectoryRef from an io_object_t. @param self The device interface to use. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created config directory object. */ IOFireWireLibConfigDirectoryRef (*CreateConfigDirectoryWithIOObject)( IOFireWireLibDeviceRef self, io_object_t inObject, REFIID iid); // --- address space support ------------------- /*! @function CreatePseudoAddressSpace @abstract Creates a pseudo address space object and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. @param self The device interface to use. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreatePseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function CreatePhysicalAddressSpace @abstract Creates a physical address space object and returns an interface to it. This will create a physical address space on the local machine. @param self The device interface to use. @param inBackingStore An block of allocated memory representing the contents of the address space. @param inSize The size in bytes of this address space @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. For future use -- always pass 0. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created physical address space object. */ IOFireWireLibPhysicalAddressSpaceRef (*CreatePhysicalAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inSize, void* inBackingStore, UInt32 inFlags, REFIID iid); // --- debugging ------------------------------- IOReturn (*FireBugMsg)( IOFireWireLibDeviceRef self, const char* msg); // // NOTE: the following methods available only in interface v2 and later // // --- eye-sock-run-U.S. ----------------------- /*! @function AddIsochCallbackDispatcherToRunLoop @abstract This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not function before this function is called. This functions is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added */ IOReturn (*AddIsochCallbackDispatcherToRunLoop)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop); /*! @function CreateRemoteIsochPort @abstract Creates a remote isochronous port object and returns an interface to it. A remote isochronous port object is an abstract entity used to represent a remote talker or listener device on an isochronous channel. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created remote isochronous port object. */ IOFireWireLibRemoteIsochPortRef (*CreateRemoteIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, REFIID iid); /*! @function CreateLocalIsochPort @abstract Creates a local isochronous port object and returns an interface to it. A local isochronous port object is an abstract entity used to represent a talking or listening endpoint in the local machine. @param self The device interface to use. @param inTalking Pass true if this port represents an isochronous talker. Pass false if this port represents an isochronous listener. @param inDCLProgram A pointer to the first DCL command struct of the DCL program to be compiled and used to send or receive data on this port. @param inStartEvent Start event bits @param inStartState Start state bits @param inStartMask Start mask bits @param inDCLProgramRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the passed DCL program occupies. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inDCLProgramRangeCount The number of virtual ranges passed to inDCLProgramRanges. Pass 0 for none. @param inBufferRanges This is an optional optimization parameter which can be used to decrease the time the local port object spends determining which set of virtual ranges the data buffers referenced by the passed DCL program occupy. Pass a pointer to an array of IOVirtualRange structs or nil to ignore this parameter. @param inBufferRangeCount The number of virtual ranges passed to inBufferRanges. Pass 0 for none. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibLocalIsochPortRef (*CreateLocalIsochPort)( IOFireWireLibDeviceRef self, Boolean inTalking, DCLCommandPtr inDCLProgram, UInt32 inStartEvent, UInt32 inStartState, UInt32 inStartMask, IOVirtualRange inDCLProgramRanges[], // optional optimization parameters UInt32 inDCLProgramRangeCount, IOVirtualRange inBufferRanges[], UInt32 inBufferRangeCount, REFIID iid); /*! @function CreateIsochChannel @abstract Creates an isochronous channel object and returns an interface to it. An isochronous channel object is an abstract entity used to represent a FireWire isochronous channel. @param self The device interface to use. @param doIRM Controls whether the channel automatically performs IRM operations. Pass true if the channel should allocate its channel and bandwidth with the IRM. Pass false to ignore the IRM. @param packetSize Size in bytes of packets being sent or received with this channel. This is automatically translated into a bandwidth allocation appropriate for the speed passed in prefSpeed. @param prefSpeed The preferred bus speed of this channel. @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibIsochChannelRef (*CreateIsochChannel)( IOFireWireLibDeviceRef self, Boolean doIrm, UInt32 packetSize, IOFWSpeed prefSpeed, REFIID iid ); /*! @function CreateDCLCommandPool @abstract Creates a command pool object and returns an interface to it. The command pool can be used to build DCL programs. @param self The device interface to use. @param size Starting size of command pool @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created object. */ IOFireWireLibDCLCommandPoolRef (*CreateDCLCommandPool)( IOFireWireLibDeviceRef self, IOByteCount size, REFIID iid ); // --- refcons --------------------------------- /*! @function GetRefCon @abstract Get user reference value set on this interface @param self The device interface to use. */ void *(*GetRefCon)( IOFireWireLibDeviceRef self); /*! @function SetRefCon @abstract Set user reference value on this interface @param self The device interface to use. */ void (*SetRefCon)( IOFireWireLibDeviceRef self, const void* refCon); // --- debugging ------------------------------- // do not use this function CFTypeRef (*GetDebugProperty)( IOFireWireLibDeviceRef self, void* interface, CFStringRef inPropertyName, CFTypeID* outPropertyType); /*! @function PrintDCLProgram @abstract Walk a DCL program linked list and print its contents @param self The device interface to use. @param inProgram A pointer to the first DCL of the program to print @param inLength Number of DCLs expected in the program. PrintDCLProgram() will report an error if this number does not match the number of DCLs found */ void (*PrintDCLProgram)( IOFireWireLibDeviceRef self, const DCLCommandPtr inProgram, UInt32 inLength); // // NOTE: the following methods available only in interface v3 and later // // --- v3 functions ---------- /*! @function CreateInitialUnitsPseudoAddressSpace @abstract Creates a pseudo address space in initial units space. @discussion Creates a pseudo address space object in initial units space and returns an interface to it. This will create a pseudo address space (software-backed) on the local machine. Availablilty: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inAddressLo The lower 32 bits of the base address of the address space to be created. The address is always in initial units space. @param inSize The size in bytes of this address space @param inRefCon A user specified reference value. This will be passed to all callback functions. @param inQueueBufferSize The size of the queue which receives packets from the bus before they are handed to the client and/or put in the backing store. A larger queue can help eliminate dropped packets when receiving large bursts of data. When a packet is received which can not fit into the queue, the packet dropped callback will be called. @param inBackingStore An optional block of allocated memory representing the contents of the address space. @param inFlags A UInt32 with bits set corresponding to the flags that should be set for this address space. <ul> <li>kFWAddressSpaceNoFlags -- All flags off</li> <li>kFWAddressSpaceNoWriteAccess -- Write access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceNoReadAccess -- Read access access to this address space will be disallowed. Setting this flag also disables compare/swap transactions on this address space.</li> <li>kFWAddressSpaceAutoWriteReply -- Writes will be made automatically, directly modifying the contents of the backing store. The user process will not be notified of writes.</li> <li>kFWAddressSpaceAutoReadReply -- Reads to this address space will be answered automagically using the contents of the backing store. The user process will not be notified of reads.</li> <li>kFWAddressSpaceAutoCopyOnWrite -- Writes to this address space will be made directly to the backing store at the same time the user process is notified of a write. Clients will only be notified of a write if kFWAddressSpaceAutoWriteReply is not set.</li> <li>kFWAddressSpaceShareIfExists -- Allows creation of this address space even if another client already has an address space at the requested address. All clients will be notified of writes to covered addresses.</li> </ul> @param iid An ID number, of type CFUUIDBytes (see CFUUID.h), identifying the type of interface to be returned for the created pseudo address space object. */ IOFireWireLibPseudoAddressSpaceRef (*CreateInitialUnitsPseudoAddressSpace)( IOFireWireLibDeviceRef self, UInt32 inAddressLo, UInt32 inSize, void* inRefCon, UInt32 inQueueBufferSize, void* inBackingStore, UInt32 inFlags, REFIID iid); /*! @function AddCallbackDispatcherToRunLoopForMode @abstract Add a run loop event source to allow IOFireWireLib callbacks to function. @discussion Installs the proper run loop event source to allow callbacks to function. This method must be called before callback notifications for this interface or any interfaces created using this interface can function. With this function, you can additionally specify for which run loop modes this source should be added. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop The run loop on which to install the event source @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function AddIsochCallbackDispatcherToRunLoop @abstract Add a run loop event source to allow IOFireWireLib isoch callbacks to function. @discussion This function adds an event source for the isochronous callback dispatcher to the specified CFRunLoop. Isochronous related callbacks will not be called unless this function has been called. This function is similar to AddCallbackDispatcherToRunLoop. The passed CFRunLoop can be different from that passed to AddCallbackDispatcherToRunLoop. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. @param inRunLoop A CFRunLoopRef for the run loop to which the event loop source should be added @param inRunLoopMode The run loop mode(s) for which to install the event source */ IOReturn (*AddIsochCallbackDispatcherToRunLoopForMode)( IOFireWireLibDeviceRef self, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode ); /*! @function RemoveIsochCallbackDispatcherFromRunLoop @abstract Removes an IOFireWireLib-added run loop event source. @discussion Reverses the effects of AddIsochCallbackDispatcherToRunLoop(). This method removes the run loop event source that was added to the specified run loop preventing any future callbacks from being called. Availability: IOFireWireDeviceInterface_v3, and newer @param self The device interface to use. */ void (*RemoveIsochCallbackDispatcherFromRunLoop)( IOFireWireLibDeviceRef self); /*! @function Seize @abstract Seize control of device/unit @discussion Allows a user space client to seize control of an in-kernel service even if that service has been Opened() by another client or in-kernel driver. This function should be used with care. Admin rights are required to use this function. Calling this method makes it appear to all other drivers that the device has been unplugged. Open() should be called after this method has been invoked. When access is complete, Close() and then IOServiceRequestProbe() should be called to restore normal operation. Calling IOServiceRequestProbe() makes it appear that the device has been "re-plugged." @param self The device interface to use. @param reserved Reserved for future use. Set to NULL. */ IOReturn (*Seize)( IOFireWireLibDeviceRef self, IOOptionBits inFlags, ... ); /*! @function FireLog @abstract Logs string to in-kernel debug buffer @param self The device interface to use. */ IOReturn (*FireLog)( IOFireWireLibDeviceRef self, const char* format, ... ); /*! @function GetBusCycleTime @abstract Get bus and cycle time. @param self The device interface to use. @param outBusTime A pointer to a UInt32 to hold the bus time @param outCycleTime A pointer to a UInt32 to hold the cycle time */ IOReturn (*GetBusCycleTime)( IOFireWireLibDeviceRef self, UInt32* outBusTime, UInt32* outCycleTime); // // v4 // /*! @function CreateCompareSwapCommand64 @abstract Create a quadlet compare/swap command object and initialize it with 64-bit values. @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. Setting the callback value to nil defaults to synchronous execution. @param addr Command target address @param cmpVal 64-bit value expected at target address @param newVal 64-bit value to be set at target address @param callback Command completion callback. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. */ IOFireWireLibCommandRef (*CreateCompareSwapCommand64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt64 cmpVal, UInt64 newVal, IOFireWireLibCommandCallback callback, Boolean failOnReset, UInt32 generation, void* inRefCon, REFIID iid); /*! @function CompareSwap64 @abstract Perform synchronous lock operation @param self The device interface to use. @param device The service (representing an attached FireWire device) to which to write. For 48-bit, device relative addressing, pass the service used to create the device interface. This can be obtained by calling GetDevice(). For 64-bit absolute addressing, pass 0. Other values are unsupported. If the quadlets stored at 'oldVal' match those passed to 'expectedVal', the lock operation was successful. @param addr Command target address @param expectedVal Pointer to quadlets expected at target. @param newVal Pointer to quadlets to atomically set at target if compare is successful. @param oldVal Pointer to quadlets to hold value found at target address after transaction if completed. @param size Size in bytes of compare swap transaction to perform. Value values are 4 and 8. @param failOnReset Pass true if the command should only be executed during the FireWire bus generation specified in 'generation'. Pass false to ignore the generation parameter. The generation can be obtained by calling GetGenerationAndNodeID() @param generation The FireWire bus generation during which the command should be executed. Ignored if failOnReset is false. @result An IOReturn error code */ IOReturn (*CompareSwap64)( IOFireWireLibDeviceRef self, io_object_t device, const FWAddress* addr, UInt32* expectedVal, UInt32* newVal, UInt32* oldVal, IOByteCount size, Boolean failOnReset, UInt32 generation); /*! @function GetBusGeneration @abstract Get bus generation number. @discussion The bus generation number stays constant between bus resets and can be used in combination with a FireWire node ID to uniquely identify nodes on the bus. Pass the generation number to functions that take or return FireWire node IDs. Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param outGeneration A pointer to a UInt32 to hold the bus generation number */ IOReturn (*GetBusGeneration)( IOFireWireLibDeviceRef self, UInt32* outGeneration ); /*! @function GetLocalNodeIDWithGeneration @abstract Get node ID of local machine. @discussion Use this function instead of GetLocalNodeID(). Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outLocalNodeID A pointer to a UInt16 to hold the node ID of the local machine. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outLocalNodeID'. Returns */ IOReturn (*GetLocalNodeIDWithGeneration)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outLocalNodeID ); /*! @function GetRemoteNodeID @abstract Get node ID of device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outRemoteNodeID A pointer to a UInt16 to hold the node ID of the remote device. @result Returns kIOReturnSuccess if a valid nodeID has been returned in 'outRemoteNodeID'. Returns */ IOReturn (*GetRemoteNodeID)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16* outRemoteNodeID ); /*! @function GetSpeedToNode @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param outSpeed A pointer to an IOFWSpeed to hold the maximum speed to the remote device. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedToNode)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, IOFWSpeed* outSpeed); /*! @function GetSpeedBetweenNodes @abstract Get maximum transfer speed to device to which this interface is attached. @discussion Availability: IOFireWireDeviceInterface_v4 and newer @param self The device interface to use. @param checkGeneration A bus generation number obtained from GetBusGeneration() @param srcNodeID A FireWire node ID. @param destNodeID A FireWire node ID. @param outSpeed A pointer to an IOFWSpeed to hold the maximum transfer speed between node 'srcNodeID' and 'destNodeID'. @result Returns kIOReturnSuccess if a valid speed has been returned in 'outSpeed'. Returns */ IOReturn (*GetSpeedBetweenNodes)( IOFireWireLibDeviceRef self, UInt32 checkGeneration, UInt16 srcNodeID, UInt16 destNodeID, IOFWSpeed* outSpeed); } IOFireWireDeviceInterface, IOFireWireUnitInterface, IOFireWireNubInterface; END OF OBJECT $1|C$6|parser