Mac Developer Library

Developer

IOFWPhysicalAddressSpace Class Reference

Options
Deployment Target:

On This Page
Language:

IOFWPhysicalAddressSpace

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable

Objective-C

@import Kernel;

Availability


Available in OS X v10.0 and later.
  • Validates the IOMemoryDescriptor, which is used to initialize the PhysicalAddressSpace.

    Declaration

    C++

    IOReturn checkMemoryInRange( IOMemoryDescriptor *memory );

    Parameters

    memory

    Points to a valid IOMemoryDescriptor.

    Return Value

    returns kIOReturnSuccess on success

  • complete the IODMACommand used by this PhysicalAddressSpace.

    Declaration

    C++

    inline IOReturn complete( none. ) ;

    Parameters

    none.

    Return Value

    returns kIOReturnSuccess on success

  • A method for processing an address space read request

    Declaration

    C++

    virtual UInt32 doRead( UInt16nodeID, IOFWSpeed &speed, FWAddressaddr, UInt32len, IOMemoryDescriptor **buf, IOByteCount *offset, IOFWRequestRefConrefcon);

    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

  • A method for processing an address space write request

    Declaration

    C++

    virtual UInt32 doWrite( UInt16nodeID, IOFWSpeed &speed, FWAddressaddr, UInt32len, const void *buf, IOFWRequestRefConreqrefcon);

    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

  • Get the DMACommand from this PhysicalAddressSpace.

    Declaration

    C++

    inline IODMACommand * getDMACommand( none. ) ;

    Parameters

    none.

    Return Value

    return previously assigned IODMACommand, null if not initialized

  • Get the length of the memory backed by PhysicalAddressSpace.

    Declaration

    C++

    UInt64 getLength( none. );

    Parameters

    none.

    Return Value

    returns the length

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

    Declaration

    C++

    IOMemoryDescriptor * getMemoryDescriptor( none. );

    Parameters

    none.

    Return Value

    returns the IOMemoryDescriptor

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

    Declaration

    C++

    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

  • Initialize physical address space.

    Declaration

    C++

    virtual bool init( IOFireWireBus *bus );

    Parameters

    bus

    Points to IOFireWireBus object.

    Return Value

    returns true if success, else false

  • Initialize physical address space with IOMemoryDescriptor.

    Declaration

    C++

    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

  • Initialize physical address space with IODMACommand.

    Declaration

    C++

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

    Parameters

    bus

    Points to IOFireWireBus object.

    command

    Points to IODMACommand.

    Return Value

    returns true if success, else false

  • Inspects whether the IODMACommand was prepared in this PhysicalAddressSpace.

    Declaration

    C++

    inline bool isPrepared( none. ) ;

    Parameters

    none.

    Return Value

    returns true if prepared, else false

  • Prepare the IODMACommand used by this PhysicalAddressSpace.

    Declaration

    C++

    inline IOReturn prepare( none. ) ;

    Parameters

    none.

    Return Value

    returns kIOReturnSuccess on success

  • Set the DMACommand for this PhysicalAddressSpace.

    Declaration

    C++

    inline void setDMACommand( IODMACommand *dma_command ) ;

    Parameters

    dma_command

    Points to IODMACommand object.

    Return Value

    none

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

    Declaration

    C++

    IOReturn setMemoryDescriptor( IOMemoryDescriptor *none. );

    Parameters

    none.

    Return Value

    returns the IOMemoryDescriptor

  • synchronize the IODMACommand used by this PhysicalAddressSpace.

    Declaration

    C++

    inline IOReturn synchronize( IOOptionBitsnone. ) ;

    Parameters

    none.

    Return Value

    returns kIOReturnSuccess on success