aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/tty
diff options
context:
space:
mode:
authorJiri Slaby <jslaby@suse.cz>2022-07-28 08:10:56 +0200
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2022-07-28 10:37:42 +0200
commit9e5f399f5c9f62e537735f2f8e42bd2f7c255c1f (patch)
tree66450d3f8f0973910c1959261b0eaab29543f7be /drivers/tty
parenttty: serial: serial_core, reformat kernel-doc for functions (diff)
downloadlinux-dev-9e5f399f5c9f62e537735f2f8e42bd2f7c255c1f.tar.xz
linux-dev-9e5f399f5c9f62e537735f2f8e42bd2f7c255c1f.zip
tty: serial: document uart_get_console()
This was the only function mentioned in the text, but was neither linked nor documented. So document and link it, so that hyperlinking works in the text. Signed-off-by: Jiri Slaby <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220728061056.20799-6-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/tty')
-rw-r--r--drivers/tty/serial/serial_core.c13
1 files changed, 9 insertions, 4 deletions
diff --git a/drivers/tty/serial/serial_core.c b/drivers/tty/serial/serial_core.c
index b2943da2d32c..339f4c421503 100644
--- a/drivers/tty/serial/serial_core.c
+++ b/drivers/tty/serial/serial_core.c
@@ -2092,10 +2092,15 @@ void uart_console_write(struct uart_port *port, const char *s,
}
EXPORT_SYMBOL_GPL(uart_console_write);
-/*
- * Check whether an invalid uart number has been specified, and
- * if so, search for the first available port that does have
- * console support.
+/**
+ * uart_get_console - get uart port for console
+ * @ports: ports to search in
+ * @nr: number of @ports
+ * @co: console to search for
+ * Returns: uart_port for the console @co
+ *
+ * Check whether an invalid uart number has been specified (as @co->index), and
+ * if so, search for the first available port that does have console support.
*/
struct uart_port * __init
uart_get_console(struct uart_port *ports, int nr, struct console *co)