Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-23 04:31:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

tty: ldiscs, fix kernel-doc

Browse Source 
As in the previous patch, fix kernel-doc in line disciplines.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20200818085655.12071-5-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Jiri Slaby 2020-08-18 10:56:52 +02:00 committed by Greg Kroah-Hartman
parent fa44195455
commit 724ac070ff
3 changed files with 49 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
drivers/tty/n_gsm.c
View File

@ -76,10 +76,9 @@ module_param(debug, int, 0600);
/** /**
* struct gsm_mux_net - network interface * struct gsm_mux_net - network interface
* @struct gsm_dlci* dlci
* *
* Created when net interface is initialized. * Created when net interface is initialized.
**/ */
struct gsm_mux_net { struct gsm_mux_net {
struct kref ref; struct kref ref;
struct gsm_dlci *dlci; struct gsm_dlci *dlci;
@ -399,7 +398,7 @@ static inline u8 gsm_fcs_add_block(u8 fcs, u8 *c, int len)
/** /**
* gsm_read_ea - read a byte into an EA * gsm_read_ea - read a byte into an EA
* @val: variable holding value * @val: variable holding value
* c: byte going into the EA * @c: byte going into the EA
* *
* Processes one byte of an EA. Updates the passed variable * Processes one byte of an EA. Updates the passed variable
* and returns 1 if the EA is now completely read * and returns 1 if the EA is now completely read
@ -513,8 +512,8 @@ static void gsm_print_packet(const char *hdr, int addr, int cr,
/** /**
* gsm_stuff_packet - bytestuff a packet * gsm_stuff_packet - bytestuff a packet
* @ibuf: input * @input: input buffer
* @obuf: output * @output: output buffer
* @len: length of input * @len: length of input
* *
* Expand a buffer by bytestuffing it. The worst case size change * Expand a buffer by bytestuffing it. The worst case size change
@ -1304,7 +1303,7 @@ static void gsm_control_transmit(struct gsm_mux *gsm, struct gsm_control *ctrl)
/** /**
* gsm_control_retransmit - retransmit a control frame * gsm_control_retransmit - retransmit a control frame
* @data: pointer to our gsm object * @t: timer contained in our gsm object
* *
* Called off the T2 timer expiry in order to retransmit control frames * Called off the T2 timer expiry in order to retransmit control frames
* that have been lost in the system somewhere. The control_lock protects * that have been lost in the system somewhere. The control_lock protects
@ -1341,7 +1340,7 @@ static void gsm_control_retransmit(struct timer_list *t)
* @gsm: the GSM channel * @gsm: the GSM channel
* @command: command to send including CR bit * @command: command to send including CR bit
* @data: bytes of data (must be kmalloced) * @data: bytes of data (must be kmalloced)
* @len: length of the block to send * @clen: length of the block to send
* *
* Queue and dispatch a control command. Only one command can be * Queue and dispatch a control command. Only one command can be
* active at a time. In theory more can be outstanding but the matching * active at a time. In theory more can be outstanding but the matching
@ -1453,7 +1452,7 @@ static void gsm_dlci_open(struct gsm_dlci *dlci)
/** /**
* gsm_dlci_t1 - T1 timer expiry * gsm_dlci_t1 - T1 timer expiry
* @dlci: DLCI that opened * @t: timer contained in the DLCI that opened
* *
* The T1 timer handles retransmits of control frames (essentially of * The T1 timer handles retransmits of control frames (essentially of
* SABM and DISC). We resend the command until the retry count runs out * SABM and DISC). We resend the command until the retry count runs out
@ -1549,7 +1548,7 @@ static void gsm_dlci_begin_close(struct gsm_dlci *dlci)
* gsm_dlci_data - data arrived * gsm_dlci_data - data arrived
* @dlci: channel * @dlci: channel
* @data: block of bytes received * @data: block of bytes received
* @len: length of received block * @clen: length of received block
* *
* A UI or UIH frame has arrived which contains data for a channel * A UI or UIH frame has arrived which contains data for a channel
* other than the control channel. If the relevant virtual tty is * other than the control channel. If the relevant virtual tty is
@ -1671,7 +1670,7 @@ static struct gsm_dlci *gsm_dlci_alloc(struct gsm_mux *gsm, int addr)
/** /**
* gsm_dlci_free - free DLCI * gsm_dlci_free - free DLCI
* @dlci: DLCI to free * @port: tty port for DLCI to free
* *
* Free up a DLCI. * Free up a DLCI.
* *
@ -2149,7 +2148,7 @@ static int gsm_activate_mux(struct gsm_mux *gsm)
/** /**
* gsm_free_mux - free up a mux * gsm_free_mux - free up a mux
* @mux: mux to free * @gsm: mux to free
* *
* Dispose of allocated resources for a dead mux * Dispose of allocated resources for a dead mux
*/ */
@ -2162,7 +2161,7 @@ static void gsm_free_mux(struct gsm_mux *gsm)
/** /**
* gsm_free_muxr - free up a mux * gsm_free_muxr - free up a mux
* @mux: mux to free * @ref: kreference to the mux to free
* *
* Dispose of allocated resources for a dead mux * Dispose of allocated resources for a dead mux
*/ */

72
drivers/tty/n_hdlc.c
View File

@ -123,13 +123,13 @@ struct n_hdlc_buf_list {
/** /**
* struct n_hdlc - per device instance data structure * struct n_hdlc - per device instance data structure
* @magic - magic value for structure * @magic: magic value for structure
* @tbusy - reentrancy flag for tx wakeup code * @tbusy: reentrancy flag for tx wakeup code
* @woke_up - tx wakeup needs to be run again as it was called while @tbusy * @woke_up: tx wakeup needs to be run again as it was called while @tbusy
* @tx_buf_list - list of pending transmit frame buffers * @tx_buf_list: list of pending transmit frame buffers
* @rx_buf_list - list of received frame buffers * @rx_buf_list: list of received frame buffers
* @tx_free_buf_list - list unused transmit frame buffers * @tx_free_buf_list: list unused transmit frame buffers
* @rx_free_buf_list - list unused received frame buffers * @rx_free_buf_list: list unused received frame buffers
*/ */
struct n_hdlc { struct n_hdlc {
int magic; int magic;
@ -187,7 +187,7 @@ static void n_hdlc_free_buf_list(struct n_hdlc_buf_list *list)
/** /**
* n_hdlc_tty_close - line discipline close * n_hdlc_tty_close - line discipline close
* @tty - pointer to tty info structure * @tty: pointer to tty info structure
* *
* Called when the line discipline is changed to something * Called when the line discipline is changed to something
* else, the tty is closed, or the tty detects a hangup. * else, the tty is closed, or the tty detects a hangup.
@ -218,7 +218,7 @@ static void n_hdlc_tty_close(struct tty_struct *tty)
/** /**
* n_hdlc_tty_open - called when line discipline changed to n_hdlc * n_hdlc_tty_open - called when line discipline changed to n_hdlc
* @tty - pointer to tty info structure * @tty: pointer to tty info structure
* *
* Returns 0 if success, otherwise error code * Returns 0 if success, otherwise error code
*/ */
@ -255,8 +255,8 @@ static int n_hdlc_tty_open(struct tty_struct *tty)
/** /**
* n_hdlc_send_frames - send frames on pending send buffer list * n_hdlc_send_frames - send frames on pending send buffer list
* @n_hdlc - pointer to ldisc instance data * @n_hdlc: pointer to ldisc instance data
* @tty - pointer to tty instance data * @tty: pointer to tty instance data
* *
* Send frames on pending send buffer list until the driver does not accept a * Send frames on pending send buffer list until the driver does not accept a
* frame (busy) this function is called after adding a frame to the send buffer * frame (busy) this function is called after adding a frame to the send buffer
@ -335,7 +335,7 @@ check_again:
/** /**
* n_hdlc_tty_wakeup - Callback for transmit wakeup * n_hdlc_tty_wakeup - Callback for transmit wakeup
* @tty - pointer to associated tty instance data * @tty: pointer to associated tty instance data
* *
* Called when low level device driver can accept more send data. * Called when low level device driver can accept more send data.
*/ */
@ -348,10 +348,10 @@ static void n_hdlc_tty_wakeup(struct tty_struct *tty)
/** /**
* n_hdlc_tty_receive - Called by tty driver when receive data is available * n_hdlc_tty_receive - Called by tty driver when receive data is available
* @tty - pointer to tty instance data * @tty: pointer to tty instance data
* @data - pointer to received data * @data: pointer to received data
* @flags - pointer to flags for data * @flags: pointer to flags for data
* @count - count of received data in bytes * @count: count of received data in bytes
* *
* Called by tty low level driver when receive data is available. Data is * Called by tty low level driver when receive data is available. Data is
* interpreted as one HDLC frame. * interpreted as one HDLC frame.
@ -408,10 +408,10 @@ static void n_hdlc_tty_receive(struct tty_struct *tty, const __u8 *data,
/** /**
* n_hdlc_tty_read - Called to retrieve one frame of data (if available) * n_hdlc_tty_read - Called to retrieve one frame of data (if available)
* @tty - pointer to tty instance data * @tty: pointer to tty instance data
* @file - pointer to open file object * @file: pointer to open file object
* @buf - pointer to returned data buffer * @buf: pointer to returned data buffer
* @nr - size of returned data buffer * @nr: size of returned data buffer
* *
* Returns the number of bytes returned or error code. * Returns the number of bytes returned or error code.
*/ */
@ -479,10 +479,10 @@ static ssize_t n_hdlc_tty_read(struct tty_struct *tty, struct file *file,
/** /**
* n_hdlc_tty_write - write a single frame of data to device * n_hdlc_tty_write - write a single frame of data to device
* @tty - pointer to associated tty device instance data * @tty: pointer to associated tty device instance data
* @file - pointer to file object data * @file: pointer to file object data
* @data - pointer to transmit data (one frame) * @data: pointer to transmit data (one frame)
* @count - size of transmit frame in bytes * @count: size of transmit frame in bytes
* *
* Returns the number of bytes written (or error code). * Returns the number of bytes written (or error code).
*/ */
@ -546,10 +546,10 @@ static ssize_t n_hdlc_tty_write(struct tty_struct *tty, struct file *file,
/** /**
* n_hdlc_tty_ioctl - process IOCTL system call for the tty device. * n_hdlc_tty_ioctl - process IOCTL system call for the tty device.
* @tty - pointer to tty instance data * @tty: pointer to tty instance data
* @file - pointer to open file object for device * @file: pointer to open file object for device
* @cmd - IOCTL command code * @cmd: IOCTL command code
* @arg - argument for IOCTL call (cmd dependent) * @arg: argument for IOCTL call (cmd dependent)
* *
* Returns command dependent result. * Returns command dependent result.
*/ */
@ -614,9 +614,9 @@ static int n_hdlc_tty_ioctl(struct tty_struct *tty, struct file *file,
/** /**
* n_hdlc_tty_poll - TTY callback for poll system call * n_hdlc_tty_poll - TTY callback for poll system call
* @tty - pointer to tty instance data * @tty: pointer to tty instance data
* @filp - pointer to open file object for device * @filp: pointer to open file object for device
* @poll_table - wait queue for operations * @wait: wait queue for operations
* *
* Determine which operations (read/write) will not block and return info * Determine which operations (read/write) will not block and return info
* to caller. * to caller.
@ -703,8 +703,8 @@ static struct n_hdlc *n_hdlc_alloc(void)
/** /**
* n_hdlc_buf_return - put the HDLC buffer after the head of the specified list * n_hdlc_buf_return - put the HDLC buffer after the head of the specified list
* @buf_list - pointer to the buffer list * @buf_list: pointer to the buffer list
* @buf - pointer to the buffer * @buf: pointer to the buffer
*/ */
static void n_hdlc_buf_return(struct n_hdlc_buf_list *buf_list, static void n_hdlc_buf_return(struct n_hdlc_buf_list *buf_list,
struct n_hdlc_buf *buf) struct n_hdlc_buf *buf)
@ -721,8 +721,8 @@ static void n_hdlc_buf_return(struct n_hdlc_buf_list *buf_list,
/** /**
* n_hdlc_buf_put - add specified HDLC buffer to tail of specified list * n_hdlc_buf_put - add specified HDLC buffer to tail of specified list
* @buf_list - pointer to buffer list * @buf_list: pointer to buffer list
* @buf - pointer to buffer * @buf: pointer to buffer
*/ */
static void n_hdlc_buf_put(struct n_hdlc_buf_list *buf_list, static void n_hdlc_buf_put(struct n_hdlc_buf_list *buf_list,
struct n_hdlc_buf *buf) struct n_hdlc_buf *buf)
@ -739,7 +739,7 @@ static void n_hdlc_buf_put(struct n_hdlc_buf_list *buf_list,
/** /**
* n_hdlc_buf_get - remove and return an HDLC buffer from list * n_hdlc_buf_get - remove and return an HDLC buffer from list
* @buf_list - pointer to HDLC buffer list * @buf_list: pointer to HDLC buffer list
* *
* Remove and return an HDLC buffer from the head of the specified HDLC buffer * Remove and return an HDLC buffer from the head of the specified HDLC buffer
* list. * list.

4
drivers/tty/n_tty.c
View File

@ -322,7 +322,7 @@ static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
/** /**
* reset_buffer_flags - reset buffer state * reset_buffer_flags - reset buffer state
* @tty: terminal to reset * @ldata: line disc data to reset
* *
* Reset the read buffer counters and clear the flags. * Reset the read buffer counters and clear the flags.
* Called from n_tty_open() and n_tty_flush_buffer(). * Called from n_tty_open() and n_tty_flush_buffer().
@ -906,7 +906,7 @@ static void echo_erase_tab(unsigned int num_chars, int after_tab,
/** /**
* echo_char_raw - echo a character raw * echo_char_raw - echo a character raw
* @c: unicode byte to echo * @c: unicode byte to echo
* @tty: terminal device * @ldata: line disc data
* *
* Echo user input back onto the screen. This must be called only when * Echo user input back onto the screen. This must be called only when
* L_ECHO(tty) is true. Called from the driver receive_buf path. * L_ECHO(tty) is true. Called from the driver receive_buf path.