From patchwork Mon Jun 29 14:04:27 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11630989 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 357B9912 for ; Mon, 29 Jun 2020 14:07:19 +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 0A42F23D99 for ; Mon, 29 Jun 2020 14:07:19 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="CcRXiULl"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="ous+18uF" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 0A42F23D99 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=akF0c8XSY03BkCt9/aFd/GINT77t/fmz+PKq/+mjTJw=; b=CcRXiULljmyxDSbYzZjo7YsWr lZ2FNNk52Wkt8aUyZZnRVXl/39yZnq3Or43KHr3zUFtT1xEDUomjunO8xQwfJPiKm5ZIPCfyVZin7 pZapai5JQhCVlAlqv8mTJro9d8gqhviZj0jisibFv2rQOje7a5EF2dMXjixguLWwliukoWXNcwlok TvHr2pkShE9/S1TOE4wzDpKqRuNHJ5gD44OkI1fghC5l7nHy4msPxM9NeScgBxDhA8MCXVwZphnsK 7DuVywfuIrQQs+w5ReMtWw5JorwWFHE2rUwVWeY5425+4E5j0m6Uie/5AkSHxaA43YZ2yUI56hwLU A/QVD7KdQ==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpuPW-0004NM-SI; Mon, 29 Jun 2020 14:05:26 +0000 Received: from mail-wr1-x444.google.com ([2a00:1450:4864:20::444]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpuOz-0004DM-Kj for linux-arm-kernel@lists.infradead.org; Mon, 29 Jun 2020 14:04:55 +0000 Received: by mail-wr1-x444.google.com with SMTP id k6so16693912wrn.3 for ; Mon, 29 Jun 2020 07:04:53 -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=yhVnLd0r7raxgcyoOCULQKwhfsHJk9/wusjVrNWGYS4=; b=ous+18uFIcLaG4cRJ524/Q1ebFSiRNvabxyUHCwVUaiHeJAFRIwyphH3zHRsSz0qS9 I5ONR3KmqwEOEL/VKlk9HPadqUmAq9XaRGcdladgrGuMDJF6qgEu6F8CckoAtv06KGIF 3bjATAYVK/0qKDy3omdQMZlPnvhr7hDQovFKt/7+86+M7yFt0QYblSF+uvHDe+QzsSni 9Ql/GNVVBEfWoOPONrJJJ7plhbru+0WlGgEssah/lUvnHKVpKZgryoy/1D9Mo50mDZ8Y sV3VnKgvzDfnBA9b6XtGg5Y4T4G24dfqY34pKwl9m+podVZRUNE9hbt/WluL86x2hc5l eO6Q== 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=yhVnLd0r7raxgcyoOCULQKwhfsHJk9/wusjVrNWGYS4=; b=aT00Nq8IFZN84uHsknx4OmvbRNB0Ss2zZ5GJm260KBoc2t9AsB1is/wJ+5tbqXHjS0 JB0fSE7ldMgVUQZ/GBCJzExM6O9+pO9ZbCsF0o+zSSxRihMYZbAJlvUKMoPjW1DgLQWz OqgkzblZPXCepVLEgYEf1LzRWsJNYS4CfQBg5OdZYjngoWyOH0oogc7NfCOF4zw/OoKK ZI3zc53h+VD6JDpeifWuTFHOswXQSOsSYOj5deGRnieSKMrtgBMES/XHY6rYs2wVR3pY aCvDgHp8lCYGZONXFCgr3gfOuOEB9PMhOepQd8NiZ9YRVRFuXoIi33gH1RRfcCvwNmxR GIQA== X-Gm-Message-State: AOAM533IBAYqOxPPAYmmMekazRMeVoYLaNhUrQbIACZFy81dXzRdW2KC KTuF3Vj+dSVaqwati3l3vL4Rsg== X-Google-Smtp-Source: ABdhPJweOwERgUR+r9gh8XzakhlezA7hIvHmDKSA8UboEuprGSmmgnfQoX93xLHK/KaSO4JsEZHXOQ== X-Received: by 2002:a5d:6603:: with SMTP id n3mr17730012wru.142.1593439492519; Mon, 29 Jun 2020 07:04:52 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id p14sm15394928wrj.14.2020.06.29.07.04.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Jun 2020 07:04:51 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 05/20] misc: habanalabs: irq: Repair kerneldoc formatting issues Date: Mon, 29 Jun 2020 15:04:27 +0100 Message-Id: <20200629140442.1043957-6-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200629140442.1043957-1-lee.jones@linaro.org> References: <20200629140442.1043957-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:444 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: Oded Gabbay , Tomer Tayar , 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 W=1 kernel builds report a lack of descriptions for various function arguments. In reality they are documented, but the formatting was not as expected '@.*:'. Instead, '-'s were used as separators. While we're here, the headers for functions various functions were written in kerneldoc format, but lack the kerneldoc identifier '/**'. Let's promote them so they can gain access to the checker. This change fixes the following W=1 warnings: drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_work' not described in 'hl_eqe_work' drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'hdev' not described in 'hl_eqe_work' drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_entry' not described in 'hl_eqe_work' Cc: Oded Gabbay Cc: Tomer Tayar Signed-off-by: Lee Jones Reviewed-by: Oded Gabbay --- drivers/misc/habanalabs/irq.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/drivers/misc/habanalabs/irq.c b/drivers/misc/habanalabs/irq.c index 4e77a73857793..6981d67153b11 100644 --- a/drivers/misc/habanalabs/irq.c +++ b/drivers/misc/habanalabs/irq.c @@ -13,9 +13,9 @@ * struct hl_eqe_work - This structure is used to schedule work of EQ * entry and armcp_reset event * - * @eq_work - workqueue object to run when EQ entry is received - * @hdev - pointer to device structure - * @eq_entry - copy of the EQ entry + * @eq_work: workqueue object to run when EQ entry is received + * @hdev: pointer to device structure + * @eq_entry: copy of the EQ entry */ struct hl_eqe_work { struct work_struct eq_work; @@ -23,7 +23,7 @@ struct hl_eqe_work { struct hl_eq_entry eq_entry; }; -/* +/** * hl_cq_inc_ptr - increment ci or pi of cq * * @ptr: the current ci or pi value of the completion queue @@ -39,7 +39,7 @@ inline u32 hl_cq_inc_ptr(u32 ptr) return ptr; } -/* +/** * hl_eq_inc_ptr - increment ci of eq * * @ptr: the current ci value of the event queue @@ -66,7 +66,7 @@ static void irq_handle_eqe(struct work_struct *work) kfree(eqe_work); } -/* +/** * hl_irq_handler_cq - irq handler for completion queue * * @irq: irq number @@ -142,7 +142,7 @@ irqreturn_t hl_irq_handler_cq(int irq, void *arg) return IRQ_HANDLED; } -/* +/** * hl_irq_handler_eq - irq handler for event queue * * @irq: irq number @@ -206,7 +206,7 @@ irqreturn_t hl_irq_handler_eq(int irq, void *arg) return IRQ_HANDLED; } -/* +/** * hl_cq_init - main initialization function for an cq object * * @hdev: pointer to device structure @@ -238,7 +238,7 @@ int hl_cq_init(struct hl_device *hdev, struct hl_cq *q, u32 hw_queue_id) return 0; } -/* +/** * hl_cq_fini - destroy completion queue * * @hdev: pointer to device structure @@ -269,7 +269,7 @@ void hl_cq_reset(struct hl_device *hdev, struct hl_cq *q) memset((void *) (uintptr_t) q->kernel_address, 0, HL_CQ_SIZE_IN_BYTES); } -/* +/** * hl_eq_init - main initialization function for an event queue object * * @hdev: pointer to device structure @@ -297,7 +297,7 @@ int hl_eq_init(struct hl_device *hdev, struct hl_eq *q) return 0; } -/* +/** * hl_eq_fini - destroy event queue * * @hdev: pointer to device structure