serial: doc: .(un)throttle() depends on hardware assisted flow control
authorGeert Uytterhoeven <geert+renesas@glider.be>
Thu, 14 Apr 2016 09:08:09 +0000 (11:08 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 15 Apr 2016 21:59:06 +0000 (15:59 -0600)
Document that .throttle() and .unthrottle() are relevant only if
hardware assisted flow control is enabled.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/serial/driver

index 03369d076ca20a9872d6e1fa18b0729e712aa166..03b703cf93182216357beb7d845ff458b4a3af86 100644 (file)
@@ -135,6 +135,7 @@ hardware.
        Notify the serial driver that input buffers for the line discipline are
        close to full, and it should somehow signal that no more characters
        should be sent to the serial port.
+       This will be called only if hardware assisted flow control is enabled.
 
        Locking: none.
 
@@ -142,6 +143,7 @@ hardware.
        Notify the serial driver that characters can now be sent to the serial
        port without fear of overrunning the input buffers of the line
        disciplines.
+       This will be called only if hardware assisted flow control is enabled.
 
        Locking: none.