serial: doc: Always refer to tty_port->mutex

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 <geert+renesas@glider.be>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Geert Uytterhoeven 2016-05-11 13:56:04 +02:00 committed by Jonathan Corbet
parent 30955e71fc
commit 95f981f2e3
1 changed files with 4 additions and 4 deletions

View File

@ -57,7 +57,7 @@ locking.
The port_sem semaphore is used to protect against ports being added/
removed or reconfigured at inappropriate times. Since v2.6.27, this
semaphore has been the 'mutex' member of the tty_port struct, and
commonly referred to as the port mutex (or port->mutex).
commonly referred to as the port mutex.
uart_ops
@ -186,7 +186,7 @@ hardware.
should be terminated when another call is made with a zero
ctl.
Locking: caller holds port->mutex
Locking: caller holds tty_port->mutex
startup(port)
Grab any interrupt resources and initialise any low level driver
@ -262,14 +262,14 @@ hardware.
Other flags may be used (eg, xon/xoff characters) if your
hardware supports hardware "soft" flow control.
Locking: caller holds port->mutex
Locking: caller holds tty_port->mutex
Interrupts: caller dependent.
This call must not sleep
set_ldisc(port,termios)
Notifier for discipline change. See Documentation/serial/tty.txt.
Locking: caller holds port->mutex
Locking: caller holds tty_port->mutex
pm(port,state,oldstate)
Perform any power management related activities on the specified