diff options
| author | Jiri Slaby <jslaby@suse.cz> | 2021-11-26 09:15:57 +0100 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2021-11-26 16:27:42 +0100 |
| commit | 4072254f96f954ec0d34899f15d987803b6d76a2 (patch) | |
| tree | a5e94e1d58e39cbfb962ae3b3590192fddacdf0f /Documentation/driver-api/serial | |
| parent | 40f4268cddb93d17a11579920d940c2dca8b9445 (diff) | |
| download | linux-stable-4072254f96f954ec0d34899f15d987803b6d76a2.tar.gz linux-stable-4072254f96f954ec0d34899f15d987803b6d76a2.tar.bz2 linux-stable-4072254f96f954ec0d34899f15d987803b6d76a2.zip | |
tty: reformat tty_struct::flags into kernel-doc
Move the partial tty_struct::flags documentation from tty_ldisc to the
tty.h header and combine it with the one-liners present there. Convert
all those to kernel-doc. This way, we can simply reference the
documentation in Documentation while the text is still along the
definitions.
Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-10-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/driver-api/serial')
| -rw-r--r-- | Documentation/driver-api/serial/tty.rst | 24 |
1 files changed, 2 insertions, 22 deletions
diff --git a/Documentation/driver-api/serial/tty.rst b/Documentation/driver-api/serial/tty.rst index 333a5923f6e1..65f971e3aada 100644 --- a/Documentation/driver-api/serial/tty.rst +++ b/Documentation/driver-api/serial/tty.rst @@ -47,28 +47,8 @@ These are documented as a part of struct tty_operations. Flags ^^^^^ -Line discipline methods have access to tty->flags field containing the -following interesting flags: - -======================= ======================================================= -TTY_THROTTLED Driver input is throttled. The ldisc should call - tty->driver->unthrottle() in order to resume - reception when it is ready to process more data. - -TTY_DO_WRITE_WAKEUP If set, causes the driver to call the ldisc's - write_wakeup() method in order to resume - transmission when it can accept more data - to transmit. - -TTY_IO_ERROR If set, causes all subsequent userspace read/write - calls on the tty to fail, returning -EIO. - -TTY_OTHER_CLOSED Device is a pty and the other side has closed. - -TTY_NO_WRITE_SPLIT Prevent driver from splitting up writes into - smaller chunks. -======================= ======================================================= - +Line discipline methods have access to :c:member:`tty_struct.flags` field. See +:doc:`tty_struct`. Locking ^^^^^^^ |