diff options
author | Gioh Kim <gioh.kim@lge.com> | 2014-05-20 19:09:35 -0400 |
---|---|---|
committer | Bjorn Helgaas <bhelgaas@google.com> | 2014-05-26 19:28:28 -0400 |
commit | 2af9da8638a139303b3cd535b458a1b2c80dd4f3 (patch) | |
tree | a6480c71dd2a80363aa0b1226ab3628374c37678 | |
parent | 34c815fbdc1257e823726f8c6bcd9255d495058d (diff) |
DMA-API: Update dma_pool_create ()and dma_pool_alloc() descriptions
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>
-rw-r--r-- | Documentation/DMA-API-HOWTO.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/DMA-API-HOWTO.txt b/Documentation/DMA-API-HOWTO.txt index b22ceff35609..dcbbe3602d78 100644 --- a/Documentation/DMA-API-HOWTO.txt +++ b/Documentation/DMA-API-HOWTO.txt | |||
@@ -429,13 +429,13 @@ Create a dma_pool like this: | |||
429 | 429 | ||
430 | struct dma_pool *pool; | 430 | struct dma_pool *pool; |
431 | 431 | ||
432 | pool = dma_pool_create(name, dev, size, align, alloc); | 432 | pool = dma_pool_create(name, dev, size, align, boundary); |
433 | 433 | ||
434 | The "name" is for diagnostics (like a kmem_cache name); dev and size | 434 | The "name" is for diagnostics (like a kmem_cache name); dev and size |
435 | are as above. The device's hardware alignment requirement for this | 435 | are as above. The device's hardware alignment requirement for this |
436 | type of data is "align" (which is expressed in bytes, and must be a | 436 | type of data is "align" (which is expressed in bytes, and must be a |
437 | power of two). If your device has no boundary crossing restrictions, | 437 | power of two). If your device has no boundary crossing restrictions, |
438 | pass 0 for alloc; passing 4096 says memory allocated from this pool | 438 | pass 0 for boundary; passing 4096 says memory allocated from this pool |
439 | must not cross 4KByte boundaries (but at that time it may be better to | 439 | must not cross 4KByte boundaries (but at that time it may be better to |
440 | use dma_alloc_coherent() directly instead). | 440 | use dma_alloc_coherent() directly instead). |
441 | 441 | ||
@@ -443,8 +443,8 @@ Allocate memory from a DMA pool like this: | |||
443 | 443 | ||
444 | cpu_addr = dma_pool_alloc(pool, flags, &dma_handle); | 444 | cpu_addr = dma_pool_alloc(pool, flags, &dma_handle); |
445 | 445 | ||
446 | flags are SLAB_KERNEL if blocking is permitted (not in_interrupt nor | 446 | flags are GFP_KERNEL if blocking is permitted (not in_interrupt nor |
447 | holding SMP locks), SLAB_ATOMIC otherwise. Like dma_alloc_coherent(), | 447 | holding SMP locks), GFP_ATOMIC otherwise. Like dma_alloc_coherent(), |
448 | this returns two values, cpu_addr and dma_handle. | 448 | this returns two values, cpu_addr and dma_handle. |
449 | 449 | ||
450 | Free memory that was allocated from a dma_pool like this: | 450 | Free memory that was allocated from a dma_pool like this: |