Commit b96cd8b0 authored by Jiri Slaby's avatar Jiri Slaby Committed by Greg Kroah-Hartman
Browse files

Documentation: move tty to driver-api 



Based on discussion starting as 87mthw2o93.fsf@meer.lwn.net, let's move
the tty documentation to driver-api. It's more appropriate there.

Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarJiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ce522ba9

Documentation/driver-api/index.rst

+1 −0
Original line number Original line Diff line number Diff line
@@ -101,6 +101,7 @@ available subsections can be seen below. 
   surface_aggregator/index

   surface_aggregator/index

   switchtec

   switchtec

   sync_file

   sync_file

   tty

   vfio-mediated-device

   vfio-mediated-device

   vfio

   vfio

   vfio-pci-device-specific-driver-acceptance

   vfio-pci-device-specific-driver-acceptance

Documentation/driver-api/serial/driver.rst

+1 −1
Original line number Original line Diff line number Diff line
@@ -311,7 +311,7 @@ hardware. 
	This call must not sleep

	This call must not sleep





  set_ldisc(port,termios)

  set_ldisc(port,termios)

	Notifier for discipline change. See Documentation/tty/tty_ldisc.rst.

	Notifier for discipline change. See ../tty/tty_ldisc.rst.





	Locking: caller holds tty_port->mutex

	Locking: caller holds tty_port->mutex

Documentation/tty/index.rst→Documentation/driver-api/tty/index.rst

+4 −5
Original line number Original line Diff line number Diff line
@@ -43,11 +43,10 @@ Writing TTY Driver 
==================

==================





Before one starts writing a TTY driver, they must consider

Before one starts writing a TTY driver, they must consider

:doc:`Serial <../driver-api/serial/driver>` and :doc:`USB Serial

:doc:`Serial <../serial/driver>` and :doc:`USB Serial <../../usb/usb-serial>`

<../usb/usb-serial>` layers

layers first. Drivers for serial devices can often use one of these specific

first. Drivers for serial devices can often use one of these specific layers to

layers to implement a serial driver. Only special devices should be handled

implement a serial driver. Only special devices should be handled directly by

directly by the TTY Layer. If you are about to write such a driver, read on.

the TTY Layer. If you are about to write such a driver, read on.





A *typical* sequence a TTY driver performs is as follows:

A *typical* sequence a TTY driver performs is as follows: