[PATCH net] doc: net: napi: Update documentation for napi_schedule_irqoff

[PATCH net] doc: net: napi: Update documentation for napi_schedule_irqoff

[Sean Anderson]

Since commit 8380c81d5c4f ("net: Treat __napi_schedule_irqoff() as
__napi_schedule() on PREEMPT_RT"), napi_schedule_irqoff will do the
right thing if IRQs are threaded. Therefore, there is no need to use
IRQF_NO_THREAD.

Signed-off-by: Sean Anderson <sean.anderson@linux.dev>
---
https://lore.kernel.org/netdev/20240913150954.2287196-1-sean.anderson@linux.dev/

 Documentation/networking/napi.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/napi.rst b/Documentation/networking/napi.rst
index 7bf7b95c4f7a..dfa5d549be9c 100644
--- a/Documentation/networking/napi.rst
+++ b/Documentation/networking/napi.rst
@@ -144,9 +144,8 @@ IRQ should only be unmasked after a successful call to napi_complete_done():
 
 napi_schedule_irqoff() is a variant of napi_schedule() which takes advantage
 of guarantees given by being invoked in IRQ context (no need to
-mask interrupts). Note that PREEMPT_RT forces all interrupts
-to be threaded so the interrupt may need to be marked ``IRQF_NO_THREAD``
-to avoid issues on real-time kernel configurations.
+mask interrupts). napi_schedule_irqoff() will fall back to napi_schedule() if
+IRQs are threaded (such as if ``PREEMPT_RT`` is enabled).
 
 Instance to queue mapping
 -------------------------
-- 
2.35.1.1320.gc452695387.dirty

Re: [PATCH net] doc: net: napi: Update documentation for napi_schedule_irqoff

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 687 bytes --]

On Mon, Sep 30, 2024 at 11:39:54AM -0400, Sean Anderson wrote:
>  napi_schedule_irqoff() is a variant of napi_schedule() which takes advantage
>  of guarantees given by being invoked in IRQ context (no need to
> -mask interrupts). Note that PREEMPT_RT forces all interrupts
> -to be threaded so the interrupt may need to be marked ``IRQF_NO_THREAD``
> -to avoid issues on real-time kernel configurations.
> +mask interrupts). napi_schedule_irqoff() will fall back to napi_schedule() if
> +IRQs are threaded (such as if ``PREEMPT_RT`` is enabled).

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH net] doc: net: napi: Update documentation for napi_schedule_irqoff

[Sebastian Andrzej Siewior]

On 2024-09-30 11:39:54 [-0400], Sean Anderson wrote:
> Since commit 8380c81d5c4f ("net: Treat __napi_schedule_irqoff() as
> __napi_schedule() on PREEMPT_RT"), napi_schedule_irqoff will do the
> right thing if IRQs are threaded. Therefore, there is no need to use
> IRQF_NO_THREAD.
> 
> Signed-off-by: Sean Anderson <sean.anderson@linux.dev>

Reviewed-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>

Thanks for docs update.

Sebastian

Re: [PATCH net] doc: net: napi: Update documentation for napi_schedule_irqoff

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by Paolo Abeni <pabeni@redhat.com>:

On Mon, 30 Sep 2024 11:39:54 -0400 you wrote:
> Since commit 8380c81d5c4f ("net: Treat __napi_schedule_irqoff() as
> __napi_schedule() on PREEMPT_RT"), napi_schedule_irqoff will do the
> right thing if IRQs are threaded. Therefore, there is no need to use
> IRQF_NO_THREAD.
> 
> Signed-off-by: Sean Anderson <sean.anderson@linux.dev>
> 
> [...]

Here is the summary with links:
  - [net] doc: net: napi: Update documentation for napi_schedule_irqoff
    https://git.kernel.org/netdev/net/c/b63ad06ddddf

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