IOFireWireCompareSwapCommandInterface

Declared In:

IOFireWireLib.h

Overview

Functions

DidLock: Determines if the last lock operation was successful.
Locked: Gets the 32-bit value returned on the last compare swap operation.
Locked64: Gets the 64-bit value returned on the last compare swap operation.
SetFlags: Sets flags governing this command's execution.
SetValues: Sets values for 32-bit compare swap operation.
SetValues64: Sets values for 64-bit compare swap operation.

DidLock

Determines if the last lock operation was successful.

Boolean ( *DidLock)(
    IOFireWireLibCompareSwapCommandRef self);

Parameters

self: The command object interface of interest.

Return Value

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

Availability: This function is available in v2 and later.

Locked

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

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

Parameters

self: The command object interface of interest.
oldValue: A pointer to contain the value returned by the target of this command on the last compare swap operation.

Return Value

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

Availability: This function is available in v2 and later.

Locked64

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

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

Parameters

self: The command object interface of interest.
oldValue: A pointer to contain the value returned by the target of this command on the last compare swap operation.

Return Value

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

Availability: This function is available in v2 and later.

SetFlags

Sets flags governing this command's execution.

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

Parameters

self: The command object interface of interest.
inFlags: A UInt32 with bits set corresponding to the flags that should be set.

Discussion

Same as SetFlags() above.

Availability: This function is available in v2 and later.

SetValues

Sets values for 32-bit compare swap operation.

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

Parameters

self: The command object interface of interest.
cmpVal: The value expected at the address targeted by this command object.
newVal: The value to be written at the address targeted by this command object.

Discussion

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.

Availability: This function is available in v2 and later.

SetValues64

Sets values for 64-bit compare swap operation.

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

Parameters

self: The command object interface of interest.
cmpVal: The value expected at the address targeted by this command object.
newVal: The value to be written at the address targeted by this command object.

Discussion

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.

Availability: This function is available in v2 and later.

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-03-11