From patchwork Tue Dec 1 14:29:59 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michal Simek X-Patchwork-Id: 11943069 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.2 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EC074C64E90 for ; Tue, 1 Dec 2020 14:31:33 +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 6AA8A20757 for ; Tue, 1 Dec 2020 14:31:29 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="qbfImzDl"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=monstr-eu.20150623.gappssmtp.com header.i=@monstr-eu.20150623.gappssmtp.com header.b="tDivfi4s" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6AA8A20757 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=xilinx.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.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: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=8+YUDD3V7l3HokKFMFCqDTJ1kok0R4g8+GprGgcWif4=; b=qbfImzDlI9HgHaZUWKdLO5f2PF pYk/CjX+d6C57p44laaZx7ShCeQLf94cjg7/MxfCZYRLqQhgZx2XV/tn+al2UxsbEs25iwDmZGthV CbF0OkKrh8XppsIRkoKDBb7O0SxkxkP38GqlxLCoYxr1WLGSai/YEIWO8f2cTdYvbELqIOHYOksIy mvMUBmwwd8Wq4ioEqbey9Ze3YwdIfKK4N8cCZL4RAuqrVuqDxhCf9aKnEjNGKbyGeyyDAcI8oWJ6Y mIdZwD82/ESaXVrt0igvo65JqAbbHruLn+NjwkBQh5MzWbbMIaVH9HicEFTW2vuyLlxMHCE8ogKDv VHIMtqzg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1kk6fP-0001nR-6j; Tue, 01 Dec 2020 14:30:07 +0000 Received: from mail-ej1-x641.google.com ([2a00:1450:4864:20::641]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1kk6fM-0001mF-Sd for linux-arm-kernel@lists.infradead.org; Tue, 01 Dec 2020 14:30:05 +0000 Received: by mail-ej1-x641.google.com with SMTP id bo9so4450069ejb.13 for ; Tue, 01 Dec 2020 06:30:02 -0800 (PST) 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:mime-version :content-transfer-encoding; bh=WO5uI3wqo8BxEatZNnJUdmrNd6YvRjUl6nOzRzJj5ts=; b=tDivfi4snLHRZnjcpXGbIG3jOFgykooGKj6LDmom5rwgcJ9bA+LT4oCpxnNPitfgIG +gDkujk+ret3qH59dm5T9KNZG6TW/myRcKpl7HqRDHVL+zBvMLoZVGEy+wW/CIvmfYwm G1GFmktC6qroZT7miiE190NoI0L4AxnTx908dxDVVI0YjKjO/l0Uly+5Xau3B81c0MHK Z7oCNHTmNhVKdwTQQy9PMMQfdKazkGGVF2yc7sFYPKtayW7xWjSZcdVRiSFYCUPwP+0S SKkoFPx1a12mMXZlGTupySZD3sJvsEQswaSY56MqHQGU9Q9elTyagouVqDbzUL7Q9zS+ WDLw== 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 :mime-version:content-transfer-encoding; bh=WO5uI3wqo8BxEatZNnJUdmrNd6YvRjUl6nOzRzJj5ts=; b=fXqGtAetjbI3wayMuA9XR7EQDgn7k/eCpZcmh+D3FNjWACHiKong+Gz5zyVRmUc7hB FBVFfGeKzk7rO3JK0GFQ/kBHibrcEDxzqfYwnYFLN/qRldgG/Mt1SEywzjl4OFzMwWnl b+Z8bZHyYIX1pG606umKOwOxhRbP7dJmew/UpFszvUe+CtqSFICYwK5dPoDuT9bFdheZ B49a5+Udo9A1xQpP5Nnf3M5lvguKc4Bc10NGWcbNPyS2HfdoUksXTxx2KxC+0s8xbWub Nr4su9sNcyRn7meZlY7HU5JkF4zt44QywjvnC5OI2sdUvET3Gj9nAwQua59auOHRC2a4 uUzw== X-Gm-Message-State: AOAM533k9m2lYOUJf/D8RrogcBMbSWY1ad3ioK3c9SCwMM5tIIj2EYq4 HHDw8U0w/7MRtZOeLPbJyK4+w6NHMmJOajIx X-Google-Smtp-Source: ABdhPJy6E1/hUVZhiVShCZ9UIUdnza6vjqzW8pG4frcVUCvFe94wBK0kPaiqudlfun797Xks+yQmBw== X-Received: by 2002:a17:906:1405:: with SMTP id p5mr3206491ejc.282.1606833001611; Tue, 01 Dec 2020 06:30:01 -0800 (PST) Received: from localhost (nat-35.starnet.cz. [178.255.168.35]) by smtp.gmail.com with ESMTPSA id q5sm924676ejr.89.2020.12.01.06.30.00 (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Tue, 01 Dec 2020 06:30:01 -0800 (PST) From: Michal Simek To: linux-kernel@vger.kernel.org, monstr@monstr.eu, michal.simek@xilinx.com, git@xilinx.com Subject: [PATCH] firmware: xilinx: Fix kernel-doc warnings Date: Tue, 1 Dec 2020 15:29:59 +0100 Message-Id: X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20201201_093005_051368_FC2F7B8E X-CRM114-Status: GOOD ( 13.85 ) 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: Ravi Patel , Sai Krishna Potthuri , Rajan Vaja , Greg Kroah-Hartman , Manish Narani , linux-arm-kernel@lists.infradead.org, Jolly Shah , Tejas Patel Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org kernel-doc is reporting some style issues. The patch is fixing them. Signed-off-by: Michal Simek --- drivers/firmware/xilinx/zynqmp.c | 46 ++++++++++++++++---------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/drivers/firmware/xilinx/zynqmp.c b/drivers/firmware/xilinx/zynqmp.c index d6f12c89c6f3..ddf8e4e72584 100644 --- a/drivers/firmware/xilinx/zynqmp.c +++ b/drivers/firmware/xilinx/zynqmp.c @@ -585,13 +585,13 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_get_pll_frac_data); /** * zynqmp_pm_set_sd_tapdelay() - Set tap delay for the SD device * - * @node_id Node ID of the device - * @type Type of tap delay to set (input/output) - * @value Value to set fot the tap delay + * @node_id: Node ID of the device + * @type: Type of tap delay to set (input/output) + * @value: Value to set fot the tap delay * * This function sets input/output tap delay for the SD device. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value) { @@ -603,12 +603,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_set_sd_tapdelay); /** * zynqmp_pm_sd_dll_reset() - Reset DLL logic * - * @node_id Node ID of the device - * @type Reset type + * @node_id: Node ID of the device + * @type: Reset type * * This function resets DLL logic for the SD device. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type) { @@ -619,12 +619,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_sd_dll_reset); /** * zynqmp_pm_write_ggs() - PM API for writing global general storage (ggs) - * @index GGS register index - * @value Register value to be written + * @index: GGS register index + * @value: Register value to be written * * This function writes value to GGS register. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_write_ggs(u32 index, u32 value) { @@ -635,12 +635,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_write_ggs); /** * zynqmp_pm_write_ggs() - PM API for reading global general storage (ggs) - * @index GGS register index - * @value Register value to be written + * @index: GGS register index + * @value: Register value to be written * * This function returns GGS register value. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_read_ggs(u32 index, u32 *value) { @@ -652,12 +652,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_read_ggs); /** * zynqmp_pm_write_pggs() - PM API for writing persistent global general * storage (pggs) - * @index PGGS register index - * @value Register value to be written + * @index: PGGS register index + * @value: Register value to be written * * This function writes value to PGGS register. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_write_pggs(u32 index, u32 value) { @@ -669,12 +669,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_write_pggs); /** * zynqmp_pm_write_pggs() - PM API for reading persistent global general * storage (pggs) - * @index PGGS register index - * @value Register value to be written + * @index: PGGS register index + * @value: Register value to be written * * This function returns PGGS register value. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_read_pggs(u32 index, u32 *value) { @@ -685,12 +685,12 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_read_pggs); /** * zynqmp_pm_set_boot_health_status() - PM API for setting healthy boot status - * @value Status value to be written + * @value: Status value to be written * * This function sets healthy bit value to indicate boot health status * to firmware. * - * @return Returns status, either success or error+reason + * Return: Returns status, either success or error+reason */ int zynqmp_pm_set_boot_health_status(u32 value) { @@ -899,10 +899,10 @@ EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_set_config); * zynqmp_pm_init_finalize() - PM call to inform firmware that the caller * master has initialized its own power management * + * Return: Returns status, either success or error+reason + * * This API function is to be used for notify the power management controller * about the completed power management initialization. - * - * Return: Returns status, either success or error+reason */ int zynqmp_pm_init_finalize(void) {