Commit 64403dc3 authored Aug 26, 2020 by Lee Jones Committed by Kalle Valo Sep 01, 2020

rsi: rsi_91x_sdio: Fix a few kernel-doc related issues



- File headers do not make for good kernel-doc candidates
 - Kernel-doc header lines should start with " *"
 - Fix doc-rot issue

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

 drivers/net/wireless/rsi/rsi_91x_sdio.c:25: warning: cannot understand function prototype: 'u16 dev_oper_mode = DEV_OPMODE_STA_BT_DUAL; '
 drivers/net/wireless/rsi/rsi_91x_sdio.c:802: warning: bad line:                                    from the device.
 drivers/net/wireless/rsi/rsi_91x_sdio.c:842: warning: Function parameter or member 'pfunction' not described in 'rsi_init_sdio_interface'
 drivers/net/wireless/rsi/rsi_91x_sdio.c:842: warning: Excess function parameter 'pkt' description in 'rsi_init_sdio_interface'

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/20200826093401.1458456-17-lee.jones@linaro.org

parent b95451e0

drivers/net/wireless/rsi/rsi_91x_sdio.c

+3 −4

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
		@@ -799,7 +799,7 @@ static int rsi_sdio_host_intf_write_pkt(struct rsi_hw *adapter,

		/**
		* rsi_sdio_host_intf_read_pkt() - This function reads the packet
		from the device.
		* from the device.
		* @adapter: Pointer to the adapter data structure.
		* @pkt: Pointer to the packet data to be read from the the device.
		* @length: Length of the data to be read from the device.
		@@ -832,11 +832,10 @@ int rsi_sdio_host_intf_read_pkt(struct rsi_hw *adapter,
		* rsi_init_sdio_interface() - This function does init specific to SDIO.
		*
		* @adapter: Pointer to the adapter data structure.
		* @pkt: Pointer to the packet data to be read from the the device.
		* @pfunction: Pointer to the sdio_func structure.
		*
		* Return: 0 on success, -1 on failure.
		*/

		static int rsi_init_sdio_interface(struct rsi_hw *adapter,
		struct sdio_func *pfunction)
		{