docs: net: page_pool: document PP_FLAG_DMA_SYNC_DEV parameters
authorJakub Kicinski <kuba@kernel.org>
Wed, 2 Aug 2023 16:18:20 +0000 (09:18 -0700)
committerJakub Kicinski <kuba@kernel.org>
Thu, 3 Aug 2023 16:54:23 +0000 (09:54 -0700)
commite70380650a32e4ccb0bd8a2d7b54e1e4a35b39ba
tree389e259f4ab62d2b9100f26fecd3728bb6c237ba
parent3986892646de95b916f6bf1c22b35dd2a3b3715a
docs: net: page_pool: document PP_FLAG_DMA_SYNC_DEV parameters

Using PP_FLAG_DMA_SYNC_DEV is a bit confusing. It was perhaps
more obvious when it was introduced but the page pool use
has grown beyond XDP and beyond packet-per-page so now
making the heads and tails out of this feature is not
trivial.

Obviously making the API more user friendly would be
a better fix, but until someone steps up to do that
let's at least document what the parameters are.

Relevant discussion in the first Link.

Link: https://lore.kernel.org/all/20230731114427.0da1f73b@kernel.org/
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Michael Chan <michael.chan@broadcom.com>
Acked-by: Jesper Dangaard Brouer <hawk@kernel.org>
Reviewed-by: Somnath Kotur <somnath.kotur@broadcom.com>
Link: https://lore.kernel.org/r/20230802161821.3621985-2-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/networking/page_pool.rst