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

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

include/linux/scatterlist.h

+5 −5
Original line number Diff line number Diff line
@@ -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 */

CRA Git | Maintained and supported by SUSTech CRA and CCSE