Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

most: fix kernel-doc warnings

Fix various W=1 kernel-doc warnings in drivers/most/:

drivers/most/most_usb.c:669: warning: Excess function parameter 'data' description in 'link_stat_timer_handler'
drivers/most/most_usb.c:769: warning: cannot understand function prototype: 'const struct file_operations hdm_usb_fops = '
drivers/most/most_usb.c:776: warning: cannot understand function prototype: 'const struct usb_device_id usbid[] = '
drivers/most/most_cdev.c:301: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Initialization of struct file_operations
drivers/most/most_cdev.c:414: warning: Function parameter or member 'args' not described in 'comp_probe'
drivers/most/most_snd.c:56: warning: Function parameter or member 'pcm_hardware' not described in 'channel'
drivers/most/most_snd.c:56: warning: Function parameter or member 'copy_fn' not described in 'channel'
drivers/most/most_snd.c:404: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Initialization of struct snd_pcm_ops
drivers/most/most_snd.c:514: warning: Function parameter or member 'device_name' not described in 'audio_probe_channel'
drivers/most/most_snd.c:703: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Initialization of the struct most_component

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Christian Gromm <christian.gromm@microchip.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20230113063947.23174-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman
fba3993e ad228a34

+12 -9
+3 -2
drivers/most/most_cdev.c
··· 297 297 return mask; 298 298 } 299 299 300 - /** 300 + /* 301 301 * Initialization of struct file_operations 302 302 */ 303 303 static const struct file_operations channel_fops = { ··· 404 404 * @channel_id: channel index/ID 405 405 * @cfg: pointer to actual channel configuration 406 406 * @name: name of the device to be created 407 + * @args: pointer to array of component parameters (from configfs) 407 408 * 408 - * This allocates achannel object and creates the device node in /dev 409 + * This allocates a channel object and creates the device node in /dev 409 410 * 410 411 * Returns 0 on success or error code otherwise. 411 412 */
+6 -4
drivers/most/most_snd.c
··· 27 27 /** 28 28 * struct channel - private structure to keep channel specific data 29 29 * @substream: stores the substream structure 30 + * @pcm_hardware: low-level hardware description 30 31 * @iface: interface for which the channel belongs to 31 32 * @cfg: channel configuration 32 33 * @card: registered sound card ··· 39 38 * @opened: set when the stream is opened 40 39 * @playback_task: playback thread 41 40 * @playback_waitq: waitq used by playback thread 41 + * @copy_fn: copy function for PCM-specific format and width 42 42 */ 43 43 struct channel { 44 44 struct snd_pcm_substream *substream; ··· 402 400 return channel->buffer_pos; 403 401 } 404 402 405 - /** 403 + /* 406 404 * Initialization of struct snd_pcm_ops 407 405 */ 408 406 static const struct snd_pcm_ops pcm_ops = { ··· 503 501 * @iface: pointer to interface instance 504 502 * @channel_id: channel index/ID 505 503 * @cfg: pointer to actual channel configuration 506 - * @arg_list: string that provides the name of the device to be created in /dev 507 - * plus the desired audio resolution 504 + * @device_name: name of the device to be created in /dev 505 + * @arg_list: string that provides the desired audio resolution 508 506 * 509 507 * Creates sound card, pcm device, sets pcm ops and registers sound card. 510 508 * ··· 701 699 return 0; 702 700 } 703 701 704 - /** 702 + /* 705 703 * Initialization of the struct most_component 706 704 */ 707 705 static struct most_component comp = {
+3 -3
drivers/most/most_usb.c
··· 660 660 661 661 /** 662 662 * link_stat_timer_handler - schedule work obtaining mac address and link status 663 - * @data: pointer to USB device instance 663 + * @t: pointer to timer_list which holds a pointer to the USB device instance 664 664 * 665 665 * The handler runs in interrupt context. That's why we need to defer the 666 666 * tasks to a work queue. ··· 763 763 mutex_unlock(&mdev->io_mutex); 764 764 } 765 765 766 - /** 766 + /* 767 767 * hdm_usb_fops - file operation table for USB driver 768 768 */ 769 769 static const struct file_operations hdm_usb_fops = { 770 770 .owner = THIS_MODULE, 771 771 }; 772 772 773 - /** 773 + /* 774 774 * usb_device_id - ID table for HCD device probing 775 775 */ 776 776 static const struct usb_device_id usbid[] = {