From: Geert Uytterhoeven Date: Thu, 4 Dec 2025 15:14:02 +0000 (+0100) Subject: Documentation: mailbox: mbox_chan_ops.flush() is optional X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=135739a2a92f9aa08702f01d7d585b34d0b95b16;p=thirdparty%2Fkernel%2Flinux.git Documentation: mailbox: mbox_chan_ops.flush() is optional 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 Signed-off-by: Jonathan Corbet Message-ID: <6a50a5d4f0d0da26e5cccf348550879e53792e6e.1764861174.git.geert+renesas@glider.be> --- diff --git a/Documentation/driver-api/mailbox.rst b/Documentation/driver-api/mailbox.rst index 0ed95009cc307..463dd032b96cd 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).