From patchwork Fri Aug 14 11:39:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 247712 Delivered-To: patch@linaro.org Received: by 2002:a92:cc90:0:0:0:0:0 with SMTP id x16csp293718ilo; Fri, 14 Aug 2020 04:41:22 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxC1yMg5td9kTRuGj52rR+YQnF9WwPEuJ+erHtJT7Uytm8AspmrzNtKqzrIWBAKl47zwBFx X-Received: by 2002:a17:906:cc4d:: with SMTP id mm13mr1899086ejb.191.1597405282068; Fri, 14 Aug 2020 04:41:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1597405282; cv=none; d=google.com; s=arc-20160816; b=IgA8DbLKKklH4qICbT1cFRCAAHJh7627DjyzxWdpKqVRtAZ11v+VE8u+XbYv1nxnrR GnOitXrPdFZC0FTUJczp7gpMQYCeGo97mj2O5/WY7WWi1i3qdA+som64d3XzIiBRlp1C nGJfNgIfYhAjLkILlMJbsBUn/T1BIj+v9/CRNGBE8qAtkczLtr+uKN5rEFycV/GsZI+J IGsIQlimre4hJXFRhoTWCTv00mP0VzdKfGu31dbq7WzhioYlaNLuLMxM8Zjh2/zFnxbb CgBVOHKSuRrTDWASDzH2fmIlIkW4B1muW5ripjTSbpdYlUtSJQItqzMGQYt5igFZlkD1 w5uA== 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=QL8P1vJDktk76ShKc1HPImGMIug4YyMuQnQRcEyKkoI=; b=WqyUKcv3gAB7GywBYCNYTvsPSuTzGTaG5Sq2tpqRU+hUIlEjhuibR1a5Lm0iC8PHNd SVmb3MQKw4tQ3U19Ja3MzeIxYaw3VCkxE5dhQ2v0xKQT3usZBVWnkhcmF1yuj05eZoeV vNaWEKVj2i4X+LLg/Pw5BN61Yf/EXfxJ4suAY04pETE32OeHKYw5hNkiNBI9HPo9qEMf OpHi6mBKVn2MfjGoAqHPPb0IEaW+eNZlSdin9RcBXnawYfua0AOnPNWiCfBoGGLPW5L7 nW4Sse70ISUF083P4TkAQo4xT12Gw2NGuH9loEED5nz8DVpLAEyFzCxwzPyc7tc22KYE zFag== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=lnMu9WBE; 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 ks22si5014849ejb.635.2020.08.14.04.41.21; Fri, 14 Aug 2020 04:41:22 -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=lnMu9WBE; 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 S1726760AbgHNLlH (ORCPT + 9 others); Fri, 14 Aug 2020 07:41:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39798 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728226AbgHNLkW (ORCPT ); Fri, 14 Aug 2020 07:40:22 -0400 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 4D3FAC061389 for ; Fri, 14 Aug 2020 04:40:18 -0700 (PDT) Received: by mail-wr1-x444.google.com with SMTP id y3so8078256wrl.4 for ; Fri, 14 Aug 2020 04:40:18 -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=QL8P1vJDktk76ShKc1HPImGMIug4YyMuQnQRcEyKkoI=; b=lnMu9WBEwLa+et+Tun3rNvwx1hf61X+CVtMJG/DDGWk2x5ctb0Nbd50aVhKtCXUC9T z6ydfEiNpiajXqm230uX3ya68ut+rULL9Dru//OVyEZ4SZ1kSGcYN7Pik0bGW0xe1/0t o0LC8U7sU4kcekipyEvc25ZIw9Iei0nwLE9H7xjrMT++K/jkrbZVgCpKLX/T7I1sTVkH wR7b71tU0bQw+hjMA7zA3bGbm+cMALRKFJhjQC/I+QEzkqSi3khmpkrIe2DjPXfhR9Vp /KA4+GUnu6MTA7dq5Kc0vhFdMxLlCV1CgQqkQPSPYU7Q90d4aRnkXxanxZvUPgLZLVbb kV6A== 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=QL8P1vJDktk76ShKc1HPImGMIug4YyMuQnQRcEyKkoI=; b=jLLgHkM6GZ+4k5ddYs1b36oTxKhWn6WWf5AhXGVLtzgWoIHn3tpxFOVMA4zTnWdT1O TS281iwpEBbHYp8/+XP6Fk0OI9Fk00XOUXYElQQHRtiZvlGeJ7c9kesjcUiohGMFAEcA CV3saIZh8rm+cffhmCuAsDPOOuucUBRn24EJWpeL0CQBQQdZ4am6evY1WtV0vC3NCPzG MpsPQDFk085Y9SinjTvYJY5NeSOXF3NLzyFnNg89hx0YjUylwOyvnuTVbIX5wwOnE2vn DSBQAqH/vExPkj0Kc/4uj2wSqkjpJDYmaVWJNB39FMUBqThcPA0+3exH+VA/U+/DfpdE 7YFg== X-Gm-Message-State: AOAM533OP6suBerNjXfCVOKUTD9Z5dDemScuNZKAcgGznjJt4GriFbqH MsGBwVc7Pdrg+nx71LEvYugkSw== X-Received: by 2002:adf:a19e:: with SMTP id u30mr2322432wru.274.1597405216394; Fri, 14 Aug 2020 04:40:16 -0700 (PDT) Received: from dell.default ([95.149.164.62]) by smtp.gmail.com with ESMTPSA id 32sm16409129wrh.18.2020.08.14.04.40.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 Aug 2020 04:40:15 -0700 (PDT) From: Lee Jones To: davem@davemloft.net, kuba@kernel.org Cc: linux-kernel@vger.kernel.org, Lee Jones , Arend van Spriel , Franky Lin , Hante Meuleman , Chi-Hsien Lin , Wright Feng , Kalle Valo , linux-wireless@vger.kernel.org, brcm80211-dev-list.pdl@broadcom.com, brcm80211-dev-list@cypress.com, netdev@vger.kernel.org Subject: [PATCH 23/30] net: wireless: broadcom: brcm80211: brcmfmac: fweh: Fix docrot related function documentation issues Date: Fri, 14 Aug 2020 12:39:26 +0100 Message-Id: <20200814113933.1903438-24-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 Also demote a commit block header which is clearly not suitable for kerneldoc. Fixes the following W=1 kernel build warning(s): drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c: In function ‘brcmf_fweh_handle_if_event’: drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:131:6: warning: variable ‘err’ set but not used [-Wunused-but-set-variable] drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:36: warning: Function parameter or member 'datalen' not described in 'brcmf_fweh_queue_item' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:44: warning: Function parameter or member 'code' not described in 'brcmf_fweh_event_name' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:44: warning: Function parameter or member 'name' not described in 'brcmf_fweh_event_name' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Function parameter or member 'emsg' not described in 'brcmf_fweh_handle_if_event' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Function parameter or member 'data' not described in 'brcmf_fweh_handle_if_event' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Excess function parameter 'item' description in 'brcmf_fweh_handle_if_event' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Excess function parameter 'ifpp' description in 'brcmf_fweh_handle_if_event' drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:391: warning: Function parameter or member 'packet_len' not described in 'brcmf_fweh_process_event' Cc: Arend van Spriel Cc: Franky Lin Cc: Hante Meuleman Cc: Chi-Hsien Lin Cc: Wright Feng Cc: Kalle Valo Cc: "David S. Miller" Cc: Jakub Kicinski Cc: Lee Jones Cc: linux-wireless@vger.kernel.org Cc: brcm80211-dev-list.pdl@broadcom.com Cc: brcm80211-dev-list@cypress.com Cc: netdev@vger.kernel.org Signed-off-by: Lee Jones --- drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) -- 2.25.1 diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c index 6f74567c7bd72..3bdbb285b3aa6 100644 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c @@ -23,6 +23,7 @@ * @ifidx: interface index related to this event. * @ifaddr: ethernet address for interface. * @emsg: common parameters of the firmware event message. + * @datalen: length of the data array * @data: event specific data part of the firmware event. */ struct brcmf_fweh_queue_item { @@ -35,7 +36,7 @@ struct brcmf_fweh_queue_item { u8 data[]; }; -/** +/* * struct brcmf_fweh_event_name - code, name mapping entry. */ struct brcmf_fweh_event_name { @@ -118,8 +119,8 @@ static int brcmf_fweh_call_event_handler(struct brcmf_pub *drvr, * brcmf_fweh_handle_if_event() - handle IF event. * * @drvr: driver information object. - * @item: queue entry. - * @ifpp: interface object (may change upon ADD action). + * @emsg: event message object. + * @data: event object. */ static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr, struct brcmf_event_msg *emsg, @@ -380,6 +381,7 @@ int brcmf_fweh_activate_events(struct brcmf_if *ifp) * * @drvr: driver information object. * @event_packet: event packet to process. + * @packet_len: length of the packet * * If the packet buffer contains a firmware event message it will * dispatch the event to a registered handler (using worker).