IOFWPhysicalAddressSpace

Inherits from
IOFWAddressSpace
Availability
Available in OS X v10.0 and later.
Declared in
IOFWPhysicalAddressSpace.h

Overview

Tasks

Miscellaneous

Instance Methods

checkMemoryInRange

Validates the IOMemoryDescriptor, which is used to initialize the PhysicalAddressSpace.

IOReturn checkMemoryInRange( IOMemoryDescriptor *memory );
Parameters
memory

Points to a valid IOMemoryDescriptor.

Return Value

returns kIOReturnSuccess on success

complete

complete the IODMACommand used by this PhysicalAddressSpace.

inline IOReturn complete( void ) ;
Parameters
none.
Return Value

returns kIOReturnSuccess on success

doRead

A method for processing an address space read request

virtual UInt32 doRead( UInt16 nodeID, IOFWSpeed &speed, FWAddress addr, UInt32 len, IOMemoryDescriptor **buf, IOByteCount *offset, IOFWRequestRefCon refcon);
Parameters
nodeID

FireWire Read from nodeID.

speed

at this 'speed'.

addr

with FireWire address 'addr'.

len

read 'len' bytes from nodeID.

buf

points to a memory descriptor containing the packet data.

offset

start from this 'offset' in 'buf'.

refcon

Can be queried for extra info about the request.

Return Value

UIn32 returns kFWResponseComplete on success

doWrite

A method for processing an address space write request

virtual UInt32 doWrite( UInt16 nodeID, IOFWSpeed &speed, FWAddress addr, UInt32 len, const void *buf, IOFWRequestRefCon refcon);
Parameters
nodeID

FireWire Write to nodeID.

speed

at this 'speed'.

addr

with FireWire address 'addr'.

len

write 'len' bytes to nodeID.

buf

obtain bytes from location given by 'buf'.

reqrefcon

Can be queried for extra info about the request.

Return Value

UIn32 returns kFWResponseComplete on success

getDMACommand

Get the DMACommand from this PhysicalAddressSpace.

inline IODMACommand * getDMACommand( void ) ;
Parameters
none.
Return Value

return previously assigned IODMACommand, null if not initialized

getLength

Get the length of the memory backed by PhysicalAddressSpace.

UInt64 getLength( void );
Parameters
none.
Return Value

returns the length

getMemoryDescriptor

Gets the memory descriptor, which is associated to this PhysicalAddressSpace.

IOMemoryDescriptor * getMemoryDescriptor( void );
Parameters
none.
Return Value

returns the IOMemoryDescriptor

getSegments

Returns the scatter gather list of memory segments from the IODMACommand used in this PhysicalAddressSpace.

inline IOReturn getSegments( UInt64 *offset, FWSegment *fw_segments, UInt32 *num_segments ) ;
Parameters
offset

input/output parameter, defines the starting and ending offset in the memory descriptor, relative to any offset passed to the prepare() method. FWSegment Points to an array of memory segments. num_segments Size of the FWSegment array.

Return Value

returns kIOReturnSuccess on success

init

Initialize physical address space.

virtual bool init( IOFireWireBus *bus );
Parameters
bus

Points to IOFireWireBus object.

Return Value

returns true if success, else false

initWithDesc

Initialize physical address space with IOMemoryDescriptor.

virtual bool initWithDesc( IOFireWireBus *bus, IOMemoryDescriptor *mem);
Parameters
bus

Points to IOFireWireBus object.

mem

Points to IOMemoryDescriptor.

Return Value

returns true if success, else false

initWithDMACommand

Initialize physical address space with IODMACommand.

virtual bool initWithDMACommand( IOFireWireBus *control, IODMACommand *command );
Parameters
bus

Points to IOFireWireBus object.

command

Points to IODMACommand.

Return Value

returns true if success, else false

isPrepared

Inspects whether the IODMACommand was prepared in this PhysicalAddressSpace.

inline bool isPrepared( void ) ;
Parameters
none.
Return Value

returns true if prepared, else false

prepare

Prepare the IODMACommand used by this PhysicalAddressSpace.

inline IOReturn prepare( void ) ;
Parameters
none.
Return Value

returns kIOReturnSuccess on success

setDMACommand

Set the DMACommand for this PhysicalAddressSpace.

inline void setDMACommand( IODMACommand *dma_command ) ;
Parameters
dma_command

Points to IODMACommand object.

Return Value

none

setMemoryDescriptor

Sets the memory descriptor, which will be associated to this PhysicalAddressSpace.

IOReturn setMemoryDescriptor( IOMemoryDescriptor *descriptor );
Parameters
none.
Return Value

returns the IOMemoryDescriptor

synchronize

synchronize the IODMACommand used by this PhysicalAddressSpace.

inline IOReturn synchronize( IOOptionBits options ) ;
Parameters
none.
Return Value

returns kIOReturnSuccess on success