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

Configure Feed

Select the types of activity you want to include in your feed.

intel_th: msu: Fix kernel-doc warnings

Correct function comments to prevent kernel-doc warnings
found when using "W=1".

msu.c:77: warning: Function parameter or member 'msc' not described in 'msc_window'
msu.c:122: warning: bad line:
msu.c:760: warning: No description found for return value of 'msc_configure'
msu.c:1309: warning: Function parameter or member 'nr_pages' not described in 'msc_buffer_alloc'
msu.c:1309: warning: Function parameter or member 'nr_wins' not described in 'msc_buffer_alloc'
msu.c:1309: warning: Excess function parameter 'size' description in 'msc_buffer_alloc'
msu.c:1376: warning: No description found for return value of 'msc_buffer_free_unless_used'
msu.c:1444: warning: No description found for return value of 'msc_win_to_user'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20240429130119.1518073-10-alexander.shishkin@linux.intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman 76e9f438 988001c7

+10 -2
+10 -2
drivers/hwtracing/intel_th/msu.c
··· 61 61 * @lo_lock: lockout state serialization 62 62 * @nr_blocks: number of blocks (pages) in this window 63 63 * @nr_segs: number of segments in this window (<= @nr_blocks) 64 + * @msc: pointer to the MSC device 64 65 * @_sgt: array of block descriptors 65 66 * @sgt: array of block descriptors 66 67 */ ··· 120 119 * @user_count: number of users of the buffer 121 120 * @mmap_count: number of mappings 122 121 * @buf_mutex: mutex to serialize access to buffer-related bits 123 - 124 122 * @enabled: MSC is enabled 125 123 * @wrap: wrapping is enabled 126 124 * @mode: MSC operating mode ··· 755 755 * Program storage mode, wrapping, burst length and trace buffer address 756 756 * into a given MSC. Then, enable tracing and set msc::enabled. 757 757 * The latter is serialized on msc::buf_mutex, so make sure to hold it. 758 + * 759 + * Return: %0 for success or a negative error code otherwise. 758 760 */ 759 761 static int msc_configure(struct msc *msc) 760 762 { ··· 1293 1291 /** 1294 1292 * msc_buffer_alloc() - allocate a buffer for MSC 1295 1293 * @msc: MSC device 1296 - * @size: allocation size in bytes 1294 + * @nr_pages: number of pages for each window 1295 + * @nr_wins: number of windows 1297 1296 * 1298 1297 * Allocate a storage buffer for MSC, depending on the msc::mode, it will be 1299 1298 * either done via msc_buffer_contig_alloc() for SINGLE operation mode or ··· 1373 1370 * @msc: MSC device 1374 1371 * 1375 1372 * This is a locked version of msc_buffer_unlocked_free_unless_used(). 1373 + * 1374 + * Return: 0 on successful deallocation or if there was no buffer to 1375 + * deallocate, -EBUSY if there are active users. 1376 1376 */ 1377 1377 static int msc_buffer_free_unless_used(struct msc *msc) 1378 1378 { ··· 1444 1438 * @data: callback's private data 1445 1439 * @src: source buffer 1446 1440 * @len: amount of data to copy from the source buffer 1441 + * 1442 + * Return: >= %0 for success or -errno for error. 1447 1443 */ 1448 1444 static unsigned long msc_win_to_user(void *data, void *src, size_t len) 1449 1445 {