Mac Dev Center Right arrow

Mac OS X Reference Library Right arrow

Drivers, Kernel, & Hardware: User-Space Device Access Right arrow

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: Notify the address space that a packet notification handler has completed.
GetBuffer: Get a pointer to the backing store for this address space
GetBufferSize: Get the size in bytes of this address space.
GetFWAddress: Get the FireWire address of this address space
GetRefCon: Returns the user refCon value for this address space.
NotificationIsOn: Is notification on?
SetReadHandler: Set the callback that should be called to handle read accesses to the corresponding address space
SetSkippedPacketHandler: Set the callback that should be called when incoming packets are dropped by the address space.
SetWriteHandler: Set the callback that should be called to handle write accesses to the corresponding address space
TurnOffNotification: Force packet notification off.
TurnOnNotification: Try to turn on packet notifications for this address space.

ClientCommandIsComplete

Notify 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: 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

Get a pointer to the backing store for this address space

void* ( *GetBuffer)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

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

GetBufferSize

Get the size in bytes of this address space.

const UInt32 (*GetBufferSize)(IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

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

GetFWAddress

Get the FireWire address of this address space

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

Parameters

self: 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

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

NotificationIsOn

Is notification 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

Set 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

Set 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

Set 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

Force packet notification off.

void ( *TurnOffNotification)(
    IOFireWireLibPseudoAddressSpaceRef self);

Parameters

self: The pseudo address interface to use.

TurnOnNotification

Try 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

Member Data

revision
version

revision

UInt32 revision;

Discussion

Interface revision

version

UInt32 version;

Discussion

Interface version

Last Updated: 2009-10-15