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

IOFireWireLibIRMAllocationInterface

Declared In:

IOFireWireLib.h

Overview

Description forthcoming

Functions

allocateIsochResources: Use this interface to allocate isochronous resources
areIsochResourcesAllocated: Poll to see if IRM resources are still allocated
deallocateIsochResources: Deallocate previously allocated resources
GetRefCon: Get the current refcon
NotificationIsOn: Is notification on?
SetRefCon: Set a new refcon
setReleaseIRMResourcesOnFree: Set a new value for releaseIRMResourcesOnFree
TurnOffNotification: Force notification off.
TurnOnNotification: Try to turn on notifications

allocateIsochResources

Use this interface to allocate isochronous resources

IOReturn ( *allocateIsochResources)(
    IOFireWireLibIRMAllocationRef self,
    UInt8 isochChannel,
    UInt32 bandwidthUnits);

Parameters

self: The IRMAllocation interface to use.
isochChannel: The isoch channel to allocate.
bandwidthUnits: The bandwidth units to allocate.

Return Value

Returns true if allocation success

areIsochResourcesAllocated

Poll to see if IRM resources are still allocated

Boolean ( *areIsochResourcesAllocated)(
    IOFireWireLibIRMAllocationRef self,
    UInt8 *pAllocatedIsochChannel,
    UInt32 *pAllocatedBandwidthUnits);

Parameters

self: The IRMAllocation interface to use.
pAllocatedIsochChannel: If allocated, the channel
pAllocatedBandwidthUnits: If allocated, the amount of bandwidth

Return Value

Returns true if currently allocated, false otherwise

deallocateIsochResources

Deallocate previously allocated resources

IOReturn ( *deallocateIsochResources)(
    IOFireWireLibIRMAllocationRef self);

Parameters

self: The IRMAllocation interface to use.

Return Value

Returns true if deallocation success

GetRefCon

Get the current refcon

void* ( *GetRefCon)(
    IOFireWireLibIRMAllocationRef self);

Parameters

self: The IRMAllocation interface to use.

Return Value

Returns the current refcon value

NotificationIsOn

Is notification on?

Boolean ( *NotificationIsOn)(
    IOFireWireLibIRMAllocationRef self);

Parameters

self: The IRMAllocation interface to use.

Return Value

Returns true if notifications for this IRMAllocation are enabled

SetRefCon

Set a new refcon

void ( *SetRefCon)(
    IOFireWireLibIRMAllocationRef self,
    void *refCon);

Parameters

self: The IRMAllocation interface to use.
refCon: The new refcon value.

setReleaseIRMResourcesOnFree

Set a new value for releaseIRMResourcesOnFree

const void (*setReleaseIRMResourcesOnFree)( IOFireWireLibIRMAllocationRef self, Boolean doRelease);

Parameters

self: The IRMAllocation interface to use.
doRelease: The new value for releaseIRMResourcesOnFree.

TurnOffNotification

Force notification off.

void ( *TurnOffNotification)(
    IOFireWireLibIRMAllocationRef self);

Parameters

self: The IRMAllocation interface to use.

TurnOnNotification

Try to turn on notifications

Boolean ( *TurnOnNotification)(
    IOFireWireLibIRMAllocationRef self);

Parameters

self: The IRMAllocation interface to use.

Return Value

Returns true upon success

Last Updated: 2009-10-15