diff options
author | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2010-05-26 17:44:21 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2010-05-27 12:12:53 -0400 |
commit | b02de871617be353c941edce5f7c22bb18499b4e (patch) | |
tree | 5d4d9cc22118ae3f4ecd134d1ce31ae3e95d33e0 | |
parent | 7cdcc8e4762f0e4a94cead6a3b57b5eaa01bd5da (diff) |
Documentation: update scatterlist struct description in DMA-API-HOWTO
Now we have <asm-generic/scatterlist.h>. Architectures should use it
instead of inventing the own scatterlist struct. Let's update the
description.
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r-- | Documentation/DMA-API-HOWTO.txt | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/Documentation/DMA-API-HOWTO.txt b/Documentation/DMA-API-HOWTO.txt index a38ddadd208e..c3ab456422f3 100644 --- a/Documentation/DMA-API-HOWTO.txt +++ b/Documentation/DMA-API-HOWTO.txt | |||
@@ -703,19 +703,10 @@ to "Closing". | |||
703 | 703 | ||
704 | 1) Struct scatterlist requirements. | 704 | 1) Struct scatterlist requirements. |
705 | 705 | ||
706 | Struct scatterlist must contain, at a minimum, the following | 706 | Don't invent the architecture specific struct scatterlist; just use |
707 | members: | 707 | <asm-generic/scatterlist.h>. You need to enable |
708 | 708 | CONFIG_NEED_SG_DMA_LENGTH if the architecture supports IOMMUs | |
709 | struct page *page; | 709 | (including software IOMMU). |
710 | unsigned int offset; | ||
711 | unsigned int length; | ||
712 | |||
713 | The base address is specified by a "page+offset" pair. | ||
714 | |||
715 | Previous versions of struct scatterlist contained a "void *address" | ||
716 | field that was sometimes used instead of page+offset. As of Linux | ||
717 | 2.5., page+offset is always used, and the "address" field has been | ||
718 | deleted. | ||
719 | 710 | ||
720 | 2) More to come... | 711 | 2) More to come... |
721 | 712 | ||