From patchwork Wed Jan 13 16:41:21 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 362171 Delivered-To: patch@linaro.org Received: by 2002:a02:ccad:0:0:0:0:0 with SMTP id t13csp693661jap; Wed, 13 Jan 2021 08:44:14 -0800 (PST) X-Google-Smtp-Source: ABdhPJzB1xyvZi8knwNnL4iXkVlB+SoJiKrOqd8vyfqbhwnV74U6v8eLhO267aSrAv6XkwJehTkd X-Received: by 2002:a05:6402:379:: with SMTP id s25mr2607215edw.367.1610556254503; Wed, 13 Jan 2021 08:44:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1610556254; cv=none; d=google.com; s=arc-20160816; b=V5xwi6bPQDw/Rk5pt6gNT8QdNI5Td6OBgiPLNAjLo5trgY8/VcG/2D4RN655H7Z2gf InfBB3WKFO7Cr+mPHshpR6qESrhkBWUP7kkHrBHsNaJy7kuMTxLAcA7QttfsszmT4TTf RnAwJAOydoA3fnLIzXHfiB9Q88BwnLaseiDS1GsugRWL//GnhRv81S2XbZ6I1BC+mGhA yJNG4pa0nSkGw3EYkxyEAZOdbwLdzsiqAsHTR11Hnmeb09cPjXqcKgP3ey4U3asTiGR4 NR2MgFjN0GY3PU6LIbbMNaHOkHALe8rUnOBUtLgwY88XzDL8ffrVBuBTE1PE8JKUPiHN 3q1A== 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=F0dvH29ffi2i4F8zScMsXrCXjoLq5dAgU1ImPQgyxOk=; b=iK7QcKwQhFkKBDaaU5h54+VKhvaaV0F7CsjTSaqEiHuNcUsb/Cr7UW6KfoZ2o+xrmY 9Iz6LpLEULJcevl307BkW56QQPi4SdYT282htqbpqLPIt3yQZl6mKsvpxs+Rhqh4EKNc rJib5Ufv5ngtQcCMlU/+xsXrypRtoJg822+QBBFMa0MJL/9vqnh3IeFhp5Lh0YIZ+n5t r3doFdOlUJREWfZ/3RIpQRb+apYc/+yBh1C8++tGfh3ZU8zIzUfYOfpvhKgb+KD+MFMO tO+RMdo5c8jnC9zd0m/zTWSmlk5b5KhF7JKn+Oz1mL2irbixaUyNz2PFhU1x8yIzQN0N qL8A== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=wibdpcpc; 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 f1si435506ejh.593.2021.01.13.08.44.14; Wed, 13 Jan 2021 08:44:14 -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=wibdpcpc; 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 S1727963AbhAMQnC (ORCPT + 7 others); Wed, 13 Jan 2021 11:43:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38016 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727884AbhAMQmv (ORCPT ); Wed, 13 Jan 2021 11:42:51 -0500 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 02B9BC0617AA for ; Wed, 13 Jan 2021 08:41:36 -0800 (PST) Received: by mail-wr1-x435.google.com with SMTP id i9so2827944wrc.4 for ; Wed, 13 Jan 2021 08:41:35 -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=F0dvH29ffi2i4F8zScMsXrCXjoLq5dAgU1ImPQgyxOk=; b=wibdpcpcVpqQHxtGL4Ai5SGD5EVrLUQO5Ly9cf7Aq2JcCEh4zDIybpj/dPs65Do5kI gvz7nkcYf4edgF5Ik8Isyw5YYiQTjT6troPEqGhyeEXTuaq01Pi+6R9+rpjyl/cGsfCc Ceh4jbARCc/OvZeoE6YplRkf9iZtmCaAQwb0aCZyNQWVNohTpORK3ZIz50vUYRGWgEob csr1PcBK3/glDfNEXOE9EjJOlbAnXW39VC4Ur2WuD4kH+cWSa3/AAt67BTDxRZ+Z1Pps rC82FPnTMc3T8zlTSaNytt2bEdMrf5s3H/F5QJfW21qJP3Fdp6D0rjvTRT54JKqIORoe HyZg== 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=F0dvH29ffi2i4F8zScMsXrCXjoLq5dAgU1ImPQgyxOk=; b=gwNceOiGJBsv4Pl4e9jgveTwcDRS17I0rr0QRDoQSvFt8MsPmSY6k05FWFCAWJ3eo7 2o5CHnj7qYHPMVYFNXvVRaohsCmpvTMP5FvZF/kLQfZXp9obGrxwVq6ecg8rhy6QgE4r 3KTkeILqHG/74wZzwRVKaYj+w1yx9q5Q6fS1vas9e/42YIAh2k9APzKO9o31EN52inJ0 wTqmuUr1tBtWcLSE62w+lPkjaTdJTyirHv6ef+FCi9P2ZaD+iI2y9qRaylOh/D7NnO73 hpVl3HZIS2mOVb5ws4JqbudTTIPxBDxxNjGD0Rh+1crJFS5wd+u2fJ+GkrhrzpH8Gk6A XlXQ== X-Gm-Message-State: AOAM530R1gojyEZWEGLHsMmSqv38pKdhtRN/s+XxegSq7s7UOLFOwc8/ m2kWQtyHW1KRZsPpLHVWLJSetA== X-Received: by 2002:adf:82c8:: with SMTP id 66mr3473869wrc.420.1610556094790; Wed, 13 Jan 2021 08:41:34 -0800 (PST) Received: from dell.default ([91.110.221.229]) by smtp.gmail.com with ESMTPSA id t16sm3836510wmi.3.2021.01.13.08.41.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Jan 2021 08:41:34 -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/7] net: ethernet: ibm: ibmvnic: Fix some kernel-doc misdemeanours Date: Wed, 13 Jan 2021 16:41:21 +0000 Message-Id: <20210113164123.1334116-6-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210113164123.1334116-1-lee.jones@linaro.org> References: <20210113164123.1334116-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 | 27 +++++++++++++-------------- drivers/net/xen-netfront.c | 6 +++--- 2 files changed, 16 insertions(+), 17 deletions(-) -- 2.25.1 diff --git a/drivers/net/ethernet/ibm/ibmvnic.c b/drivers/net/ethernet/ibm/ibmvnic.c index aed985e08e8ad..4c4252e68de5a 100644 --- a/drivers/net/ethernet/ibm/ibmvnic.c +++ b/drivers/net/ethernet/ibm/ibmvnic.c @@ -1384,10 +1384,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 + * @hdr_data: buffer to write the header to * * Reads hdr_field to determine which headers are needed by firmware. * Builds a buffer containing these headers. Saves individual header @@ -1444,11 +1444,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 + * @hdr_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 @@ -1496,10 +1496,9 @@ 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 + * @txbuff: tx buffer + * @num_entries: number of descriptors to be sent + * @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. @@ -1925,7 +1924,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. */ diff --git a/drivers/net/xen-netfront.c b/drivers/net/xen-netfront.c index c20b78120bb42..6ef2adbd283a3 100644 --- a/drivers/net/xen-netfront.c +++ b/drivers/net/xen-netfront.c @@ -1580,7 +1580,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. @@ -1657,7 +1657,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 @@ -2303,7 +2303,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,