Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2025-01-09 06:33:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

tty: move tty_ldisc docs to new Documentation/tty/

Browse Source 
Create a new directory in Documentation/ called tty. We will create more
documents in it in the next patches, so let's have this one in the very
same place.

Change title accordingly and all the headers. This is the way what other
documents look like in this directory in the next patches. So make this
unified.

And add a TOC.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-20-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Jiri Slaby 2021-11-26 09:16:07 +01:00 committed by Greg Kroah-Hartman
parent 3be491d74a
commit 7e6c0b22f4
2 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/driver-api/serial/index.rst
View File

@ -9,7 +9,6 @@ Support for Serial devices
driver
tty
Serial drivers
==============

23
Documentation/driver-api/serial/tty.rst → Documentation/tty/tty_ldisc.rst
View File

@ -1,13 +1,10 @@
=================
The Lockronomicon
=================
.. SPDX-License-Identifier: GPL-2.0
Your guide to the ancient and twisted locking policies of the tty layer and
the warped logic behind them. Beware all ye who read on.
===================
TTY Line Discipline
===================
Line Discipline
---------------
.. contents:: :local:
Line disciplines are registered with tty_register_ldisc() passing the
discipline number and the ldisc structure. At the point of registration the
@ -33,25 +30,25 @@ counts the number of threads of execution within an ldisc method (plus those
about to enter and exit although this detail matters not).
Line Discipline Methods
-----------------------
=======================
.. kernel-doc:: include/linux/tty_ldisc.h
:identifiers: tty_ldisc_ops
Driver Access
^^^^^^^^^^^^^
=============
Line discipline methods can call the methods of the underlying hardware driver.
These are documented as a part of struct tty_operations.
Flags
^^^^^
TTY Flags
=========
Line discipline methods have access to :c:member:`tty_struct.flags` field. See
:doc:`tty_struct`.
Locking
^^^^^^^
=======
Callers to the line discipline functions from the tty layer are required to
take line discipline locks. The same is true of calls from the driver side