0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 ==========
0004 TTY Buffer
0005 ==========
0006
0007 .. contents:: :local:
0008
0009 Here, we document functions for taking care of tty buffer and their flipping.
0010 Drivers are supposed to fill the buffer by one of those functions below and
0011 then flip the buffer, so that the data are passed to :doc:`line discipline
0012 <tty_ldisc>` for further processing.
0013
0014 Flip Buffer Management
0015 ======================
0016
0017 .. kernel-doc:: drivers/tty/tty_buffer.c
0018 :identifiers: tty_prepare_flip_string tty_insert_flip_string_fixed_flag
0019 tty_insert_flip_string_flags __tty_insert_flip_char
0020 tty_flip_buffer_push tty_ldisc_receive_buf
0021
0022 ----
0023
0024 Other Functions
0025 ===============
0026
0027 .. kernel-doc:: drivers/tty/tty_buffer.c
0028 :identifiers: tty_buffer_space_avail tty_buffer_set_limit
0029
0030 ----
0031
0032 Buffer Locking
0033 ==============
0034
0035 These are used only in special circumstances. Avoid them.
0036
0037 .. kernel-doc:: drivers/tty/tty_buffer.c
0038 :identifiers: tty_buffer_lock_exclusive tty_buffer_unlock_exclusive
0039
0040 ----
0041
0042 Internal Functions
0043 ==================
0044
0045 .. kernel-doc:: drivers/tty/tty_buffer.c
0046 :internal:
