Documentation: move tty to driver-api
Based on discussion starting as 87mthw2o93.fsf@meer.lwn.net, let's move the tty documentation to driver-api. It's more appropriate there. Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Jiri Slaby <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
committed by
Greg Kroah-Hartman
parent
ce522ba9ef
commit
b96cd8b05e
@@ -0,0 +1,46 @@
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
==========
|
||||
TTY Buffer
|
||||
==========
|
||||
|
||||
.. contents:: :local:
|
||||
|
||||
Here, we document functions for taking care of tty buffer and their flipping.
|
||||
Drivers are supposed to fill the buffer by one of those functions below and
|
||||
then flip the buffer, so that the data are passed to :doc:`line discipline
|
||||
<tty_ldisc>` for further processing.
|
||||
|
||||
Flip Buffer Management
|
||||
======================
|
||||
|
||||
.. kernel-doc:: drivers/tty/tty_buffer.c
|
||||
:identifiers: tty_prepare_flip_string tty_insert_flip_string_fixed_flag
|
||||
tty_insert_flip_string_flags __tty_insert_flip_char
|
||||
tty_flip_buffer_push tty_ldisc_receive_buf
|
||||
|
||||
----
|
||||
|
||||
Other Functions
|
||||
===============
|
||||
|
||||
.. kernel-doc:: drivers/tty/tty_buffer.c
|
||||
:identifiers: tty_buffer_space_avail tty_buffer_set_limit
|
||||
|
||||
----
|
||||
|
||||
Buffer Locking
|
||||
==============
|
||||
|
||||
These are used only in special circumstances. Avoid them.
|
||||
|
||||
.. kernel-doc:: drivers/tty/tty_buffer.c
|
||||
:identifiers: tty_buffer_lock_exclusive tty_buffer_unlock_exclusive
|
||||
|
||||
----
|
||||
|
||||
Internal Functions
|
||||
==================
|
||||
|
||||
.. kernel-doc:: drivers/tty/tty_buffer.c
|
||||
:internal:
|
||||
Reference in New Issue
Block a user