serial: document start_rx member at struct uart_ops
authorMauro Carvalho Chehab <mchehab@kernel.org>
Thu, 18 Aug 2022 13:38:58 +0000 (15:38 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 18 Aug 2022 14:40:31 +0000 (16:40 +0200)
Fix this doc build warning:
./include/linux/serial_core.h:397: warning: Function parameter or member 'start_rx' not described in 'uart_ops'

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/5d07ae2eec8fbad87e623160f9926b178bef2744.1660829433.git.mchehab@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/serial_core.h

index aef3145f2032969e671bdd88d54415603a9d8199..6e4f4765d209c2695c28ade792473362b862b3ca 100644 (file)
@@ -141,6 +141,14 @@ struct gpio_desc;
  *     Locking: none.
  *     Interrupts: caller dependent.
  *
+ * @start_rx: ``void ()(struct uart_port *port)``
+ *
+ *     Start receiving characters.
+ *
+ *     Locking: @port->lock taken.
+ *     Interrupts: locally disabled.
+ *     This call must not sleep
+ *
  * @stop_rx: ``void ()(struct uart_port *port)``
  *
  *     Stop receiving characters; the @port is in the process of being closed.