Commit 6f4d367f authored Apr 14, 2021 by Lee Jones Committed by Greg Kroah-Hartman May 10, 2021

staging: most: dim2: Provide missing descriptions and fix doc-rot

Also demote merely half-complete header.

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

drivers/staging/most/dim2/dim2.c:69: warning: Function parameter or member 'name' not described in 'hdm_channel'
drivers/staging/most/dim2/dim2.c:69: warning: Function parameter or member 'reset_dbr_size' not described in 'hdm_channel'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'dev' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'name' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'clk_speed' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'clk' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'clk_pll' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'bus' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'on_netinfo' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:104: warning: Function parameter or member 'disable_platform' not described in 'dim2_hdm'
drivers/staging/most/dim2/dim2.c:440: warning: Function parameter or member 'most_iface' not described in 'configure_channel'
drivers/staging/most/dim2/dim2.c:440: warning: Function parameter or member 'ch_idx' not described in 'configure_channel'
drivers/staging/most/dim2/dim2.c:440: warning: Function parameter or member 'ccfg' not described in 'configure_channel'
drivers/staging/most/dim2/dim2.c:440: warning: Excess function parameter 'iface' description in 'configure_channel'
drivers/staging/most/dim2/dim2.c:440: warning: Excess function parameter 'channel' description in 'configure_channel'
drivers/staging/most/dim2/dim2.c:440: warning: Excess function parameter 'channel_config' description in 'configure_channel'
drivers/staging/most/dim2/dim2.c:558: warning: Function parameter or member 'most_iface' not described in 'enqueue'
drivers/staging/most/dim2/dim2.c:558: warning: Function parameter or member 'ch_idx' not described in 'enqueue'
drivers/staging/most/dim2/dim2.c:558: warning: Excess function parameter 'iface' description in 'enqueue'
drivers/staging/most/dim2/dim2.c:558: warning: Excess function parameter 'channel' description in 'enqueue'
drivers/staging/most/dim2/dim2.c:591: warning: Function parameter or member 'most_iface' not described in 'request_netinfo'
drivers/staging/most/dim2/dim2.c:591: warning: Function parameter or member 'ch_idx' not described in 'request_netinfo'
drivers/staging/most/dim2/dim2.c:591: warning: Function parameter or member 'on_netinfo' not described in 'request_netinfo'
drivers/staging/most/dim2/dim2.c:591: warning: Excess function parameter 'iface' description in 'request_netinfo'
drivers/staging/most/dim2/dim2.c:591: warning: Excess function parameter 'channel_id' description in 'request_netinfo'
drivers/staging/most/dim2/dim2.c:631: warning: Function parameter or member 'most_iface' not described in 'poison_channel'
drivers/staging/most/dim2/dim2.c:631: warning: Function parameter or member 'ch_idx' not described in 'poison_channel'
drivers/staging/most/dim2/dim2.c:631: warning: Excess function parameter 'iface' description in 'poison_channel'
drivers/staging/most/dim2/dim2.c:631: warning: Excess function parameter 'channel_id' description in 'poison_channel'

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Nícolas F. R. A. Prado" <nfraprado@protonmail.com>
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-30-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent 061e390b

drivers/staging/most/dim2/dim2.c

+13 −10

Original line number	Diff line number	Diff line
		@@ -50,8 +50,10 @@ static DECLARE_TASKLET_OLD(dim2_tasklet, dim2_tasklet_fn);

		/**
		* struct hdm_channel - private structure to keep channel specific data
		* @name: channel name
		* @is_initialized: identifier to know whether the channel is initialized
		* @ch: HAL specific channel data
		* @reset_dbr_size: reset DBR data buffer size
		* @pending_list: list to keep MBO's before starting transfer
		* @started_list: list to keep MBO's after starting transfer
		* @direction: channel direction (TX or RX)
		@@ -68,7 +70,7 @@ struct hdm_channel {
		enum most_channel_data_type data_type;
		};

		/**
		/*
		* struct dim2_hdm - private structure to keep interface specific data
		* @hch: an array of channel specific data
		* @most_iface: most interface structure
		@@ -428,9 +430,9 @@ static void complete_all_mbos(struct list_head *head)

		/**
		* configure_channel - initialize a channel
		* @iface: interface the channel belongs to
		* @channel: channel to be configured
		* @channel_config: structure that holds the configuration information
		* @most_iface: interface the channel belongs to
		* @ch_idx: channel index to be configured
		* @ccfg: structure that holds the configuration information
		*
		* Receives configuration information from mostcore and initialize
		* the corresponding channel. Return 0 on success, negative on failure.
		@@ -546,8 +548,8 @@ static int configure_channel(struct most_interface *most_iface, int ch_idx,

		/**
		* enqueue - enqueue a buffer for data transfer
		* @iface: intended interface
		* @channel: ID of the channel the buffer is intended for
		* @most_iface: intended interface
		* @ch_idx: ID of the channel the buffer is intended for
		* @mbo: pointer to the buffer object
		*
		* Push the buffer into pending_list and try to transfer one buffer from
		@@ -579,8 +581,9 @@ static int enqueue(struct most_interface *most_iface, int ch_idx,

		/**
		* request_netinfo - triggers retrieving of network info
		* @iface: pointer to the interface
		* @channel_id: corresponding channel ID
		* @most_iface: pointer to the interface
		* @ch_idx: corresponding channel ID
		* @on_netinfo: call-back used to deliver network status to mostcore
		*
		* Send a command to INIC which triggers retrieving of network info by means of
		* "Message exchange over MDP/MEP". Return 0 on success, negative on failure.
		@@ -621,8 +624,8 @@ static void request_netinfo(struct most_interface *most_iface, int ch_idx,

		/**
		* poison_channel - poison buffers of a channel
		* @iface: pointer to the interface the channel to be poisoned belongs to
		* @channel_id: corresponding channel ID
		* @most_iface: pointer to the interface the channel to be poisoned belongs to
		* @ch_idx: corresponding channel ID
		*
		* Destroy a channel and complete all the buffers in both started_list &
		* pending_list. Return 0 on success, negative on failure.