withSpecification
Creates and initializes an DMA command in one operation.
Declaration
static OSPtr<IODMACommand> withSpecification(SegmentFunction outSegFunc, UInt8 numAddressBits, UInt64 maxSegmentSize, MappingOptions mappingOptions, UInt64 maxTransferSize, UInt32 alignment, IOMapper *mapper, void *refCon);Parameters
- outSegFunc:
SegmentFunction to call to output one physical segment. A set of nine commonly required segment functions are provided.
- numAddressBits:
Number of bits that the hardware uses on its internal address bus. Typically 32 but may be more on modern hardware. A 0 implies no-restriction other than that implied by the output segment function.
- maxSegmentSize:
Maximum allowable size for one segment. If 0 is passed the maximum segment size is unlimited.
- mappingOptions:
The type of mapping that is required to translate an IOMemoryDescriptor into the desired number of bits. For instance if your hardware only supports 32 bits but must run on machines with > 4G of RAM some mapping will be required. Number of bits will be specified in numAddressBits, see below.This parameter can take 3 values:- kNonCoherent - used for non-coherent hardware transfers, Mapped - Validate that all I/O bus generated addresses are within the number of addressing bits specified, Bypassed indicates that bypassed addressing is required, this is used when the hardware transferes are into coherent memory but no mapping is required. See also prepare() for failure cases.
- maxTransferSize:
Maximum size of an entire transfer. Defaults to 0 indicating no maximum.
- alignment:
Alignment restriction, in bytes, on I/O bus addresses. Defaults to single byte alignment.
- mapper:
For mapping types kMapped & kBypassed mapper is used to define the hardware that will perform the mapping, defaults to the system mapper.
- refCon:
A reference constant for the object.
Return Value
Returns a new memory cursor if successfully created and initialized, 0 otherwise.
Discussion
Factory function to create and initialize an IODMACommand in one operation.