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

IOFireWireAVCLib.h

Include Path :	<IOKit/avc>
Path:	/System/Library/Frameworks/IOKit.framework/Versions/A/Headers/avc/IOFireWireAVCLib.h
Includes:	<IOKit/IOCFPlugIn.h> <IOKit/firewire/IOFireWireFamilyCommon.h> <IOKit/avc/IOFireWireAVCConsts.h>

Overview

This header file contains the definitions of the IOFireWireAVCLibUnitInterface (the initial interface discovered for all AV/C unit drivers), the IOFireWireAVCLibProtocolInterface (the initial interface discovered for all AV/C protocol drivers), and the IOFireWireAVCLibConsumerInterface (a limited implementation of an interface for asychronous connections).

C Pseudoclasses

IOFireWireAVCLibConsumerInterface: Interface for an asynchronous connection consumer.
IOFireWireAVCLibProtocolInterface: Initial interface discovered for all AV/C protocol drivers.
IOFireWireAVCLibUnitInterface: Initial interface discovered for all AV/C unit drivers.

Typedefs

IOFireWireAVCFrameStatusHandler

Callback called when the consumer/controller has data available for the client.

typedef void ( *IOFireWireAVCFrameStatusHandler)(
    void *refcon,
    UInt32 mode,
    UInt32 count );

Fields

refCon: The refcon supplied when a connection is made.
mode: The current mode (such as SEND, MORE, LAST, etc.).
count: The segment size.

IOFireWireAVCLibAsynchronousCommandCallback

Callback called when there is a response to an asynchronous AV/C command, a bus reset, or for other reasons.

typedef void ( *IOFireWireAVCLibAsynchronousCommandCallback)(
    void *pRefCon,
    IOFireWireAVCLibAsynchronousCommand *pCommandObject);

Fields

pRefCon: Pointer to arbitrary data supplied when the IOFireWireAVCLibAsynchronousCommand object was created.
pCommandObject: Pointer to an IOFireWireAVCLibAsynchronousCommand object passed back in createAVCAsynchronousCommand.

IOFireWireAVCPortStateHandler

Callback called when the connection to a producer changes.

typedef void ( *IOFireWireAVCPortStateHandler)(
    void *refcon,
    UInt32 state );

Fields

refCon: The refcon supplied when a connection is made.
state: The state of the connection (can be Bus Suspended, Bus Resumed, Plug Reconnected, Plug Disconnected, Device Removed).

IOFWAVCCommandHandlerCallback

Callback called when an incoming AV/C 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.
srcNodeID: The node ID of the device who sent us this command.
speed: The speed of the AV/C command packet.
command: A pointer to the command bytes.
cmdLen: The length of the AV/C command bytes buffer in bytes.

Return Value

The callback handler should return success if it will send the AV/C 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: The refcon supplied when a client is registered.
generation: Bus generation the command was received in.
nodeID: The node originating the request.
plug: The plug number.
oldVal: The value the plug used to contain.
newVal: 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 an incoming AV/C 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. Returns an error if not accepting the sig format change.

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