[PATCH v2 net-next] net: page_pool: Add page_pool_put_page_bulk() to page_pool.rst

[PATCH v2 net-next] net: page_pool: Add page_pool_put_page_bulk() to page_pool.rst

[Lorenzo Bianconi]

Introduce page_pool_put_page_bulk() entry into the API section of
page_pool.rst

Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
Signed-off-by: Lorenzo Bianconi <lorenzo@kernel.org>
---
Changes since v1:
- addressed Ilias's comments
---
 Documentation/networking/page_pool.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/networking/page_pool.rst b/Documentation/networking/page_pool.rst
index 43088ddf95e4..a147591ce203 100644
--- a/Documentation/networking/page_pool.rst
+++ b/Documentation/networking/page_pool.rst
@@ -97,6 +97,14 @@ a page will cause no race conditions is enough.
 
 * page_pool_get_dma_dir(): Retrieve the stored DMA direction.
 
+* page_pool_put_page_bulk(): Tries to refill a number of pages into the
+  ptr_ring cache holding ptr_ring producer lock. If the ptr_ring is full,
+  page_pool_put_page_bulk() will release leftover pages to the page allocator.
+  page_pool_put_page_bulk() is suitable to be run inside the driver NAPI tx
+  completion loop for the XDP_REDIRECT use case.
+  Please note the caller must not use data area after running
+  page_pool_put_page_bulk(), as this function overwrites it.
+
 Coding examples
 ===============
 
-- 
2.28.0

Re: [PATCH v2 net-next] net: page_pool: Add page_pool_put_page_bulk() to page_pool.rst

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (refs/heads/master):

On Mon, 23 Nov 2020 16:45:46 +0100 you wrote:
> Introduce page_pool_put_page_bulk() entry into the API section of
> page_pool.rst
> 
> Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
> Signed-off-by: Lorenzo Bianconi <lorenzo@kernel.org>
> ---
> Changes since v1:
> - addressed Ilias's comments
> 
> [...]

Here is the summary with links:
  - [v2,net-next] net: page_pool: Add page_pool_put_page_bulk() to page_pool.rst
    https://git.kernel.org/netdev/net-next/c/2f1cce214b23

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html