Mac Developer Library

Developer

IOFireWireAVCSubUnit Class Reference

Options
Deployment Target:

On This Page
Language:

IOFireWireAVCSubUnit

nub for sub unit of AVC devices. Just for matching, calls the AVC unit for all functions. More...

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable @import Kernel;

Availability


Available in OS X v10.2 and later.
  • Sends an AVC command to the device and stores the response.

    Declaration

    C++

    virtual IOReturn AVCCommand( const UInt8 *command, UInt32cmdLen, UInt8 *response, UInt32 *responseLen);

    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.

    Import Statement

  • 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.

    Declaration

    C++

    virtual IOReturn AVCCommandInGeneration( UInt32generation, const UInt8 *command, UInt32cmdLen, UInt8 *response, UInt32 *responseLen);

    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.

    Import Statement

  • Overrideable method to control the open / close behaviour of an IOService.

    Declaration

    C++

    virtual void handleClose( IOService *forClient, IOOptionBitsoptions );

    Parameters

    forClient

    Designates the client of the provider requesting the close.

    options

    Options for the close, may be interpreted by the implementor of handleOpen.

    Discussion

    See IOService for discussion.

    Import Statement

  • Overrideable method to control the open / close behaviour of an IOService.

    Declaration

    C++

    virtual bool handleOpen( IOService *forClient, IOOptionBits options, void *arg );

    Parameters

    forClient

    Designates the client of the provider requesting the open.

    options

    Options for the open, may be interpreted by the implementor of handleOpen.

    Return Value

    Return true if the open was successful, false otherwise.

    Discussion

    See IOService for discussion.

    Import Statement

  • Matching language support Match on the following properties of the sub unit: Vendor_ID GUID SubUnit_Type

    Declaration

    C++

    virtual bool matchPropertyTable( OSDictionary *table);

    Import Statement

  • 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.

    Declaration

    C++

    virtual IOReturn updateAVCCommandTimeout();

    Import Statement

Data Types

  • Declaration

    C++

    struct ExpansionData { };

    Discussion

    This structure will be used to expand the capablilties of the class in the future.

Instance Variables

  • Reserved for future use. (Internal use only)

    Declaration

    C++

    ExpansionData *reserved;