0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 ========
0004 TTY Port
0005 ========
0006
0007 .. contents:: :local:
0008
0009 The TTY drivers are advised to use struct tty_port helpers as much as possible.
0010 If the drivers implement :c:member:`tty_port.ops.activate()` and
0011 :c:member:`tty_port.ops.shutdown()`, they can use tty_port_open(),
0012 tty_port_close(), and tty_port_hangup() in respective
0013 :c:member:`tty_struct.ops` hooks.
0014
0015 The reference and details are contained in the `TTY Port Reference`_ and `TTY
0016 Port Operations Reference`_ sections at the bottom.
0017
0018 TTY Port Functions
0019 ==================
0020
0021 Init & Destroy
0022 --------------
0023
0024 .. kernel-doc:: drivers/tty/tty_port.c
0025 :identifiers: tty_port_init tty_port_destroy
0026 tty_port_get tty_port_put
0027
0028 Open/Close/Hangup Helpers
0029 -------------------------
0030
0031 .. kernel-doc:: drivers/tty/tty_port.c
0032 :identifiers: tty_port_install tty_port_open tty_port_block_til_ready
0033 tty_port_close tty_port_close_start tty_port_close_end tty_port_hangup
0034 tty_port_shutdown
0035
0036 TTY Refcounting
0037 ---------------
0038
0039 .. kernel-doc:: drivers/tty/tty_port.c
0040 :identifiers: tty_port_tty_get tty_port_tty_set
0041
0042 TTY Helpers
0043 -----------
0044
0045 .. kernel-doc:: drivers/tty/tty_port.c
0046 :identifiers: tty_port_tty_hangup tty_port_tty_wakeup
0047
0048
0049 Modem Signals
0050 -------------
0051
0052 .. kernel-doc:: drivers/tty/tty_port.c
0053 :identifiers: tty_port_carrier_raised tty_port_raise_dtr_rts
0054 tty_port_lower_dtr_rts
0055
0056 ----
0057
0058 TTY Port Reference
0059 ==================
0060
0061 .. kernel-doc:: include/linux/tty_port.h
0062 :identifiers: tty_port
0063
0064 ----
0065
0066 TTY Port Operations Reference
0067 =============================
0068
0069 .. kernel-doc:: include/linux/tty_port.h
0070 :identifiers: tty_port_operations
