From patchwork Wed Jul 6 10:06:22 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Ciocaltea X-Patchwork-Id: 589160 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id F1F1FC433EF for ; Wed, 6 Jul 2022 10:06:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231861AbiGFKGr (ORCPT ); Wed, 6 Jul 2022 06:06:47 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44912 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231411AbiGFKGp (ORCPT ); Wed, 6 Jul 2022 06:06:45 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DD44125281; Wed, 6 Jul 2022 03:06:44 -0700 (PDT) Received: from localhost (unknown [188.24.177.228]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: cristicc) by madras.collabora.co.uk (Postfix) with ESMTPSA id 97DDF66019A7; Wed, 6 Jul 2022 11:06:43 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1657102003; bh=E67xkUkVcw1cpepE9DKG7WA5Ipv1XTkU98A1bQ6zDEs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=lKWZaw/DnC2rAPjdELFrvSZ+ubc/0j0QXdgVxj6QaTs92/0ZtnbzDLVzK2Hh9FbHl CnCJFCEKySJGgmZUOncZPTNnWQdSCxZAiTRI9PYh37FrSZBGAjA079HkMgv75pX02Y 9itounrN2+zNjy+Hosu65IMa5JHkGpy2IKGno5FhYgsNvLizlrkdEubrZmkfzJ8upm PQiXsu1oDJ02iKrgKJwcWnbtblwjm5+S+n3JcCqhxgrVRDYY3oA3BVhSxgpYs1QQvN xW8IO+TrrTOLTjpA90sVcUeoB4ozBQCfte19y5zK2M4ruVKLuHx/qmJRDkcsdkrami tx/VTkU6+hdQw== From: Cristian Ciocaltea To: Mark Brown , Sanjay R Mehta Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org, kernel@collabora.com, Anastasios Vacharakis , cristian.ciocaltea@collabora.com Subject: [PATCH 1/5] spi: amd: Limit max transfer and message size Date: Wed, 6 Jul 2022 13:06:22 +0300 Message-Id: <20220706100626.1234731-2-cristian.ciocaltea@collabora.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> References: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org Enabling the SPI CS35L41 audio codec driver for Steam Deck [1] revealed a problem with the current AMD SPI controller driver implementation, consisting of an unrecoverable system hang. The issue can be prevented if we ensure the max transfer size and the max message size do not exceed the FIFO buffer size. According to the implementation of the downstream driver, the AMD SPI controller is not able to handle more than 70 bytes per transfer, which corresponds to the size of the FIFO buffer. Hence, let's fix this by setting the SPI limits mentioned above. [1] https://lore.kernel.org/r/20220621213819.262537-1-cristian.ciocaltea@collabora.com Reported-by: Anastasios Vacharakis Fixes: bbb336f39efc ("spi: spi-amd: Add AMD SPI controller driver support") Signed-off-by: Cristian Ciocaltea --- drivers/spi/spi-amd.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/drivers/spi/spi-amd.c b/drivers/spi/spi-amd.c index cba6a4486c24..efdcbe6c4c26 100644 --- a/drivers/spi/spi-amd.c +++ b/drivers/spi/spi-amd.c @@ -33,6 +33,7 @@ #define AMD_SPI_RX_COUNT_REG 0x4B #define AMD_SPI_STATUS_REG 0x4C +#define AMD_SPI_FIFO_SIZE 70 #define AMD_SPI_MEM_SIZE 200 /* M_CMD OP codes for SPI */ @@ -270,6 +271,11 @@ static int amd_spi_master_transfer(struct spi_master *master, return 0; } +static size_t amd_spi_max_transfer_size(struct spi_device *spi) +{ + return AMD_SPI_FIFO_SIZE; +} + static int amd_spi_probe(struct platform_device *pdev) { struct device *dev = &pdev->dev; @@ -302,6 +308,8 @@ static int amd_spi_probe(struct platform_device *pdev) master->flags = SPI_MASTER_HALF_DUPLEX; master->setup = amd_spi_master_setup; master->transfer_one_message = amd_spi_master_transfer; + master->max_transfer_size = amd_spi_max_transfer_size; + master->max_message_size = amd_spi_max_transfer_size; /* Register the controller with SPI framework */ err = devm_spi_register_master(dev, master); From patchwork Wed Jul 6 10:06:23 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Ciocaltea X-Patchwork-Id: 588039 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C0665C43334 for ; Wed, 6 Jul 2022 10:06:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231150AbiGFKGt (ORCPT ); Wed, 6 Jul 2022 06:06:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45116 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231882AbiGFKGs (ORCPT ); Wed, 6 Jul 2022 06:06:48 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6096724F17; Wed, 6 Jul 2022 03:06:47 -0700 (PDT) Received: from localhost (unknown [188.24.177.228]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: cristicc) by madras.collabora.co.uk (Postfix) with ESMTPSA id 16E2C660199B; Wed, 6 Jul 2022 11:06:46 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1657102006; bh=FmxZRY8cqywyghtbXjPA0/ptVzriuh2ktG2Ioln5htI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=X6T3kmQ6RZbnGOWq4NKT0yn91BDvbxVGjHHc8LafSVnKs/n4ztddqBQqgb/NSKAMu Cen54Xr8Mp9dr4mGnNDOABblL0kE1DPng8MynfvSqtsZMtIPLeQscv0H+z50su8/Tl 1DSWEF264w7OV1slzSHkzLWNjq4XMpSiTLvnD8SmdtXk0zfG22ZWCWWp1SLGyQavE4 tNqdWqKrMDBjddiOwJDDa+X2GY5FkMPNwVUg2lMRw7YIx6fb285N8fgLX9FHYF/NGz ssoPuhMHChPkhiFKVHiHA/up6T7kKLV/C6NfRINk0ehTIw2Rq7f2vX6PyqGSA6SjSt 9M5wXbDPENLdA== From: Cristian Ciocaltea To: Mark Brown , Sanjay R Mehta Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org, kernel@collabora.com, Anastasios Vacharakis , cristian.ciocaltea@collabora.com Subject: [PATCH 2/5] spi: amd: Make use of devm_spi_alloc_master() Date: Wed, 6 Jul 2022 13:06:23 +0300 Message-Id: <20220706100626.1234731-3-cristian.ciocaltea@collabora.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> References: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org Make use of the devm variant of spi_alloc_master() in order to cleanup and simplify the error handling in the probe function by getting rid of the goto statements. Signed-off-by: Cristian Ciocaltea --- drivers/spi/spi-amd.c | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/drivers/spi/spi-amd.c b/drivers/spi/spi-amd.c index efdcbe6c4c26..3dc17a80c55c 100644 --- a/drivers/spi/spi-amd.c +++ b/drivers/spi/spi-amd.c @@ -281,10 +281,10 @@ static int amd_spi_probe(struct platform_device *pdev) struct device *dev = &pdev->dev; struct spi_master *master; struct amd_spi *amd_spi; - int err = 0; + int err; /* Allocate storage for spi_master and driver private data */ - master = spi_alloc_master(dev, sizeof(struct amd_spi)); + master = devm_spi_alloc_master(dev, sizeof(struct amd_spi)); if (!master) { dev_err(dev, "Error allocating SPI master\n"); return -ENOMEM; @@ -295,7 +295,7 @@ static int amd_spi_probe(struct platform_device *pdev) if (IS_ERR(amd_spi->io_remap_addr)) { err = PTR_ERR(amd_spi->io_remap_addr); dev_err(dev, "error %d ioremap of SPI registers failed\n", err); - goto err_free_master; + return err; } dev_dbg(dev, "io_remap_address: %p\n", amd_spi->io_remap_addr); @@ -313,15 +313,8 @@ static int amd_spi_probe(struct platform_device *pdev) /* Register the controller with SPI framework */ err = devm_spi_register_master(dev, master); - if (err) { + if (err) dev_err(dev, "error %d registering SPI controller\n", err); - goto err_free_master; - } - - return 0; - -err_free_master: - spi_master_put(master); return err; } From patchwork Wed Jul 6 10:06:24 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Ciocaltea X-Patchwork-Id: 589159 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 19B05C43334 for ; Wed, 6 Jul 2022 10:06:55 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231411AbiGFKGy (ORCPT ); Wed, 6 Jul 2022 06:06:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45160 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231972AbiGFKGu (ORCPT ); Wed, 6 Jul 2022 06:06:50 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [IPv6:2a00:1098:0:82:1000:25:2eeb:e5ab]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D15B125287; Wed, 6 Jul 2022 03:06:49 -0700 (PDT) Received: from localhost (unknown [188.24.177.228]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: cristicc) by madras.collabora.co.uk (Postfix) with ESMTPSA id 86F2F66019AB; Wed, 6 Jul 2022 11:06:48 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1657102008; bh=gvIHZ0H7Q8LwPXB1Gy+8YPWBSTNwl9kEIMKaZUZmZKo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=n/rjwqGoKWfoDBQ4eb5lDTrVYeT2/wlrVznFjAdEtOJjKvgdkkNIYZJbqk8x+AGvF BeBBYRL7n+oPHJdwEziklhji2xoG2HcIo2WxVp5bKj9h7IFXMhvuLH3kTgzwaloi8x ZVp/5ET0x7kXT0E6nhgnQxlNd1LlgykT586dtXMswf/YIyejyhva2vXSR0Er7pf+uy 7qDLEoYUxXz5iEe/FGvgH5dZMntLoZObFnSSHH4JKmXKrPKsXeFWqV7DOtx5GQz6h1 VO5TPVS7vLXA8NGhu64iRfaXWq35gDSWKcrAirl7nLTdz4/DRp3UXTtX423wKgj0Ty PHRRJagJf1AYQ== From: Cristian Ciocaltea To: Mark Brown , Sanjay R Mehta Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org, kernel@collabora.com, Anastasios Vacharakis , cristian.ciocaltea@collabora.com Subject: [PATCH 3/5] spi: amd: Make use of dev_err_probe() Date: Wed, 6 Jul 2022 13:06:24 +0300 Message-Id: <20220706100626.1234731-4-cristian.ciocaltea@collabora.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> References: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org Simplify the error handling in probe function by switching from dev_err() to dev_err_probe(). Signed-off-by: Cristian Ciocaltea --- drivers/spi/spi-amd.c | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/drivers/spi/spi-amd.c b/drivers/spi/spi-amd.c index 3dc17a80c55c..1aa19a02a7b6 100644 --- a/drivers/spi/spi-amd.c +++ b/drivers/spi/spi-amd.c @@ -285,18 +285,15 @@ static int amd_spi_probe(struct platform_device *pdev) /* Allocate storage for spi_master and driver private data */ master = devm_spi_alloc_master(dev, sizeof(struct amd_spi)); - if (!master) { - dev_err(dev, "Error allocating SPI master\n"); - return -ENOMEM; - } + if (!master) + return dev_err_probe(dev, -ENOMEM, "Error allocating SPI master\n"); amd_spi = spi_master_get_devdata(master); amd_spi->io_remap_addr = devm_platform_ioremap_resource(pdev, 0); - if (IS_ERR(amd_spi->io_remap_addr)) { - err = PTR_ERR(amd_spi->io_remap_addr); - dev_err(dev, "error %d ioremap of SPI registers failed\n", err); - return err; - } + if (IS_ERR(amd_spi->io_remap_addr)) + return dev_err_probe(dev, PTR_ERR(amd_spi->io_remap_addr), + "ioremap of SPI registers failed\n"); + dev_dbg(dev, "io_remap_address: %p\n", amd_spi->io_remap_addr); amd_spi->version = (enum amd_spi_versions) device_get_match_data(dev); @@ -314,9 +311,9 @@ static int amd_spi_probe(struct platform_device *pdev) /* Register the controller with SPI framework */ err = devm_spi_register_master(dev, master); if (err) - dev_err(dev, "error %d registering SPI controller\n", err); + return dev_err_probe(dev, err, "error registering SPI controller\n"); - return err; + return 0; } #ifdef CONFIG_ACPI From patchwork Wed Jul 6 10:06:25 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Ciocaltea X-Patchwork-Id: 588038 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1CD2AC43334 for ; Wed, 6 Jul 2022 10:06:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232392AbiGFKGz (ORCPT ); Wed, 6 Jul 2022 06:06:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45216 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232271AbiGFKGy (ORCPT ); Wed, 6 Jul 2022 06:06:54 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [IPv6:2a00:1098:0:82:1000:25:2eeb:e5ab]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 46B5325284; Wed, 6 Jul 2022 03:06:53 -0700 (PDT) Received: from localhost (unknown [188.24.177.228]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: cristicc) by madras.collabora.co.uk (Postfix) with ESMTPSA id 0957D66019A9; Wed, 6 Jul 2022 11:06:51 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1657102012; bh=3I35O1AT5GLyf6sHTq4insD++gylKKUaNaI+fLxsC3c=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=mKVvA9izt0IBZJgG1uh/thru3eAbfsII5K4qfu7MLrGh7jHSz9auEHbga3XuQGwJO ku8doxLrQf8MJPwNSzZuqG7KNUb4PMGBCd56eBCHbfXb8xJKuEOC4JtDv3s1cG6RvN PTlQoHrbSkYpZMw/CCOrXH3UrcnJ0yk0VyGi1US9wbfiw0EKsz5INGYXI/JJfUi/2w KRrhT3dsKN6ubEZO43shb+o4SZKQNGnCQoImVPy2F2CyXJpwRPGZK33jiXTG57eQ+X tl63C1QhZKmv0plHopwXW7g2L3fzyxnPntHzKSJdY+kz7/J7ABN9iLpiaWQikk3oEu b0MW0/60EYpTw== From: Cristian Ciocaltea To: Mark Brown , Sanjay R Mehta Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org, kernel@collabora.com, Anastasios Vacharakis , cristian.ciocaltea@collabora.com Subject: [PATCH 4/5] spi: amd: Drop io_base_addr member from struct amd_spi Date: Wed, 6 Jul 2022 13:06:25 +0300 Message-Id: <20220706100626.1234731-5-cristian.ciocaltea@collabora.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> References: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org The io_base_addr member of struct amd_spi is not referenced anywhere in the driver implementation and there is no indication that it could be used in the future, hence drop it. Signed-off-by: Cristian Ciocaltea --- drivers/spi/spi-amd.c | 1 - 1 file changed, 1 deletion(-) diff --git a/drivers/spi/spi-amd.c b/drivers/spi/spi-amd.c index 1aa19a02a7b6..6eddb950e1ad 100644 --- a/drivers/spi/spi-amd.c +++ b/drivers/spi/spi-amd.c @@ -47,7 +47,6 @@ enum amd_spi_versions { struct amd_spi { void __iomem *io_remap_addr; - unsigned long io_base_addr; enum amd_spi_versions version; }; From patchwork Wed Jul 6 10:06:26 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cristian Ciocaltea X-Patchwork-Id: 589158 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 33D17C43334 for ; Wed, 6 Jul 2022 10:07:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232640AbiGFKHJ (ORCPT ); Wed, 6 Jul 2022 06:07:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45348 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232554AbiGFKG6 (ORCPT ); Wed, 6 Jul 2022 06:06:58 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 43AF3252A8; Wed, 6 Jul 2022 03:06:56 -0700 (PDT) Received: from localhost (unknown [188.24.177.228]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: cristicc) by madras.collabora.co.uk (Postfix) with ESMTPSA id E2ABB66019A8; Wed, 6 Jul 2022 11:06:54 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1657102015; bh=0Mp3rHQ9jijT39OI8RMdTMOQmr91ofvOGZwnNCt8nFM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=QPV0/Vu5urmVm10fjiVkxWNBk/0R8QlN3aAu3/LZgk11NcgE7NKzaBpEgmL9LcpKb pglVu3Byg2MM5/KPTGnLa9Z4NqvcycglVpMzJNE4zA5eYZY8LvM5O716GmjW3+WC3G 5by7/lromGDL7IFm5YfJUYnlIDlXDeRkgStD/k4D2zpmuET1hqbczHJIvZ/+6W0mt9 x51WtQjxU2KKh64ZeKcgBLoacWgB7BydFaRh6fa2nadHwK+uSnq6F6dr2K28jcXKiO 3YEShPZATRepJICflZvkgJ5sRdItZ7krewEo0e9Lto5blWiI7RAlgjOiFXq+fvDJcT 3Gf4W04moraSw== From: Cristian Ciocaltea To: Mark Brown , Sanjay R Mehta Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org, kernel@collabora.com, Anastasios Vacharakis , cristian.ciocaltea@collabora.com Subject: [PATCH 5/5] spi: amd: Add struct and enum kernel-doc comments Date: Wed, 6 Jul 2022 13:06:26 +0300 Message-Id: <20220706100626.1234731-6-cristian.ciocaltea@collabora.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> References: <20220706100626.1234731-1-cristian.ciocaltea@collabora.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org Provide documentation comments in the kernel-doc format for enum amd_spi_versions and struct amd_spi. Signed-off-by: Cristian Ciocaltea --- drivers/spi/spi-amd.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/drivers/spi/spi-amd.c b/drivers/spi/spi-amd.c index 6eddb950e1ad..08df4f8d0531 100644 --- a/drivers/spi/spi-amd.c +++ b/drivers/spi/spi-amd.c @@ -40,11 +40,21 @@ #define AMD_SPI_XFER_TX 1 #define AMD_SPI_XFER_RX 2 +/** + * enum amd_spi_versions - SPI controller versions + * @AMD_SPI_V1: AMDI0061 hardware version + * @AMD_SPI_V2: AMDI0062 hardware version + */ enum amd_spi_versions { - AMD_SPI_V1 = 1, /* AMDI0061 */ - AMD_SPI_V2, /* AMDI0062 */ + AMD_SPI_V1 = 1, + AMD_SPI_V2, }; +/** + * struct amd_spi - SPI driver instance + * @io_remap_addr: Start address of the SPI controller registers + * @version: SPI controller hardware version + */ struct amd_spi { void __iomem *io_remap_addr; enum amd_spi_versions version;