scatterlist: add generic wrappers for iterating over sgtable objects
authorMarek Szyprowski <m.szyprowski@samsung.com>
Wed, 13 May 2020 13:32:09 +0000 (15:32 +0200)
committerChristoph Hellwig <hch@lst.de>
Wed, 13 May 2020 13:48:17 +0000 (15:48 +0200)
commit709d6d73c756107fb8a292a9f957d630097425fa
treef90f9d9d24c4bad6b37fa4e7a87f3b42b6f343e5
parentd9d200bcebc1f6e56f0178cbb8db9953e8cc9a11
scatterlist: add generic wrappers for iterating over sgtable objects

struct sg_table is a common structure used for describing a memory
buffer. It consists of a scatterlist with memory pages and DMA addresses
(sgl entry), as well as the number of scatterlist entries: CPU pages
(orig_nents entry) and DMA mapped pages (nents entry).

It turned out that it was a common mistake to misuse nents and orig_nents
entries, calling the scatterlist iterating functions with a wrong number
of the entries.

To avoid such issues, lets introduce a common wrappers operating directly
on the struct sg_table objects, which take care of the proper use of
the nents and orig_nents entries.

While touching this, lets clarify some ambiguities in the comments for
the existing for_each helpers.

Signed-off-by: Marek Szyprowski <m.szyprowski@samsung.com>
Reviewed-by: Robin Murphy <robin.murphy@arm.com>
Signed-off-by: Christoph Hellwig <hch@lst.de>
include/linux/scatterlist.h