Mac Developer Library

Developer

IONaturalMemoryCursor Class Reference

Options
Deployment Target:

On This Page

IONaturalMemoryCursor

An IOMemoryCursor subclass that outputs a vector of PhysicalSegments in the natural byte orientation for the CPU.

The IONaturalMemoryCursor would be used when it is too difficult to safely describe a SegmentFunction that is more appropriate for your hardware. This cursor just outputs an array of PhysicalSegments.

  • Generates a CPU natural physical scatter/gather list given a memory descriptor.

    Declaration

    virtual UInt32 getPhysicalSegments( IOMemoryDescriptor *descriptor, IOByteCount fromPosition, PhysicalSegment *segments, UInt32 maxSegments, UInt32 inMaxTransferSize = 0, IOByteCount *transferSize = 0)

    Parameters

    descriptor

    IOMemoryDescriptor that describes the data associated with an I/O request.

    fromPosition

    Starting location of the I/O within a memory descriptor.

    segments

    Pointer to an array of IOMemoryCursor::PhysicalSegments for the output physical scatter/gather list.

    maxSegments

    Maximum number of segments that can be written to segments array.

    inMaxTransferSize

    Maximum transfer size is limited to that many bytes, otherwise it defaults to the maximum transfer size specified when the memory cursor was initialized.

    transferSize

    Pointer to an IOByteCount variable that can contain the total size of the transfer being described. Defaults to 0 indicating that no transfer size need be returned.

    Return Value

    If the descriptor is exhausted of memory, a zero is returned, otherwise the number of segments that were filled in is returned.

    Discussion

    Generates a list of physical segments from the given memory descriptor, relative to the current position of the descriptor. Wraps IOMemoryCursor::genPhysicalSegments.

  • Primary initializer for the IONaturalMemoryCursor class.

    Declaration

    virtual bool initWithSpecification( IOPhysicalLength maxSegmentSize, IOPhysicalLength maxTransferSize, IOPhysicalLength alignment = 1);

    Parameters

    maxSegmentSize

    Maximum allowable size for one segment. Defaults to 0.

    maxTransferSize

    Maximum size of an entire transfer. Defaults to 0 indicating no maximum.

    alignment

    Alignment restrictions on output physical addresses. Not currently implemented. Defaults to single byte alignment.

    Return Value

    Returns true if the inherited classes and this instance initialize successfully.

  • Outputs the given segment into the output segments array in natural byte order.

    Declaration

    static void outputSegment( PhysicalSegment segment, void *segments, UInt32 segmentIndex);

    Parameters

    segment

    The physical address and length that is next to be output.

    segments

    Base of the output vector of DMA address length pairs.

    segmentIndex

    Index to output 'segment' in the 'segments' array.

  • Creates and initializes an IONaturalMemoryCursor in one operation.

    Declaration

    static IONaturalMemoryCursor * withSpecification( IOPhysicalLength maxSegmentSize, IOPhysicalLength maxTransferSize, IOPhysicalLength alignment = 1);

    Parameters

    maxSegmentSize

    Maximum allowable size for one segment. Defaults to 0.

    maxTransferSize

    Maximum size of an entire transfer. Defaults to 0 indicating no maximum.

    alignment

    Alignment restrictions on output physical addresses. Not currently implemented. Defaults to single byte alignment.

    Return Value

    Returns a new memory cursor if successfully created and initialized, 0 otherwise.

    Discussion

    Factory function to create and initialize an IONaturalMemoryCursor in one operation. For more information, see IONaturalMemoryCursor::initWithSpecification.

Constants

  • Declaration

    #define naturalOutputSegment IONaturalMemoryCursor::outputSegment

    Constants

    • naturalOutputSegment

      Backward compatibility define for the old global function definition. See IONaturalMemoryCursor::outputSegment.