From patchwork Thu Nov 26 13:38:50 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 332975 Delivered-To: patch@linaro.org Received: by 2002:a17:906:4755:0:0:0:0 with SMTP id j21csp152729ejs; Thu, 26 Nov 2020 05:39:45 -0800 (PST) X-Google-Smtp-Source: ABdhPJyKuaNdenMqMhcsZGySm22ORZE4Nn4xhG5f0sUz4Lzci+Sm/vOnGWKsPhJCRBjRLr3Ns9rI X-Received: by 2002:a17:906:2c44:: with SMTP id f4mr2769425ejh.139.1606397985441; Thu, 26 Nov 2020 05:39:45 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1606397985; cv=none; d=google.com; s=arc-20160816; b=Qt3idhWfUQHh/E/q9YIC04/IHPgQ0GgbXi36C9wObOGFS6MwiDBnwYP2MMway+JvVV lHFhdh9jICl6yrDPErgjnf4lIruFf3DIB3r556+C1F8hMerJD9n41ptwDeC5+4bsxlXR 6UI3zBe3YnnlZj7KarSuxjTBi7Zhi6LX9Uf36OmRDBzV7KJ4Rp4U0atoBGaHS7ak5QMy pFxIZYN/KsoY0/10BzJHfTs6FaKt43Yw7tp92ttEKfYwWXRabDqHWJCRs+QvKANoKX0p vsTSgG9D0e1WNxOh+zQM4hT5KjBGU1cG/NpVNDMEyy0atZJPGycT5peIMtfC8aL+clhP QOzg== 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=J04TG1Pd2VMEs10XeVongpt36rd/B3l0W5A2vaR7ZWw=; b=AqJ81Uz1xv6RB7yD5bq5HQzISnqAwpSigiV5W6ctQuOWPCa2waTxBLN0q0jecOXcKg KZuotu3oOF0Lv4Qg9AuUbBSibk01Un4p3BtlJI2QFt/z4QuAq7rMLCW5PhgMEJc6uqKg R1CklECngE6Lptv3/XQ3JkKw1b5qbtKZUgw1XgaCPTuU/ZWYJ9y77Yn4uBC4prDXg8/q J3BLtkr+mwsjbNSvPqwi/Ok9J/fd+aBKMY22wLgW6gdyQaZIHDsu5BV9ggsw8x12oiAI SzPycaYMQdgnic2dVfiUEQEXdDC367h5FPNOFyKt0rg9096bScJkp9LSd6ZX57kI6Pvn 8C8w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ASuVkVTc; 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 bt20si3037473edb.405.2020.11.26.05.39.45; Thu, 26 Nov 2020 05:39:45 -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=ASuVkVTc; 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 S2390585AbgKZNjb (ORCPT + 8 others); Thu, 26 Nov 2020 08:39:31 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58226 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2390522AbgKZNjG (ORCPT ); Thu, 26 Nov 2020 08:39:06 -0500 Received: from mail-wr1-x444.google.com (mail-wr1-x444.google.com [IPv6:2a00:1450:4864:20::444]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 44CB3C0613D4 for ; Thu, 26 Nov 2020 05:39:06 -0800 (PST) Received: by mail-wr1-x444.google.com with SMTP id r3so2201416wrt.2 for ; Thu, 26 Nov 2020 05:39:06 -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=J04TG1Pd2VMEs10XeVongpt36rd/B3l0W5A2vaR7ZWw=; b=ASuVkVTcgwd/WCUwH04MEIkheHtx5Wjw2rIYLxShk06kubCFMXm+otYbDyMnX4BqK7 Sw1YvK+F3whskVSDQyijQJWP7yXIzzCYuEDLCKtx2CaUJkAaRY1C2HtdJ2Z8I09aj+rp S7o4H42oKh3GRNmuAm5XHVbFFoICws/3LxAPUwMelCmfba3MAskBeFnhHo7SrMLj9Qzv pqCV6UV2zzo6SwVIk6pGdX+MUAIfe4Jcqn7ui7qfpp/Tex0G3XWC9wWhnwJfB/nUIj9q Op9fEXSZhUanQjdXi4sNoUK3Vohya2vRNVaOZcacB5tfg2zCCFjjNgHXL1xH6rtkqcV6 H9iw== 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=J04TG1Pd2VMEs10XeVongpt36rd/B3l0W5A2vaR7ZWw=; b=MXjMxmkih2S97j7Jj0PGRoDOr5oZmimDccPfKnkYLZMhEpCw9RAobO3NjZl+QFb4Gv uYA7Rvgtn6fJHG19kgb/LTI8VbE/O4QQdiQQAPaFf5zKTNLQ6N82YJOu2oHUQxAN+RNL 1BIPoxjATWb0DYHT5pTG8y1R5I1bIz+am/YNPByJcSeHmlX9PRqsxeASFeyQp6Pqqw+O i8dxQj8jGjXaOINedd/NTNFRamSZnAXlWj8YF7Ah9oP4cYKnvJMC0x64gaTOSQWO8vHb ThhaDITLOPbTcDPfcY+vLfjJaYR6bvwt4BnjfLTLbyrXIPz1evG/AjWzuUkX3YVXGlcs m37Q== X-Gm-Message-State: AOAM530WU1dGhr9w9x8LgAU6NkO1AXV81mRrPNWO6JOQlKzBR0w3WGtN mBD/MU6E9fax5pxuFi50JMpxLg== X-Received: by 2002:a5d:4cca:: with SMTP id c10mr3926754wrt.176.1606397944966; Thu, 26 Nov 2020 05:39:04 -0800 (PST) Received: from dell.default ([91.110.221.235]) by smtp.gmail.com with ESMTPSA id s133sm7035825wmf.38.2020.11.26.05.39.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 26 Nov 2020 05:39:03 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Dany Madden , Lijun Pan , Sukadev Bhattiprolu , Michael Ellerman , Benjamin Herrenschmidt , Paul Mackerras , "David S. Miller" , Jakub Kicinski , Santiago Leon , Thomas Falcon , John Allen , netdev@vger.kernel.org, linuxppc-dev@lists.ozlabs.org Subject: [PATCH 5/8] net: ethernet: ibm: ibmvnic: Fix some kernel-doc misdemeanours Date: Thu, 26 Nov 2020 13:38:50 +0000 Message-Id: <20201126133853.3213268-6-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201126133853.3213268-1-lee.jones@linaro.org> References: <20201126133853.3213268-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): from drivers/net/ethernet/ibm/ibmvnic.c:35: inlined from ‘handle_vpd_rsp’ at drivers/net/ethernet/ibm/ibmvnic.c:4124:3: drivers/net/ethernet/ibm/ibmvnic.c:1362: warning: Function parameter or member 'hdr_field' not described in 'build_hdr_data' drivers/net/ethernet/ibm/ibmvnic.c:1362: warning: Function parameter or member 'skb' not described in 'build_hdr_data' drivers/net/ethernet/ibm/ibmvnic.c:1362: warning: Function parameter or member 'hdr_len' not described in 'build_hdr_data' drivers/net/ethernet/ibm/ibmvnic.c:1362: warning: Function parameter or member 'hdr_data' not described in 'build_hdr_data' drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Function parameter or member 'hdr_field' not described in 'create_hdr_descs' drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Function parameter or member 'hdr_data' not described in 'create_hdr_descs' drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Function parameter or member 'len' not described in 'create_hdr_descs' drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Function parameter or member 'hdr_len' not described in 'create_hdr_descs' drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Function parameter or member 'scrq_arr' not described in 'create_hdr_descs' drivers/net/ethernet/ibm/ibmvnic.c:1474: warning: Function parameter or member 'txbuff' not described in 'build_hdr_descs_arr' drivers/net/ethernet/ibm/ibmvnic.c:1474: warning: Function parameter or member 'num_entries' not described in 'build_hdr_descs_arr' drivers/net/ethernet/ibm/ibmvnic.c:1474: warning: Function parameter or member 'hdr_field' not described in 'build_hdr_descs_arr' drivers/net/ethernet/ibm/ibmvnic.c:1832: warning: Function parameter or member 'adapter' not described in 'do_change_param_reset' drivers/net/ethernet/ibm/ibmvnic.c:1832: warning: Function parameter or member 'rwi' not described in 'do_change_param_reset' drivers/net/ethernet/ibm/ibmvnic.c:1832: warning: Function parameter or member 'reset_state' not described in 'do_change_param_reset' drivers/net/ethernet/ibm/ibmvnic.c:1911: warning: Function parameter or member 'adapter' not described in 'do_reset' drivers/net/ethernet/ibm/ibmvnic.c:1911: warning: Function parameter or member 'rwi' not described in 'do_reset' drivers/net/ethernet/ibm/ibmvnic.c:1911: warning: Function parameter or member 'reset_state' not described in 'do_reset' Cc: Dany Madden Cc: Lijun Pan Cc: Sukadev Bhattiprolu Cc: Michael Ellerman Cc: Benjamin Herrenschmidt Cc: Paul Mackerras Cc: "David S. Miller" Cc: Jakub Kicinski Cc: Santiago Leon Cc: Thomas Falcon Cc: John Allen Cc: netdev@vger.kernel.org Cc: linuxppc-dev@lists.ozlabs.org Signed-off-by: Lee Jones --- drivers/net/ethernet/ibm/ibmvnic.c | 28 ++++++++++++++-------------- drivers/net/xen-netfront.c | 6 +++--- 2 files changed, 17 insertions(+), 17 deletions(-) -- 2.25.1 diff --git a/drivers/net/ethernet/ibm/ibmvnic.c b/drivers/net/ethernet/ibm/ibmvnic.c index b0884eba568d7..36ea37721e3c8 100644 --- a/drivers/net/ethernet/ibm/ibmvnic.c +++ b/drivers/net/ethernet/ibm/ibmvnic.c @@ -1376,10 +1376,10 @@ static int ibmvnic_close(struct net_device *netdev) /** * build_hdr_data - creates L2/L3/L4 header data buffer - * @hdr_field - bitfield determining needed headers - * @skb - socket buffer - * @hdr_len - array of header lengths - * @tot_len - total length of data + * @hdr_field: bitfield determining needed headers + * @skb: socket buffer + * @hdr_len: array of header lengths + * @tot_len: total length of data * * Reads hdr_field to determine which headers are needed by firmware. * Builds a buffer containing these headers. Saves individual header @@ -1436,11 +1436,11 @@ static int build_hdr_data(u8 hdr_field, struct sk_buff *skb, /** * create_hdr_descs - create header and header extension descriptors - * @hdr_field - bitfield determining needed headers - * @data - buffer containing header data - * @len - length of data buffer - * @hdr_len - array of individual header lengths - * @scrq_arr - descriptor array + * @hdr_field: bitfield determining needed headers + * @data: buffer containing header data + * @len: length of data buffer + * @hdr_len: array of individual header lengths + * @scrq_arr: descriptor array * * Creates header and, if needed, header extension descriptors and * places them in a descriptor array, scrq_arr @@ -1488,10 +1488,10 @@ static int create_hdr_descs(u8 hdr_field, u8 *hdr_data, int len, int *hdr_len, /** * build_hdr_descs_arr - build a header descriptor array - * @skb - socket buffer - * @num_entries - number of descriptors to be sent - * @subcrq - first TX descriptor - * @hdr_field - bit field determining which headers will be sent + * @skb: socket buffer + * @num_entries: number of descriptors to be sent + * @subcrq: first TX descriptor + * @hdr_field: bit field determining which headers will be sent * * This function will build a TX descriptor array with applicable * L2/L3/L4 packet header descriptors to be sent by send_subcrq_indirect. @@ -1997,7 +1997,7 @@ static int do_change_param_reset(struct ibmvnic_adapter *adapter, return 0; } -/** +/* * do_reset returns zero if we are able to keep processing reset events, or * non-zero if we hit a fatal error and must halt. */ diff --git a/drivers/net/xen-netfront.c b/drivers/net/xen-netfront.c index 920cac4385bf7..93740ef4cf1b4 100644 --- a/drivers/net/xen-netfront.c +++ b/drivers/net/xen-netfront.c @@ -1582,7 +1582,7 @@ static struct net_device *xennet_create_dev(struct xenbus_device *dev) return ERR_PTR(err); } -/** +/* * Entry point to this code when a new device is created. Allocate the basic * structures and the ring buffers for communication with the backend, and * inform the backend of the appropriate details for those. @@ -1659,7 +1659,7 @@ static void xennet_disconnect_backend(struct netfront_info *info) } } -/** +/* * We are reconnecting to the backend, due to a suspend/resume, or a backend * driver restart. We tear down our netif structure and recreate it, but * leave the device-layer structures intact so that this is transparent to the @@ -2305,7 +2305,7 @@ static int xennet_connect(struct net_device *dev) return 0; } -/** +/* * Callback received when the backend's state changes. */ static void netback_changed(struct xenbus_device *dev,