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

IOFireWirePCRSpace

Inherits from:	IOFWPseudoAddressSpace
Declared In:	IOFireWirePCRSpace.h

Overview

object to multiplex users of the PCR plug registers

Functions

allocateInputPlug: allocates an input plug.
allocateOutputPlug: allocates an output plug.
clearAllP2PConnections
freeInputPlug: deallocates an input plug.
freeOutputPlug: deallocates an output plug.
getPCRAddressSpace: returns the IOFireWirePCRSpace object for the given FireWire bus
init: initializes the IOFireWirePCRSpace object
readInputMasterPlug: returns the current value of the input master plug.
readInputPlug: returns the current value of an input plug.
readOutputMasterPlug: returns the current value of the output master plug.
readOutputPlug: returns the current value of an output plug.
setAVCTargetSpacePointer
updateInputMasterPlug: updates the value of the master input plug (simulating a lock transaction).
updateInputPlug: updates the value of an input plug (simulating a lock transaction).
updateOutputMasterPlug: updates the value of the master output plug (simulating a lock transaction).
updateOutputPlug: updates the value of an output plug (simulating a lock transaction).

allocateInputPlug

allocates an input plug.

public

virtual IOReturn allocateInputPlug(
    void *refcon,
    IOFireWirePCRCallback func,
    UInt32 &plug);

Parameters

refcon: arbitrary value passed back as first argument of callback.
func: callback function when a successful lock transaction to the plug has been performed
plug: set to the plug number if a plug is successfully allocated

allocateOutputPlug

allocates an output plug.

public

virtual IOReturn allocateOutputPlug(
    void *refcon,
    IOFireWirePCRCallback func,
    UInt32 &plug);

Parameters

refcon: arbitrary value passed back as first argument of callback.
func: callback function when a successful lock transaction to the plug has been performed
plug: set to the plug number if a plug is successfully allocated

clearAllP2PConnections

public

virtual void clearAllP2PConnections(
    void);

freeInputPlug

deallocates an input plug.

public

virtual void freeInputPlug(
    UInt32 plug);

Parameters

plug: value returned by allocateInputPlug.

freeOutputPlug

deallocates an output plug.

public

virtual void freeOutputPlug(
    UInt32 plug);

Parameters

plug: value returned by allocateOutputPlug.

getPCRAddressSpace

returns the IOFireWirePCRSpace object for the given FireWire bus

public

static IOFireWirePCRSpace *getPCRAddressSpace(
    IOFireWireBus *bus);

Parameters

bus: The FireWire bus

init

initializes the IOFireWirePCRSpace object

public

virtual bool init(
    IOFireWireBus *bus);

readInputMasterPlug

returns the current value of the input master plug.

public

virtual UInt32 readInputMasterPlug();

readInputPlug

returns the current value of an input plug.

public

virtual UInt32 readInputPlug(
    UInt32 plug);

Parameters

plug: value returned by allocateInputPlug.

readOutputMasterPlug

returns the current value of the output master plug.

public

virtual UInt32 readOutputMasterPlug();

readOutputPlug

returns the current value of an output plug.

public

virtual UInt32 readOutputPlug(
    UInt32 plug);

Parameters

plug: value returned by allocateOutputPlug.

setAVCTargetSpacePointer

public

virtual void setAVCTargetSpacePointer(
    IOFireWireAVCTargetSpace *pAVCTargetSpace);

updateInputMasterPlug

updates the value of the master input plug (simulating a lock transaction).

public

virtual IOReturn updateInputMasterPlug(
    UInt32 oldVal,
    UInt32 newVal);

Parameters

oldVal: value returned by readInputMasterPlug.
newVal: new value to store in plug if it's current value is oldVal.

updateInputPlug

updates the value of an input plug (simulating a lock transaction).

public

virtual IOReturn updateInputPlug(
    UInt32 plug,
    UInt32 oldVal,
    UInt32 newVal);

Parameters

plug: value returned by allocateInputPlug.
oldVal: value returned by readInputPlug.
newVal: new value to store in plug if it's current value is oldVal.

updateOutputMasterPlug

updates the value of the master output plug (simulating a lock transaction).

public

virtual IOReturn updateOutputMasterPlug(
    UInt32 oldVal,
    UInt32 newVal);

Parameters

oldVal: value returned by readOutputMasterPlug.
newVal: new value to store in plug if it's current value is oldVal.

updateOutputPlug

updates the value of an output plug (simulating a lock transaction).

public

virtual IOReturn updateOutputPlug(
    UInt32 plug,
    UInt32 oldVal,
    UInt32 newVal);

Parameters

plug: value returned by allocateOutputPlug.
oldVal: value returned by readOutputPlug.
newVal: new value to store in plug if it's current value is oldVal.

Structs and Unions

ExpansionData

protected

struct ExpansionData {
};

Discussion

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

Member Data

reserved

protected

ExpansionData *reserved;

Discussion

Reserved for future use. (Internal use only)

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