linux-dev/Documentation/serial/driver, branch master

docs: serial: convert docs to ReST and rename to *.rst

2019-04-25T09:37:42Z

The converted files are focused at the Kernel internal API, so, this is a good candidate for the kernel API set of books. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Greg Kroah-Hartman

serial: docs: Fix filename for serial reference implementation

2018-09-20T13:12:35Z

Currently documentation mentions a file but the filename has a typo in it, underscore instead of hyphen. This makes grep'ing for the file hard. Use correct filename for file amba-pl011.c Signed-off-by: Tobin C. Harding Signed-off-by: Greg Kroah-Hartman

serial: doc: Use port->state instead of info

2016-05-14T16:18:25Z

As of commit ebd2c8f6d2ec4012 ("serial: kill off uart_info"), the circular transmission buffer is part of struct uart_state instead of struct uart_info. Make it clear this structure is pointed to from struct uart_port. Change 'circ' to 'circ_buf' to match the structure name while we're at it. Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: Always refer to tty_port->mutex

2016-05-14T16:18:19Z

Stop referring to the mutex member of the tty_port struct as 'port->mutex', as 'port' is ambiguous, and usually refers to the uart_port struct in this document. Use 'tty_port->mutex' instead, following the single existing use. Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: .break_ctl() may sleep

2016-04-16T16:43:12Z

break_ctl() is not called from any sort of atomic context, so there is no problem with it sleeping. Reported-by: Peter Hurley Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: .(un)throttle() are serialized by the tty layer

2016-04-15T21:59:12Z

Document that .(un)throttle() are serialized with each other, and with termios modification by the tty layer. Reported-by: Peter Hurley Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: .(un)throttle() depends on hardware assisted flow control

2016-04-15T21:59:06Z

Document that .throttle() and .unthrottle() are relevant only if hardware assisted flow control is enabled. Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: Re-add paragraph documenting uart_console_write()

2016-04-15T21:59:01Z

Commit 834392a7d92677ff ("serial: doc: Un-document non-existing uart_write_console()") removed a paragraph about a helper function that seemed to never exist. Peter Hurley pointed out that the function does exist, but is called differently. Re-add the paragraph, with the function name corrected. Fixes: 834392a7d92677ff ("serial: doc: Un-document non-existing uart_write_console()") Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: Correct return type of mctrl_gpio_to_gpiod()

2016-03-31T06:58:39Z

Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

serial: doc: Grammar s/function are/functions are/

2016-03-31T06:58:35Z

Signed-off-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet