From patchwork Fri Nov 6 21:36:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 320837 Delivered-To: patch@linaro.org Received: by 2002:a92:7b12:0:0:0:0:0 with SMTP id w18csp1651871ilc; Fri, 6 Nov 2020 13:40:40 -0800 (PST) X-Google-Smtp-Source: ABdhPJwJtYcaqhalRrvgcH609mjiAmNZUCSGe4m4DmLsYCXTTKYkTBjsy+2BPtiuH0pyIASWL1vI X-Received: by 2002:a05:6000:345:: with SMTP id e5mr4492688wre.333.1604698840085; Fri, 06 Nov 2020 13:40:40 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1604698840; cv=none; d=google.com; s=arc-20160816; b=qRQfU9rAKcGJGGxtVVqQqxkPnFNpNShRM5kLnNXuEix6AnefjlnuDcMi374usyWIKv xxeHiDra9GHqqa4J8Pi9eze/5Fhg67Wnr87nw+3fiL134C+1XiNHKH2+9430Bowxp1Lx VrbxtKz+CWIyZGprzUrauZICS4wg3rThflnWBWrD3AXafzwKG/AcIR4UBYCtM2crZWqX I3omeVw+qZDevOxYFtpD4EcvjtnK40gIsAZ67kVN2bH2u7jD99xx7d3vxdbXXnUcWsiA Q2Td8UFvaUXubyf3h8wqfMQuhWK+91OUPYGVoWq+nyu/QpJA5cmqnr8JTkuAH9As/OCe YKnQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=errors-to:sender:content-transfer-encoding:cc:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:mime-version:references:in-reply-to:message-id:date :subject:to:from:dkim-signature:dkim-signature; bh=qYFXGHJ+seoQipdoVZO+eC0JavciE+RxMUNfbt8cpEk=; b=jSb8DjzDr1fCy1IrOET/p/vCSrDbpHxvydvzv1LhB186Rc/UtMjlwEc1Yw1GAPHP5G 4xfieNKjmQhG71Vyb1ssjwOuQVFFbrlVEHTJaQh/wkLwqAsAWMK/S5HPEiyLGHcIAsya zymP9DH6f5Ssih1ldj4o4OPbPQqRkR7FEyGJgOodiK2xyBQQHuPTuQFd8AWWP7IHJS9G X+Ss2gsawF1u8SQt5RU3QWMz53tVbp5fcjNahEn/C8+VxgcDjt4rSLIwox4/Xmu4DQpc wfFA8aVFUB96MH+cR+XQ09T/QKDSfdHi1jES77m7qR9olSMDIbm2Cbmgm5KvVhW7b0es LTCQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@lists.infradead.org header.s=merlin.20170209 header.b=LyyJ0+px; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=fQkMLtI3; spf=pass (google.com: best guess record for domain of linux-mtd-bounces+patch=linaro.org@lists.infradead.org designates 2001:8b0:10b:1231::1 as permitted sender) smtp.mailfrom="linux-mtd-bounces+patch=linaro.org@lists.infradead.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from merlin.infradead.org (merlin.infradead.org. [2001:8b0:10b:1231::1]) by mx.google.com with ESMTPS id q4si2260420wrw.54.2020.11.06.13.40.39 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Nov 2020 13:40:40 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-mtd-bounces+patch=linaro.org@lists.infradead.org designates 2001:8b0:10b:1231::1 as permitted sender) client-ip=2001:8b0:10b:1231::1; Authentication-Results: mx.google.com; dkim=pass header.i=@lists.infradead.org header.s=merlin.20170209 header.b=LyyJ0+px; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=fQkMLtI3; spf=pass (google.com: best guess record for domain of linux-mtd-bounces+patch=linaro.org@lists.infradead.org designates 2001:8b0:10b:1231::1 as permitted sender) smtp.mailfrom="linux-mtd-bounces+patch=linaro.org@lists.infradead.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.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=qYFXGHJ+seoQipdoVZO+eC0JavciE+RxMUNfbt8cpEk=; b=LyyJ0+pxvOdhJFK9e1lXy+SRE VsOPrRWP+ETTwEmEattnSOb1OZZWvLw44PnJPp9rabjaxgoXv9kPG1emhQvyvZ4TjZ6LjE3oYt1fk hxv3Z72sytRCavvRTA9hGPakYD9YWUE8B3KjMeX1fZaQ2m8q0LO5GR+OB15+uPcTW3yTMTW2psq+j TFndfQ6nH0SKn0ndd0u4qydVE/kq+t4QjGxb2/mk4FuG3p6nh8ErP6rKMfmCGMgPCTvFLvA/Yjnm+ paEiEkdzLqXG8HgBRDgukWjUaj0zry27nSajJkIUDvH8hPt9pvdGBZnbWJZ5ZbGLF/VNa7ywVHa0a grTlJ+YIw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1kb9SR-0003wl-DQ; Fri, 06 Nov 2020 21:39:43 +0000 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1kb9QD-0002ge-9q for linux-mtd@lists.infradead.org; Fri, 06 Nov 2020 21:37:29 +0000 Received: by mail-wm1-x341.google.com with SMTP id p22so2815761wmg.3 for ; Fri, 06 Nov 2020 13:37:25 -0800 (PST) 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=L9e594iGsPQazHtR8mr0tF4GNyBoavTbOlvYUU648dY=; b=fQkMLtI3jRMu0qJTAzLmT9sPs3g2kSFvpEfcUm48VsT9veBNfwxyjelqHMe5RGhlJl yAdcpBeo6Viv+XbU7khoYaO2OCICXxNtrjXAWn9GmjWK6wON3wcQnp30LoNA46vsnaTf PT/DIyVKteZ69p56UD52b8pS6Rfmws+Ofjhv2UTmpVqUP+afGGgpudPY1aJ1CKhxSZA3 Jd7s6g2FSXBobiP6aWe/HsuPwzQklf4lNRrZDxfI8IGsmErymbBTaeH7Z2Udwiw8OBZ4 irGVpOVEJcL3/u4qjf5Pxy4Q5f6x8jPNb7+Uu3MgSQtrgGD8pef6VLhQPkDAUHw59LEK SY1Q== 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=L9e594iGsPQazHtR8mr0tF4GNyBoavTbOlvYUU648dY=; b=lco7CmwkjSxewwGeEe0P9dTjT+zHWjH6p95SnJMrP7h+nWzG2BSKjpSiB6VKT7nkdI c3gqSNbuvCh+u8wClc3dVO0eXTEKF1j+vrV6SEJoI+YC9xhb/ZAF0vuvEJ1ATMnYH8Gz LZsN9g4xFo4K2/9YSd6mnpZx93xSAm6PXY6rVGCmVput0WG/jZDpZPAAIQ5kIr16DKwE GwD+502IHpKukdPaRgmFUOpqX9qWzRPnDm8WtxgQdgyqj1e624O47Jo7s/6vlXxEm+Q4 fKfSnHYaFxeK+ksfv9tiE9qB7hVCn0tiOdCnsnTFo1xKitczZSL8yFs9M4kXAflCFTar l9hQ== X-Gm-Message-State: AOAM530JOGexPsboeOeyZ+yC6OjQHoEuLtzYZVWZfgT637PPwdpCJYGH rQ45rE6ONsVAwbMa3qUEepPHj2RZ44C0z4ls X-Received: by 2002:a1c:e286:: with SMTP id z128mr1590177wmg.33.1604698644192; Fri, 06 Nov 2020 13:37:24 -0800 (PST) Received: from dell.default ([91.110.221.236]) by smtp.gmail.com with ESMTPSA id d16sm3984942wrw.17.2020.11.06.13.37.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Nov 2020 13:37:23 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH v2 19/23] mtd: nand: raw: omap2: Fix a bunch of kernel-doc misdemeanours Date: Fri, 6 Nov 2020 21:36:51 +0000 Message-Id: <20201106213655.1838861-20-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201106213655.1838861-1-lee.jones@linaro.org> References: <20201106213655.1838861-1-lee.jones@linaro.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20201106_163725_530001_6870FA36 X-CRM114-Status: GOOD ( 17.53 ) 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:341 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -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_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain X-BeenThere: linux-mtd@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux MTD discussion mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Vignesh Raghavendra , Richard Weinberger , linux-kernel@vger.kernel.org, linux-mtd@lists.infradead.org, Miquel Raynal , Jian Zhang Sender: "linux-mtd" Errors-To: linux-mtd-bounces+patch=linaro.org@lists.infradead.org Fixes the following W=1 kernel build warning(s): drivers/mtd/nand/raw/omap2.c:191: warning: Function parameter or member 'info' not described in 'omap_prefetch_enable' drivers/mtd/nand/raw/omap2.c:221: warning: Function parameter or member 'cs' not described in 'omap_prefetch_reset' drivers/mtd/nand/raw/omap2.c:221: warning: Function parameter or member 'info' not described in 'omap_prefetch_reset' drivers/mtd/nand/raw/omap2.c:946: warning: Function parameter or member 'chip' not described in 'omap_enable_hwecc' drivers/mtd/nand/raw/omap2.c:946: warning: Excess function parameter 'mtd' description in 'omap_enable_hwecc' drivers/mtd/nand/raw/omap2.c:1017: warning: Function parameter or member 'chip' not described in 'omap_dev_ready' drivers/mtd/nand/raw/omap2.c:1017: warning: Excess function parameter 'mtd' description in 'omap_dev_ready' drivers/mtd/nand/raw/omap2.c:1036: warning: Function parameter or member 'chip' not described in 'omap_enable_hwecc_bch' drivers/mtd/nand/raw/omap2.c:1036: warning: Excess function parameter 'mtd' description in 'omap_enable_hwecc_bch' drivers/mtd/nand/raw/omap2.c:1142: warning: Function parameter or member 'ecc_calc' not described in '_omap_calculate_ecc_bch' drivers/mtd/nand/raw/omap2.c:1142: warning: Excess function parameter 'ecc_code' description in '_omap_calculate_ecc_bch' drivers/mtd/nand/raw/omap2.c:1270: warning: Function parameter or member 'ecc_calc' not described in 'omap_calculate_ecc_bch_sw' drivers/mtd/nand/raw/omap2.c:1270: warning: Excess function parameter 'ecc_code' description in 'omap_calculate_ecc_bch_sw' drivers/mtd/nand/raw/omap2.c:1284: warning: Function parameter or member 'ecc_calc' not described in 'omap_calculate_ecc_bch_multi' drivers/mtd/nand/raw/omap2.c:1284: warning: Excess function parameter 'ecc_code' description in 'omap_calculate_ecc_bch_multi' drivers/mtd/nand/raw/omap2.c:1681: warning: Function parameter or member 'info' not described in 'is_elm_present' drivers/mtd/nand/raw/omap2.c:1681: warning: Function parameter or member 'elm_node' not described in 'is_elm_present' drivers/mtd/nand/raw/omap2.c:1681: warning: Excess function parameter 'omap_nand_info' description in 'is_elm_present' Cc: Miquel Raynal Cc: Richard Weinberger Cc: Vignesh Raghavendra Cc: Jian Zhang Cc: linux-mtd@lists.infradead.org Signed-off-by: Lee Jones --- drivers/mtd/nand/raw/omap2.c | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) -- 2.25.1 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/ diff --git a/drivers/mtd/nand/raw/omap2.c b/drivers/mtd/nand/raw/omap2.c index 4cc47ab7f01ad..fbb9955f24671 100644 --- a/drivers/mtd/nand/raw/omap2.c +++ b/drivers/mtd/nand/raw/omap2.c @@ -184,6 +184,7 @@ static inline struct omap_nand_info *mtd_to_omap(struct mtd_info *mtd) * @dma_mode: dma mode enable (1) or disable (0) * @u32_count: number of bytes to be transferred * @is_write: prefetch read(0) or write post(1) mode + * @info: NAND device structure containing platform data */ static int omap_prefetch_enable(int cs, int fifo_th, int dma_mode, unsigned int u32_count, int is_write, struct omap_nand_info *info) @@ -213,7 +214,7 @@ static int omap_prefetch_enable(int cs, int fifo_th, int dma_mode, return 0; } -/** +/* * omap_prefetch_reset - disables and stops the prefetch engine */ static int omap_prefetch_reset(int cs, struct omap_nand_info *info) @@ -938,7 +939,7 @@ static int omap_calculate_ecc(struct nand_chip *chip, const u_char *dat, /** * omap_enable_hwecc - This function enables the hardware ecc functionality - * @mtd: MTD device structure + * @chip: NAND chip object * @mode: Read/Write mode */ static void omap_enable_hwecc(struct nand_chip *chip, int mode) @@ -1008,7 +1009,7 @@ static int omap_wait(struct nand_chip *this) /** * omap_dev_ready - checks the NAND Ready GPIO line - * @mtd: MTD device structure + * @chip: NAND chip object * * Returns true if ready and false if busy. */ @@ -1021,7 +1022,7 @@ static int omap_dev_ready(struct nand_chip *chip) /** * omap_enable_hwecc_bch - Program GPMC to perform BCH ECC calculation - * @mtd: MTD device structure + * @chip: NAND chip object * @mode: Read/Write mode * * When using BCH with SW correction (i.e. no ELM), sector size is set @@ -1130,7 +1131,7 @@ static u8 bch8_polynomial[] = {0xef, 0x51, 0x2e, 0x09, 0xed, 0x93, 0x9a, 0xc2, * _omap_calculate_ecc_bch - Generate ECC bytes for one sector * @mtd: MTD device structure * @dat: The pointer to data on which ecc is computed - * @ecc_code: The ecc_code buffer + * @ecc_calc: The ecc_code buffer * @i: The sector number (for a multi sector page) * * Support calculating of BCH4/8/16 ECC vectors for one sector @@ -1258,7 +1259,7 @@ static int _omap_calculate_ecc_bch(struct mtd_info *mtd, * omap_calculate_ecc_bch_sw - ECC generator for sector for SW based correction * @chip: NAND chip object * @dat: The pointer to data on which ecc is computed - * @ecc_code: The ecc_code buffer + * @ecc_calc: Buffer storing the calculated ECC bytes * * Support calculating of BCH4/8/16 ECC vectors for one sector. This is used * when SW based correction is required as ECC is required for one sector @@ -1274,7 +1275,7 @@ static int omap_calculate_ecc_bch_sw(struct nand_chip *chip, * omap_calculate_ecc_bch_multi - Generate ECC for multiple sectors * @mtd: MTD device structure * @dat: The pointer to data on which ecc is computed - * @ecc_code: The ecc_code buffer + * @ecc_calc: Buffer storing the calculated ECC bytes * * Support calculating of BCH4/8/16 ecc vectors for the entire page in one go. */ @@ -1673,7 +1674,8 @@ static int omap_read_page_bch(struct nand_chip *chip, uint8_t *buf, /** * is_elm_present - checks for presence of ELM module by scanning DT nodes - * @omap_nand_info: NAND device structure containing platform data + * @info: NAND device structure containing platform data + * @elm_node: ELM's DT node */ static bool is_elm_present(struct omap_nand_info *info, struct device_node *elm_node)