]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
lib/scatterlist: Remove leftover from sg_page_iter comment
authorGal Pressman <galpress@amazon.com>
Mon, 6 May 2019 15:02:56 +0000 (18:02 +0300)
committerJason Gunthorpe <jgg@mellanox.com>
Tue, 7 May 2019 15:47:47 +0000 (12:47 -0300)
Commit d901b2760dc6 ("lib/scatterlist: Provide a DMA page iterator") added
the sg DMA iterator but a leftover remained in the sg_page_iter
documentation as you cannot get the page dma address (only the page
itself), fix it.

Signed-off-by: Gal Pressman <galpress@amazon.com>
Reviewed-by: Mukesh Ojha <mojha@codeaurora.org>
Signed-off-by: Jason Gunthorpe <jgg@mellanox.com>
include/linux/scatterlist.h

index b4be960c7e5dbaec396180c8f870b588078d5e41..30a9a55c28ba1acd6a8130301587a4e347cea2ad 100644 (file)
@@ -340,11 +340,11 @@ int sg_alloc_table_chained(struct sg_table *table, int nents,
  * sg page iterator
  *
  * Iterates over sg entries page-by-page.  On each successful iteration, you
- * can call sg_page_iter_page(@piter) to get the current page and its dma
- * address. @piter->sg will point to the sg holding this page and
- * @piter->sg_pgoffset to the page's page offset within the sg. The iteration
- * will stop either when a maximum number of sg entries was reached or a
- * terminating sg (sg_last(sg) == true) was reached.
+ * can call sg_page_iter_page(@piter) to get the current page.
+ * @piter->sg will point to the sg holding this page and @piter->sg_pgoffset to
+ * the page's page offset within the sg. The iteration will stop either when a
+ * maximum number of sg entries was reached or a terminating sg
+ * (sg_last(sg) == true) was reached.
  */
 struct sg_page_iter {
        struct scatterlist      *sg;            /* sg holding the page */