From patchwork Tue Jun 30 13:51:05 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11634127 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 4BD11138C for ; Tue, 30 Jun 2020 14:00:57 +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 C1A3B206BE for ; Tue, 30 Jun 2020 14:00:56 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="fghH7NHx"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="d7k/5kR1" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C1A3B206BE 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=WiVFRaN3aJuUafkIxVKuJnMnMzriUqI8dctNBL9JbYA=; b=fghH7NHxvMntm28wi0jNW52QD ruiHPEWfIpfv+CMQ6jmtH2wRmcjUSH5So8xF2oajvImFnDpO2NWfybEF1C/oDoEe4/NtIFNp/ikB5 O4EN5omlPKVi8OnOs6MpreqQ0LTj0hetV9yw9SLnSgKbolTdNM7klZPB6Q3pm2c8RjexYhHJxr/QK X/Xi9ImIhNue/QJMaFLyG3McMnWIC4e/3cotYKMOpqn3S0xkqjytzAwcWoF73tTlV8GJ0mNVso4w1 9irHnU2uEOXr6Ih+YLbs6UEUHff6SGrzf1aJbHpSJP1CGfmqkrn9FRfuC/0FmK2vtz7qnmLL+Kgth BJ13SIFPA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqGlx-0004uG-Pg; Tue, 30 Jun 2020 13:58:06 +0000 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqGfl-0001IM-IJ for linux-arm-kernel@lists.infradead.org; Tue, 30 Jun 2020 13:51:42 +0000 Received: by mail-wm1-x344.google.com with SMTP id 17so19666189wmo.1 for ; Tue, 30 Jun 2020 06:51:41 -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=y1zDXtnu4nYqM822JS90Uin0HwiZbzzdDBFpt66EWWs=; b=d7k/5kR1qiJB9I8wUeO83oekbSzZU46dMeScb0EzHVURvCyrbXk22BSOWM13XyQfXA L3RPHyLinXF2f6JXJeD2Fg1c6YkaXr7SR3yfuhwD2YXqQhVqJ9YX4k8AjZsbGyp4FGQZ BzvEp6WPUEno848z2J9xukGRDZ7BFdONeFmHe0p3+qPu7B9kHH4RBtMrYlGJsbmkWDCV y7jAs2hIF5HP+6I81qf2QOcBLnlVbmEU4BzDpO0o1Hnb67F4ZTc/SIqxJRriKk7MbTfu y8wY4Rz8ziEOXnTvSEN0ADNEg+jEFmj9Hj+jdifuGZusImdpAjBegKAr2hdrfDYj8RzI C5pw== 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=y1zDXtnu4nYqM822JS90Uin0HwiZbzzdDBFpt66EWWs=; b=ZKFwQvKI8cVtwuPw7Xs0HtneEZkS13SER1MsUOGzQhC8EpUNEr/bEyF+pl4hCDmpIk J/hTn7cHvasHD8tIvNYiQAp5Mg55A0voVjOZFQwFF5XJ4ufW0fGeB2OKjMG0246fGMGT LwHEWvPq1/j5vL+u8/G/VKcJ33Uj9l5mQNnm/NBZzzmuZn3hWOGLVBYf7EvMkpyMhkXX Tbk9xZezgCnyDG5fZvyXlM/EFfU4wHbtFOZ/0t+lny0tOMGl/0wFHnLAWlZmYS97sy4O W1zsxpRSNztwHOyQmHXf81qm5wBF0vJcrlJh7vgFRgfPdTBNeB6YUl2YSl5fc7C7f8DO 3qfA== X-Gm-Message-State: AOAM531kmfXctH6O9TJIwocaOW/D0S4DGJBriN46dvUTU9k093BgJ1tm dQ3pIJI1A8vFhvpT770amU3gbopJ9c4= X-Google-Smtp-Source: ABdhPJzsUzBMER02528kWrOC9qgDSaXSh2ak8iFAlndL0t+7FKAxkUl019ETK2s+ggIgnhv+g5sDVQ== X-Received: by 2002:a1c:98cc:: with SMTP id a195mr21391693wme.89.1593525100565; Tue, 30 Jun 2020 06:51:40 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id t4sm3876746wmf.4.2020.06.30.06.51.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 Jun 2020 06:51:39 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 25/30] misc: mic: scif: scif_rma: Repair a bunch of kerneldoc issues Date: Tue, 30 Jun 2020 14:51:05 +0100 Message-Id: <20200630135110.2236389-26-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:344 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: Ashutosh Dixit , Lee Jones , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Sudeep Dutt Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org Firstly, for some reason documentation of all 'scifdev' arguments are missing, so apply those. Also remove 2 descriptions of 'ep' which appear to document non-existent function arguments. drivers/misc/mic/scif/scif_rma.c:468: warning: Function parameter or member 'scifdev' not described in 'scif_create_remote_window' drivers/misc/mic/scif/scif_rma.c:468: warning: Excess function parameter 'ep' description in 'scif_create_remote_window' drivers/misc/mic/scif/scif_rma.c:510: warning: Excess function parameter 'ep' description in 'scif_destroy_remote_window' drivers/misc/mic/scif/scif_rma.c:1045: warning: Function parameter or member 'scifdev' not described in 'scif_alloc_req' drivers/misc/mic/scif/scif_rma.c:1080: warning: Function parameter or member 'scifdev' not described in 'scif_alloc_gnt_rej' drivers/misc/mic/scif/scif_rma.c:1104: warning: Function parameter or member 'scifdev' not described in 'scif_free_virt' drivers/misc/mic/scif/scif_rma.c:1142: warning: Function parameter or member 'scifdev' not described in 'scif_recv_reg' drivers/misc/mic/scif/scif_rma.c:1178: warning: Function parameter or member 'scifdev' not described in 'scif_recv_unreg' drivers/misc/mic/scif/scif_rma.c:1243: warning: Function parameter or member 'scifdev' not described in 'scif_recv_reg_ack' drivers/misc/mic/scif/scif_rma.c:1262: warning: Function parameter or member 'scifdev' not described in 'scif_recv_reg_nack' drivers/misc/mic/scif/scif_rma.c:1280: warning: Function parameter or member 'scifdev' not described in 'scif_recv_unreg_ack' drivers/misc/mic/scif/scif_rma.c:1299: warning: Function parameter or member 'scifdev' not described in 'scif_recv_unreg_nack' Cc: Sudeep Dutt Cc: Ashutosh Dixit Signed-off-by: Lee Jones --- drivers/misc/mic/scif/scif_rma.c | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/drivers/misc/mic/scif/scif_rma.c b/drivers/misc/mic/scif/scif_rma.c index 406cd5abfa726..de8f61efaef5c 100644 --- a/drivers/misc/mic/scif/scif_rma.c +++ b/drivers/misc/mic/scif/scif_rma.c @@ -458,7 +458,7 @@ static void scif_destroy_remote_lookup(struct scif_dev *remote_dev, /** * scif_create_remote_window: - * @ep: end point + * @scifdev: SCIF device * @nr_pages: number of pages in window * * Allocate and prepare a remote registration window. @@ -500,7 +500,6 @@ scif_create_remote_window(struct scif_dev *scifdev, int nr_pages) /** * scif_destroy_remote_window: - * @ep: end point * @window: remote registration window * * Deallocate resources for remote window. @@ -1037,6 +1036,7 @@ void scif_free_window_offset(struct scif_endpt *ep, /** * scif_alloc_req: Respond to SCIF_ALLOC_REQ interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Remote side is requesting a memory allocation. @@ -1072,6 +1072,7 @@ void scif_alloc_req(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_alloc_gnt_rej: Respond to SCIF_ALLOC_GNT/REJ interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Remote side responded to a memory allocation. @@ -1096,6 +1097,7 @@ void scif_alloc_gnt_rej(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_free_virt: Respond to SCIF_FREE_VIRT interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Free up memory kmalloc'd earlier. @@ -1134,6 +1136,7 @@ scif_fixup_aper_base(struct scif_dev *dev, struct scif_window *window) /** * scif_recv_reg: Respond to SCIF_REGISTER interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Update remote window list with a new registered window. @@ -1170,6 +1173,7 @@ void scif_recv_reg(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_recv_unreg: Respond to SCIF_UNREGISTER interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Remove window from remote registration list; @@ -1235,6 +1239,7 @@ void scif_recv_unreg(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_recv_reg_ack: Respond to SCIF_REGISTER_ACK interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Wake up the window waiting to complete registration. @@ -1253,6 +1258,7 @@ void scif_recv_reg_ack(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_recv_reg_nack: Respond to SCIF_REGISTER_NACK interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Wake up the window waiting to inform it that registration @@ -1272,6 +1278,7 @@ void scif_recv_reg_nack(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_recv_unreg_ack: Respond to SCIF_UNREGISTER_ACK interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Wake up the window waiting to complete unregistration. @@ -1290,6 +1297,7 @@ void scif_recv_unreg_ack(struct scif_dev *scifdev, struct scifmsg *msg) /** * scif_recv_unreg_nack: Respond to SCIF_UNREGISTER_NACK interrupt message + * @scifdev: SCIF device * @msg: Interrupt message * * Wake up the window waiting to inform it that unregistration