serial: doc: Always refer to tty_port->mutex
authorGeert Uytterhoeven <geert+renesas@glider.be>
Wed, 11 May 2016 11:56:04 +0000 (13:56 +0200)
committerJonathan Corbet <corbet@lwn.net>
Sat, 14 May 2016 16:18:19 +0000 (10:18 -0600)
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>
Documentation/serial/driver

index 39701515832b70b06390b393beaa9abadeba4e04..90889c785809cde1490bbf3c5ec290ae84245501 100644 (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