From patchwork Fri Aug 14 11:39:04 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 247729 Delivered-To: patch@linaro.org Received: by 2002:a92:cc90:0:0:0:0:0 with SMTP id x16csp296083ilo; Fri, 14 Aug 2020 04:45:31 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy4wmfkBHoudN39y5xhVp/1rCpMP70i4tLccBSM+j1Pdpj+y62Rv/raOaKyfjkK5/4D0tM8 X-Received: by 2002:a17:906:7f05:: with SMTP id d5mr1952739ejr.122.1597405531589; Fri, 14 Aug 2020 04:45:31 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1597405531; cv=none; d=google.com; s=arc-20160816; b=XL6EnUM4fWxwOI7UYAnkV14DWAh+ZIYPp2Kg40cDPYyYuLUGzDYVV92qjICJocbTe8 d5xg1AEeap1/43BDOu+mRYy1sJmAOgLElgtADB5+Dj+ypHtAsOjDSuZizIWCfjdYNgR9 y+B9l28J7Q7JLwE+C5jd9VeaRQqFiC3FSVKUXOEL923jtrlRfZrk/XOdlpNUXt0dzOy8 hK5dIIjVHDEoBdfN+yNCGKwD4L8CYUtI652XsmMKQf+4Ohiy/wKXVszff9Pqz87gLg7r 1KNAbOAWF+gdUZX+iqkrE60g0treWYxPxhOvhPItnpLc5GnIotMZvaOWR5+qWiWD3Zqv cDDA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=dAFcbyfiLFxJ6YM+Uc6dODcjCd4qp0P9KJY2UNEh1zo=; b=ijwbtT/mvNaHNH7zxZ1lJzh2nnD2FYR585DK14KamHWiPkt5YLKFqgdMeCNUK+nhEA 30nyGJyIM3QBMc8IxPBX9T/V6nO3zfCHrTy7GmMQQHUWPHvxDoGb+vrqDd1p4fHIIu0J IbKToG7f8WgYsxR7/a0mXRnY5kXkd7uEI9IwTU42vpvzDiVxpd/Yt7cB/luul45fRReZ cGA6BmfzWHy6bP3MDFV5nF2OquL2AqIK91Zoujao6zaOOQpOJ1N+VozqmVqkb3OChd1i 7tY7toVsUT3N4HGkPWNcZQqOZ6lKZ1oxcn4iNsT/rd6GETuap/lVF+pCwCJanGQsIkEY T+Fg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=k8kEegPS; 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 d7si5053420edv.498.2020.08.14.04.45.31; Fri, 14 Aug 2020 04:45:31 -0700 (PDT) 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=k8kEegPS; 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 S1727874AbgHNLp1 (ORCPT + 9 others); Fri, 14 Aug 2020 07:45:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39646 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728068AbgHNLjp (ORCPT ); Fri, 14 Aug 2020 07:39:45 -0400 Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 64203C061384 for ; Fri, 14 Aug 2020 04:39:45 -0700 (PDT) Received: by mail-wm1-x341.google.com with SMTP id t14so7660447wmi.3 for ; Fri, 14 Aug 2020 04:39:45 -0700 (PDT) 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=dAFcbyfiLFxJ6YM+Uc6dODcjCd4qp0P9KJY2UNEh1zo=; b=k8kEegPS0quMxSTfE7dBkHWMmAbsOVdPpMm+2w3g7QaYRpMghCVXHHJQJamNkPf23T NppWzNwMEKB5c14BXvafBgOE4W6+0xY3S5+mTVCoP1dUkk3zIjc9qBTGWt0NkLRv36LD PaVPu6dWmwBiyJ00l5QgTxE21W2RR522LGo4/gnqx1ivQ+62Xx8IRpUnvDGXp0mCtxne JQioCT7UqvYv6rU3G0ZU5DseIwQ7FFWkXh6FLI/+xg+sjVjN8rDiHKtmDK5nQkcCz6Hf +aAhf6IUcDV7BUQNaS36OT9l+T99FKMCs/cW4i314ImOqOavpV5evntHwgf/e9TjFDIq tkaw== 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=dAFcbyfiLFxJ6YM+Uc6dODcjCd4qp0P9KJY2UNEh1zo=; b=A2YCKnEwsDuE/meXMNQqvo4cVwE5JVefGtOxJsqYDOa3wktyoRY5lhKpdNKxARp1Hm wtwsTgVXj+25pLG7+3yBxkyR3nA1cBqTeAhws4BObfMNsqqjXE839wDjAly7SfHDbVpz ZonHpcKx5KyzkehqoRgY9yJP2NbqIkECyZO/mKvlJ1qeYVmuGHqOotxn2SJ8PYxFyyRf PmS8IX1+wiz+nXytBZ8MvMIF0nv45dgfrspMxdBO6f98w61lZTJDbRM+XyW981orYKGI A7C/qhqcGkM1GNx7OAzF1cN5i0b+vtXAlJQd1wWuZR9b1+yyWhpbOLfHaGwCutWxwGpb /xWw== X-Gm-Message-State: AOAM5319Gy0ZwC3ITnJo4ubhdN+qgFIPhGZ0yDPdjXvTpD88npQ1vnql NP7kv9dJfMnNDzxnG8SCvQXjscHs6KtF/w== X-Received: by 2002:a1c:3c87:: with SMTP id j129mr2154154wma.176.1597405180892; Fri, 14 Aug 2020 04:39:40 -0700 (PDT) Received: from dell.default ([95.149.164.62]) by smtp.gmail.com with ESMTPSA id 32sm16409129wrh.18.2020.08.14.04.39.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 Aug 2020 04:39:40 -0700 (PDT) From: Lee Jones To: davem@davemloft.net, kuba@kernel.org Cc: linux-kernel@vger.kernel.org, Lee Jones , Jay Vosburgh , Veaceslav Falico , Andy Gospodarek , netdev@vger.kernel.org Subject: [PATCH 01/30] net: bonding: bond_3ad: Fix a bunch of kerneldoc parameter issues Date: Fri, 14 Aug 2020 12:39:04 +0100 Message-Id: <20200814113933.1903438-2-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200814113933.1903438-1-lee.jones@linaro.org> References: <20200814113933.1903438-1-lee.jones@linaro.org> MIME-Version: 1.0 Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Renames and missing descriptions. Fixes the following W=1 kernel build warning(s): drivers/net/bonding/bond_3ad.c:140: warning: Function parameter or member 'port' not described in '__get_first_agg' drivers/net/bonding/bond_3ad.c:140: warning: Excess function parameter 'bond' description in '__get_first_agg' drivers/net/bonding/bond_3ad.c:1655: warning: Function parameter or member 'agg' not described in 'ad_agg_selection_logic' drivers/net/bonding/bond_3ad.c:1655: warning: Excess function parameter 'aggregator' description in 'ad_agg_selection_logic' drivers/net/bonding/bond_3ad.c:1817: warning: Function parameter or member 'port' not described in 'ad_initialize_port' drivers/net/bonding/bond_3ad.c:1817: warning: Excess function parameter 'aggregator' description in 'ad_initialize_port' drivers/net/bonding/bond_3ad.c:1976: warning: Function parameter or member 'timeout' not described in 'bond_3ad_initiate_agg_selection' drivers/net/bonding/bond_3ad.c:2274: warning: Function parameter or member 'work' not described in 'bond_3ad_state_machine_handler' drivers/net/bonding/bond_3ad.c:2274: warning: Excess function parameter 'bond' description in 'bond_3ad_state_machine_handler' drivers/net/bonding/bond_3ad.c:2508: warning: Function parameter or member 'link' not described in 'bond_3ad_handle_link_change' drivers/net/bonding/bond_3ad.c:2508: warning: Excess function parameter 'status' description in 'bond_3ad_handle_link_change' drivers/net/bonding/bond_3ad.c:2566: warning: Function parameter or member 'bond' not described in 'bond_3ad_set_carrier' drivers/net/bonding/bond_3ad.c:2677: warning: Function parameter or member 'bond' not described in 'bond_3ad_update_lacp_rate' drivers/net/bonding/bond_3ad.c:1655: warning: Function parameter or member 'agg' not described in 'ad_agg_selection_logic' drivers/net/bonding/bond_3ad.c:1655: warning: Excess function parameter 'aggregator' description in 'ad_agg_selection_logic' drivers/net/bonding/bond_3ad.c:1817: warning: Function parameter or member 'port' not described in 'ad_initialize_port' drivers/net/bonding/bond_3ad.c:1817: warning: Excess function parameter 'aggregator' description in 'ad_initialize_port' drivers/net/bonding/bond_3ad.c:1976: warning: Function parameter or member 'timeout' not described in 'bond_3ad_initiate_agg_selection' drivers/net/bonding/bond_3ad.c:2274: warning: Function parameter or member 'work' not described in 'bond_3ad_state_machine_handler' drivers/net/bonding/bond_3ad.c:2274: warning: Excess function parameter 'bond' description in 'bond_3ad_state_machine_handler' drivers/net/bonding/bond_3ad.c:2508: warning: Function parameter or member 'link' not described in 'bond_3ad_handle_link_change' drivers/net/bonding/bond_3ad.c:2508: warning: Excess function parameter 'status' description in 'bond_3ad_handle_link_change' drivers/net/bonding/bond_3ad.c:2566: warning: Function parameter or member 'bond' not described in 'bond_3ad_set_carrier' drivers/net/bonding/bond_3ad.c:2677: warning: Function parameter or member 'bond' not described in 'bond_3ad_update_lacp_rate' Cc: Jay Vosburgh Cc: Veaceslav Falico Cc: Andy Gospodarek Cc: "David S. Miller" Cc: Jakub Kicinski Cc: netdev@vger.kernel.org Signed-off-by: Lee Jones --- drivers/net/bonding/bond_3ad.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) -- 2.25.1 diff --git a/drivers/net/bonding/bond_3ad.c b/drivers/net/bonding/bond_3ad.c index 31e43a2197a30..cddaa43a9d527 100644 --- a/drivers/net/bonding/bond_3ad.c +++ b/drivers/net/bonding/bond_3ad.c @@ -130,7 +130,7 @@ static inline struct bonding *__get_bond_by_port(struct port *port) /** * __get_first_agg - get the first aggregator in the bond - * @bond: the bond we're looking at + * @port: the port we're looking at * * Return the aggregator of the first slave in @bond, or %NULL if it can't be * found. @@ -1626,7 +1626,7 @@ static int agg_device_up(const struct aggregator *agg) /** * ad_agg_selection_logic - select an aggregation group for a team - * @aggregator: the aggregator we're looking at + * @agg: the aggregator we're looking at * @update_slave_arr: Does slave array need update? * * It is assumed that only one aggregator may be selected for a team. @@ -1810,7 +1810,7 @@ static void ad_initialize_agg(struct aggregator *aggregator) /** * ad_initialize_port - initialize a given port's parameters - * @aggregator: the aggregator we're looking at + * @port: the port we're looking at * @lacp_fast: boolean. whether fast periodic should be used */ static void ad_initialize_port(struct port *port, int lacp_fast) @@ -1967,6 +1967,7 @@ static void ad_marker_response_received(struct bond_marker *marker, /** * bond_3ad_initiate_agg_selection - initate aggregator selection * @bond: bonding struct + * @timeout: timeout value to set * * Set the aggregation selection timer, to initiate an agg selection in * the very near future. Called during first initialization, and during @@ -2259,7 +2260,7 @@ void bond_3ad_update_ad_actor_settings(struct bonding *bond) /** * bond_3ad_state_machine_handler - handle state machines timeout - * @bond: bonding struct to work on + * @work: work context to fetch bonding struct to work on from * * The state machine handling concept in this module is to check every tick * which state machine should operate any function. The execution order is @@ -2500,7 +2501,7 @@ void bond_3ad_adapter_speed_duplex_changed(struct slave *slave) /** * bond_3ad_handle_link_change - handle a slave's link status change indication * @slave: slave struct to work on - * @status: whether the link is now up or down + * @link: whether the link is now up or down * * Handle reselection of aggregator (if needed) for this port. */ @@ -2551,7 +2552,7 @@ void bond_3ad_handle_link_change(struct slave *slave, char link) /** * bond_3ad_set_carrier - set link state for bonding master - * @bond - bonding structure + * @bond: bonding structure * * if we have an active aggregator, we're up, if not, we're down. * Presumes that we cannot have an active aggregator if there are @@ -2664,7 +2665,7 @@ int bond_3ad_lacpdu_recv(const struct sk_buff *skb, struct bonding *bond, /** * bond_3ad_update_lacp_rate - change the lacp rate - * @bond - bonding struct + * @bond: bonding struct * * When modify lacp_rate parameter via sysfs, * update actor_oper_port_state of each port.