tty: add throttle/unthrottle helpers

[linux-2.6-omap-h63xx.git] / include / linux / tty_driver.h

diff --git a/include/linux/tty_driver.h b/include/linux/tty_driver.h
index f80d73b690f65d1c03d5bd0c0c4844c0cc7a7e4e..59f1c0bd8f9c6f8734a1320185a3eb28a9b29990 100644 (file)
--- a/include/linux/tty_driver.h
+++ b/include/linux/tty_driver.h
@@ -100,6 +100,8 @@
  *     This routine notifies the tty 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 tty.
+ *
+ *     Optional: Always invoke via tty_throttle();
  * 
  * void (*unthrottle)(struct tty_struct * tty);
  *
@@ -107,6 +109,8 @@
  *     that characters can now be sent to the tty without fear of
  *     overrunning the input buffers of the line disciplines.
  * 
+ *     Optional: Always invoke via tty_unthrottle();
+ *
  * void (*stop)(struct tty_struct *tty);
  *
  *     This routine notifies the tty driver that it should stop