Structure

IOFireWireLocalIsochPortInterface

FireWire user client local isochronous port object.

Overview

Represents a FireWire isochronous talker or listener within the local machine. Isochronous transfer is controlled by an associated DCL (Data Stream Control Language) program, which is similar to a hardware DMA program but is hardware agnostic. DCL programs can be written using the IOFireWireDCLCommandPoolInterface object.

This interface contains all methods of IOFireWireIsochPortInterface and IOFireWireLocalIsochPortInterface. This interface will contain all v2 methods of IOFireWireLocalIsochPortInterface when instantiated as v2 or newer.

Transfer buffers for the local isoch port must all come from a single allocation made with vm_allocate() or mmap(..., MAP_ANON ).

Calling vm_deallocate() on the buffers before deallocating a local isoch port object may result in a deadlock.

Note: Calling Release() on the local isoch port may not immediately release the isoch port; so it may not be safe to call vm_deallocate() on your transfer buffers. To guarantee the port has been release, run the isochronous runloop until the port is finalized (it has processed any pending callbacks). The finalize callback will be called when the port is finalized. Set the finalize callback using SetFinalizeCallback().

Topics

Miscellaneous

AllocatePort

The method is called when the port should configure its associated hardware to prepare to send or receive isochronous data on the channel number and at the speed specified.

GetRefCon

Get reference value associated with this port.

GetSupported

The method is called to determine which FireWire isochronous channels and speed this port supports.

ModifyJumpDCL

Change the jump target label of a jump DCL.

ModifyTransferPacketDCL

Modify the transfer size of a transfer packet DCL (send or receive)

ModifyTransferPacketDCLBuffer

NOT IMPLEMENTED. Modify the transfer size of a transfer packet DCL (send or receive)

ModifyTransferPacketDCLSize

Modify the transfer size of a transfer packet DCL (send or receive)

PrintDCLProgram

Display the contents of a DCL program.

ReleasePort

The method is called to release the hardware after the channel has been stopped.

SetFinalizeCallback

Set the finalize callback for a local isoch port

SetRefCon

Set reference value associated with this port.

Start

The method is called when the port is to begin talking or listening.

Stop

The method is called when the port is to stop talking or listening.

Instance Variables

version

revision

Instance Properties

AddRef
Notify
QueryInterface
Release
SetResourceUsageFlags

See Also

COM Interfaces

IOATASMARTInterface

Self-Monitoring, Analysis, and Reporting Technology Interface.

IOFireWireAsyncStreamCommandInterface
IOFireWireAVCLibConsumerInterface

Interface for an asynchronous connection consumer.

IOFireWireAVCLibProtocolInterface

Initial interface discovered for all AVC protocol drivers.

IOFireWireAVCLibUnitInterface

Initial interface discovered for all AVC Unit drivers.

IOFireWireCommandInterface

IOFireWireLib command object.

IOFireWireCompareSwapCommandInterface
IOFireWireCompareSwapCommandInterface_v3
IOFireWireConfigDirectoryInterface

IOFireWireLib device config ROM browsing interface

IOFireWireDCLCommandPoolInterface
IOFireWireDeviceInterface

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

IOFireWireIsochChannelInterface

FireWire user client isochronous channel object.

IOFireWireIsochPortInterface

FireWire user client isochronous port interface

IOFireWireLibIRMAllocationInterface
IOFireWireLibPHYPacketListenerInterface

Represents and provides management functions for a phy packet listener object.

IOFireWireLibVectorCommandInterface

IOFireWireLib command object for grouping commands execution.

IOFireWireLocalUnitDirectoryInterface

IOFireWireNubInterface

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

IOFireWireNuDCLPoolInterface

Use this interface to build NuDCL-based DCL programs.

IOFireWirePHYCommandInterface
IOFireWirePhysicalAddressSpaceInterface

IOFireWireLib physical address space object. ( interface name: IOFireWirePhysicalAddressSpaceInterface )

IOFireWirePseudoAddressSpaceInterface

IOFireWireReadCommandInterface

IOFireWireLib block read command object.

IOFireWireReadQuadletCommandInterface

IOFireWireReadQuadletCommandInterface -- IOFireWireLib quadlet read command object.

IOFireWireRemoteIsochPortInterface
IOFireWireSBP2LibLoginInterface

Supplies the login maintenance and Normal Command ORB execution portions of the API.

IOFireWireSBP2LibLUNInterface

Initial interface disovered for all drivers.

IOFireWireSBP2LibMgmtORBInterface

Supplies non login related management ORBs. Management ORBs can be executed independent of a login, if necessary. Management ORBs are created using the IOFireWireSBP2LibLUNInterface.

IOFireWireSBP2LibORBInterface

Represents an SBP2 normal command ORB. Supplies the APIs for configuring normal command ORBs. This includes setting the command block and writing the page tables for I/O. The ORBs are executed using the submitORB method in IOFireWireSBP2LibLoginInterface.

IOFireWireUnitInterface

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

IOFireWireWriteCommandInterface

IOFireWireLib block read command object.

IOFireWireWriteQuadletCommandInterface

IOFireWireLib quadlet read command object.

IOFWAsyncStreamListenerInterface

Represents and provides management functions for a asyn stream listener object.

IOHIDDeviceDeviceInterface

The object you use to access HID devices from user space, returned by version 1.5 of the IOHIDFamily.

IOHIDDeviceInterface

CFPlugin object subclass which provides the primary interface to HID devices.

IOHIDDeviceInterface121

CFPlugin object subclass which provides the primary interface to HID devices. This class is a subclass of IOHIDDeviceInterface.

IOHIDDeviceInterface122

CFPlugin object subclass which provides the primary interface to HID devices. This class is a subclass of IOHIDDeviceInterface121.

IOHIDDeviceQueueInterface

The object you use to access a HID queue from user space, returned by version 1.5 of the IOHIDFamily.

IOHIDDeviceTransactionInterface

The object you use to access a HID transaction from user space, returned by version 1.5 of the IOHIDFamily.

IOHIDOutputTransactionInterface

CFPlugin object subclass which privides interface for output transactions to HID devices. Created by a IOHIDDeviceInterface object.

IOHIDQueueInterface

CFPlugin object subclass which provides an interface for input queues from HID devices. Created by an IOHIDDeviceInterface object.

IOUPSPlugInInterface

Represents and provides management functions for a UPS device.

IOUSBDeviceInterface

The object you use to access USB devices from user space, returned by all versions of the IOUSBFamily currently shipping.

IOUSBDeviceInterface182

The object you use to access USB devices from user space, returned by the IOUSBFamily version 1.8.2 and above.

IOUSBDeviceInterface187

The object you use to access USB devices from user space, returned by the IOUSBFamily version 10.8.7 and above.

IOUSBDeviceInterface197

The object you use to access USB devices from user space, returned by the IOUSBFamily version 1.9.7 and above.

IOUSBDeviceInterface245

The object you use to access USB devices from user space, returned by the IOUSBFamily version 2.4.5 and above.

IOUSBDeviceInterface300

The object you use to access USB devices from user space, returned by the IOUSBFamily version 3.0.0 and above.

IOUSBDeviceInterface320

The object you use to access USB devices from user space, returned by the IOUSBFamily version 3.2.0 and above.

IOUSBDeviceInterface500

The object you use to access USB devices from user space, returned by the IOUSBFamily version 3.2.0 and above.

IOUSBInterfaceInterface

The object you use to access a USB device interface from user space, returned by all versions of the IOUSBFamily currently shipping.

IOUSBInterfaceInterface182

The object you use to access a USB device interface from user space, returned by the IOUSBFamily version 1.8.2 and above.

IOUSBInterfaceInterface183

The object you use to access a USB device interface from user space, returned by the IOUSBFamily version 1.8.3 and above.

IOUSBInterfaceInterface190

The object you use to access a USB device interface from user space, returned by the IOUSBFamily version 1.9 and above.

IOUSBInterfaceInterface192

The object you use to access a USB device interface from user space, returned by the IOUSBFamily version 1.9.2 and above.

IOUSBInterfaceInterface197

The object you use to access a USB device interface from user space, returned by the IOUSBFamily version 1.9.7 and above.

MMCDeviceInterface

Basic interface for an MMC-2 Compliant Device.

SCSITaskDeviceInterface

Basic interface for a SCSITask Device.

SCSITaskInterface

Basic interface for a SCSITask.