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>
This commit is contained in:
Jiri Slaby
2022-07-28 08:10:56 +02:00
committed by Greg Kroah-Hartman
parent 987233b342
commit 9e5f399f5c
2 changed files with 10 additions and 5 deletions

View File

@ -76,7 +76,7 @@ Other functions
uart_add_one_port uart_remove_one_port uart_console_write uart_add_one_port uart_remove_one_port uart_console_write
uart_parse_earlycon uart_parse_options uart_set_options uart_parse_earlycon uart_parse_options uart_set_options
uart_get_lsr_info uart_handle_dcd_change uart_handle_cts_change uart_get_lsr_info uart_handle_dcd_change uart_handle_cts_change
uart_try_toggle_sysrq uart_try_toggle_sysrq uart_get_console
Other notes Other notes
----------- -----------

View File

@ -2092,10 +2092,15 @@ void uart_console_write(struct uart_port *port, const char *s,
} }
EXPORT_SYMBOL_GPL(uart_console_write); EXPORT_SYMBOL_GPL(uart_console_write);
/* /**
* Check whether an invalid uart number has been specified, and * uart_get_console - get uart port for console
* if so, search for the first available port that does have * @ports: ports to search in
* console support. * @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 struct uart_port * __init
uart_get_console(struct uart_port *ports, int nr, struct console *co) uart_get_console(struct uart_port *ports, int nr, struct console *co)