DMA-API: Update dma_pool_create ()and dma_pool_alloc() descriptions
authorGioh Kim <gioh.kim@lge.com>
Tue, 20 May 2014 23:09:35 +0000 (17:09 -0600)
committerBjorn Helgaas <bhelgaas@google.com>
Mon, 26 May 2014 23:28:28 +0000 (17:28 -0600)
Use "boundary" to be more descriptive than "alloc" in the dma_pool_create()
documentation.

Replace "SLAB_KERNEL" and "SLAB_ATOMIC" with the correct "GFP_KERNEL" and
"GFP_ATOMIC."

[bhelgaas: changelog]
Signed-off-by: Gioh Kim <gioh.kim@lge.com>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Documentation/DMA-API-HOWTO.txt

index b22ceff356094105006b4913651b13f9bff0f3f8..dcbbe3602d78a9f0864500c3d106feffb06f00a1 100644 (file)
@@ -429,13 +429,13 @@ Create a dma_pool like this:
 
        struct dma_pool *pool;
 
-       pool = dma_pool_create(name, dev, size, align, alloc);
+       pool = dma_pool_create(name, dev, size, align, boundary);
 
 The "name" is for diagnostics (like a kmem_cache name); dev and size
 are as above.  The device's hardware alignment requirement for this
 type of data is "align" (which is expressed in bytes, and must be a
 power of two).  If your device has no boundary crossing restrictions,
-pass 0 for alloc; passing 4096 says memory allocated from this pool
+pass 0 for boundary; passing 4096 says memory allocated from this pool
 must not cross 4KByte boundaries (but at that time it may be better to
 use dma_alloc_coherent() directly instead).
 
@@ -443,8 +443,8 @@ Allocate memory from a DMA pool like this:
 
        cpu_addr = dma_pool_alloc(pool, flags, &dma_handle);
 
-flags are SLAB_KERNEL if blocking is permitted (not in_interrupt nor
-holding SMP locks), SLAB_ATOMIC otherwise.  Like dma_alloc_coherent(),
+flags are GFP_KERNEL if blocking is permitted (not in_interrupt nor
+holding SMP locks), GFP_ATOMIC otherwise.  Like dma_alloc_coherent(),
 this returns two values, cpu_addr and dma_handle.
 
 Free memory that was allocated from a dma_pool like this: