serial: doc: Document .throttle()
authorGeert Uytterhoeven <geert+renesas@glider.be>
Mon, 14 Mar 2016 15:16:11 +0000 (16:16 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 31 Mar 2016 06:58:13 +0000 (00:58 -0600)
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/serial/driver

index 61d520dea4c6e13acee78cd34f2e5297700d9585..50f3d94ed50b341e15c52cf295c123ddef397bdd 100644 (file)
@@ -126,6 +126,13 @@ hardware.
        Interrupts: locally disabled.
        This call must not sleep
 
+  throttle(port)
+       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.
+
+       Locking: none.
+
   send_xchar(port,ch)
        Transmit a high priority character, even if the port is stopped.
        This is used to implement XON/XOFF flow control and tcflow().  If