diff options
| author | Jiri Slaby <jslaby@suse.cz> | 2021-11-26 11:16:05 +0300 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2021-11-26 18:27:43 +0300 |
| commit | 385812835431c9055362f453da6d59e7dfcde430 (patch) | |
| tree | 7406ff30f99deedeabf03651b31ecc2833a046dc /drivers/tty/tty_io.c | |
| parent | 98629663bff8c2831f9cfd2b4e67537b24a48daa (diff) | |
| download | linux-385812835431c9055362f453da6d59e7dfcde430.tar.xz | |
tty: add kernel-doc for more tty_driver functions
The only documented function for tty_driver structure
allocation/registration was __tty_alloc_driver(). Fix highlighting in
that comment.
And add kernel-doc headers to all tty_driver_kref_put(),
tty_register_driver(), and tty_unregister_driver() -- i.e. the main
ones. More to follow later.
Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-18-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/tty/tty_io.c')
| -rw-r--r-- | drivers/tty/tty_io.c | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/drivers/tty/tty_io.c b/drivers/tty/tty_io.c index b23269eb0cba..26b325e44c53 100644 --- a/drivers/tty/tty_io.c +++ b/drivers/tty/tty_io.c @@ -3394,13 +3394,22 @@ static void destruct_tty_driver(struct kref *kref) kfree(driver); } +/** + * tty_driver_kref_put -- drop a reference to a tty driver + * @driver: driver of which to drop the reference + * + * The final put will destroy and free up the driver. + */ void tty_driver_kref_put(struct tty_driver *driver) { kref_put(&driver->kref, destruct_tty_driver); } EXPORT_SYMBOL(tty_driver_kref_put); -/* +/** + * tty_register_driver -- register a tty driver + * @driver: driver to register + * * Called by a tty driver to register itself. */ int tty_register_driver(struct tty_driver *driver) @@ -3462,7 +3471,10 @@ err: } EXPORT_SYMBOL(tty_register_driver); -/* +/** + * tty_unregister_driver -- unregister a tty driver + * @driver: driver to unregister + * * Called by a tty driver to unregister itself. */ void tty_unregister_driver(struct tty_driver *driver) |