From patchwork Wed Nov 4 09:06:07 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 320519 Delivered-To: patch@linaro.org Received: by 2002:a92:7b12:0:0:0:0:0 with SMTP id w18csp5278686ilc; Wed, 4 Nov 2020 01:07:38 -0800 (PST) X-Google-Smtp-Source: ABdhPJwTAvdanLa1pUoIL8y1qHZEfpdc2oiHbe1R8aKFno1nUdpiVSaykEGZTdTgK64NAHCIIBGe X-Received: by 2002:a17:906:3689:: with SMTP id a9mr24035688ejc.403.1604480858440; Wed, 04 Nov 2020 01:07:38 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1604480858; cv=none; d=google.com; s=arc-20160816; b=qQUp9PJavAB6G3lrlee6ti9MR2f9POkhGcrbhXMaTmEeG3cAUCmNbOEeANl5nPz/rY odBcGHlgPp4K3kO/RTocuRhCmIyjDrNSJR6Bz8HU0AjAZxiBOV0Lpfky2l+GVs2BIVK0 Y3g+3MKt08y+2PzOt3qSpj2AnfcFvRMQk3JZJQCWGR/Kq2wZa4QmWrjQKjRCbn8lGSwg 1joiWSiB+aflMqJxLrkd/jKHapTQnNkWpoUM12plMFkBywHGFxmXg9lCi+G9XGNk8UXj /D1UbeRIGG36VGBXwqt0ArZsV1SVft0EJi9UVSihdKfRHLfnbSwYBnTMwjkce92NAmU3 ON9g== 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=/B2umlHEGwiWmUzcbuvTIa6aaDkptaAOjJxXB95ER8o=; b=ZWF93Pbf0FtM8Ng+F261/VDX2J6qx0BP8rnBdetQ1Aa3nVYjYgVna7sBecTG6EfMh/ CBnDVEWSdS/CWccbVLnvcqBrp0+2QQ170X39MjB6aS952uBYdk3nkwaoBYRRD2ZfJC2h 2NcWl6pnl+9K6biyT/5BlUra2jIgVz1PRcDiQUesbsXAVTDZIXdOsvG5kH91b/C1I/2T zdJfB3H+igW6tpDRvN97S1GQCjFRJGKL2GUjzlcmX4nlc8EPxYDSuzSzQW3ASI91a3xP KCFzGFFoImqb6GpV1Zk8kmStzk7YuKF1kz0W6pJYiGfK9jVfFVVo1qi88siB4Wyulgd5 5tPA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="q3O/SXd4"; 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 d21si1134330ejz.214.2020.11.04.01.07.38; Wed, 04 Nov 2020 01:07:38 -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="q3O/SXd4"; 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 S1728287AbgKDJHh (ORCPT + 8 others); Wed, 4 Nov 2020 04:07:37 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51118 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728999AbgKDJGi (ORCPT ); Wed, 4 Nov 2020 04:06:38 -0500 Received: from mail-wm1-x342.google.com (mail-wm1-x342.google.com [IPv6:2a00:1450:4864:20::342]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 726CEC0613D3 for ; Wed, 4 Nov 2020 01:06:36 -0800 (PST) Received: by mail-wm1-x342.google.com with SMTP id d142so1608324wmd.4 for ; Wed, 04 Nov 2020 01:06:36 -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=/B2umlHEGwiWmUzcbuvTIa6aaDkptaAOjJxXB95ER8o=; b=q3O/SXd4LV8Ycy1SNvZO/331iDTMCBCi8rZ58FfA5rgOfwOMV3xdfcQ3fXzVezQH0G +kWKkHrxzkgm88APVQPS3NRojiXIMSF6xaiJ/b1UvLhT2GvLse1x6a7/Zl0XGL2K1cfG S1FVBL26Ka6AoRQ//rNLtIaWg/HUa0NJLSAHQUJ18bmofOY7Q6RIlslTHkHYnGKPZh0S TCWisaLpOSszO/NlsTXsYORH9y+dPxCSPAPlAYpIoQVZe6HD8xvTGj4b8UGE78ZaDHFP cMpv0UoPO7nSdYIzAwSNmWBTV6mG0RtmxCCSH3/neHoVNHpEu8DwyiHz0j6+zhIWG36V /M+w== 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=/B2umlHEGwiWmUzcbuvTIa6aaDkptaAOjJxXB95ER8o=; b=Vjw+qn/p0a+UHyS70TaFH1uzFrTNN/FFpotMJQycUlVIUs8PQftzN9bQ13JrqPK/5U Az5uLevgxFuUH76suS4kpqnh7t6cgXcp0DNiCTXhXuBRgMvTujBeZWfZQnWQOCJ4JSmV tSsBu3CtOlXwewMjcwey60/twWXV7+65Xloq30vrBaxMpuF6YwM+uNkHPNaKulBdgRNQ MAc+VEgdEWFlibuq5BiN2qrjupagit4W7jJFP9+HK5yahJQTGE5NK/hF0isZvKXElm+2 W/mUdi/75KjlPjHHT6WK6Nxfu4+1JZ7gAoQuUFY8TbQEfd6nRcoo4WLgA40sI98IGoZT ntNw== X-Gm-Message-State: AOAM530e083GT6gxRzltjSjzab6M1Rvq5WXCJ5D2WAllRvk9exurNu61 I9r6CA7tvXO5K7UOMo7jA15Vcw== X-Received: by 2002:a1c:df89:: with SMTP id w131mr3289237wmg.164.1604480795182; Wed, 04 Nov 2020 01:06:35 -0800 (PST) Received: from dell.default ([91.110.221.242]) by smtp.gmail.com with ESMTPSA id e25sm1607823wrc.76.2020.11.04.01.06.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Nov 2020 01:06:34 -0800 (PST) From: Lee Jones To: davem@davemloft.net, kuba@kernel.org Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Lee Jones , Dany Madden , Lijun Pan , Sukadev Bhattiprolu , Michael Ellerman , Benjamin Herrenschmidt , Paul Mackerras , Santiago Leon , Thomas Falcon , John Allen , netdev@vger.kernel.org, linuxppc-dev@lists.ozlabs.org Subject: [PATCH 09/12] net: ethernet: ibm: ibmvnic: Fix some kernel-doc misdemeanours Date: Wed, 4 Nov 2020 09:06:07 +0000 Message-Id: <20201104090610.1446616-10-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201104090610.1446616-1-lee.jones@linaro.org> References: <20201104090610.1446616-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 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) -- 2.25.1 Reviewed-by: Andrew Lunn Reviewed-by: Dany Madden diff --git a/drivers/net/ethernet/ibm/ibmvnic.c b/drivers/net/ethernet/ibm/ibmvnic.c index 1dc3cfdb38abc..b30e1f5784bad 100644 --- a/drivers/net/ethernet/ibm/ibmvnic.c +++ b/drivers/net/ethernet/ibm/ibmvnic.c @@ -1357,10 +1357,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 @@ -1417,11 +1417,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 @@ -1469,10 +1469,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. @@ -1835,7 +1835,7 @@ static int ibmvnic_set_mac(struct net_device *netdev, void *p) return rc; } -/** +/* * 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. */