From patchwork Mon Nov 2 11:45:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 320260 Delivered-To: patch@linaro.org Received: by 2002:a92:7b12:0:0:0:0:0 with SMTP id w18csp3658163ilc; Mon, 2 Nov 2020 03:48:19 -0800 (PST) X-Google-Smtp-Source: ABdhPJzWPk2K4dxkXiYuSkFS5OuN2Wl5kTJ34EnPFBKpasPo81SLU/LrIFEDTUFElrV0XbS0424v X-Received: by 2002:a05:6402:1112:: with SMTP id u18mr16447886edv.349.1604317699766; Mon, 02 Nov 2020 03:48:19 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1604317699; cv=none; d=google.com; s=arc-20160816; b=R2J/Z9xODHWtNWgaHc856jiI0sspzZYkN/QZJDvfCKwTKmxhwE2/3ESxXmCfaMGmim PtahLT8uCQtxsvx4PkWawGCoJQRRwh9b7cbG1PQm/YYQcJWG9Xcaz1PfYbOqxAOkSnS0 ov4nNlio9m56W1gott16PzB50XNFUJgpcTO/Bwy7SssucZDAYUDX/18pHm04dHxyWpwI JgfesgfJFW6U2yYUQbKETxyYsOQ+DxZ3PYigcCgXu56Vy1+A536ezPLtWxE1jKZl+2+N zGK7VIBJCwux6QiI22EuGz9rL/Rk2vmQOSxbsIXuJuTZsD+8eqertsHEKNVgZ9IBiH2x vSLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=IWgM+9wLuX8CxFAK18XYYejQxSRrdtsxUWktHkjPbDM=; b=fQwOpndPXmH3zZJ9PPXSjuNRaviQ2eFSoYXpApbLsWoDGGBEBb7zFPaVy2r98pJlic 9UE0Eto5cduA06oplKlfTZUsCXiYdbM7gILRJWwcsaUP4TT8ndzuFEode9/oiGcMs7EW FsucDhgHduwgO7wmgIke3d+WhAnExWYL1407WAUypvPgVgXsODjHxu3yCGGRz+yfeVqo 3estsYrTwUgAw065gX4diniHVDaFcBrzw5N4SJnbA90OA7C5Ote5RbL+nepNtV0/hgeh AfdPwQKIzNVccGknIwMkAlFhHFYiv+pfmVdC0cHlL70RzFeRqGvyjz6FsD+v8Z/ejzOo et9Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=E6Fp50ul; spf=pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=netdev-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id a18si5278362edb.306.2020.11.02.03.48.19; Mon, 02 Nov 2020 03:48:19 -0800 (PST) Received-SPF: pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=E6Fp50ul; spf=pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=netdev-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728826AbgKBLsR (ORCPT + 8 others); Mon, 2 Nov 2020 06:48:17 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51376 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728660AbgKBLpw (ORCPT ); Mon, 2 Nov 2020 06:45:52 -0500 Received: from mail-wr1-x441.google.com (mail-wr1-x441.google.com [IPv6:2a00:1450:4864:20::441]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 321D1C061A48 for ; Mon, 2 Nov 2020 03:45:45 -0800 (PST) Received: by mail-wr1-x441.google.com with SMTP id n18so14211282wrs.5 for ; Mon, 02 Nov 2020 03:45:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=IWgM+9wLuX8CxFAK18XYYejQxSRrdtsxUWktHkjPbDM=; b=E6Fp50ulPAfuAJ6P5gCUm0zVao8mKSzXvbeCmHfykPE1YvpvDyXsSz+Q2Gl3X25pgS cIphkuRccC94rwEIfwRbgic+6QEQysrjw+3g6OV95uygyBShSSXVKixSsgLvIK+dD+RY JpQCTEjNt49VEK43k+g+1S+knd0zPP5GfGt82z1CG8WsIzEaMYIiL5ioSD2LOajWViEA QUIe3imS+ofT2HZKN+TvNazJt1XTQZBYh7Zrgmf6m5+vj73MVctzPfGK49IfyZOy5SDk bBkpri/Ulz7dh5vV0yRW7MFPkfmZk3X9tcAB5IoRFUUwoI1hLXZa55J72xKZxxy4Xso/ di0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=IWgM+9wLuX8CxFAK18XYYejQxSRrdtsxUWktHkjPbDM=; b=LDW8LMWTM/t49Fmqr8WL7oqhj28a6kaGvd/8VxVaFyMKlv+cHQHnfm8uDMLxuyOE/7 Q2wlb5R3l/bTBirw6FPLxF+JFZHLT4Q8Md8Ld1ppRwR5a6Sg+8NEB5NmpHMtLNxexFe2 zDugO2fMBcSps0Eie52lmvjCCPPw8XTCTb2fILJ7perXj+Bq06aURFdcibRxlXIYvncT Vfuo0yBkIQYtdi+eNubjDh3yvpXuzneVA/CcXZ6yhGce3+0H7yF/8OXQDEsCinN5PRXi JxAh0BLgPn7KDjaF1+NxL6yptjwcm8vfnUzTlemCvx6NY/SAA2hDkWksUZuHuNNTvL2H gxJw== X-Gm-Message-State: AOAM5332pBLRZGb1z2C3r9fbAAEaQWWCnipnTNsJA2P+lw06NSDInGmC GGdPU4KTFJnc7ztZnL0PKQDy3A== X-Received: by 2002:adf:e849:: with SMTP id d9mr21045411wrn.25.1604317543902; Mon, 02 Nov 2020 03:45:43 -0800 (PST) Received: from dell.default ([91.110.221.242]) by smtp.gmail.com with ESMTPSA id g66sm15545352wmg.37.2020.11.02.03.45.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Nov 2020 03:45:43 -0800 (PST) From: Lee Jones To: davem@davemloft.net Cc: Lee Jones , Harry Morris , Alexander Aring , Stefan Schmidt , Jakub Kicinski , linux-wpan@vger.kernel.org, netdev@vger.kernel.org Subject: [PATCH 20/30] net: ieee802154: ca8210: Fix a bunch of kernel-doc issues Date: Mon, 2 Nov 2020 11:45:02 +0000 Message-Id: <20201102114512.1062724-21-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102114512.1062724-1-lee.jones@linaro.org> References: <20201102114512.1062724-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Fixes the following W=1 kernel build warning(s): drivers/net/ieee802154/ca8210.c:326: warning: Function parameter or member 'readq' not described in 'ca8210_test' drivers/net/ieee802154/ca8210.c:375: warning: Function parameter or member 'spi_transfer_complete' not described in 'ca8210_priv' drivers/net/ieee802154/ca8210.c:375: warning: Function parameter or member 'sync_exchange_complete' not described in 'ca8210_priv' drivers/net/ieee802154/ca8210.c:375: warning: Function parameter or member 'promiscuous' not described in 'ca8210_priv' drivers/net/ieee802154/ca8210.c:430: warning: Function parameter or member 'short_address' not described in 'macaddr' drivers/net/ieee802154/ca8210.c:723: warning: Function parameter or member 'cas_ctl' not described in 'ca8210_rx_done' drivers/net/ieee802154/ca8210.c:723: warning: Excess function parameter 'arg' description in 'ca8210_rx_done' drivers/net/ieee802154/ca8210.c:1289: warning: Excess function parameter 'device_ref' description in 'tdme_checkpibattribute' drivers/net/ieee802154/ca8210.c:3054: warning: Function parameter or member 'spi_device' not described in 'ca8210_remove' drivers/net/ieee802154/ca8210.c:3054: warning: Excess function parameter 'priv' description in 'ca8210_remove' drivers/net/ieee802154/ca8210.c:3104: warning: Function parameter or member 'spi_device' not described in 'ca8210_probe' drivers/net/ieee802154/ca8210.c:3104: warning: Excess function parameter 'priv' description in 'ca8210_probe' Cc: Harry Morris Cc: Alexander Aring Cc: Stefan Schmidt Cc: "David S. Miller" Cc: Jakub Kicinski Cc: linux-wpan@vger.kernel.org Cc: netdev@vger.kernel.org Signed-off-by: Lee Jones --- drivers/net/ieee802154/ca8210.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) -- 2.25.1 Acked-by: Stefan Schmidt diff --git a/drivers/net/ieee802154/ca8210.c b/drivers/net/ieee802154/ca8210.c index 4eb64709d44cb..9b3ab7acad37e 100644 --- a/drivers/net/ieee802154/ca8210.c +++ b/drivers/net/ieee802154/ca8210.c @@ -316,6 +316,7 @@ struct cas_control { * struct ca8210_test - ca8210 test interface structure * @ca8210_dfs_spi_int: pointer to the entry in the debug fs for this device * @up_fifo: fifo for upstream messages + * @readq: read wait queue * * This structure stores all the data pertaining to the debug interface */ @@ -346,12 +347,12 @@ struct ca8210_test { * @ca8210_is_awake: nonzero if ca8210 is initialised, ready for comms * @sync_down: counts number of downstream synchronous commands * @sync_up: counts number of upstream synchronous commands - * @spi_transfer_complete completion object for a single spi_transfer - * @sync_exchange_complete completion object for a complete synchronous API - * exchange - * @promiscuous whether the ca8210 is in promiscuous mode or not + * @spi_transfer_complete: completion object for a single spi_transfer + * @sync_exchange_complete: completion object for a complete synchronous API + * exchange + * @promiscuous: whether the ca8210 is in promiscuous mode or not * @retries: records how many times the current pending spi - * transfer has been retried + * transfer has been retried */ struct ca8210_priv { struct spi_device *spi; @@ -420,8 +421,8 @@ struct fulladdr { /** * union macaddr: generic MAC address container - * @short_addr: 16-bit short address - * @ieee_address: 64-bit extended address as LE byte array + * @short_address: 16-bit short address + * @ieee_address: 64-bit extended address as LE byte array * */ union macaddr { @@ -714,7 +715,7 @@ static void ca8210_mlme_reset_worker(struct work_struct *work) /** * ca8210_rx_done() - Calls various message dispatches responding to a received * command - * @arg: Pointer to the cas_control object for the relevant spi transfer + * @cas_ctrl: Pointer to the cas_control object for the relevant spi transfer * * Presents a received SAP command from the ca8210 to the Cascoda EVBME, test * interface and network driver. @@ -1277,7 +1278,6 @@ static u8 tdme_channelinit(u8 channel, void *device_ref) * @pib_attribute: Attribute Number * @pib_attribute_length: Attribute length * @pib_attribute_value: Pointer to Attribute Value - * @device_ref: Nondescript pointer to target device * * Return: 802.15.4 status code of checks */ @@ -3046,7 +3046,7 @@ static void ca8210_test_interface_clear(struct ca8210_priv *priv) /** * ca8210_remove() - Shut down a ca8210 upon being disconnected - * @priv: Pointer to private data structure + * @spi_device: Pointer to spi device data structure * * Return: 0 or linux error code */ @@ -3096,7 +3096,7 @@ static int ca8210_remove(struct spi_device *spi_device) /** * ca8210_probe() - Set up a connected ca8210 upon being detected by the system - * @priv: Pointer to private data structure + * @spi_device: Pointer to spi device data structure * * Return: 0 or linux error code */