ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference

IOFireWireAVCNub

Inherits from:	IOService
Declared In:	IOFireWireAVCUnit.h

Overview

nub for AVC devices

Functions

AVCCommand: Sends an AVC command to the device and stores the response.
AVCCommandInGeneration: Sends an AVC command to the device and stores the response. The command must complete in the specified FireWire bus generation otherwise kIOFireWireBusReset is returned.
getDevice: Returns the FireWire device nub that is this object's provider .
updateAVCCommandTimeout: By default, AVCCommands timeout 10 seconds after receiving an Interim response. This function resets the timeout of the current command to 10 seconds from the current time. Call this repeatedly for AVC commands that take a very long time to execute to prevent premature timeout.

AVCCommand

Sends an AVC command to the device and stores the response.

public

virtual IOReturn AVCCommand(
    const UInt8 * command,
    UInt32 cmdLen,
    UInt8 * response,
    UInt32 *responseLen) = 0;

Parameters

command: Pointer to command to send.
cmdLen: Length of the command.
response: Pointer to place to store the response.
responseLen: Pointer to response length - initialize to the size of the buffer pointed to by response, updated to the number of bytes returned by the device.

AVCCommandInGeneration

Sends an AVC command to the device and stores the response. The command must complete in the specified FireWire bus generation otherwise kIOFireWireBusReset is returned.

public

virtual IOReturn AVCCommandInGeneration(
    UInt32 generation, 
    const UInt8 * command,
    UInt32 cmdLen,
    UInt8 * response,
    UInt32 *responseLen) = 0;

Parameters

generation: The bus generation that the command must execute in.
command: Pointer to command to send.
cmdLen: Length of the command.
response: Pointer to place to store the response.
responseLen: Pointer to response length - initialize to the size of the buffer pointed to by response, updated to the number of bytes returned by the device.

getDevice

Returns the FireWire device nub that is this object's provider .

public

IOFireWireNub* getDevice() const ;

By default, AVCCommands timeout 10 seconds after receiving an Interim response. This function resets the timeout of the current command to 10 seconds from the current time. Call this repeatedly for AVC commands that take a very long time to execute to prevent premature timeout.

public

virtual IOReturn updateAVCCommandTimeout() = 0;

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: 2008-12-19