]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: mailbox: mbox_chan_ops.flush() is optional
authorGeert Uytterhoeven <geert+renesas@glider.be>
Thu, 4 Dec 2025 15:14:02 +0000 (16:14 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 22 Dec 2025 22:30:31 +0000 (15:30 -0700)
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <6a50a5d4f0d0da26e5cccf348550879e53792e6e.1764861174.git.geert+renesas@glider.be>

Documentation/driver-api/mailbox.rst

index 0ed95009cc307a41e1cfb5e05987fbe82b33bd1b..463dd032b96cd45d7cb9545b19c67a5cd2dfdbe4 100644 (file)
@@ -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).