IOFireWireCompareSwapCommandInterface

Overview

Description forthcoming

Functions

Cancel

Cancel command execution

DidLock

Was the last lock operation successful?

GetStatus

Return command completion status.

GetTargetAddress

Get command target address.

GetTransferredBytes

Return number of bytes transferred by this command object when it last completed execution.

IsExecuting

Is this command object currently executing?

Locked

Get the 32-bit value returned on the last compare swap operation.

Locked64

Get the 64-bit value returned on the last compare swap operation.

SetCallback

Set the completion handler to be called once the command completes asynchronous execution .

SetFlags

Set flags governing this command's execution.

SetGeneration

Set FireWire bus generation for which the command object shall be valid. If the failOnReset attribute has been set, the command will only be considered for execution during the bus generation specified by this function.

SetRefCon

Set the user refCon value. This is the user defined value that will be passed in the refCon argument to the completion function.

SetTarget

Set command target address

SetValues

Set values for 32-bit compare swap operation. Calling this function will make the command object perform 32-bit compare swap transactions on the bus. To perform 64-bit compare swap operations, use the SetValues64() call, below.

SetValues64

Set values for 64-bit compare swap operation. Calling this function will make the command object perform 64-bit compare swap transactions on the bus. To perform 32-bit compare swap operations, use the SetValues() call, above.

Submit

SubmitWithRefconAndCallback

Set the command refCon value and callback handler, and submit the command to FireWire for execution.

Cancel command execution

IOReturn ( *Cancel)(
    IOFireWireLibCommandRef self,
    IOReturn reason);  

Parameters

Return Value

An IOReturn result code

Discussion

Availability: (for interfaces obtained with ID)

Was the last lock operation successful?

Boolean ( *DidLock)(
    IOFireWireLibCompareSwapCommandRef self);  

Parameters

Return Value

Returns true if the last lock operation performed by this command object was successful, false otherwise.

Discussion

Available in v2 and newer.

Return command completion status.

IOReturn ( *GetStatus)(
    IOFireWireLibCommandRef self);  

Parameters

Return Value

An IOReturn error code indicating the completion error (if any) returned the last time this command object was executed

Discussion

Availability: (for interfaces obtained with ID)

Get command target address.

void ( *GetTargetAddress)(
    IOFireWireLibCommandRef self,
    FWAddress *outAddr);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Return number of bytes transferred by this command object when it last completed execution.

UInt32 ( *GetTransferredBytes)(
    IOFireWireLibCommandRef self);  

Parameters

Return Value

A UInt32 containing the bytes transferred value

Discussion

Availability: (for interfaces obtained with ID)

Is this command object currently executing?

const Boolean (*IsExecuting)(IOFireWireLibCommandRef self);  

Parameters

Return Value

Returns true if the command object is executing.

Discussion

Availability: (for interfaces obtained with ID)

Get the 32-bit value returned on the last compare swap operation.

IOReturn ( *Locked)(
    IOFireWireLibCompareSwapCommandRef self,
    UInt32 *oldValue);  

Parameters

Return Value

Returns kIOReturnBadArgument if the last compare swap operation performed was 64-bit.

Discussion

Available in v2 and newer.

Get the 64-bit value returned on the last compare swap operation.

IOReturn ( *Locked64)(
    IOFireWireLibCompareSwapCommandRef self,
    UInt64 *oldValue);  

Parameters

Return Value

Returns kIOReturnBadArgument if the last compare swap performed was 32-bit.

Discussion

Available in v2 and newer.

Set the completion handler to be called once the command completes asynchronous execution .

void ( *SetCallback)(
    IOFireWireLibCommandRef self,
    IOFireWireLibCommandCallback inCallback);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Set flags governing this command's execution.

void ( *SetFlags)(
    IOFireWireLibCompareSwapCommandRef self,
    UInt32 inFlags);  

Parameters

Discussion

Available in v2 and newer. Same as SetFlags() above.

Set FireWire bus generation for which the command object shall be valid. If the failOnReset attribute has been set, the command will only be considered for execution during the bus generation specified by this function.

void ( *SetGeneration)(
    IOFireWireLibCommandRef self,
    UInt32 generation);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Set the user refCon value. This is the user defined value that will be passed in the refCon argument to the completion function.

void ( *SetRefCon)(
    IOFireWireLibCommandRef self,
    void *refCon);  

Discussion

Availability: (for interfaces obtained with ID)

Set command target address

void ( *SetTarget)(
    IOFireWireLibCommandRef self,
    const FWAddress* addr);  

Parameters

Discussion

Availability: (for interfaces obtained with ID)

Set values for 32-bit compare swap operation. Calling this function will make the command object perform 32-bit compare swap transactions on the bus. To perform 64-bit compare swap operations, use the SetValues64() call, below.

void ( *SetValues)(
    IOFireWireLibCompareSwapCommandRef self,
    UInt32 cmpVal,
    UInt32 newVal);  

Parameters

Discussion

Available in v2 and newer.

Set values for 64-bit compare swap operation. Calling this function will make the command object perform 64-bit compare swap transactions on the bus. To perform 32-bit compare swap operations, use the SetValues() call, above.

void ( *SetValues64)(
    IOFireWireLibCompareSwapCommandRef self,
    UInt64 cmpVal,
    UInt64 newVal);  

Parameters

Discussion

Available in v2 and newer.

IOReturn ( *Submit)(
    IOFireWireLibCommandRef self);  

Discussion

Description forthcoming

Set the command refCon value and callback handler, and submit the command to FireWire for execution.

IOReturn ( *SubmitWithRefconAndCallback)(
    IOFireWireLibCommandRef self,
    void *refCon,
    IOFireWireLibCommandCallback inCallback);  

Parameters

Return Value

An IOReturn result code indicating whether or not the command was successfully submitted

Discussion

Availability: (for interfaces obtained with ID)

Member Data

revision

version

UInt32 revision;  

Discussion

Interface revision.

UInt32 version;  

Discussion

Interface version.

Last Updated: 2009-10-15