From patchwork Wed Jun 21 02:34:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nishanth Menon X-Patchwork-Id: 13286592 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 1D5FBEB64D7 for ; Wed, 21 Jun 2023 02:35:17 +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:MIME-Version:Message-ID:Date:Subject:CC :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=z+HGvkJYi/y3kQJdbYjQgp/5xXZ9HlnATKfT16xAS70=; b=vgGCF2jYb64cj8 oro17OQMjcxGQVE+xCdnUMsqWElvxg2whupTBzanWPScejNTYTZQ2T/BgaujHgvuHN8TtRYh6wIge YsqH9RAJyGXlg8P4yTODaTp/9mU2wu0kQOpDkzLqkmQjOQypOdWmVzBSYIvZgyQSONxFd8O3DoM/y 44xAEsYSdtEpYVjKLx8DpaVKclKfeDTHCSH2B+uVJcadqiBIiIyNKOsGxt8/fUDOxMCX16KaqLY6K /bS+wxct3QhZWQK5OrOjds9iZBgbQIj4DVzgttMm4LLDi71SVwmJp0T9PpeC5mq08H5t1ISFDr7ND 3KI9lORwh1RBB8f22QfQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qBngL-00CxIB-21; Wed, 21 Jun 2023 02:34:53 +0000 Received: from fllv0016.ext.ti.com ([198.47.19.142]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qBngI-00CxG7-23 for linux-arm-kernel@lists.infradead.org; Wed, 21 Jun 2023 02:34:52 +0000 Received: from lelv0265.itg.ti.com ([10.180.67.224]) by fllv0016.ext.ti.com (8.15.2/8.15.2) with ESMTP id 35L2Yh0j070029; Tue, 20 Jun 2023 21:34:43 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1687314883; bh=q0hvlpgx9vGyvHElW9ks+VEoe38LpUfFmwWhcP8F0H8=; h=From:To:CC:Subject:Date; b=zFR+Z9C/3CGTRUuNAsVeaRlV77dVnhPEEJO9Td2OPxrWxyxVE10fSah03LHjSnr/R Psjl6MXTuUFq+gECcPD64QqrQUftEKrIkd6KPg4bD1xWEiOB/loqHaO1yKuWHRQREF KVrSk0fuc9zdZv1t4cDGXhYsPglXyH2am7X52BK4= Received: from DLEE104.ent.ti.com (dlee104.ent.ti.com [157.170.170.34]) by lelv0265.itg.ti.com (8.15.2/8.15.2) with ESMTPS id 35L2Yh65007937 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL); Tue, 20 Jun 2023 21:34:43 -0500 Received: from DLEE105.ent.ti.com (157.170.170.35) by DLEE104.ent.ti.com (157.170.170.34) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23; Tue, 20 Jun 2023 21:34:43 -0500 Received: from lelv0327.itg.ti.com (10.180.67.183) by DLEE105.ent.ti.com (157.170.170.35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23 via Frontend Transport; Tue, 20 Jun 2023 21:34:43 -0500 Received: from localhost (ileaxei01-snat.itg.ti.com [10.180.69.5]) by lelv0327.itg.ti.com (8.15.2/8.15.2) with ESMTP id 35L2Yhdf010455; Tue, 20 Jun 2023 21:34:43 -0500 From: Nishanth Menon To: Santosh Shilimkar , Tero Kristo , Nishanth Menon CC: , , , , , Randy Dunlap , Peter Ujfalusi Subject: [PATCH V2] soc: ti: k3-ringacc: Fixup documentation errors Date: Tue, 20 Jun 2023 21:34:42 -0500 Message-ID: <20230621023442.275128-1-nm@ti.com> X-Mailer: git-send-email 2.40.0 MIME-Version: 1.0 X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230620_193450_754219_3A38FE3D X-CRM114-Status: GOOD ( 10.51 ) 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: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org 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 * 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;