From patchwork Tue Jun 30 13:51:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11634069 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1B8E013B6 for ; Tue, 30 Jun 2020 13:58:22 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id AFD6C20774 for ; Tue, 30 Jun 2020 13:58:21 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="D7pT9LYJ"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="OihDsauu" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org AFD6C20774 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=fpZsF2Tz3JwktoVIGW/m9I4rsCfnqDZlaso8kGyB6sM=; b=D7pT9LYJ0PU0i0xPhWjwmFYGu qpMQsirQBncVnUosjCkcy0jHBF04KbDxQjgU5ekYPsT/DNZNYsTS+Ia427H2NJTG9X6Xnae3bzQQe Fb9fb4e20+v1mzEqtXAIh+z3db0DbYHns7jv5RVQKbnykjGxno9n67noNPMjxAZFOKQqOkO571hau rTSzHuituY7F0ZXumW4ZCLjggQZ1bznf/Ypn829kKwVNHZgQd2plYHU+JYgcJOaX7NRt9c9zp9zS9 q6jQc9jPYcHLdDY429QwLMXTXXi9QX4u6FC81UGjLvXMZrXEXtAr9nSz+GEfeHQm1Mat93M19P8uf Kx+aJSuog==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqGja-0003jS-3d; Tue, 30 Jun 2020 13:55:38 +0000 Received: from mail-wm1-x342.google.com ([2a00:1450:4864:20::342]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqGfi-0001HA-Hs for linux-arm-kernel@lists.infradead.org; Tue, 30 Jun 2020 13:51:40 +0000 Received: by mail-wm1-x342.google.com with SMTP id 17so19666023wmo.1 for ; Tue, 30 Jun 2020 06:51:38 -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=9c9u4tDA/tuITz0x9b4sRgCY6xDvpdYsLA/gKX2PRak=; b=OihDsauuGos+atBkAQmQ98Sb91kjMWCgnGuEglF6lG3XVluS7gxfiGT0wk9w2Y8SfH D9GTgo0Ir3t2J6nII/WVYTtVb/HJR0tonCmcM9ADBX5FLB+DhZy2VNjFbD0kXBHESIrN RVfBZLfPS04fsIkGMFbQIBroUkgdpoPqfDUgc3IHQtAiPEF0pUTrBLJCCZBiwYIJreGZ vQon9WHCo66yzUZ995FfFpSeRjj7ievLDE4/ojI7H/AqcalrBC6Fa1cPozv+hq/aed96 p/7y3KOknwmQ//WDGuRXWHvn4ONfhCXtjxIQlHAoEjnlQv1qgjyppYVqWapkXjru66dz WtGw== 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=9c9u4tDA/tuITz0x9b4sRgCY6xDvpdYsLA/gKX2PRak=; b=TbWDBTHhAcKhjbzK4H4CHyAEL5of69z5In8+BDj4SccM/91bvYfn7mRgE2XzMFYitB aICeVr/7MNGPzq3qAXTM/bfLovL/tdPks4AgLP8PBsGe+w4MmsDYp4Fa1FBMkAHvXPM0 3jSANj/UV5Zn8JjeDjc848o01uL/VrSm9lffxWahFRZ5Uxe5LMXvuTYEWcxmhECRXsS1 KT0nhI6JpvUx9OoWRL/OFarE3c1/WzdUGM6t+xdFyjhUTDS7nlvMVZxVa1G3PPf0/w+v FMh2qhPGcVhWB6x7YR4dlMeTygVwK7h6lCI83BYPwJ6FxeoGz7K87g/xLuIJnJwb6UhM Vn1A== X-Gm-Message-State: AOAM531U2E20AGCGEHrJmy6cZNwblgkgBSUQiF6Y4VzCf7wUx4ER6MeX 1zkwcCvaj+OSROC+QHtr04ecdw== X-Google-Smtp-Source: ABdhPJwRlejJQlEt5qpd9gycW4xMxVnkRlVdobgJjdYhmGmJu5MUUVgXNCMeq0EgZH3mSLHi19ymmg== X-Received: by 2002:a7b:cd90:: with SMTP id y16mr21226455wmj.20.1593525097096; Tue, 30 Jun 2020 06:51:37 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id t4sm3876746wmf.4.2020.06.30.06.51.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 Jun 2020 06:51:36 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 22/30] misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups Date: Tue, 30 Jun 2020 14:51:02 +0100 Message-Id: <20200630135110.2236389-23-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200630135110.2236389-1-lee.jones@linaro.org> References: <20200630135110.2236389-1-lee.jones@linaro.org> MIME-Version: 1.0 X-Spam-Note: CRM114 invocation failed X-Spam-Score: -0.2 (/) X-Spam-Report: SpamAssassin version 3.4.4 on merlin.infradead.org summary: Content analysis details: (-0.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:342 listed in] [list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Lee Jones , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org Includes; missing descriptions for function args, the promotion of obvious kerneldoc headers and the mis-formatting of existing argument descriptions. Fixes the following W=1 kernel build warnings: drivers/misc/mic/scif/scif_nm.c:19: warning: Function parameter or member 'node' not described in 'scif_invalidate_ep' drivers/misc/mic/scif/scif_nm.c:173: warning: Function parameter or member 'node_id' not described in 'scif_disconnect_node' Signed-off-by: Lee Jones --- drivers/misc/mic/scif/scif_nm.c | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/drivers/misc/mic/scif/scif_nm.c b/drivers/misc/mic/scif/scif_nm.c index c537df84539a9..c4d9422082b7d 100644 --- a/drivers/misc/mic/scif/scif_nm.c +++ b/drivers/misc/mic/scif/scif_nm.c @@ -14,6 +14,8 @@ /** * scif_invalidate_ep() - Set state for all connected endpoints * to disconnected and wake up all send/recv waitqueues + * + * @node: Node to invalidate */ static void scif_invalidate_ep(int node) { @@ -99,11 +101,10 @@ void scif_send_acks(struct scif_dev *dev) } } -/* - * scif_cleanup_scifdev - * +/** + * scif_cleanup_scifdev - Uninitialize SCIF data structures for remote + * SCIF device. * @dev: Remote SCIF device. - * Uninitialize SCIF data structures for remote SCIF device. */ void scif_cleanup_scifdev(struct scif_dev *dev) { @@ -136,8 +137,8 @@ void scif_cleanup_scifdev(struct scif_dev *dev) scif_cleanup_qp(dev); } -/* - * scif_remove_node: +/** + * scif_remove_node * * @node: Node to remove */ @@ -162,9 +163,9 @@ static int scif_send_rmnode_msg(int node, int remove_node) } /** - * scif_node_disconnect: + * scif_node_disconnect * - * @node_id[in]: source node id. + * @node_id: source node id [in] * @mgmt_initiated: Disconnection initiated from the mgmt node * * Disconnect a node from the scif network.