Received-SPF: pass (google.com: domain of linux-kernel+bounces-25783-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: Javier Carrasco <javier.carrasco@wolfvision.net>
Date: Mon, 15 Jan 2024 10:16:33 +0100
Subject: [PATCH 3/3] ALSA: usb: add support for XMOS XVF3500
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240115-feature-xvf3500_driver-v1-3-ed9cfb48bb85@wolfvision.net>
References: <20240115-feature-xvf3500_driver-v1-0-ed9cfb48bb85@wolfvision.net>
In-Reply-To: <20240115-feature-xvf3500_driver-v1-0-ed9cfb48bb85@wolfvision.net>
To: Rob Herring <robh+dt@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, Liam Girdwood <lgirdwood@gmail.com>, 
 Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>, 
 Takashi Iwai <tiwai@suse.com>
Cc: Rob Herring <robh@kernel.org>, devicetree@vger.kernel.org, 
 linux-kernel@vger.kernel.org, linux-sound@vger.kernel.org, 
 Javier Carrasco <javier.carrasco@wolfvision.net>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?djZCQ1l4enNQQ29mMzFhWnA2UXA2WlJiMWl2WmsxK2tVVUdMK0lybHBzK3pY?=
 =?utf-8?B?VHFDS3B5ZGhBRnA3aHBkek1nNlp3enJSc0wwWk1lSlhSUGlscVRldjdraGZL?=
 =?utf-8?B?SEkwb0twYUY1MEFJajV2U2pBMWVQYnRhRVpIODg2NmtMNWxKeERQM1BlNlBn?=
 =?utf-8?B?dS80dTlSc3FTaEo5VXhFSG9wUUtuRmdLMXE1aXRKWkt5ZUVrUWgzMHBwU0tk?=
 =?utf-8?B?NmQvV0Nsc2NNM1ZYaXdLRS9FZGgyTllJeXV4ZElEMDYwbWt2R0F4MmZ3ck9U?=
 =?utf-8?B?TnJxZjFPUTJQMXJITEI0aWFiaFNEOHZtZUhxa2lNSXpIUkRCZzZSVkNGdjh1?=
 =?utf-8?B?T2R4ZTczUmM5bVMwVzFuaEhERWpkbUVpKzNnNE5kN0dkYmVUeDZ4bzV4UWcz?=
 =?utf-8?B?eWRrRGpRcStGd3JKVzUreHhranZKMnlpR3dIQnlRd0VJTUlOK3g5ZXlkenVQ?=
 =?utf-8?B?QncvalNvb2srRkZJNitKZFBodzJGSEQzZ2Vla0RnVm1janhLWkVrS2JJV1Na?=
 =?utf-8?B?TXhMY3ZYWEYrd0pwZWJMOFA0a2htMVdjRU1mK3Y4ZDAzZE0reWErR3paWXVW?=
 =?utf-8?B?eEc1WlpnSk9iSVhXNzNJZjZtWHB1czZKNmI2YmVEeFN4VXYyVEdGOUxRUGpu?=
 =?utf-8?B?T2VvcDlMTUtmVVBaTk9XQzhUdW9NcU5kQXp6dkxoNkgrNGlFdnV1T3IrOTFS?=
 =?utf-8?B?V1FWaHR1NXA1Z0FDekpwOW4zdWpCOGVvUm5hSHhaSCtVMkthNSs5eDZPTHl6?=
 =?utf-8?B?bG5ReDl5WHdYVjQxLzlXOXV5L3JIdFFZMklHQVVTM28rMXpaTWJMZkFESG85?=
 =?utf-8?B?UkFkZVY3M1ZYbjRXbXprT3ZuQ3dteUFsdnNPSWFvQnNhU05Eb3l4MVdUV3FN?=
 =?utf-8?B?NTh1c3VXNnBtZDRrdmVDSXlDK0ltL3g1cGNwbUNGNTlyL2NuT3VPSjlsODdi?=
 =?utf-8?B?MnVERkdhNnNQVEQ0RzBLaGx0VGRtTmFydkZHVmhsVWpqUElFY3oyVWdrdzlw?=
 =?utf-8?B?SitZN3RsdElHRXZ0clVWTkY3aGlTM3dPeGttRDlPcVdHOU5idHB6RVJjOGZn?=
 =?utf-8?B?MGlOVUVwMXBkNFZjRzQzSEhOeFpkVk9PR0wyK3JKdmJIWjREUFdEQzd2eFhv?=
 =?utf-8?B?ZSs2ZzlzL0RlVXExQnpwMWZIWGpCSWVzbm1FK0MzVk5ud21oYUdOSkhpdC9P?=
 =?utf-8?B?NnE5TjloeEs3d292dFQ2WW1uaklzamtiVDJONWFEYXJ6RmpOVlg5SFkvbERs?=
 =?utf-8?B?M3lQSzVPWjVrQThHTnFOVFBySW51blRMMEZxbUtzMStITGIwWWpwZkNqRmla?=
 =?utf-8?B?RGFBVUtuUHR0UUlJbkZFbDNVRWE4U0lsYmd1Uzh3TDBGNGZZQys5MzJQQTNl?=
 =?utf-8?B?NkhUTWM0VG1INUN4UmNLaFpGQ1U4YWQ0enQzb3RHT0tjc1RmdkhwSk8vOE5k?=
 =?utf-8?B?RmlGWmhaN2NLZVF0R1RUVUd3eUo1a1RuRE02MXRnSHY3aHp4R2hDQ01Jb25V?=
 =?utf-8?B?S2NFbm9Qek5FejlEdjBOdWg4M0JIUUtRYWpZL2lYZ05Wcy82dEZ2THBjeFdZ?=
 =?utf-8?B?eXdtbmorMXMxd2d2alIydXY5bU5zdnZhZ0pLazFyUjlMVU1OOXVFWUo2a1JC?=
 =?utf-8?B?OXZuOFNIVEdWRnpta1p3YWlEdVphRmdjZVpHc3ZLMExXaTBYZkZGT0xJZTdD?=
 =?utf-8?B?bHdjQkhrNDRXTnc5SmxaY3BWNFNnV1N4S3l5TnVyR00rS3NrZlF3Q0FCZUx0?=
 =?utf-8?B?MVpxVzgvMEJQeXplRkNYV0dLME1WYXhOZG5EaFRhQ3pPUkZzdTR1QWJSUDA2?=
 =?utf-8?B?dlJ2anhtS3BKL05ZeThzSXZibmVqL3hWYzRCallXTjY0L0p2dDB2ZW9sVE1k?=
 =?utf-8?B?NUhEN1RhdHJTd004L2pqc2dQNE9wR2l1UU5WQ2N5SlBma01uV25FaFBGSFFU?=
 =?utf-8?B?QkhKclhpZm9wZm5ZSDJvZmsyUXFrc3NTV0U4NlJDUmRWampZeE8xT2pQZmVG?=
 =?utf-8?B?UGtiQ0hobDZZcWtQQ3ZXWngrY09ZV0FqRGhlZGs1aFdTRkNHL0FINmY2dXhr?=
 =?utf-8?B?MGsxUG1YK1YwN0h4VGErK1VGbTJpNjlkcng3bGN1c1haV0ZVQXFnMFBmck9H?=
 =?utf-8?B?b0pEWGFOcWc4U0JYcE1kZkFPdVEvZ3NxL1c5YlRFY0wvNllVNmpuMGJpZlUr?=
 =?utf-8?Q?GrTu4WEiieWKvNIWE4eu/wk=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 58937aab-5fea-4fd5-2088-08dc15aaaeab
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Jan 2024 09:16:40.0772
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: e94ec9da-9183-471e-83b3-51baa8eb804f
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: jIt9WMZc1q+8eyoy7eCxIzFr08JjHIDOs/zfp7/noIqgNFBZcXDxQfpweShnSzOr+kPEdzrqRACkZ5L2xHWmS3nkE1jtrhr/2ZfxbdOjhnA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM9PR08MB6035

The XMOS XVF3500 VocalFusion Voice Processor[1] is a low-latency, 32-bit
multicore controller for voice processing.

This simple driver provides the power sequence the device requires,
which consists of enabling the regulators that control the device
supplies and a reset de-assertion after a delay of at least 100ns.

Simple PM operations to handle the power sequence after resuming
from a power-down mode are also provided.

Once in normal operation, the device registers itself as a USB device.
Therefore, this driver requires USB to be available in order to
guarantee full support.

[1] https://www.xmos.com/xvf3500/

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 MAINTAINERS                 |   7 +++
 sound/usb/Kconfig           |   9 +++
 sound/usb/Makefile          |   3 +-
 sound/usb/xvf3500/Makefile  |   4 ++
 sound/usb/xvf3500/xvf3500.c | 140 ++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 162 insertions(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index a7c4cf8201e0..fb9be0e12c71 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -23960,6 +23960,13 @@ S:	Supported
 W:	http://www.marvell.com
 F:	drivers/i2c/busses/i2c-xlp9xx.c
 
+XMOS XVF3500 VOICE PROCESSOR DRIVER
+M:	Javier Carrasco <javier.carrasco@wolfvision.net>
+L:	linux-sound@vger.kernel.org
+S:	Supported
+F:	Documentation/devicetree/bindings/sound/xmos,xvf3500.yaml
+F:	sound/usb/xvf3500/xvf3500.c
+
 XRA1403 GPIO EXPANDER
 M:	Nandor Han <nandor.han@ge.com>
 L:	linux-gpio@vger.kernel.org
diff --git a/sound/usb/Kconfig b/sound/usb/Kconfig
index 4a9569a3a39a..11565429163b 100644
--- a/sound/usb/Kconfig
+++ b/sound/usb/Kconfig
@@ -176,6 +176,15 @@ config SND_BCD2000
 	  To compile this driver as a module, choose M here: the module
 	  will be called snd-bcd2000.
 
+config SND_XVF3500
+	tristate "XMOS XVF3500 voice processor driver"
+	help
+	  Say Y here to include support for the XMOS XVF3500 voice
+	  processor.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called snd-xvf3500.
+
 source "sound/usb/line6/Kconfig"
 
 endif	# SND_USB
diff --git a/sound/usb/Makefile b/sound/usb/Makefile
index 8c657c2753c8..4171db0f483c 100644
--- a/sound/usb/Makefile
+++ b/sound/usb/Makefile
@@ -34,5 +34,6 @@ obj-$(CONFIG_SND_USB_UA101) += snd-usbmidi-lib.o
 obj-$(CONFIG_SND_USB_USX2Y) += snd-usbmidi-lib.o
 obj-$(CONFIG_SND_USB_US122L) += snd-usbmidi-lib.o
 
-obj-$(CONFIG_SND) += misc/ usx2y/ caiaq/ 6fire/ hiface/ bcd2000/
+obj-$(CONFIG_SND) += misc/ usx2y/ caiaq/ 6fire/ hiface/ bcd2000/ xvf3500/
 obj-$(CONFIG_SND_USB_LINE6)	+= line6/
+
diff --git a/sound/usb/xvf3500/Makefile b/sound/usb/xvf3500/Makefile
new file mode 100644
index 000000000000..51a61c8f165d
--- /dev/null
+++ b/sound/usb/xvf3500/Makefile
@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: GPL-2.0-only
+snd-xvf3500-y := xvf3500.o
+
+obj-$(CONFIG_SND_XVF3500) += snd-xvf3500.o
diff --git a/sound/usb/xvf3500/xvf3500.c b/sound/usb/xvf3500/xvf3500.c
new file mode 100644
index 000000000000..647e5d09d1e5
--- /dev/null
+++ b/sound/usb/xvf3500/xvf3500.c
@@ -0,0 +1,140 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Driver for the XMOS XVF3500 VocalFusion Voice Processor.
+ *
+ * Copyright (C) 2023 WolfVision GmbH.
+ *
+ */
+
+#include <linux/gpio/consumer.h>
+#include <linux/module.h>
+#include <linux/of_platform.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+#include <linux/regulator/consumer.h>
+
+static const char * const supply_names[] = {
+	"vcc1v0",
+	"vcc3v3",
+};
+
+#define NUM_SUPPLIES ARRAY_SIZE(supply_names)
+
+struct xvf3500 {
+	struct regulator_bulk_data supplies[NUM_SUPPLIES];
+	struct device *dev;
+	struct gpio_desc *reset;
+};
+
+static int xvf3500_power(struct xvf3500 *priv, bool on)
+{
+	int ret;
+
+	if (on) {
+		ret = regulator_bulk_enable(NUM_SUPPLIES, priv->supplies);
+		if (ret) {
+			dev_err(priv->dev, "failed to enable supplies: %d\n", ret);
+			return ret;
+		}
+		/*
+		 * A delay of >=100ns + regulator startup is needed before releasing
+		 * the reset here. Wait for 10 ms to be on the safe side.
+		 */
+		fsleep(10000);
+		gpiod_set_value_cansleep(priv->reset, 0);
+	} else {
+		gpiod_set_value_cansleep(priv->reset, 1);
+		ret = regulator_bulk_disable(NUM_SUPPLIES, priv->supplies);
+		if (ret) {
+			dev_err(priv->dev, "failed to disable supplies: %d\n", ret);
+			return ret;
+		}
+	}
+
+	return 0;
+}
+
+static int xvf3500_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct xvf3500 *priv;
+	int ret;
+
+	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	priv->dev = dev;
+	dev_set_drvdata(dev, priv);
+
+	regulator_bulk_set_supply_names(priv->supplies, supply_names,
+					NUM_SUPPLIES);
+
+	ret = devm_regulator_bulk_get(dev, NUM_SUPPLIES, priv->supplies);
+	if (ret) {
+		dev_err_probe(dev, ret, "Failed to get regulator supplies\n");
+		return ret;
+	}
+
+	priv->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);
+	if (IS_ERR(priv->reset))
+		return dev_err_probe(priv->dev, PTR_ERR(priv->reset),
+				     "failed to get reset GPIO\n");
+
+	return xvf3500_power(priv, true);
+}
+
+static void xvf3500_remove(struct platform_device *pdev)
+{
+	struct xvf3500 *priv = dev_get_drvdata(&pdev->dev);
+
+	xvf3500_power(priv, false);
+}
+
+#ifdef CONFIG_PM_SLEEP
+static int xvf3500_suspend(struct device *dev)
+{
+	struct xvf3500 *priv = dev_get_drvdata(dev);
+
+	xvf3500_power(priv, false);
+
+	return 0;
+}
+
+static int xvf3500_resume(struct device *dev)
+{
+	struct xvf3500 *priv = dev_get_drvdata(dev);
+
+	xvf3500_power(priv, true);
+
+	return 0;
+}
+
+static SIMPLE_DEV_PM_OPS(xvf3500_pm, xvf3500_suspend, xvf3500_resume);
+#define XVF3500_PM_OPS	(&xvf3500_pm)
+#else
+#define XVF3500_PM_OPS	NULL
+#endif /* CONFIG_PM_SLEEP */
+
+static const struct of_device_id xvf3500_of_table[] = {
+	{
+		.compatible = "xmos,xvf3500",
+	},
+	{},
+};
+MODULE_DEVICE_TABLE(of, xvf3500_of_table);
+
+static struct platform_driver xvf3500_driver = {
+	.driver = {
+		.name = "xvf3500",
+		.of_match_table = xvf3500_of_table,
+		.pm = XVF3500_PM_OPS,
+	},
+	.probe = xvf3500_probe,
+	.remove_new = xvf3500_remove,
+};
+module_platform_driver(xvf3500_driver);
+
+MODULE_AUTHOR("Javier Carrasco <javier.carrasco@wolfvision.net>");
+MODULE_DESCRIPTION("XMOS XVF3500 Voice Processor");
+MODULE_LICENSE("GPL");

-- 
2.39.2