From patchwork Mon Jun 29 14:04:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11630985 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 F006D912 for ; Mon, 29 Jun 2020 14:07:07 +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 C719923D99 for ; Mon, 29 Jun 2020 14:07:07 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="lgd3yVp9"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="EBCbSVbx" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C719923D99 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=v+d75nRv5S+TQFka4deV6tyuJ3zUZHIpndcUgQhF/wk=; b=lgd3yVp9f4Rp3Kbh/+RVwmq/5 GaQCvwpSyjud8ssWQazVaDv7Qu1kFZ1vywJefueZHTYxSFijgSq3sUjfb6CZLZpyj86xmTiSFfLtE 04Qo14QOUo5obZQ7wm/6zaiGL5oYJbnoR08ItidV/G3tYkOU4yyp2pA2JuotOMCqGqaw7Ov29721l 0o+5Tshny16NHqha4gGfRLNUNJdZUjtIOga9XyN2TGcaDf0/td3sF01Zxxk2Zgslgih3uxpZivxlu VSiGfBzFkCW5jIV/U+6iPDrhjvfAIizt9b9nqIZLyGJIbZF0hKxxwcpu4L1RFjwrKumqiNtxriR1P kmh/b/svA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jpuPS-0004Ly-UX; Mon, 29 Jun 2020 14:05:23 +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 1jpuOx-0004Cs-QB for linux-arm-kernel@lists.infradead.org; Mon, 29 Jun 2020 14:04:55 +0000 Received: by mail-wm1-x344.google.com with SMTP id j18so15513185wmi.3 for ; Mon, 29 Jun 2020 07:04:51 -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=snRavlMzvk6o89999ihW2SJGcP4kgkkLuKbzazJuz7M=; b=EBCbSVbxb5YiApQEcA5o+TIGFgyXHcDAl7i662DfxDYdnp862l0GPoQfWOcNUtjcSe jnezcozxuPVkZo5f4KjMKLccsMOZTvdDTyEbUlK4123+wVNAkXCXWv8ZfYrJxAS3qZ93 8vrs/CdF0z7YODI7HgsfSKNJdxYv1vhR4+IGMmCaoAOzFgJycGJVJ0ZGcNbsup+I/eZE XqHkVB4Rbu4LtbCpo307g++fMpBLSJJGlXhTLve6b5TV0o4HitW+xa8FO/mP/sCAT6Pa 3VnkcXGnjMH8qE1jsEUyE7sTCYERb3R3EtTgvwOpZAcOq6zxn7z3UFHnAkImidK5q/fj I+6g== 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=snRavlMzvk6o89999ihW2SJGcP4kgkkLuKbzazJuz7M=; b=hEc9IVtXzXlGPHP1eHLEKcGMsPZACOPV6hG4q99rUwS73qOgca213cGarZVZkuI7+F nJxJwkcVXW8n7DknOzOfRHBaWGpZ12AXxISbq9A+APs4jtaM0EPVE7bT8VPClfmdHySn 4a9s0Hr0MQVwEpkiMsWD19Ntx8AMI9bt2iQKlhiOWax5ftzAwKgqsr9CxjpGaM73D5yK cUA+jvQa7RzTKez8fMqf1u6prIAOz5Ba0DQARifI0TDVz8C/qQdclHr+JmRYfIhiSM9H O3NN6Ym73HXfiW5xFgnNt+UgJgwq3WputxCXM2Osm/jNcJZUJPrNBHpDn3Uk6QOH1gZh gd9Q== X-Gm-Message-State: AOAM532GDs5MhDgUYHoBn4nt1gMczKoCxjxJwGIN6HoIl4t/Bp5ofs3s 1gbrptcnyMjmXA7iNXbO6UeMDA== X-Google-Smtp-Source: ABdhPJwtIrvDrDIcBEd1RS2NhZDsLvIxIfEKOQpWVF86D0jsOeJclt4mGbamK7+WRgzx6R43bbW3/Q== X-Received: by 2002:a1c:2cd7:: with SMTP id s206mr16182224wms.109.1593439490833; Mon, 29 Jun 2020 07:04:50 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id p14sm15394928wrj.14.2020.06.29.07.04.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Jun 2020 07:04:50 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 04/20] misc: habanalabs: pci: Fix a variety of kerneldoc issues Date: Mon, 29 Jun 2020 15:04:26 +0100 Message-Id: <20200629140442.1043957-5-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: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: 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 hl_pci_bars_map() has a miss-typed argument name in the function description. hl_pci_elbi_write() was missing documented arguments. The headers for functions hl_pci_bars_unmap(), hl_pci_elbi_write() and hl_pci_reset_link_through_bridge() were written in kerneldoc format, but lack the kerneldoc identifier '/**'. Let's promote them so they can gain access to the checker. These changes fix the following W=1 kernel build warnings: drivers/misc/habanalabs/pci.c:27: warning: Function parameter or member 'name' not described in 'hl_pci_bars_map' drivers/misc/habanalabs/pci.c:27: warning: Excess function parameter 'bar_name' description in 'hl_pci_bars_map' drivers/misc/habanalabs/pci.c:147: warning: Function parameter or member 'addr' not described in 'hl_pci_iatu_write' drivers/misc/habanalabs/pci.c:147: warning: Function parameter or member 'data' not described in 'hl_pci_iatu_write' drivers/misc/habanalabs/pci.c:324: warning: Excess function parameter 'dma_mask' description in 'hl_pci_set_dma_mask' Cc: Oded Gabbay Cc: Tomer Tayar Signed-off-by: Lee Jones Reviewed-by: Oded Gabbay --- drivers/misc/habanalabs/pci.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/drivers/misc/habanalabs/pci.c b/drivers/misc/habanalabs/pci.c index 9f634ef6f5b37..24073e8eb8df9 100644 --- a/drivers/misc/habanalabs/pci.c +++ b/drivers/misc/habanalabs/pci.c @@ -15,7 +15,7 @@ /** * hl_pci_bars_map() - Map PCI BARs. * @hdev: Pointer to hl_device structure. - * @bar_name: Array of BAR names. + * @name: Array of BAR names. * @is_wc: Array with flag per BAR whether a write-combined mapping is needed. * * Request PCI regions and map them to kernel virtual addresses. @@ -61,7 +61,7 @@ int hl_pci_bars_map(struct hl_device *hdev, const char * const name[3], return rc; } -/* +/** * hl_pci_bars_unmap() - Unmap PCI BARS. * @hdev: Pointer to hl_device structure. * @@ -80,9 +80,11 @@ static void hl_pci_bars_unmap(struct hl_device *hdev) pci_release_regions(pdev); } -/* +/** * hl_pci_elbi_write() - Write through the ELBI interface. * @hdev: Pointer to hl_device structure. + * @addr: Address to write to + * @data: Data to write * * Return: 0 on success, negative value for failure. */ @@ -140,6 +142,8 @@ static int hl_pci_elbi_write(struct hl_device *hdev, u64 addr, u32 data) /** * hl_pci_iatu_write() - iatu write routine. * @hdev: Pointer to hl_device structure. + * @addr: Address to write to + * @data: Data to write * * Return: 0 on success, negative value for failure. */ @@ -161,7 +165,7 @@ int hl_pci_iatu_write(struct hl_device *hdev, u32 addr, u32 data) return 0; } -/* +/** * hl_pci_reset_link_through_bridge() - Reset PCI link. * @hdev: Pointer to hl_device structure. */