ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

 

IOFireWireIsochPortInterface

Declared In:

Overview

FireWire user client isochronous port interface.

Discussion

Isochronous ports represent talkers or listeners on a FireWire isochronous channel. This is a base class containing all isochronous port functionality not specific to any type of port. Ports are added to channel interfaces (IOFireWireIsochChannelInterface) which coordinate the start and stop of isochronous traffic on a FireWire bus isochronous channel.


Functions

AllocatePort

Called when the port should configure its associated hardware to prepare to send or receive isochronous data.

GetRefCon

Gets reference value associated with this port.

GetSupported

Determines which FireWire isochronous channels and speed this port supports.

ReleasePort

Releases the hardware after the channel has been stopped.

SetRefCon

Sets reference value associated with this port.

Start

Called when the port is to begin talking or listening.

Stop

Called when the port is to stop talking or listening.

AllocatePort

Called when the port should configure its associated hardware to prepare to send or receive isochronous data. 

IOReturn ( *AllocatePort)(
    IOFireWireLibIsochPortRef self,
    IOFWSpeed speed,
    UInt32 chan );
Parameters
self

The isoch port interface to use.

speed

Channel speed.

chan

Channel number (0-63).

Return Value

Returns kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

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. This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

GetRefCon

Gets reference value associated with this port. 

void* ( *GetRefCon)(
    IOFireWireLibIsochPortRef self);
Parameters
self

The isoch port interface to use.

Return Value

Returns the port refcon value.

Discussion

Set the reference value with SetRefCon.

GetSupported

Determines which FireWire isochronous channels and speed this port supports. 

IOReturn ( *GetSupported)(
    IOFireWireLibIsochPortRef self,
    IOFWSpeed *maxSpeed,
    UInt64 *chanSupported );
Parameters
self

The isoch port interface to use.

maxSpeed

A pointer to an IOFWSpeed which should be filled with the maximum speed this port can talk or listen.

chanSupported

A pointer to a UInt64 which should be filled with a bitmask representing the FireWire bus isochonous channels on which the port can talk or listen. Set '1' for supported, '0' for unsupported.

Return Value

Returns kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

ReleasePort

Releases the hardware after the channel has been stopped. 

IOReturn ( *ReleasePort)(
    IOFireWireLibIsochPortRef self );
Parameters
self

The isoch port interface to use.

Return Value

Returns kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

SetRefCon

Sets reference value associated with this port. 

void ( *SetRefCon)(
    IOFireWireLibIsochPortRef self,
    void *inRefCon);
Parameters
self

The isoch port interface to use.

inRefCon

Returns the new reference value.

Discussion

Retrieve the reference value with GetRefCon.

Start

Called when the port is to begin talking or listening. 

IOReturn ( *Start)(
    IOFireWireLibIsochPortRef self );
Parameters
self

The isoch port interface to use.

Return Value

Returns kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.

Stop

Called when the port is to stop talking or listening. 

IOReturn ( *Stop)(
    IOFireWireLibIsochPortRef self );
Parameters
self

The isoch port interface to use.

Return Value

Returns kIOReturnSuccess on success, other return any other IOReturn error code.

Discussion

This method is called by the channel object to which a port has been added. Subclasses of IOFireWireIsochPortInterface override this method to support specific hardware. Do not call this method directly.


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.

 

Last Updated: 2009-02-23