From patchwork Fri Jul 28 13:17:25 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michal Simek X-Patchwork-Id: 9868781 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id B516660382 for ; Fri, 28 Jul 2017 13:18:30 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A0346288D4 for ; Fri, 28 Jul 2017 13:18:30 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 948E6288DC; Fri, 28 Jul 2017 13:18:30 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_DNSWL_NONE autolearn=unavailable version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [65.50.211.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 2EC35288D4 for ; Fri, 28 Jul 2017 13:18:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:Cc:List-Subscribe: List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id: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:In-Reply-To: References:List-Owner; bh=3tmfAxqFBEnFNw/Z9cvfk6pWeXkLABw/eyN16Hw6e/0=; b=TuL qkXTszpmrFOyKLddD8aeNLgbAY/H9ex0Q2zDOs5SHOInDua6L9xhsbLNBmzwsa1hCyKplp9OX+u9G nYdcDmIOvetx/zC3ku94cwmq+MrNjpMc1uFm1HydsjKDK17CPf71cmerrwasNbkgAL/iLCvDbno8q +1Z15mJ4ZTypMOYSA3chy+iQNnxGOBsUJYSQjqfV5wvnlAvlihHhvPqbXZyBUmwHfc5u9AJrsQtai QGAVWEnihv+LDPMPe7uDEvkZThBehzEjQdC7e1CWwVl1Bb4pi2pilM0G4mBivIu6QC98+sXDjzjX3 vt+q+aId5fSVKLNEqTKfD3e08SMcXNw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.87 #1 (Red Hat Linux)) id 1db59t-00045M-NJ; Fri, 28 Jul 2017 13:18:25 +0000 Received: from mail-wr0-x244.google.com ([2a00:1450:400c:c0c::244]) by bombadil.infradead.org with esmtps (Exim 4.87 #1 (Red Hat Linux)) id 1db59O-0003V0-3l for linux-arm-kernel@lists.infradead.org; Fri, 28 Jul 2017 13:18:04 +0000 Received: by mail-wr0-x244.google.com with SMTP id o33so19060112wrb.1 for ; Fri, 28 Jul 2017 06:17:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monstr-eu.20150623.gappssmtp.com; s=20150623; h=sender:from:to:cc:subject:date:message-id; bh=LhLBbF4ij4m6S4Qr5YVLAuGYN0H5ccjEZ5XoUYZw5bY=; b=VjuJ8sM8tO5MPBG3mLF4ZMIJf5YVZnOscDIk7abCUlvcximtfea01ENs11XXZKBVQN W8kYisqFp9DeNKWqHEtRW01q1TzmMuyx4+wydLh54HbvKuA9qQS3q6Ux3Jefvw4QMYOt a6hYzyzNrNFzQVXntt9Vhn6IlmfCmCbCHMtdt4XcitalfmC2K5/EH5upmMhROfjGEX95 jrC9OBec2yo9RdDe9euixoOpdot3GmSDvKKuA2BOkSvC5E7F4zqO6IL0JZ1/wGSW7hWQ 5ijHk+p5svB8Mqe/c13un8cF6f6a+/q7HrMiHZ32LZqh7euDDSVrMqjBa+aDqNdFI0O2 iKEA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id; bh=LhLBbF4ij4m6S4Qr5YVLAuGYN0H5ccjEZ5XoUYZw5bY=; b=ZqthYg0y2THgjG9NBhtbH4Sj/MvHVw+fyiy1+wAowRL+c3g59CxjmonMG2S41j7sPi Ovj7dHVaraFOgH0yOllChaVDjgjTRfUhAHLxS+0xwnrZzyhyvi8gWxEMmDVEh0jnMswU WELCZ/LOQQf8Xtxy23p8TSfi5Y6nVXrF13xqtzVRziC8sGC8ofVltoq1lzCbXUmglaQY t2suQDSkIxUeRPK4aFeO3E6ZBxg/wZFfbJ2G7LHU2AploPVl8ps2G68rCOIYJZZJUWAp YMc7ZZTHZQCMhmYEV8VwuM8LrrXJsO6XlUQWCNwnAf4mGotIUkAukRRiRO5e4+XirCSK MniA== X-Gm-Message-State: AIVw112D6rUR2agO7vEqKR11/b/1fM28n4SekB44U6CC5g/mC5nXOrVK ejNsHZW22+giH4LF X-Received: by 10.223.170.144 with SMTP id h16mr6159861wrc.227.1501247851539; Fri, 28 Jul 2017 06:17:31 -0700 (PDT) Received: from localhost (nat-35.starnet.cz. [178.255.168.35]) by smtp.gmail.com with ESMTPSA id p45sm21755732wrb.75.2017.07.28.06.17.30 (version=TLS1_2 cipher=AES128-SHA bits=128/128); Fri, 28 Jul 2017 06:17:30 -0700 (PDT) From: Michal Simek To: linux-kernel@vger.kernel.org, monstr@monstr.eu Subject: [PATCH 1/2] char: xilinx_hwicap: Fix kernel doc warnings Date: Fri, 28 Jul 2017 15:17:25 +0200 Message-Id: <6da0afe2afd2c7a21d16da9a9c7acab09385ae2c.1501247838.git.michal.simek@xilinx.com> X-Mailer: git-send-email 1.9.1 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20170728_061754_620651_05F4A804 X-CRM114-Status: GOOD ( 12.26 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-arm-kernel@lists.infradead.org, Nava kishore Manne , Arnd Bergmann , =?UTF-8?q?S=C3=B6ren=20Brinkmann?= , Greg Kroah-Hartman MIME-Version: 1.0 Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP From: Nava kishore Manne This patch fixes the kernel doc warnings in the driver. Signed-off-by: Nava kishore Manne Signed-off-by: Michal Simek --- drivers/char/xilinx_hwicap/xilinx_hwicap.c | 4 ++++ drivers/char/xilinx_hwicap/xilinx_hwicap.h | 7 +++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/drivers/char/xilinx_hwicap/xilinx_hwicap.c b/drivers/char/xilinx_hwicap/xilinx_hwicap.c index 3e6b23c3453c..5e5c8ee23a5b 100644 --- a/drivers/char/xilinx_hwicap/xilinx_hwicap.c +++ b/drivers/char/xilinx_hwicap/xilinx_hwicap.c @@ -222,6 +222,8 @@ * hwicap_command_desync - Send a DESYNC command to the ICAP port. * @drvdata: a pointer to the drvdata. * + * Returns: '0' on success and failure value on error + * * This command desynchronizes the ICAP After this command, a * bitstream containing a NULL packet, followed by a SYNCH packet is * required before the ICAP will recognize commands. @@ -255,6 +257,8 @@ static int hwicap_command_desync(struct hwicap_drvdata *drvdata) * Examples: XHI_IDCODE, XHI_FLR. * @reg_data: returns the value of the register. * + * Returns: '0' on success and failure value on error + * * Sends a query packet to the ICAP and then receives the response. * The icap is left in Synched state. */ diff --git a/drivers/char/xilinx_hwicap/xilinx_hwicap.h b/drivers/char/xilinx_hwicap/xilinx_hwicap.h index 38b145eaf24d..1f687a71e36e 100644 --- a/drivers/char/xilinx_hwicap/xilinx_hwicap.h +++ b/drivers/char/xilinx_hwicap/xilinx_hwicap.h @@ -193,11 +193,12 @@ struct config_registers { * hwicap_type_1_read - Generates a Type 1 read packet header. * @reg: is the address of the register to be read back. * + * Return: * Generates a Type 1 read packet header, which is used to indirectly * read registers in the configuration logic. This packet must then * be sent through the icap device, and a return packet received with * the information. - **/ + */ static inline u32 hwicap_type_1_read(u32 reg) { return (XHI_TYPE_1 << XHI_TYPE_SHIFT) | @@ -208,7 +209,9 @@ static inline u32 hwicap_type_1_read(u32 reg) /** * hwicap_type_1_write - Generates a Type 1 write packet header * @reg: is the address of the register to be read back. - **/ + * + * Return: Type 1 write packet header + */ static inline u32 hwicap_type_1_write(u32 reg) { return (XHI_TYPE_1 << XHI_TYPE_SHIFT) |