hamza.kesraoui/sst-linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tty: reformat kernel-doc in tty_ldisc.c

Browse Source 
Kernel-doc is a bit strict about some formatting. So fix these:
1) When there is a tab in comments, it thinks the line is a continuation
   one. So the description of the functions end up as descriptions of
   the last parameter described. Remove the tabs.

2) Remove newlines before parameters description and after the comments.
   This was not wrong per se, only inconsistent with the rest of the
   file.

3) Add periods to the end of sentences where appropriate.

4) Add "()" to function names and "%" to constants, so that they are
   properly highlighted.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-14-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Jiri Slaby 2021-11-26 09:16:01 +01:00 committed by Greg Kroah-Hartman
parent 796a75a987
commit cbb68f9199
1 changed files with 132 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

292
drivers/tty/tty_ldisc.c
View File

@ -47,17 +47,14 @@ static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS]; static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
/** /**
* tty_register_ldisc - install a line discipline * tty_register_ldisc - install a line discipline
* @new_ldisc: pointer to the ldisc object * @new_ldisc: pointer to the ldisc object
* *
* Installs a new line discipline into the kernel. The discipline * Installs a new line discipline into the kernel. The discipline is set up as
* is set up as unreferenced and then made available to the kernel * unreferenced and then made available to the kernel from this point onwards.
* from this point onwards.
* *
* Locking: * Locking: takes %tty_ldiscs_lock to guard against ldisc races
* takes tty_ldiscs_lock to guard against ldisc races
*/ */
int tty_register_ldisc(struct tty_ldisc_ops *new_ldisc) int tty_register_ldisc(struct tty_ldisc_ops *new_ldisc)
{ {
unsigned long flags; unsigned long flags;
@ -75,14 +72,13 @@ int tty_register_ldisc(struct tty_ldisc_ops *new_ldisc)
EXPORT_SYMBOL(tty_register_ldisc); EXPORT_SYMBOL(tty_register_ldisc);
/** /**
* tty_unregister_ldisc - unload a line discipline * tty_unregister_ldisc - unload a line discipline
* @ldisc: ldisc number * @ldisc: ldisc number
* *
* Remove a line discipline from the kernel providing it is not * Remove a line discipline from the kernel providing it is not currently in
* currently in use. * use.
* *
* Locking: * Locking: takes %tty_ldiscs_lock to guard against ldisc races
* takes tty_ldiscs_lock to guard against ldisc races
*/ */
void tty_unregister_ldisc(struct tty_ldisc_ops *ldisc) void tty_unregister_ldisc(struct tty_ldisc_ops *ldisc)
@ -122,27 +118,25 @@ static void put_ldops(struct tty_ldisc_ops *ldops)
} }
static int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD); static int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD);
/**
* tty_ldisc_get - take a reference to an ldisc
* @tty: tty device
* @disc: ldisc number
*
* Takes a reference to a line discipline. Deals with refcounts and
* module locking counts.
*
* Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
* if the discipline is not registered
* -EAGAIN if request_module() failed to load or register the
* discipline
* -ENOMEM if allocation failure
*
* Otherwise, returns a pointer to the discipline and bumps the
* ref count
*
* Locking:
* takes tty_ldiscs_lock to guard against ldisc races
*/
/**
* tty_ldisc_get - take a reference to an ldisc
* @tty: tty device
* @disc: ldisc number
*
* Takes a reference to a line discipline. Deals with refcounts and module
* locking counts. If the discipline is not available, its module loaded, if
* possible.
*
* Returns:
* * -%EINVAL if the discipline index is not [%N_TTY .. %NR_LDISCS] or if the
* discipline is not registered
* * -%EAGAIN if request_module() failed to load or register the discipline
* * -%ENOMEM if allocation failure
* * Otherwise, returns a pointer to the discipline and bumps the ref count
*
* Locking: takes %tty_ldiscs_lock to guard against ldisc races
*/
static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc) static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
{ {
struct tty_ldisc *ld; struct tty_ldisc *ld;
@ -176,10 +170,11 @@ static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
return ld; return ld;
} }
/* /**
* tty_ldisc_put - release the ldisc * tty_ldisc_put - release the ldisc
* @ld: lisdsc to release
* *
* Complement of tty_ldisc_get(). * Complement of tty_ldisc_get().
*/ */
static void tty_ldisc_put(struct tty_ldisc *ld) static void tty_ldisc_put(struct tty_ldisc *ld)
{ {
@ -226,25 +221,22 @@ const struct seq_operations tty_ldiscs_seq_ops = {
}; };
/** /**
* tty_ldisc_ref_wait - wait for the tty ldisc * tty_ldisc_ref_wait - wait for the tty ldisc
* @tty: tty device * @tty: tty device
* *
* Dereference the line discipline for the terminal and take a * Dereference the line discipline for the terminal and take a reference to it.
* reference to it. If the line discipline is in flux then * If the line discipline is in flux then wait patiently until it changes.
* wait patiently until it changes.
* *
* Returns: NULL if the tty has been hungup and not re-opened with * Returns: %NULL if the tty has been hungup and not re-opened with a new file
* a new file descriptor, otherwise valid ldisc reference * descriptor, otherwise valid ldisc reference
* *
* Note 1: Must not be called from an IRQ/timer context. The caller * Note 1: Must not be called from an IRQ/timer context. The caller must also
* must also be careful not to hold other locks that will deadlock * be careful not to hold other locks that will deadlock against a discipline
* against a discipline change, such as an existing ldisc reference * change, such as an existing ldisc reference (which we check for).
* (which we check for)
* *
* Note 2: a file_operations routine (read/poll/write) should use this * Note 2: a file_operations routine (read/poll/write) should use this function
* function to wait for any ldisc lifetime events to finish. * to wait for any ldisc lifetime events to finish.
*/ */
struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty) struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
{ {
struct tty_ldisc *ld; struct tty_ldisc *ld;
@ -258,14 +250,13 @@ struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait); EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
/** /**
* tty_ldisc_ref - get the tty ldisc * tty_ldisc_ref - get the tty ldisc
* @tty: tty device * @tty: tty device
* *
* Dereference the line discipline for the terminal and take a * Dereference the line discipline for the terminal and take a reference to it.
* reference to it. If the line discipline is in flux then * If the line discipline is in flux then return %NULL. Can be called from IRQ
* return NULL. Can be called from IRQ and timer functions. * and timer functions.
*/ */
struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty) struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
{ {
struct tty_ldisc *ld = NULL; struct tty_ldisc *ld = NULL;
@ -280,13 +271,12 @@ struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
EXPORT_SYMBOL_GPL(tty_ldisc_ref); EXPORT_SYMBOL_GPL(tty_ldisc_ref);
/** /**
* tty_ldisc_deref - free a tty ldisc reference * tty_ldisc_deref - free a tty ldisc reference
* @ld: reference to free up * @ld: reference to free up
* *
* Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May * Undoes the effect of tty_ldisc_ref() or tty_ldisc_ref_wait(). May be called
* be called in IRQ context. * in IRQ context.
*/ */
void tty_ldisc_deref(struct tty_ldisc *ld) void tty_ldisc_deref(struct tty_ldisc *ld)
{ {
ldsem_up_read(&ld->tty->ldisc_sem); ldsem_up_read(&ld->tty->ldisc_sem);
@ -386,13 +376,12 @@ static void tty_ldisc_unlock_pair(struct tty_struct *tty,
} }
/** /**
* tty_ldisc_flush - flush line discipline queue * tty_ldisc_flush - flush line discipline queue
* @tty: tty * @tty: tty to flush ldisc for
* *
* Flush the line discipline queue (if any) and the tty flip buffers * Flush the line discipline queue (if any) and the tty flip buffers for this
* for this tty. * @tty.
*/ */
void tty_ldisc_flush(struct tty_struct *tty) void tty_ldisc_flush(struct tty_struct *tty)
{ {
struct tty_ldisc *ld = tty_ldisc_ref(tty); struct tty_ldisc *ld = tty_ldisc_ref(tty);
@ -404,21 +393,18 @@ void tty_ldisc_flush(struct tty_struct *tty)
EXPORT_SYMBOL_GPL(tty_ldisc_flush); EXPORT_SYMBOL_GPL(tty_ldisc_flush);
/** /**
* tty_set_termios_ldisc - set ldisc field * tty_set_termios_ldisc - set ldisc field
* @tty: tty structure * @tty: tty structure
* @disc: line discipline number * @disc: line discipline number
* *
* This is probably overkill for real world processors but * This is probably overkill for real world processors but they are not on hot
* they are not on hot paths so a little discipline won't do * paths so a little discipline won't do any harm.
* any harm.
* *
* The line discipline-related tty_struct fields are reset to * The line discipline-related tty_struct fields are reset to prevent the ldisc
* prevent the ldisc driver from re-using stale information for * driver from re-using stale information for the new ldisc instance.
* the new ldisc instance.
* *
* Locking: takes termios_rwsem * Locking: takes termios_rwsem
*/ */
static void tty_set_termios_ldisc(struct tty_struct *tty, int disc) static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
{ {
down_write(&tty->termios_rwsem); down_write(&tty->termios_rwsem);
@ -430,16 +416,14 @@ static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
} }
/** /**
* tty_ldisc_open - open a line discipline * tty_ldisc_open - open a line discipline
* @tty: tty we are opening the ldisc on * @tty: tty we are opening the ldisc on
* @ld: discipline to open * @ld: discipline to open
* *
* A helper opening method. Also a convenient debugging and check * A helper opening method. Also a convenient debugging and check point.
* point.
* *
* Locking: always called with BTM already held. * Locking: always called with BTM already held.
*/ */
static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld) static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
{ {
WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags)); WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
@ -457,14 +441,12 @@ static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
} }
/** /**
* tty_ldisc_close - close a line discipline * tty_ldisc_close - close a line discipline
* @tty: tty we are opening the ldisc on * @tty: tty we are opening the ldisc on
* @ld: discipline to close * @ld: discipline to close
* *
* A helper close method. Also a convenient debugging and check * A helper close method. Also a convenient debugging and check point.
* point.
*/ */
static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld) static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
{ {
lockdep_assert_held_write(&tty->ldisc_sem); lockdep_assert_held_write(&tty->ldisc_sem);
@ -476,14 +458,13 @@ static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
} }
/** /**
* tty_ldisc_failto - helper for ldisc failback * tty_ldisc_failto - helper for ldisc failback
* @tty: tty to open the ldisc on * @tty: tty to open the ldisc on
* @ld: ldisc we are trying to fail back to * @ld: ldisc we are trying to fail back to
* *
* Helper to try and recover a tty when switching back to the old * Helper to try and recover a tty when switching back to the old ldisc fails
* ldisc fails and we need something attached. * and we need something attached.
*/ */
static int tty_ldisc_failto(struct tty_struct *tty, int ld) static int tty_ldisc_failto(struct tty_struct *tty, int ld)
{ {
struct tty_ldisc *disc = tty_ldisc_get(tty, ld); struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
@ -501,14 +482,13 @@ static int tty_ldisc_failto(struct tty_struct *tty, int ld)
} }
/** /**
* tty_ldisc_restore - helper for tty ldisc change * tty_ldisc_restore - helper for tty ldisc change
* @tty: tty to recover * @tty: tty to recover
* @old: previous ldisc * @old: previous ldisc
* *
* Restore the previous line discipline or N_TTY when a line discipline * Restore the previous line discipline or %N_TTY when a line discipline change
* change fails due to an open error * fails due to an open error
*/ */
static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old) static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
{ {
/* There is an outstanding reference here so this is safe */ /* There is an outstanding reference here so this is safe */
@ -528,16 +508,15 @@ static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
} }
/** /**
* tty_set_ldisc - set line discipline * tty_set_ldisc - set line discipline
* @tty: the terminal to set * @tty: the terminal to set
* @disc: the line discipline number * @disc: the line discipline number
* *
* Set the discipline of a tty line. Must be called from a process * Set the discipline of a tty line. Must be called from a process context. The
* context. The ldisc change logic has to protect itself against any * ldisc change logic has to protect itself against any overlapping ldisc
* overlapping ldisc change (including on the other end of pty pairs), * change (including on the other end of pty pairs), the close of one side of a
* the close of one side of a tty/pty pair, and eventually hangup. * tty/pty pair, and eventually hangup.
*/ */
int tty_set_ldisc(struct tty_struct *tty, int disc) int tty_set_ldisc(struct tty_struct *tty, int disc)
{ {
int retval; int retval;
@ -613,10 +592,10 @@ err:
EXPORT_SYMBOL_GPL(tty_set_ldisc); EXPORT_SYMBOL_GPL(tty_set_ldisc);
/** /**
* tty_ldisc_kill - teardown ldisc * tty_ldisc_kill - teardown ldisc
* @tty: tty being released * @tty: tty being released
* *
* Perform final close of the ldisc and reset tty->ldisc * Perform final close of the ldisc and reset @tty->ldisc
*/ */
static void tty_ldisc_kill(struct tty_struct *tty) static void tty_ldisc_kill(struct tty_struct *tty)
{ {
@ -633,12 +612,11 @@ static void tty_ldisc_kill(struct tty_struct *tty)
} }
/** /**
* tty_reset_termios - reset terminal state * tty_reset_termios - reset terminal state
* @tty: tty to reset * @tty: tty to reset
* *
* Restore a terminal to the driver default state. * Restore a terminal to the driver default state.
*/ */
static void tty_reset_termios(struct tty_struct *tty) static void tty_reset_termios(struct tty_struct *tty)
{ {
down_write(&tty->termios_rwsem); down_write(&tty->termios_rwsem);
@ -650,19 +628,17 @@ static void tty_reset_termios(struct tty_struct *tty)
/** /**
* tty_ldisc_reinit - reinitialise the tty ldisc * tty_ldisc_reinit - reinitialise the tty ldisc
* @tty: tty to reinit * @tty: tty to reinit
* @disc: line discipline to reinitialize * @disc: line discipline to reinitialize
* *
* Completely reinitialize the line discipline state, by closing the * Completely reinitialize the line discipline state, by closing the current
* current instance, if there is one, and opening a new instance. If * instance, if there is one, and opening a new instance. If an error occurs
* an error occurs opening the new non-N_TTY instance, the instance * opening the new non-%N_TTY instance, the instance is dropped and @tty->ldisc
* is dropped and tty->ldisc reset to NULL. The caller can then retry * reset to %NULL. The caller can then retry with %N_TTY instead.
* with N_TTY instead.
* *
* Returns 0 if successful, otherwise error code < 0 * Returns: 0 if successful, otherwise error code < 0
*/ */
int tty_ldisc_reinit(struct tty_struct *tty, int disc) int tty_ldisc_reinit(struct tty_struct *tty, int disc)
{ {
struct tty_ldisc *ld; struct tty_ldisc *ld;
@ -692,21 +668,20 @@ int tty_ldisc_reinit(struct tty_struct *tty, int disc)
} }
/** /**
* tty_ldisc_hangup - hangup ldisc reset * tty_ldisc_hangup - hangup ldisc reset
* @tty: tty being hung up * @tty: tty being hung up
* @reinit: whether to re-initialise the tty * @reinit: whether to re-initialise the tty
* *
* Some tty devices reset their termios when they receive a hangup * Some tty devices reset their termios when they receive a hangup event. In
* event. In that situation we must also switch back to N_TTY properly * that situation we must also switch back to %N_TTY properly before we reset
* before we reset the termios data. * the termios data.
* *
* Locking: We can take the ldisc mutex as the rest of the code is * Locking: We can take the ldisc mutex as the rest of the code is careful to
* careful to allow for this. * allow for this.
* *
* In the pty pair case this occurs in the close() path of the * In the pty pair case this occurs in the close() path of the tty itself so we
* tty itself so we must be careful about locking rules. * must be careful about locking rules.
*/ */
void tty_ldisc_hangup(struct tty_struct *tty, bool reinit) void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
{ {
struct tty_ldisc *ld; struct tty_ldisc *ld;
@ -752,15 +727,14 @@ void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
} }
/** /**
* tty_ldisc_setup - open line discipline * tty_ldisc_setup - open line discipline
* @tty: tty being shut down * @tty: tty being shut down
* @o_tty: pair tty for pty/tty pairs * @o_tty: pair tty for pty/tty pairs
* *
* Called during the initial open of a tty/pty pair in order to set up the * Called during the initial open of a tty/pty pair in order to set up the line
* line disciplines and bind them to the tty. This has no locking issues * disciplines and bind them to the @tty. This has no locking issues as the
* as the device isn't yet active. * device isn't yet active.
*/ */
int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty) int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
{ {
int retval = tty_ldisc_open(tty, tty->ldisc); int retval = tty_ldisc_open(tty, tty->ldisc);
@ -783,13 +757,12 @@ int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
} }
/** /**
* tty_ldisc_release - release line discipline * tty_ldisc_release - release line discipline
* @tty: tty being shut down (or one end of pty pair) * @tty: tty being shut down (or one end of pty pair)
* *
* Called during the final close of a tty or a pty pair in order to shut * Called during the final close of a tty or a pty pair in order to shut down
* down the line discpline layer. On exit, each tty's ldisc is NULL. * the line discpline layer. On exit, each tty's ldisc is %NULL.
*/ */
void tty_ldisc_release(struct tty_struct *tty) void tty_ldisc_release(struct tty_struct *tty)
{ {
struct tty_struct *o_tty = tty->link; struct tty_struct *o_tty = tty->link;
@ -814,13 +787,12 @@ void tty_ldisc_release(struct tty_struct *tty)
} }
/** /**
* tty_ldisc_init - ldisc setup for new tty * tty_ldisc_init - ldisc setup for new tty
* @tty: tty being allocated * @tty: tty being allocated
* *
* Set up the line discipline objects for a newly allocated tty. Note that * Set up the line discipline objects for a newly allocated tty. Note that the
* the tty structure is not completely set up when this call is made. * tty structure is not completely set up when this call is made.
*/ */
int tty_ldisc_init(struct tty_struct *tty) int tty_ldisc_init(struct tty_struct *tty)
{ {
struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY); struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
@ -832,11 +804,11 @@ int tty_ldisc_init(struct tty_struct *tty)
} }
/** /**
* tty_ldisc_deinit - ldisc cleanup for new tty * tty_ldisc_deinit - ldisc cleanup for new tty
* @tty: tty that was allocated recently * @tty: tty that was allocated recently
* *
* The tty structure must not becompletely set up (tty_ldisc_setup) when * The tty structure must not be completely set up (tty_ldisc_setup()) when
* this call is made. * this call is made.
*/ */
void tty_ldisc_deinit(struct tty_struct *tty) void tty_ldisc_deinit(struct tty_struct *tty)
{ {