diff options
| author | Jiri Slaby <jslaby@suse.cz> | 2022-04-11 13:01:38 +0200 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2022-04-14 18:24:23 +0200 |
| commit | b96cd8b05ead8939b972192c4f4ac2fc2dffceb7 (patch) | |
| tree | b554644a530ad0fffc2201a759c2ffaf951244bc /Documentation/tty/tty_port.rst | |
| parent | ce522ba9ef7e2d9fb22a39eb3371c0c64e2a433e (diff) | |
| download | linux-b96cd8b05ead8939b972192c4f4ac2fc2dffceb7.tar.gz | |
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: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/tty/tty_port.rst')
| -rw-r--r-- | Documentation/tty/tty_port.rst | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/Documentation/tty/tty_port.rst b/Documentation/tty/tty_port.rst deleted file mode 100644 index 5cb90e954fcf..000000000000 --- a/Documentation/tty/tty_port.rst +++ /dev/null @@ -1,70 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -======== -TTY Port -======== - -.. contents:: :local: - -The TTY drivers are advised to use struct tty_port helpers as much as possible. -If the drivers implement :c:member:`tty_port.ops.activate()` and -:c:member:`tty_port.ops.shutdown()`, they can use tty_port_open(), -tty_port_close(), and tty_port_hangup() in respective -:c:member:`tty_struct.ops` hooks. - -The reference and details are contained in the `TTY Port Reference`_ and `TTY -Port Operations Reference`_ sections at the bottom. - -TTY Port Functions -================== - -Init & Destroy --------------- - -.. kernel-doc:: drivers/tty/tty_port.c - :identifiers: tty_port_init tty_port_destroy - tty_port_get tty_port_put - -Open/Close/Hangup Helpers -------------------------- - -.. kernel-doc:: drivers/tty/tty_port.c - :identifiers: tty_port_install tty_port_open tty_port_block_til_ready - tty_port_close tty_port_close_start tty_port_close_end tty_port_hangup - tty_port_shutdown - -TTY Refcounting ---------------- - -.. kernel-doc:: drivers/tty/tty_port.c - :identifiers: tty_port_tty_get tty_port_tty_set - -TTY Helpers ------------ - -.. kernel-doc:: drivers/tty/tty_port.c - :identifiers: tty_port_tty_hangup tty_port_tty_wakeup - - -Modem Signals -------------- - -.. kernel-doc:: drivers/tty/tty_port.c - :identifiers: tty_port_carrier_raised tty_port_raise_dtr_rts - tty_port_lower_dtr_rts - ----- - -TTY Port Reference -================== - -.. kernel-doc:: include/linux/tty_port.h - :identifiers: tty_port - ----- - -TTY Port Operations Reference -============================= - -.. kernel-doc:: include/linux/tty_port.h - :identifiers: tty_port_operations |