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

IOFireWireAVCLib.h

Includes:

Overview

Use the links in the table of contents to the left to access the documentation.

C Pseudoclasses

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.

Typedefs

IOFWAVCCommandHandlerCallback: Callback called when a incoming AVC command matching a registered command handler is received.
IOFWAVCPCRCallback: Callback called after a successful lock transaction to a CMP plug.
IOFWAVCRequestCallback: This Callback has been deprecated. Use installAVCCommandHandler instead.
IOFWAVCSubunitPlugHandlerCallback: Callback called when a incoming AVC command matching a registered command handler is received.

IOFWAVCCommandHandlerCallback

Callback called when a incoming AVC command matching a registered command handler is received.

typedef IOReturn ( *IOFWAVCCommandHandlerCallback)(
    void *refCon,
    UInt32 generation,
    UInt16 srcNodeID,
    IOFWSpeed speed,
    const UInt8 * command,
    UInt32 cmdLen);

Parameters

refCon: The refcon supplied when a client is registered
generation: The FireWire bus generation value at the time the command was received
scrNodeID: The node ID of the device who sent us this command
speed: The speed the AVC command packet
command: A pointer to the command bytes
cmdLen: The length of the AVC command bytes buffer in bytes

Return Value

The callback handler should return success if it will send the AVC response, or an error if it doesn't want to handle the command

IOFWAVCPCRCallback

Callback called after a successful lock transaction to a CMP plug.

typedef void ( *IOFWAVCPCRCallback)(
    void *refcon,
    UInt32 generation,
    UInt16 nodeID,
    UInt32 plug, 
    UInt32 oldVal,
    UInt32 newVal);

Fields

refcon: refcon supplied when a client is registered
generation: Bus generation command was received in
nodeID: is the node originating the request
plugNo: is the plug number
oldVal: is the value the plug used to contain
newVal: is the quad written into the plug

IOFWAVCRequestCallback

This Callback has been deprecated. Use installAVCCommandHandler instead.

typedef IOReturn ( *IOFWAVCRequestCallback)(
    void *refCon,
    UInt32 generation,
    UInt16 srcNodeID, 
    const UInt8 * command,
    UInt32 cmdLen,
    UInt8 * response,
    UInt32 *responseLen);

IOFWAVCSubunitPlugHandlerCallback

Callback called when a incoming AVC command matching a registered command handler is received.

typedef IOReturn ( *IOFWAVCSubunitPlugHandlerCallback)(
    void *refCon, 
    UInt32 subunitTypeAndID, 
    IOFWAVCPlugTypes plugType, 
    UInt32 plugNum, 
    IOFWAVCSubunitPlugMessages plugMessage, 
    UInt32 messageParams);

Parameters

refCon: The refcon supplied when a client is registered
subunitTypeAndID: The subunit type and id of this plug
plugType: The type of plug receiving the message
plugNum: The number of the plug receiving the message
plugMessage: The plug message
messageParams: The parameters associated with the plug message

Return Value

The return value is only pertinent for the kIOFWAVCSubunitPlugMsgSignalFormatModified message. Return an error if not accepting the sig format change.

Did this document help you?

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

Last Updated: 2009-10-15