[PATCH v1] ALSA SoC: Texas Instruments TAS2781 Audio Smart Amp

[Mark Brown]

On Tue, Dec 20, 2022 at 11:11:57PM +0800, Kevin Lu wrote:

> The TAS2781 driver implements a flexible and configurable register setting
> for one, two, even multiple TAS2781 chips. All the register setting are in
> a bin file. Almost no specific register setting can be found in the code.

This driver needs a very substantial rework to fit within the relevant
kernel frameworks, even from a coding style level it's clearly not well
integrated kernel code and the integration with several kernel
frameworks all look to need rework.

> +++ b/sound/soc/codecs/tas2781-dsp.c
> @@ -0,0 +1,2483 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * ALSA SoC Texas Instruments TAS2781 Audio Smart Amplifier

Please make the entire comment a C++ one so things look more
intentional.

> + * Copyright (C) 2022 - 2023 Texas Instruments Incorporated
> + * https://www.ti.com

Given that it's still 2022 I rather doubt the 2023 copyright, though I
guess we'll see some changes in 2023...

> + * The TAS2781 driver implements a flexible and configurable register setting
> + * for one, two, even multiple TAS2781 chips. All the register setting are in
> + * a bin file. Almost no specific register setting can be found in the code.

This isn't how we generally do drivers in Linux, we expect the device
settings to be controlled via the ALSA userspace and kernel APIs.
Downloadable firmwares are of course OK, and there are things like
coefficient data which are naturally binary data, but normal device
control should be done via the standard interfaces.  Some of this does
look like it might fit with firmware stuff but I'm not clear that it's
all of it and the code generally doesn't look like it's trying very hard
to fit within the standard kernel frameworks.

Given this I've not read too far into the driver, just skimmed it.

> +#define TAS2781_CAL_BIN_PATH	("/lib/firmware/")

Let request_firmware() figure this out.

> +struct TYCRC {

> +const unsigned int BinFileformatVerInfo[][2] = {

> +static int fw_parse_block_data_kernel(struct TFirmware *pFirmware,
> +	struct TBlock *pBlock, const struct firmware *pFW, int offset)

Please follow the kernel coding style for naming things, this makes it
quite hard to read a lot of the code.

> +static const unsigned char crc8_lookup_table[CRC8_TABLE_SIZE] = {
> +	0x00, 0x4D, 0x9A, 0xD7, 0x79, 0x34, 0xE3, 0xAE,

We have lib/crc8.c.

> +static const struct i2c_device_id tasdevice_id[] = {
> +	{ "audev", GENERAL_AUDEV },

audev?

> +static bool tasdevice_volatile(struct device *dev, unsigned int reg)
> +{
> +	return true;
> +}
> +
> +static bool tasdevice_writeable(struct device *dev, unsigned int reg)
> +{
> +	return true;
> +}

These are pointless, remove them.

> +static const struct regmap_config tasdevice_regmap = {
> +	.reg_bits = 8,
> +	.val_bits = 8,
> +	.writeable_reg = tasdevice_writeable,
> +	.volatile_reg = tasdevice_volatile,
> +	.cache_type = REGCACHE_FLAT,
> +	.max_register = 1 * 128,
> +};

Given that the device has pages and books which aren't modelled here I
can't see how a cache is going to work well, though since the driver
marks every register as volatile it'll never do anything.

> +static const struct of_device_id tasdevice_of_match[] = {
> +	{ .compatible = "ti,audev" },
> +	{ .compatible = "ti,tas2781" },
> +	{},
> +};

This is adding a DT binding, the DT binding must be documented but is
not.

> +static int tas2781_digital_getvol(struct snd_kcontrol *kcontrol,
> +	struct snd_ctl_elem_value *ucontrol)
> +{

This is just a straightforward register read, I don't see why it's not
using the standard helpers.

> +	if (tas_dev->tas2781_set_global != NULL) {
> +		ret = tasdevice_dev_write(tas_dev, tas_dev->ndev,
> +			mc->reg, val);
> +		if (ret)
> +			dev_err(tas_dev->dev,
> +			"%s, set digital vol error in global mode\n",
> +			__func__);
> +	} else {
> +		for (i = 0; i < tas_dev->ndev; i++) {

This appears to be trying to open code some mechanism for tying
multiple devices together.  Don't do that, if that feature is needed
implement it at the framework level rather than trying to open code it
in the driver.

The function is also failing to generate events, running mixer-test on a
card with the device included should show this and potentially other
issues.

> +static int tasdevice_hw_params(struct snd_pcm_substream *substream,
> +	struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)

This doesn't actually appear to interact with the device which means it
won't actually do anything.  This is a problem with a lot of the
callbacks.

> +static void tasdevice_enable_irq(
> +	struct tasdevice_priv *tas_dev, bool enable)
> +{
> +	struct irq_desc *desc = NULL;
> +
> +	if (enable) {
> +		if (tas_dev->mIrqInfo.mb_irq_enable)
> +			return;
> +		if (gpio_is_valid(tas_dev->mIrqInfo.mn_irq_gpio)) {
> +			desc = irq_to_desc(tas_dev->mIrqInfo.mn_irq);
> +			if (desc && desc->depth > 0)
> +				enable_irq(tas_dev->mIrqInfo.mn_irq);
> +			else

Drivers really shouldn't be peering inside irq descriptors, if you need
to do this it generally indicates that whatever is done is a bad idea.

> +				dev_info(tas_dev->dev,
> +					"### irq already enabled\n");

Please don't spam the logs in normal operation, this is a problem
throughout the driver.

> +static int tasdevice_mute(struct snd_soc_dai *dai, int mute, int stream)
> +{

> +	tasdevice_set_power_state(tas_dev, mute);

mute is not a power management function, it should mute and unmute only.
Power managment should be integrated with DAPM.

> +static irqreturn_t tasdevice_irq_handler(int irq,
> +	void *dev_id)
> +{
> +	struct tasdevice_priv *tas_dev = (struct tasdevice_priv *)dev_id;
> +;
> +	/* get IRQ status after 100 ms */
> +	schedule_delayed_work(&tas_dev->mIrqInfo.irq_work,
> +		msecs_to_jiffies(100));
> +	return IRQ_HANDLED;
> +}

Why this delay?

> +	rc = of_property_read_u32(np, dts_glb_addr_tag,
> +			&(tas_dev->glb_addr.mnDevAddr));
> +	if (rc) {

Please just put the DT properties into the code directly rather than
adding a layer of indirection liek this, look at what other drivers do.

> +static int tasdevice_regmap_write(
> +	struct tasdevice_priv *tas_dev,
> +	unsigned int reg, unsigned int value)
> +{
> +	int nResult = 0;
> +	int retry_count = TASDEVICE_RETRY_COUNT;
> +
> +	while (retry_count--) {
> +		nResult = regmap_write(tas_dev->regmap, reg,
> +			value);
> +		if (nResult >= 0)
> +			break;
> +		usleep_range(5000, 5050);

Is the device really so unstable that it always needs multiple attempts
to do any I/O?

> +static int tasdevice_change_chn_book_page(
> +	struct tasdevice_priv *tas_dev, enum channel chn,
> +	int book, int page)
> +{

regmap has generic support for register paging, use it.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://mailman.alsa-project.org/pipermail/alsa-devel/attachments/20221221/82b388d3/attachment.sig>