litmus-rt-ext-res.git/Documentation/serial/driver, branch EXT-RES

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

2016-05-14T16:18:25+00:00

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:19+00:00

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:12+00:00

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:12+00:00

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:06+00:00

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:01+00:00

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:39+00:00

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

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

2016-03-31T06:58:35+00:00

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

serial: doc: Spelling s/divsor/divisor/

2016-03-31T06:58:29+00:00

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

serial: doc: .break_ctl() is called with port->mutex() held

2016-03-31T06:58:25+00:00

Note that mutex_lock() should not be called with interrupts disabled.

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