Skip to contentSkip to conversation

termios: document callback more clearly

PATCH New Alan Cox 1 participant 1 message Nov 19, 2007 Documentation

lore
Share & tools
lore

Alan Cox

author
#0 lore raw

PATCH 1/1 termios: document callback more clearly

Documentation/tty.txt +8 -0
diff -u --new-file --recursive --exclude-from /usr/src/exclude linux.vanilla-2.6.24-rc2-mm1/Documentation/tty.txt linux-2.6.24-rc2-mm1/Documentation/tty.txt
@@ -132,6 +132,14 @@
 			tty->termios. Previous settings should be passed in
 			the "old" argument.
 
+			The API is defined such that the driver should return
+			the actual modes selected. This means that the
+			driver function is responsible for modifying any
+			bits in the request it cannot fulfill to indicate
+			the actual modes being used. A device with no
+			hardware capability for change (eg a USB dongle or
+			virtual port) can provide NULL for this method.
+
 throttle()		Notify 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