Commit 04190ec6 authored by Alexander Shishkin's avatar Alexander Shishkin Committed by Greg Kroah-Hartman
Browse files

intel_th: msu: Fix less trivial kernel-doc warnings 



Correct function comments to prevent kernel-doc warnings found when using
"W=1" that the drive-by fixers had trouble documenting and skipped over.

msu.c:168: warning: Function parameter or struct member 'msu_base' not described in 'msc'
msu.c:168: warning: Function parameter or struct member 'work' not described in 'msc'
msu.c:168: warning: Function parameter or struct member 'switch_on_unlock' not described in 'msc'
msu.c:168: warning: Function parameter or struct member 'iter_list' not described in 'msc'
msu.c:168: warning: Function parameter or struct member 'stop_on_full' not described in 'msc'
msu.c:168: warning: Function parameter or struct member 'do_irq' not described in 'msc'
msu.c:168: warning: Function parameter or struct member 'multi_is_broken' not described in 'msc'

Signed-off-by: default avatarAlexander Shishkin <alexander.shishkin@linux.intel.com>
Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20250211185017.1759193-3-alexander.shishkin@linux.intel.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 4738d3d3

drivers/hwtracing/intel_th/msu.c

+8 −1
Original line number Diff line number Diff line
@@ -105,13 +105,16 @@ struct msc_iter { 


/**

 * struct msc - MSC device representation

 * @reg_base:		register window base address

 * @reg_base:		register window base address for the entire MSU

 * @msu_base:		register window base address for this MSC

 * @thdev:		intel_th_device pointer

 * @mbuf:		MSU buffer, if assigned

 * @mbuf_priv:		MSU buffer's private data, if @mbuf

 * @work:		a work to stop the trace when the buffer is full

 * @win_list:		list of windows in multiblock mode

 * @single_sgt:		single mode buffer

 * @cur_win:		current window

 * @switch_on_unlock:	window to switch to when it becomes available

 * @nr_pages:		total number of pages allocated for this buffer

 * @single_sz:		amount of data in single mode

 * @single_wrap:	single mode wrap occurred
@@ -122,8 +125,12 @@ struct msc_iter { 
 * @user_count:		number of users of the buffer

 * @mmap_count:		number of mappings

 * @buf_mutex:		mutex to serialize access to buffer-related bits

 * @iter_list:		list of open file descriptor iterators

 * @stop_on_full:	stop the trace if the current window is full

 * @enabled:		MSC is enabled

 * @wrap:		wrapping is enabled

 * @do_irq:		IRQ resource is available, handle interrupts

 * @multi_is_broken:	multiblock mode enabled (not disabled by PCI drvdata)

 * @mode:		MSC operating mode

 * @burst_len:		write burst length

 * @index:		number of this MSC in the MSU