From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4FEEFEB64D7 for ; Wed, 21 Jun 2023 02:40:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:From:References:Cc:To: Subject:MIME-Version:Date:Message-ID:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=8GWWkNGdyo+0hmb4kKmLkI/mIGMt1AX1LnNxfh1VwWE=; b=rJ+xg03AgnbBr3 +cGOQBA9ro2SoWJDbuZaGTYCeQrekUMXsRsVNZ/kFKnY7EVW6XOB1htZi5Vhl4nUT4A8ZoRLzs96h EjiW7JxdDCwb+JG/vqIqfUO3d4sgteVXc0ah6t5K/rcezBWL8wthAzDGTnc6cj59cSddtOHd5aESz STi7/rliimolgK92WO9VDsSJY+ncwFpkIw1nW7XGpxnzmEGoMYQRv8i/kK4nwy8UB2v4hzacvmYNI PDGmxiyz5AHo6uq5d8e1ZYby0rEPONG6pSCEK7VezMkr8za3+w6mDsxkTNP1fhWWnyGYFIhy/lagO LJ6Gquajr6kna7sksYEg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qBnli-00CyJN-0J; Wed, 21 Jun 2023 02:40:26 +0000 Received: from [2601:1c2:980:9ec0::2764] by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qBnlf-00CyIW-1X; Wed, 21 Jun 2023 02:40:24 +0000 Message-ID: Date: Tue, 20 Jun 2023 19:40:22 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.11.2 Subject: Re: [PATCH V2] soc: ti: k3-ringacc: Fixup documentation errors Content-Language: en-US To: Nishanth Menon , Santosh Shilimkar , Tero Kristo Cc: vigneshr@ti.com, praneeth@ti.com, u-kumar1@ti.com, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Peter Ujfalusi References: <20230621023442.275128-1-nm@ti.com> From: Randy Dunlap In-Reply-To: <20230621023442.275128-1-nm@ti.com> X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On 6/20/23 19:34, Nishanth Menon wrote: > Fixup couple of misses in documentation. This squashes the following > warnings: > drivers/soc/ti/k3-ringacc.c:135: warning: Function parameter or member 'tdown_complete' not described in 'k3_ring_state' > drivers/soc/ti/k3-ringacc.c:238: warning: expecting prototype for struct k3_ringacc. Prototype was for struct k3_ringacc_soc_data instead > > While at this, replace "w/a" to indicate workaround to help clarify. > > Cc: Peter Ujfalusi > Reviewed-by: Randy Dunlap > Signed-off-by: Nishanth Menon > --- > Changes since V1: > * Fixedup a couple of places where "w/a" is used - replaced with > "workaround" to indicate quirk workaround Thanks for that. Good change. > * Picked up Randy's Reviewed-by. > > V1: https://lore.kernel.org/all/20230621022407.270842-1-nm@ti.com/ > > drivers/soc/ti/k3-ringacc.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > diff --git a/drivers/soc/ti/k3-ringacc.c b/drivers/soc/ti/k3-ringacc.c > index 8f131368a758..999403e1b9e0 100644 > --- a/drivers/soc/ti/k3-ringacc.c > +++ b/drivers/soc/ti/k3-ringacc.c > @@ -125,6 +125,7 @@ struct k3_ring_ops { > * @occ: Occupancy > * @windex: Write index > * @rindex: Read index > + * @tdown_complete: Tear down complete state > */ > struct k3_ring_state { > u32 free; > @@ -192,7 +193,7 @@ struct k3_ringacc_ops { > * @num_rings: number of ring in RA > * @rings_inuse: bitfield for ring usage tracking > * @rm_gp_range: general purpose rings range from tisci > - * @dma_ring_reset_quirk: DMA reset w/a enable > + * @dma_ring_reset_quirk: DMA reset workaround enable > * @num_proxies: number of RA proxies > * @proxy_inuse: bitfield for proxy usage tracking > * @rings: array of rings descriptors (struct @k3_ring) > @@ -229,9 +230,9 @@ struct k3_ringacc { > }; > > /** > - * struct k3_ringacc - Rings accelerator SoC data > + * struct k3_ringacc_soc_data - Rings accelerator SoC data > * > - * @dma_ring_reset_quirk: DMA reset w/a enable > + * @dma_ring_reset_quirk: DMA reset workaround enable > */ > struct k3_ringacc_soc_data { > unsigned dma_ring_reset_quirk:1; -- ~Randy _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel