Commit 470d48c1 authored Aug 19, 2020 by Lee Jones Committed by Kalle Valo Sep 01, 2020

rsi: Fix some kernel-doc issues

The file header should not be kernel-doc. Add missing 'rec_pkt'
description. Update 'rsi_91x_init()'s parameter description.

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

drivers/net/wireless/rsi/rsi_91x_main.c:17: warning: Function parameter or member 'fmt' not described in 'pr_fmt'
drivers/net/wireless/rsi/rsi_91x_main.c:156: warning: Function parameter or member 'rx_pkt' not described in 'rsi_read_pkt'
drivers/net/wireless/rsi/rsi_91x_main.c:287: warning: Function parameter or member 'oper_mode' not described in 'rsi_91x_init'
drivers/net/wireless/rsi/rsi_91x_main.c:287: warning: Excess function parameter 'void' description in 'rsi_91x_init'

Cc: Amitkumar Karwar <amitkarwar@gmail.com>
Cc: Siva Rebbagondla <siva8118@gmail.com>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20200819072402.3085022-3-lee.jones@linaro.org

parent 34537d49

drivers/net/wireless/rsi/rsi_91x_main.c

+3 −2

Original line number	Diff line number	Diff line
		/**
		/*
		* Copyright (c) 2014 Redpine Signals Inc.
		*
		* Permission to use, copy, modify, and/or distribute this software for any
		@@ -148,6 +148,7 @@ static struct sk_buff rsi_prepare_skb(struct rsi_common common,
		/**
		* rsi_read_pkt() - This function reads frames from the card.
		* @common: Pointer to the driver private structure.
		* @rcv_pkt: Received pkt.
		* @rcv_pkt_len: Received pkt length. In case of USB it is 0.
		*
		* Return: 0 on success, -1 on failure.
		@@ -279,7 +280,7 @@ void rsi_set_bt_context(void priv, void bt_context)

		/**
		* rsi_91x_init() - This function initializes os interface operations.
		* @void: Void.
		* @oper_mode: One of DEV_OPMODE_*.
		*
		* Return: Pointer to the adapter structure on success, NULL on failure .
		*/