* [PATCH] Documentation: mailbox: mbox_chan_ops.flush() is optional
@ 2025-12-04 15:14 Geert Uytterhoeven
2025-12-22 22:25 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Geert Uytterhoeven @ 2025-12-04 15:14 UTC (permalink / raw)
To: Jonathan Corbet, Thierry Reding, Jassi Brar
Cc: linux-doc, linux-renesas-soc, linux-kernel, Geert Uytterhoeven
When the optional .flush() method was added to the mbox_chan structure,
the documentation was not updated.
Fixes: a8803d7421cc2be2 ("mailbox: Support blocking transfers in atomic context")
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
Documentation/driver-api/mailbox.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/driver-api/mailbox.rst b/Documentation/driver-api/mailbox.rst
index 0ed95009cc307a41..463dd032b96cd45d 100644
--- a/Documentation/driver-api/mailbox.rst
+++ b/Documentation/driver-api/mailbox.rst
@@ -27,7 +27,7 @@ Controller Driver (See include/linux/mailbox_controller.h)
Allocate mbox_controller and the array of mbox_chan.
-Populate mbox_chan_ops, except peek_data() all are mandatory.
+Populate mbox_chan_ops, except flush() and peek_data() all are mandatory.
The controller driver might know a message has been consumed
by the remote by getting an IRQ or polling some hardware flag
or it can never know (the client knows by way of the protocol).
--
2.43.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: mailbox: mbox_chan_ops.flush() is optional
2025-12-04 15:14 [PATCH] Documentation: mailbox: mbox_chan_ops.flush() is optional Geert Uytterhoeven
@ 2025-12-22 22:25 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2025-12-22 22:25 UTC (permalink / raw)
To: Geert Uytterhoeven, Thierry Reding, Jassi Brar
Cc: linux-doc, linux-renesas-soc, linux-kernel, Geert Uytterhoeven
Geert Uytterhoeven <geert+renesas@glider.be> writes:
> When the optional .flush() method was added to the mbox_chan structure,
> the documentation was not updated.
>
> Fixes: a8803d7421cc2be2 ("mailbox: Support blocking transfers in atomic context")
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> Documentation/driver-api/mailbox.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/mailbox.rst b/Documentation/driver-api/mailbox.rst
> index 0ed95009cc307a41..463dd032b96cd45d 100644
> --- a/Documentation/driver-api/mailbox.rst
> +++ b/Documentation/driver-api/mailbox.rst
> @@ -27,7 +27,7 @@ Controller Driver (See include/linux/mailbox_controller.h)
>
>
> Allocate mbox_controller and the array of mbox_chan.
> -Populate mbox_chan_ops, except peek_data() all are mandatory.
> +Populate mbox_chan_ops, except flush() and peek_data() all are mandatory.
> The controller driver might know a message has been consumed
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-12-22 22:25 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-12-04 15:14 [PATCH] Documentation: mailbox: mbox_chan_ops.flush() is optional Geert Uytterhoeven
2025-12-22 22:25 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®