Documentation/driver-api/mailbox.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
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
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
© 2016 - 2026 Red Hat, Inc.