71 lines · plain
1.. SPDX-License-Identifier: GPL-2.02 3========4TTY Port5========6 7.. contents:: :local:8 9The TTY drivers are advised to use struct tty_port helpers as much as possible.10If the drivers implement :c:member:`tty_port.ops.activate()` and11:c:member:`tty_port.ops.shutdown()`, they can use tty_port_open(),12tty_port_close(), and tty_port_hangup() in respective13:c:member:`tty_struct.ops` hooks.14 15The reference and details are contained in the `TTY Port Reference`_ and `TTY16Port Operations Reference`_ sections at the bottom.17 18TTY Port Functions19==================20 21Init & Destroy22--------------23 24.. kernel-doc:: drivers/tty/tty_port.c25 :identifiers: tty_port_init tty_port_destroy26 tty_port_get tty_port_put27 28Open/Close/Hangup Helpers29-------------------------30 31.. kernel-doc:: drivers/tty/tty_port.c32 :identifiers: tty_port_install tty_port_open tty_port_block_til_ready33 tty_port_close tty_port_close_start tty_port_close_end tty_port_hangup34 tty_port_shutdown35 36TTY Refcounting37---------------38 39.. kernel-doc:: drivers/tty/tty_port.c40 :identifiers: tty_port_tty_get tty_port_tty_set41 42TTY Helpers43-----------44 45.. kernel-doc:: drivers/tty/tty_port.c46 :identifiers: tty_port_tty_hangup tty_port_tty_wakeup47 48 49Modem Signals50-------------51 52.. kernel-doc:: drivers/tty/tty_port.c53 :identifiers: tty_port_carrier_raised tty_port_raise_dtr_rts54 tty_port_lower_dtr_rts55 56----57 58TTY Port Reference59==================60 61.. kernel-doc:: include/linux/tty_port.h62 :identifiers: tty_port63 64----65 66TTY Port Operations Reference67=============================68 69.. kernel-doc:: include/linux/tty_port.h70 :identifiers: tty_port_operations71