diff options
| author | Jakub Kicinski <kuba@kernel.org> | 2023-08-07 23:00:51 +0200 |
|---|---|---|
| committer | Jakub Kicinski <kuba@kernel.org> | 2023-08-09 01:09:10 +0200 |
| commit | 2c2b88748fd5028a7771a864d46b1b78fb436a07 (patch) | |
| tree | 7c86326693d0e3d393bccbc71790131d043711ba /Documentation/networking/page_pool.rst | |
| parent | devlink: Remove unused devlink_dpipe_table_resource_set() declaration (diff) | |
| download | linux-2c2b88748fd5028a7771a864d46b1b78fb436a07.tar.xz linux-2c2b88748fd5028a7771a864d46b1b78fb436a07.zip | |
docs: net: page_pool: de-duplicate the intro comment
In commit 82e896d992fa ("docs: net: page_pool: use kdoc to avoid
duplicating the information") I shied away from using the DOC:
comments when moving to kdoc for documenting page_pool API,
because I wasn't sure how familiar people are with it.
Turns out there is already a DOC: comment for the intro, which
is the same in both places, modulo what looks like minor rewording.
Use the version from Documentation/ but keep the contents with
the code.
Acked-by: Jesper Dangaard Brouer <hawk@kernel.org>
Link: https://lore.kernel.org/r/20230807210051.1014580-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'Documentation/networking/page_pool.rst')
| -rw-r--r-- | Documentation/networking/page_pool.rst | 18 |
1 files changed, 2 insertions, 16 deletions
diff --git a/Documentation/networking/page_pool.rst b/Documentation/networking/page_pool.rst index 68b82cea13e4..215ebc92752c 100644 --- a/Documentation/networking/page_pool.rst +++ b/Documentation/networking/page_pool.rst @@ -4,22 +4,8 @@ Page Pool API ============= -The page_pool allocator is optimized for the XDP mode that uses one frame -per-page, but it can fallback on the regular page allocator APIs. - -Basic use involves replacing alloc_pages() calls with the -page_pool_alloc_pages() call. Drivers should use page_pool_dev_alloc_pages() -replacing dev_alloc_pages(). - -API keeps track of in-flight pages, in order to let API user know -when it is safe to free a page_pool object. Thus, API users -must call page_pool_put_page() to free the page, or attach -the page to a page_pool-aware objects like skbs marked with -skb_mark_for_recycle(). - -API user must call page_pool_put_page() once on a page, as it -will either recycle the page, or in case of refcnt > 1, it will -release the DMA mapping and in-flight state accounting. +.. kernel-doc:: include/net/page_pool/helpers.h + :doc: page_pool allocator Architecture overview ===================== |