Commit d2c4ada1 authored by Gal Pressman's avatar Gal Pressman Committed by Jason Gunthorpe

lib/scatterlist: Remove leftover from sg_page_iter comment

Commit d901b276 ("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: default avatarGal Pressman <galpress@amazon.com>
Reviewed-by: default avatarMukesh Ojha <mojha@codeaurora.org>
Signed-off-by: default avatarJason Gunthorpe <jgg@mellanox.com>
parent f23afd75
...@@ -340,11 +340,11 @@ int sg_alloc_table_chained(struct sg_table *table, int nents, ...@@ -340,11 +340,11 @@ int sg_alloc_table_chained(struct sg_table *table, int nents,
* sg page iterator * sg page iterator
* *
* Iterates over sg entries page-by-page. On each successful iteration, you * 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 * can call sg_page_iter_page(@piter) to get the current page.
* address. @piter->sg will point to the sg holding this page and * @piter->sg will point to the sg holding this page and @piter->sg_pgoffset to
* @piter->sg_pgoffset to the page's page offset within the sg. The iteration * the page's page offset within the sg. The iteration will stop either when a
* will stop either when a maximum number of sg entries was reached or a * maximum number of sg entries was reached or a terminating sg
* terminating sg (sg_last(sg) == true) was reached. * (sg_last(sg) == true) was reached.
*/ */
struct sg_page_iter { struct sg_page_iter {
struct scatterlist *sg; /* sg holding the page */ struct scatterlist *sg; /* sg holding the page */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment