Documentation/driver-api/tty/tty_struct.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ==========
   4 TTY Struct
   5 ==========
   6
   7 .. contents:: :local:
   8
   9 struct tty_struct is allocated by the TTY layer upon the first open of the TTY
  10 device and released after the last close. The TTY layer passes this structure
  11 to most of struct tty_operation's hooks. Members of tty_struct are documented
  12 in `TTY Struct Reference`_ at the bottom.
  13
  14 Initialization
  15 ==============
  16
  17 .. kernel-doc:: drivers/tty/tty_io.c
  18    :identifiers: tty_init_termios
  19
  20 Name
  21 ====
  22
  23 .. kernel-doc:: drivers/tty/tty_io.c
  24    :identifiers: tty_name
  25
  26 Reference counting
  27 ==================
  28
  29 .. kernel-doc:: include/linux/tty.h
  30    :identifiers: tty_kref_get
  31
  32 .. kernel-doc:: drivers/tty/tty_io.c
  33    :identifiers: tty_kref_put
  34
  35 Install
  36 =======
  37
  38 .. kernel-doc:: drivers/tty/tty_io.c
  39    :identifiers: tty_standard_install
  40
  41 Read & Write
  42 ============
  43
  44 .. kernel-doc:: drivers/tty/tty_io.c
  45    :identifiers: tty_put_char
  46
  47 Start & Stop
  48 ============
  49
  50 .. kernel-doc:: drivers/tty/tty_io.c
  51    :identifiers: start_tty stop_tty
  52
  53 Wakeup
  54 ======
  55
  56 .. kernel-doc:: drivers/tty/tty_io.c
  57    :identifiers: tty_wakeup
  58
  59 Hangup
  60 ======
  61
  62 .. kernel-doc:: drivers/tty/tty_io.c
  63    :identifiers: tty_hangup tty_vhangup tty_hung_up_p
  64
  65 Misc
  66 ====
  67
  68 .. kernel-doc:: drivers/tty/tty_io.c
  69    :identifiers: tty_do_resize
  70
  71 TTY Struct Flags
  72 ================
  73
  74 .. kernel-doc:: include/linux/tty.h
  75    :doc: TTY Struct Flags
  76
  77 TTY Struct Reference
  78 ====================
  79
  80 .. kernel-doc:: include/linux/tty.h
  81    :identifiers: tty_struct