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

staging: most: i2c: Fix a little doc-rot

Fixes the following W=1 kernel build warning(s):

drivers/staging/most/i2c/i2c.c:66: warning: Function parameter or member 'most_iface' not described in 'configure_channel'
drivers/staging/most/i2c/i2c.c:66: warning: Function parameter or member 'ch_idx' not described in 'configure_channel'
drivers/staging/most/i2c/i2c.c:66: warning: Excess function parameter 'iface' description in 'configure_channel'
drivers/staging/most/i2c/i2c.c:66: warning: Excess function parameter 'channel' description in 'configure_channel'
drivers/staging/most/i2c/i2c.c:121: warning: Function parameter or member 'most_iface' not described in 'enqueue'
drivers/staging/most/i2c/i2c.c:121: warning: Function parameter or member 'ch_idx' not described in 'enqueue'
drivers/staging/most/i2c/i2c.c:121: warning: Excess function parameter 'iface' description in 'enqueue'
drivers/staging/most/i2c/i2c.c:121: warning: Excess function parameter 'channel' description in 'enqueue'
drivers/staging/most/i2c/i2c.c:166: warning: Function parameter or member 'most_iface' not described in 'poison_channel'
drivers/staging/most/i2c/i2c.c:166: warning: Function parameter or member 'ch_idx' not described in 'poison_channel'
drivers/staging/most/i2c/i2c.c:166: warning: Excess function parameter 'iface' description in 'poison_channel'
drivers/staging/most/i2c/i2c.c:166: warning: Excess function parameter 'channel_id' description in 'poison_channel'

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Andrey Shvetsov <andrey.shvetsov@k2l.de>
Cc: linux-staging@lists.linux.dev
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210414181129.1628598-34-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
f74afcfd 1658384f

+6 -6
+6 -6
drivers/staging/most/i2c/i2c.c
··· 51 51 52 52 /** 53 53 * configure_channel - called from MOST core to configure a channel 54 - * @iface: interface the channel belongs to 55 - * @channel: channel to be configured 54 + * @most_iface: interface the channel belongs to 55 + * @ch_idx: channel to be configured 56 56 * @channel_config: structure that holds the configuration information 57 57 * 58 58 * Return 0 on success, negative on failure. ··· 107 107 108 108 /** 109 109 * enqueue - called from MOST core to enqueue a buffer for data transfer 110 - * @iface: intended interface 111 - * @channel: ID of the channel the buffer is intended for 110 + * @most_iface: intended interface 111 + * @ch_idx: ID of the channel the buffer is intended for 112 112 * @mbo: pointer to the buffer object 113 113 * 114 114 * Return 0 on success, negative on failure. ··· 153 153 154 154 /** 155 155 * poison_channel - called from MOST core to poison buffers of a channel 156 - * @iface: pointer to the interface the channel to be poisoned belongs to 157 - * @channel_id: corresponding channel ID 156 + * @most_iface: pointer to the interface the channel to be poisoned belongs to 157 + * @ch_idx: corresponding channel ID 158 158 * 159 159 * Return 0 on success, negative on failure. 160 160 *