]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/IOKit/IODMACommand.h
xnu-1699.22.73.tar.gz
[apple/xnu.git] / iokit / IOKit / IODMACommand.h
index a2a2852f336e3cf577f39713e6d86bbd4c6f67e6..c8bd8b37a333dca36ebbcb8ef45065ea9c4f9218 100644 (file)
@@ -258,7 +258,7 @@ public:
 
 /*! @function setMemoryDescriptor
     @abstract Sets and resets the DMACommand's current memory descriptor
-    @discussion The DMA command will configure itself based on the information that it finds in the memory descriptor.  It looks for things like the direction of the memory descriptor and whether the current memory descriptor is already mapped into some IOMMU.  As a programmer convenience it can also prepare the memory descriptor immediately.  See prepare().  Note the IODMACommand is designed to used multiple times with a succession of memory descriptors, making the pooling of commands possible.  It is an error though to attempt to reset a currently prepared() DMA command.  Warning: This routine may block so never try to autoprepare an IODMACommand while in a gated context, i.e. one of the WorkLoops action call outs.
+    @discussion The DMA command will configure itself based on the information that it finds in the memory descriptor.  It looks for things like the direction of the memory descriptor and whether the current memory descriptor is already mapped into some IOMMU.  As a programmer convenience it can also prepare the DMA command immediately.  See prepare().  Note the IODMACommand is designed to used multiple times with a succession of memory descriptors, making the pooling of commands possible.  It is an error though to attempt to reset a currently prepared() DMA command.  Warning: This routine may block so never try to autoprepare an IODMACommand while in a gated context, i.e. one of the WorkLoops action call outs.
     @param mem A pointer to the current I/Os memory descriptor.
     @param autoPrepare An optional boolean variable that will call the prepare() function automatically after the memory descriptor is processed. Defaults to true.
     @result Returns kIOReturnSuccess, kIOReturnBusy if currently prepared, kIOReturnNoSpace if the length(mem) >= Maximum Transfer Size or the error codes returned by prepare() (qv).