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

IOFireWireCompareSwapCommandInterface_v3

Declared In:

IOFireWireLib.h

Overview

Use the links in the table of contents to the left to access the documentation.

Functions

DidLock: Was the last lock operation successful?
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.
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.

DidLock

Was the last lock operation 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.

Discussion

Available in v2 and newer.

Locked

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

Discussion

Available in v2 and newer.

Locked64

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

Discussion

Available in v2 and newer.

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

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

Available in v2 and newer.

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.

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

Available in v2 and newer.

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