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

IOFireWirePseudoAddressSpaceInterface

Declared In:

IOFireWireLib.h

Overview

Represents and provides management functions for a pseudo address space (software-backed) in the local machine.

Pseudo address space objects can be created using IOFireWireDeviceInterface.

Functions

ClientCommandIsComplete: Notifies the address space that a packet notification handler has completed.
GetBuffer: Gets a pointer to the backing store for this address space.
GetBufferSize: Gets the size in bytes of this address space.
GetFWAddress: Gets the FireWire address of this address space.
GetRefCon: Returns the user refCon value for this address space.
NotificationIsOn: Determines if notification is on.
SetReadHandler: Sets the callback that should be called to handle read accesses to the corresponding address space.
SetSkippedPacketHandler: Sets the callback that should be called when incoming packets are dropped by the address space.
SetWriteHandler: Sets the callback that should be called to handle write accesses to the corresponding address space.
TurnOffNotification: Forces packet notification off.
TurnOnNotification: Tries to turn on packet notifications for this address space.

ClientCommandIsComplete

Notifies the address space that a packet notification handler has completed.

void ( *ClientCommandIsComplete)(
    IOFireWireLibPseudoAddressSpaceRef self,
    FWClientCommandID commandID,
    IOReturn status);

Parameters

self: The address space interface to use.
commandID: The ID of the packet notification being completed. This is the same ID that was passed when a packet notification handler is called.
status: Returns the completion status of the packet handler.

Discussion

Packet notifications are received one at a time, in order. This function must be called after a packet handler has completed its work.

GetBuffer

Gets a pointer to the backing store for this address space.

void* ( *GetBuffer)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

Returns a pointer to the backing store of this pseudo address space. Returns nil if none.

GetBufferSize

Gets the size in bytes of this address space.

const UInt32 (*GetBufferSize)(IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

Returns the size of the pseudo address space in bytes. Returns 0 for none.

GetFWAddress

Gets the FireWire address of this address space.

void ( *GetFWAddress)(
    IOFireWireLibPseudoAddressSpaceRef self,
    FWAddress *outAddr);

Parameters

self: Returns the pseudo address interface to use.

GetRefCon

Returns the user refCon value for this address space.

void* ( *GetRefCon)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

Returns the size of the pseudo address space in bytes. Returns 0 for none.

NotificationIsOn

Determines if notification is on.

Boolean ( *NotificationIsOn)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

Returns true if packet notifications for this address space are active.

SetReadHandler

Sets the callback that should be called to handle read accesses to the corresponding address space.

const IOFireWirePseudoAddressSpaceReadHandler (*SetReadHandler)( IOFireWireLibPseudoAddressSpaceRef self, IOFireWirePseudoAddressSpaceReadHandler inReader);

Parameters

self: The address space interface to use.
inReader: The callback to set.

Return Value

Returns the callback that was previously set or nil for none.

SetSkippedPacketHandler

Sets the callback that should be called when incoming packets are dropped by the address space.

const IOFireWirePseudoAddressSpaceSkippedPacketHandler (*SetSkippedPacketHandler)( IOFireWireLibPseudoAddressSpaceRef self, IOFireWirePseudoAddressSpaceSkippedPacketHandler inHandler);

Parameters

self: The address space interface to use.
inHandler: The callback to set.

Return Value

Returns the callback that was previously set or nil for none.

SetWriteHandler

Sets the callback that should be called to handle write accesses to the corresponding address space.

const IOFireWirePseudoAddressSpaceWriteHandler (*SetWriteHandler)( IOFireWireLibPseudoAddressSpaceRef self, IOFireWirePseudoAddressSpaceWriteHandler inWriter);

Parameters

self: The address space interface to use.
inWriter: The callback to set.

Return Value

Returns the callback that was previously set or nil for none.

TurnOffNotification

Forces packet notification off.

void ( *TurnOffNotification)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The pseudo address interface to use.

TurnOnNotification

Tries to turn on packet notifications for this address space.

Boolean ( *TurnOnNotification)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

Returns true upon success.

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