Mac Dev Center Mac OS X Reference Library Drivers, Kernel, & Hardware: User-Space Device Access I/O Kit Framework Reference

IOFireWirePhysicalAddressSpaceInterface

Declared In:

IOFireWireLib.h

Overview

IOFireWireLib physical address space object. ( interface name: IOFireWirePhysicalAddressSpaceInterface )

Discussion

Represents and provides management functions for a physical address space (hardware-backed) in the local machine.
Physical address space objects can be created using IOFireWireDeviceInterface.

Functions

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
GetPhysicalAddress: Returns the physical address of the beginning of this address space
GetPhysicalSegment: Returns the physical segment containing the address at a specified offset from the beginning of this address space
GetPhysicalSegments: Returns the list of physical memory ranges this address space occupies on the local machine.

GetBuffer

Get a pointer to the backing store for this address space

void* ( *GetBuffer)( 
    IOFireWireLibPhysicalAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

A pointer to the backing store of this address space.

GetBufferSize

Get the size in bytes of this address space.

const UInt32 (*GetBufferSize)( IOFireWireLibPhysicalAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

Size of the pseudo address space in bytes.

GetFWAddress

Get the FireWire address of this address space

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

Parameters

self: The address space interface to use.

GetPhysicalAddress

Returns the physical address of the beginning of this address space

IOPhysicalAddress ( *GetPhysicalAddress)( 
    IOFireWireLibPhysicalAddressSpaceRef self);

Parameters

self: The address space interface to use.

Return Value

The physical address of the start of this address space

GetPhysicalSegment

Returns the physical segment containing the address at a specified offset from the beginning of this address space

IOPhysicalAddress ( *GetPhysicalSegment)( 
    IOFireWireLibPhysicalAddressSpaceRef self, 
    IOByteCount offset, 
    IOByteCount *length);

Parameters

self: The address space interface to use.
offset: Offset from beginning of address space
length: Pointer to a value which upon completion will contain the length of the segment returned by the function.

Return Value

The address of the physical segment containing the address at the specified offset of the address space

GetPhysicalSegments

Returns the list of physical memory ranges this address space occupies on the local machine.

void ( *GetPhysicalSegments)( 
    IOFireWireLibPhysicalAddressSpaceRef self, 
    UInt32 *ioSegmentCount, 
    IOByteCount outSegments[], 
    IOPhysicalAddress outAddresses[]);

Parameters

self: The address space interface to use.
ioSegmentCount: Pass in a pointer to the number of list entries in outSegments and outAddress. Upon completion, this will contain the actual number of segments returned in outSegments and outAddress
outSegments: A pointer to an array to hold the function results. Upon completion, this will contain the lengths of the physical segments this address space occupies on the local machine
outAddresses: A pointer to an array to hold the function results. Upon completion, this will contain the addresses of the physical segments this address space occupies on the local machine. If NULL, ioSegmentCount will contain the number of physical segments in the address space.

Member Data

revision
version

revision

UInt32 revision;

Discussion

Interface revision.

version

UInt32 version;

Discussion

Interface version.

Did this document help you?

Shop the Apple Online Store (1-800-MY-APPLE), visit an Apple Retail Store, or find a reseller.

Last Updated: 2009-10-15