tty_buffer.rst 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .. SPDX-License-Identifier: GPL-2.0
  2. ==========
  3. TTY Buffer
  4. ==========
  5. .. contents:: :local:
  6. Here, we document functions for taking care of tty buffer and their flipping.
  7. Drivers are supposed to fill the buffer by one of those functions below and
  8. then flip the buffer, so that the data are passed to :doc:`line discipline
  9. <tty_ldisc>` for further processing.
  10. Flip Buffer Management
  11. ======================
  12. .. kernel-doc:: drivers/tty/tty_buffer.c
  13. :identifiers: tty_prepare_flip_string
  14. tty_flip_buffer_push tty_ldisc_receive_buf
  15. .. kernel-doc:: include/linux/tty_flip.h
  16. :identifiers: tty_insert_flip_string_fixed_flag tty_insert_flip_string_flags
  17. tty_insert_flip_char
  18. ----
  19. Other Functions
  20. ===============
  21. .. kernel-doc:: drivers/tty/tty_buffer.c
  22. :identifiers: tty_buffer_space_avail tty_buffer_set_limit
  23. ----
  24. Buffer Locking
  25. ==============
  26. These are used only in special circumstances. Avoid them.
  27. .. kernel-doc:: drivers/tty/tty_buffer.c
  28. :identifiers: tty_buffer_lock_exclusive tty_buffer_unlock_exclusive
  29. ----
  30. Internal Functions
  31. ==================
  32. .. kernel-doc:: drivers/tty/tty_buffer.c
  33. :internal: