UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

tty: reformat TTY_DRIVER_ flags into kernel-doc 

We want to reference TTY_DRIVER_* flags in Documentation/ later in this
series. But the current documentation in the TTY_DRIVER_*'s header does
not allow that. Reformat it to kernel-doc using "DOC" directive and
line-feeds, so that we can include it as it is.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-11-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Jiri Slaby 2021-11-26 09:15:58 +01:00 committed by Greg Kroah-Hartman
parent 4072254f96
commit 34d809f8b4
1 changed files with 42 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
include/linux/tty_driver.h
View File

@ -492,49 +492,53 @@ static inline void tty_set_operations(struct tty_driver *driver,
/* tty driver magic number */ /* tty driver magic number */
#define TTY_DRIVER_MAGIC 0x5402 #define TTY_DRIVER_MAGIC 0x5402
/* /**
* tty driver flags * DOC: TTY Driver Flags
* *
* TTY_DRIVER_RESET_TERMIOS --- requests the tty layer to reset the * TTY_DRIVER_RESET_TERMIOS
* termios setting when the last process has closed the device. * Requests the tty layer to reset the termios setting when the last
* Used for PTY's, in particular. * process has closed the device. Used for PTYs, in particular.
* *
* TTY_DRIVER_REAL_RAW --- if set, indicates that the driver will * TTY_DRIVER_REAL_RAW
* guarantee never to set any special character handling * Indicates that the driver will guarantee not to set any special
* flags if ((IGNBRK || (!BRKINT && !PARMRK)) && (IGNPAR || * character handling flags if this is set for the tty:
* !INPCK)). That is, if there is no reason for the driver to
* send notifications of parity and break characters up to the
* line driver, it won't do so. This allows the line driver to
* optimize for this case if this flag is set. (Note that there
* is also a promise, if the above case is true, not to signal
* overruns, either.)
* *
* TTY_DRIVER_DYNAMIC_DEV --- if set, the individual tty devices need * ``(IGNBRK || (!BRKINT && !PARMRK)) && (IGNPAR || !INPCK)``
* to be registered with a call to tty_register_device() when the
* device is found in the system and unregistered with a call to
* tty_unregister_device() so the devices will be show up
* properly in sysfs. If not set, driver->num entries will be
* created by the tty core in sysfs when tty_register_driver() is
* called. This is to be used by drivers that have tty devices
* that can appear and disappear while the main tty driver is
* registered with the tty core.
* *
* TTY_DRIVER_DEVPTS_MEM -- don't use the standard arrays, instead * That is, if there is no reason for the driver to
* use dynamic memory keyed through the devpts filesystem. This * send notifications of parity and break characters up to the line
* is only applicable to the pty driver. * driver, it won't do so. This allows the line driver to optimize for
* this case if this flag is set. (Note that there is also a promise, if
* the above case is true, not to signal overruns, either.)
* *
* TTY_DRIVER_HARDWARE_BREAK -- hardware handles break signals. Pass * TTY_DRIVER_DYNAMIC_DEV
* the requested timeout to the caller instead of using a simple * The individual tty devices need to be registered with a call to
* on/off interface. * tty_register_device() when the device is found in the system and
* unregistered with a call to tty_unregister_device() so the devices will
* be show up properly in sysfs. If not set, all &tty_driver.num entries
* will be created by the tty core in sysfs when tty_register_driver() is
* called. This is to be used by drivers that have tty devices that can
* appear and disappear while the main tty driver is registered with the
* tty core.
* *
* TTY_DRIVER_DYNAMIC_ALLOC -- do not allocate structures which are * TTY_DRIVER_DEVPTS_MEM
* needed per line for this driver as it would waste memory. * Don't use the standard arrays (&tty_driver.ttys and
* The driver will take care. * &tty_driver.termios), instead use dynamic memory keyed through the
* devpts filesystem. This is only applicable to the PTY driver.
* *
* TTY_DRIVER_UNNUMBERED_NODE -- do not create numbered /dev nodes. In * TTY_DRIVER_HARDWARE_BREAK
* other words create /dev/ttyprintk and not /dev/ttyprintk0. * Hardware handles break signals. Pass the requested timeout to the
* Applicable only when a driver for a single tty device is * &tty_operations.break_ctl instead of using a simple on/off interface.
* being allocated. *
* TTY_DRIVER_DYNAMIC_ALLOC
* Do not allocate structures which are needed per line for this driver
* (&tty_driver.ports) as it would waste memory. The driver will take
* care. This is only applicable to the PTY driver.
*
* TTY_DRIVER_UNNUMBERED_NODE
* Do not create numbered ``/dev`` nodes. For example, create
* ``/dev/ttyprintk`` and not ``/dev/ttyprintk0``. Applicable only when a
* driver for a single tty device is being allocated.
*/ */
#define TTY_DRIVER_INSTALLED 0x0001 #define TTY_DRIVER_INSTALLED 0x0001
#define TTY_DRIVER_RESET_TERMIOS 0x0002 #define TTY_DRIVER_RESET_TERMIOS 0x0002