From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.5 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 71342C38A30 for ; Sat, 18 Apr 2020 12:37:58 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4709B206D9 for ; Sat, 18 Apr 2020 12:37:58 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=gmx.net header.i=@gmx.net header.b="c0tHAiCY" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726050AbgDRMh5 (ORCPT ); Sat, 18 Apr 2020 08:37:57 -0400 Received: from mout.gmx.net ([212.227.15.15]:41333 "EHLO mout.gmx.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725804AbgDRMhy (ORCPT ); Sat, 18 Apr 2020 08:37:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1587213462; bh=Nv/90+/Hq71cvdxi2hkZt7Oq59PfL7K9OjVLWz8Wb6E=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=c0tHAiCYl/tAzAdx48pC2y1yZ4u2SvgR4Tsr3H/pljz9Gd99YeEAWj3m/LnYMEZh2 JOzbjayfeGV385oIotZzyS9KRLyVBFHmerQcugmi2hEVZdzTds4u5jCsPB4KbWWs2v r9kOGq5caQpFiM+jis1avBQ8ck719E6OMPXOajJg= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from localhost.localdomain ([83.52.229.196]) by mail.gmx.com (mrgmx005 [212.227.17.184]) with ESMTPSA (Nemesis) id 1MwQT9-1j9Lpw3ZUD-00sMNp; Sat, 18 Apr 2020 14:37:42 +0200 From: Oscar Carter To: Forest Bond , Greg Kroah-Hartman Cc: Oscar Carter , Quentin Deslandes , Malcolm Priestley , Amir Mahdi Ghorbanian , Stefano Brivio , "John B. Wyatt IV" , Colin Ian King , Dan Carpenter , devel@driverdev.osuosl.org, linux-kernel@vger.kernel.org Subject: [PATCH 2/2] staging: vt6656: Fix functions' documentation Date: Sat, 18 Apr 2020 14:36:59 +0200 Message-Id: <20200418123659.4475-3-oscar.carter@gmx.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200418123659.4475-1-oscar.carter@gmx.com> References: <20200418123659.4475-1-oscar.carter@gmx.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Provags-ID: V03:K1:mB4zQowuyWmvxC+Wq3YX8wOLaAnyQfTLIS2TSz5ejVjujx6ZJLE xqpP/0pUOoraAPpxY6+2CDpZGFhMVBgztmBjBkHUxEkR4+z0nmiH14CQvU7/eASxuZM6Utb hYRj1a3Knfbk5+b5zvT+4Y9HopDYe/1EgArk/r6O3AUSUPie/RdzUv1wvc3FtNlPk7Z6D2R 6YStcaMFYWEsBzgttydIg== X-UI-Out-Filterresults: notjunk:1;V03:K0:FBoiNOo5RIs=:E0OZgooBgRiI56cRGMzDMI m/s+rexf43ovAoikMZhz6uC8vTUhRdXUwUSwLHi1pFpAAX9iz2OAl1xKYUSXO4Iyycv8qH6LM VPGa9oyJYGYXKqVXAZ0wa58tPJJ9DDpH6i2Bado4Pz7/YJwIQWOB4XgucdXh1oYKMhX2CczSW cfaho26PIIWvXEUVTneMl0v3XrbLt91KpaULMt8ESmcGf2opAn5pgmXcYqZLT6gr6EMaMrhOH Yj/lc1KofAjVWz7BwK6uEdJ5IbscdvBuvAbyD3dpMAvWCh+6q80AYOmKM2XbiKuhEbwbNLAKN l9zBGDFqCxBhvr1e4NzhYg0cPrawiNKG6h+nx+UPgrHHG56PE06L09busfrS76MOZSOX5iUpZ MVQiQyYuiLDcx9sv4TXmEyV+1zD+UZZ+tGMEIeJ6aNruFyEXQU74A3BP/tibbk6zN/nuPiwxF oUa29HajsABuDbHIgcrHkCW8ssja+I7vSBifMKKIlTAP5zk1dddMu+ln65cYvsJjLrzZHNnk3 9vXkYDxQRksyIJj4Uzpjd22WF3yONySzzltWzdrlVE7R029QikkgNr9E7fZE8vaXEB/vroMbR oPY+njzWHlqmyU9lW9iM8llxYbaCPDMBVlepBBUKvr5X7CmzIrtTkJ1Uqimtu4BkQasj/gyZn A7Png1B6HVCbCRRHLIXQxkMRG03XZmnSAj+pWqFJfjX0qcuBCbKkC7rF6OJ23//is8YEUQTXW dW0hkPRU8VT11PTBc29GCB05dxMpfscdey+NGYvQBPCZv5CZA5pyIPaKPnW16rZNASDXoGi2E XxIdgKbUse899pa1qcVvreEPY8lopeA/M6vYrLlAToalbdxtQxw/wgvg0TRAGeqx6cmmolf4L rbaisiVXUqsXkLYIecSrJvjoUFsjmR0jdElY92pBO8ncjYSYgvRiwvQACTAOSNbA6Su+r+CGC BaOfvXF0hhc79UYjD5jk9i3JfF7hBxArOgZNnIADx8XjZF0Ppsp0BgDnkyIsKRyMj/2S2nyD+ HgJWaNLag2h8WbFauVA4JNFuH4vqTRfVDS3tFt5YpYWZLDwPNE8qwMsTIS1viWUnngp4Xpge0 EIGoX48lfnsvawuXxb0B6qJfw2w5Wj7O3ZK81lOxw0HMrOvI0juc+Ny9+SZkx1KuXUha3B+va rCnJseMpxBoxnkp/otyYp23cmUvQhl1I30jZmzDuKTCaNeXerTdEsPBslOcGB0c4KnBzCF2+h V1Q8FO2DqI2dUKxQe Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Replace the functions' documentation by the kernel-doc style fixing the parameters and return value. Signed-off-by: Oscar Carter =2D-- drivers/staging/vt6656/card.c | 101 +++++++++++---------------------- drivers/staging/vt6656/mac.c | 67 ++++++++-------------- drivers/staging/vt6656/power.c | 12 ++-- 3 files changed, 61 insertions(+), 119 deletions(-) diff --git a/drivers/staging/vt6656/card.c b/drivers/staging/vt6656/card.c index 99ad56b7617d..51acf2212577 100644 =2D-- a/drivers/staging/vt6656/card.c +++ b/drivers/staging/vt6656/card.c @@ -46,15 +46,12 @@ static const u16 cw_rxbcntsf_off[MAX_RATE] =3D { 192, 96, 34, 17, 34, 23, 17, 11, 8, 5, 4, 3 }; -/* - * Description: Set NIC media channel +/** + * vnt_set_channel - Set NIC media channel. + * @priv: The adapter to be set. + * @connection_channel: The channel to be set. * - * Parameters: - * In: - * pDevice - The adapter to be set - * connection_channel - Channel to be set - * Out: - * none + * Return: 0 if successful, or a negative error code on failure. */ int vnt_set_channel(struct vnt_private *priv, u32 connection_channel) { @@ -99,19 +96,13 @@ static const u8 vnt_rspinf_gb_table[] =3D { 0x0e, 0x8d, 0x0a, 0x88, 0x0a, 0x8c, 0x0a, 0x8c, 0x0a }; -/* - * Description: Set RSPINF - * - * Parameters: - * In: - * pDevice - The adapter to be set - * Out: - * none - * - * Return Value: None. +/** + * vnt_set_rspinf - Set RSPINF. + * @priv: The adapter to be set. + * @bb_type: The base band type. * + * Return: 0 if successful, or a negative error code on failure. */ - int vnt_set_rspinf(struct vnt_private *priv, u8 bb_type) { const u8 *data; @@ -145,17 +136,11 @@ int vnt_set_rspinf(struct vnt_private *priv, u8 bb_t= ype) MESSAGE_REQUEST_MACREG, len, data); } -/* - * Description: Update IFS - * - * Parameters: - * In: - * priv - The adapter to be set - * Out: - * none - * - * Return Value: None. +/** + * vnt_update_ifs - Update IFS. + * @priv: The adapter to be set. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_update_ifs(struct vnt_private *priv) { @@ -300,20 +285,14 @@ u64 vnt_get_tsf_offset(u8 rx_rate, u64 tsf1, u64 tsf= 2) return tsf1 - tsf2 - (u64)cw_rxbcntsf_off[rx_rate % MAX_RATE]; } -/* - * Description: Sync. TSF counter to BSS - * Get TSF offset and write to HW - * - * Parameters: - * In: - * priv - The adapter to be sync. - * time_stamp - Rx BCN's TSF - * local_tsf - Local TSF - * Out: - * none - * - * Return Value: none +/** + * vnt_adjust_tsf - Sync TSF counter to BSS. Get TSF offset and write to = HW. + * @priv: The adapter to be set. + * @rx_rate: The Rx rate. + * @time_stamp: The Rx BCN's TSF. + * @local_tsf: The local TSF. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_adjust_tsf(struct vnt_private *priv, u8 rx_rate, u64 time_stamp, u64 local_tsf) @@ -408,19 +387,13 @@ u64 vnt_get_next_tbtt(u64 tsf, u16 beacon_interval) return tsf; } -/* - * Description: Set NIC TSF counter for first Beacon time - * Get NEXTTBTT from adjusted TSF and Beacon Interval - * - * Parameters: - * In: - * dwIoBase - IO Base - * beacon_interval - Beacon Interval - * Out: - * none - * - * Return Value: none +/** + * vnt_reset_next_tbtt - Set NIC TSF counter for first beacon time. Get + * NEXTTBTT from adjusted TSF and beacon interval. + * @priv: The adapter to be set. + * @beacon_interval: The beacon interval. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_reset_next_tbtt(struct vnt_private *priv, u16 beacon_interval) { @@ -444,20 +417,14 @@ int vnt_reset_next_tbtt(struct vnt_private *priv, u1= 6 beacon_interval) MESSAGE_REQUEST_TBTT, 0, 8, data); } -/* - * Description: Sync NIC TSF counter for Beacon time - * Get NEXTTBTT and write to HW - * - * Parameters: - * In: - * priv - The adapter to be set - * tsf - Current TSF counter - * beacon_interval - Beacon Interval - * Out: - * none - * - * Return Value: none +/** + * vnt_update_next_tbtt - Sync NIC TSF counter for beacon time. Get NEXTT= BTT + * and write to HW. + * @priv: The adapter to be set. + * @tsf: The current TSF counter. + * @beacon_interval: The beacon interval. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_update_next_tbtt(struct vnt_private *priv, u64 tsf, u16 beacon_interval) diff --git a/drivers/staging/vt6656/mac.c b/drivers/staging/vt6656/mac.c index 639172fad0f3..c4b541178109 100644 =2D-- a/drivers/staging/vt6656/mac.c +++ b/drivers/staging/vt6656/mac.c @@ -22,18 +22,12 @@ #include "mac.h" #include "usbpipe.h" -/* - * Description: - * Write MAC Multicast Address Mask - * - * Parameters: - * In: - * mc_filter (mac filter) - * Out: - * none - * - * Return Value: none +/** + * vnt_mac_set_filter - Write MAC multicast address mask. + * @priv: The adapter to be set. + * @mc_filter: The mac filter. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_mac_set_filter(struct vnt_private *priv, u64 mc_filter) { @@ -44,16 +38,11 @@ int vnt_mac_set_filter(struct vnt_private *priv, u64 m= c_filter) (u8 *)&le_mc); } -/* - * Description: - * Shut Down MAC - * - * Parameters: - * In: - * Out: - * none - * +/** + * vnt_mac_shutdown - Shut down MAC. + * @priv: The adapter to be set. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_mac_shutdown(struct vnt_private *priv) { @@ -72,19 +61,12 @@ int vnt_mac_set_bb_type(struct vnt_private *priv, u8 t= ype) data); } -/* - * Description: - * Disable the Key Entry by MISCFIFO - * - * Parameters: - * In: - * dwIoBase - Base Address for MAC - * - * Out: - * none - * - * Return Value: none +/** + * vnt_mac_disable_keyentry - Disable the key entry by MISCFIFO. + * @priv: The adapter to be set. + * @entry_idx: The entry index. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_mac_disable_keyentry(struct vnt_private *priv, u8 entry_idx) { @@ -92,19 +74,16 @@ int vnt_mac_disable_keyentry(struct vnt_private *priv,= u8 entry_idx) sizeof(entry_idx), &entry_idx); } -/* - * Description: - * Set the Key by MISCFIFO - * - * Parameters: - * In: - * dwIoBase - Base Address for MAC - * - * Out: - * none - * - * Return Value: none +/** + * vnt_mac_set_keyentry - Set the key by MISCFIFO. + * @priv: The adapter to be set. + * @key_ctl: The key control. + * @entry_idx: The entry index. + * @key_idx: The key index. + * @addr: The ethernet address. + * @key: The key. * + * Return: 0 if successful, or a negative error code on failure. */ int vnt_mac_set_keyentry(struct vnt_private *priv, u16 key_ctl, u32 entry= _idx, u32 key_idx, u8 *addr, u8 *key) diff --git a/drivers/staging/vt6656/power.c b/drivers/staging/vt6656/power= .c index 2d8d5a332a63..cca50c9f4087 100644 =2D-- a/drivers/staging/vt6656/power.c +++ b/drivers/staging/vt6656/power.c @@ -77,16 +77,12 @@ void vnt_enable_power_saving(struct vnt_private *priv,= u16 listen_interval) dev_dbg(&priv->usb->dev, "PS:Power Saving Mode Enable...\n"); } -/* - * - * Routine Description: - * Disable hw power saving functions - * - * Return Value: - * None. +/** + * vnt_disable_power_saving - Disable hw power saving functions. + * @priv: The adapter to be set. * + * Return: 0 if successful, or a negative error code on failure. */ - int vnt_disable_power_saving(struct vnt_private *priv) { int ret; =2D- 2.20.1