tty_struct.rst 1.5 KB

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