Commit fba3993e authored by Randy Dunlap's avatar Randy Dunlap Committed by Greg Kroah-Hartman
Browse files

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: default avatarRandy 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: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ad228a34

drivers/most/most_cdev.c

+3 −2
Original line number Diff line number Diff line
@@ -297,7 +297,7 @@ static __poll_t comp_poll(struct file *filp, poll_table *wait) 
	return mask;

}



/**

/*

 * Initialization of struct file_operations

 */

static const struct file_operations channel_fops = {
@@ -404,6 +404,7 @@ static int comp_tx_completion(struct most_interface *iface, int channel_id) 
 * @channel_id: channel index/ID

 * @cfg: pointer to actual channel configuration

 * @name: name of the device to be created

 * @args: pointer to array of component parameters (from configfs)

 *

 * This allocates a channel object and creates the device node in /dev

 *

drivers/most/most_snd.c

+6 −4
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ static struct most_component comp; 
/**

 * struct channel - private structure to keep channel specific data

 * @substream: stores the substream structure

 * @pcm_hardware: low-level hardware description

 * @iface: interface for which the channel belongs to

 * @cfg: channel configuration

 * @card: registered sound card
@@ -38,6 +39,7 @@ static struct most_component comp; 
 * @opened: set when the stream is opened

 * @playback_task: playback thread

 * @playback_waitq: waitq used by playback thread

 * @copy_fn: copy function for PCM-specific format and width

 */

struct channel {

	struct snd_pcm_substream *substream;
@@ -400,7 +402,7 @@ static snd_pcm_uframes_t pcm_pointer(struct snd_pcm_substream *substream) 
	return channel->buffer_pos;

}



/**

/*

 * Initialization of struct snd_pcm_ops

 */

static const struct snd_pcm_ops pcm_ops = {
@@ -501,8 +503,8 @@ static void release_adapter(struct sound_adapter *adpt) 
 * @iface: pointer to interface instance

 * @channel_id: channel index/ID

 * @cfg: pointer to actual channel configuration

 * @arg_list: string that provides the name of the device to be created in /dev

 *	      plus the desired audio resolution

 * @device_name: name of the device to be created in /dev

 * @arg_list: string that provides the desired audio resolution

 *

 * Creates sound card, pcm device, sets pcm ops and registers sound card.

 *
@@ -699,7 +701,7 @@ static int audio_tx_completion(struct most_interface *iface, int channel_id) 
	return 0;

}



/**

/*

 * Initialization of the struct most_component

 */

static struct most_component comp = {

drivers/most/most_usb.c

+3 −3
Original line number Diff line number Diff line
@@ -660,7 +660,7 @@ static void hdm_request_netinfo(struct most_interface *iface, int channel, 


/**

 * link_stat_timer_handler - schedule work obtaining mac address and link status

 * @data: pointer to USB device instance

 * @t: pointer to timer_list which holds a pointer to the USB device instance

 *

 * The handler runs in interrupt context. That's why we need to defer the

 * tasks to a work queue.
@@ -763,14 +763,14 @@ static void wq_clear_halt(struct work_struct *wq_obj) 
	mutex_unlock(&mdev->io_mutex);

}



/**

/*

 * hdm_usb_fops - file operation table for USB driver

 */

static const struct file_operations hdm_usb_fops = {

	.owner = THIS_MODULE,

};



/**

/*

 * usb_device_id - ID table for HCD device probing

 */

static const struct usb_device_id usbid[] = {