Unverified Commit 5209af4d authored by Mark Brown's avatar Mark Brown
Browse files

ASoC: cs35l56: More support for new Dell laptops 

Merge series from Richard Fitzgerald <rf@opensource.cirrus.com>:

Some new Dell models use spare pins on the amp as a binary integer
value to indicate the speaker type. The driver must use this to
select the correct firmware files for the hardware.

Patch #1 is the new support.
The other patches are for KUnit testing.
parents 84faa915 6f220440

include/sound/cs35l56.h

+37 −0
Original line number Diff line number Diff line
@@ -9,6 +9,7 @@ 
#ifndef __CS35L56_H

#define __CS35L56_H



#include <linux/bits.h>

#include <linux/debugfs.h>

#include <linux/firmware/cirrus/cs_dsp.h>

#include <linux/regulator/consumer.h>
@@ -26,6 +27,9 @@ struct snd_ctl_elem_value; 
#define CS35L56_GLOBAL_ENABLES				0x0002014

#define CS35L56_BLOCK_ENABLES				0x0002018

#define CS35L56_BLOCK_ENABLES2				0x000201C

#define CS35L56_SYNC_GPIO1_CFG				0x0002410

#define CS35L56_ASP2_DIO_GPIO13_CFG			0x0002440

#define CS35L56_UPDATE_REGS				0x0002A0C

#define CS35L56_REFCLK_INPUT				0x0002C04

#define CS35L56_GLOBAL_SAMPLE_RATE			0x0002C0C

#define CS35L56_OTP_MEM_53				0x00300D4
@@ -65,6 +69,9 @@ struct snd_ctl_elem_value; 
#define CS35L56_IRQ1_MASK_8				0x000E0AC

#define CS35L56_IRQ1_MASK_18				0x000E0D4

#define CS35L56_IRQ1_MASK_20				0x000E0DC

#define CS35L56_GPIO_STATUS1				0x000F000

#define CS35L56_GPIO1_CTRL1				0x000F008

#define CS35L56_GPIO13_CTRL1				0x000F038

#define CS35L56_MIXER_NGATE_CH1_CFG			0x0010004

#define CS35L56_MIXER_NGATE_CH2_CFG			0x0010008

#define CS35L56_DSP_MBOX_1_RAW				0x0011000
@@ -130,6 +137,17 @@ struct snd_ctl_elem_value; 
#define CS35L56_MTLREVID_MASK				0x0000000F

#define CS35L56_REVID_B0				0x000000B0



/* PAD_INTF */

#define CS35L56_PAD_GPIO_PULL_MASK			GENMASK(3, 2)

#define CS35L56_PAD_GPIO_IE				BIT(0)



#define CS35L56_PAD_PULL_NONE				0

#define CS35L56_PAD_PULL_UP				1

#define CS35L56_PAD_PULL_DOWN				2



/* UPDATE_REGS */

#define CS35L56_UPDT_GPIO_PRES				BIT(6)



/* ASP_ENABLES1 */

#define CS35L56_ASP_RX2_EN_SHIFT			17

#define CS35L56_ASP_RX1_EN_SHIFT			16
@@ -185,6 +203,12 @@ struct snd_ctl_elem_value; 
/* MIXER_NGATE_CHn_CFG */

#define CS35L56_AUX_NGATE_CHn_EN			0x00000001



/* GPIOn_CTRL1 */

#define CS35L56_GPIO_DIR_MASK				BIT(31)

#define CS35L56_GPIO_FN_MASK				GENMASK(2, 0)



#define CS35L56_GPIO_FN_GPIO				0x00000001



/* Mixer input sources */

#define CS35L56_INPUT_SRC_NONE				0x00

#define CS35L56_INPUT_SRC_ASP1RX1			0x08
@@ -279,6 +303,7 @@ struct snd_ctl_elem_value; 
#define CS35L56_HALO_STATE_TIMEOUT_US			250000

#define CS35L56_RESET_PULSE_MIN_US			1100

#define CS35L56_WAKE_HOLD_TIME_US			1000

#define CS35L56_PAD_PULL_SETTLE_US			10



#define CS35L56_CALIBRATION_POLL_US			(100 * USEC_PER_MSEC)

#define CS35L56_CALIBRATION_TIMEOUT_US			(5 * USEC_PER_SEC)
@@ -289,6 +314,9 @@ struct snd_ctl_elem_value; 
#define CS35L56_NUM_BULK_SUPPLIES			3

#define CS35L56_NUM_DSP_REGIONS				5



#define CS35L56_MAX_GPIO				13

#define CS35L63_MAX_GPIO				9



/* Additional margin for SYSTEM_RESET to control port ready on SPI */

#define CS35L56_SPI_RESET_TO_PORT_READY_US (CS35L56_CONTROL_PORT_READY_US + 2500)
@@ -338,6 +366,10 @@ struct cs35l56_base { 
	const struct cirrus_amp_cal_controls *calibration_controls;

	struct dentry *debugfs;

	u64 silicon_uid;

	u8 onchip_spkid_gpios[5];

	u8 num_onchip_spkid_gpios;

	u8 onchip_spkid_pulls[5];

	u8 num_onchip_spkid_pulls;

};



static inline bool cs35l56_is_otp_register(unsigned int reg)
@@ -413,6 +445,11 @@ void cs35l56_warn_if_firmware_missing(struct cs35l56_base *cs35l56_base); 
void cs35l56_log_tuning(struct cs35l56_base *cs35l56_base, struct cs_dsp *cs_dsp);

int cs35l56_hw_init(struct cs35l56_base *cs35l56_base);

int cs35l56_get_speaker_id(struct cs35l56_base *cs35l56_base);

int cs35l56_check_and_save_onchip_spkid_gpios(struct cs35l56_base *cs35l56_base,

					      const u32 *gpios, int num_gpios,

					      const u32 *pulls, int num_pulls);

int cs35l56_configure_onchip_spkid_pads(struct cs35l56_base *cs35l56_base);

int cs35l56_read_onchip_spkid(struct cs35l56_base *cs35l56_base);

int cs35l56_get_bclk_freq_id(unsigned int freq);

void cs35l56_fill_supply_names(struct regulator_bulk_data *data);

sound/soc/codecs/Kconfig

+14 −0
Original line number Diff line number Diff line
@@ -936,6 +936,20 @@ config SND_SOC_CS35L56_TEST 
	help

	  This builds KUnit tests for the Cirrus Logic cs35l56

	  codec driver.



	  For more information on KUnit and unit tests in general,

	  please refer to the KUnit documentation in

	  Documentation/dev-tools/kunit/.

	  If in doubt, say "N".



config SND_SOC_CS35L56_SHARED_TEST

	tristate "KUnit test for Cirrus Logic cs35l56-shared" if !KUNIT_ALL_TESTS

	depends on SND_SOC_CS35L56_SHARED && KUNIT

	default KUNIT_ALL_TESTS

	help

	  This builds KUnit tests for the Cirrus Logic cs35l56-shared

	  module.



	  For more information on KUnit and unit tests in general,

	  please refer to the KUnit documentation in

	  Documentation/dev-tools/kunit/.

sound/soc/codecs/Makefile

+2 −0
Original line number Diff line number Diff line
@@ -77,6 +77,7 @@ snd-soc-cs35l45-spi-y := cs35l45-spi.o 
snd-soc-cs35l45-i2c-y := cs35l45-i2c.o

snd-soc-cs35l56-y := cs35l56.o

snd-soc-cs35l56-shared-y := cs35l56-shared.o

snd-soc-cs35l56-shared-test-y := cs35l56-shared-test.o

snd-soc-cs35l56-i2c-y := cs35l56-i2c.o

snd-soc-cs35l56-spi-y := cs35l56-spi.o

snd-soc-cs35l56-sdw-y := cs35l56-sdw.o
@@ -512,6 +513,7 @@ obj-$(CONFIG_SND_SOC_CS35L45_SPI) += snd-soc-cs35l45-spi.o 
obj-$(CONFIG_SND_SOC_CS35L45_I2C)	+= snd-soc-cs35l45-i2c.o

obj-$(CONFIG_SND_SOC_CS35L56)	+= snd-soc-cs35l56.o

obj-$(CONFIG_SND_SOC_CS35L56_SHARED)	+= snd-soc-cs35l56-shared.o

obj-$(CONFIG_SND_SOC_CS35L56_SHARED_TEST) += snd-soc-cs35l56-shared-test.o

obj-$(CONFIG_SND_SOC_CS35L56_I2C)	+= snd-soc-cs35l56-i2c.o

obj-$(CONFIG_SND_SOC_CS35L56_SPI)	+= snd-soc-cs35l56-spi.o

obj-$(CONFIG_SND_SOC_CS35L56_SDW)	+= snd-soc-cs35l56-sdw.o

sound/soc/codecs/cs35l56-shared-test.c

0 → 100644
+680 −0

File added.

Preview size limit exceeded, changes collapsed.

sound/soc/codecs/cs35l56-shared.c

+172 −0
Original line number Diff line number Diff line
@@ -5,13 +5,16 @@ 
// Copyright (C) 2023 Cirrus Logic, Inc. and

//                    Cirrus Logic International Semiconductor Ltd.



#include <kunit/static_stub.h>

#include <linux/array_size.h>

#include <linux/bitfield.h>

#include <linux/cleanup.h>

#include <linux/debugfs.h>

#include <linux/firmware/cirrus/wmfw.h>

#include <linux/fs.h>

#include <linux/gpio/consumer.h>

#include <linux/kstrtox.h>

#include <linux/pm_runtime.h>

#include <linux/regmap.h>

#include <linux/regulator/consumer.h>

#include <linux/spi/spi.h>
@@ -182,6 +185,8 @@ static bool cs35l56_readable_reg(struct device *dev, unsigned int reg) 
	case CS35L56_OTP_MEM_53:

	case CS35L56_OTP_MEM_54:

	case CS35L56_OTP_MEM_55:

	case CS35L56_SYNC_GPIO1_CFG ... CS35L56_ASP2_DIO_GPIO13_CFG:

	case CS35L56_UPDATE_REGS:

	case CS35L56_ASP1_ENABLES1:

	case CS35L56_ASP1_CONTROL1:

	case CS35L56_ASP1_CONTROL2:
@@ -213,6 +218,7 @@ static bool cs35l56_readable_reg(struct device *dev, unsigned int reg) 
	case CS35L56_IRQ1_MASK_8:

	case CS35L56_IRQ1_MASK_18:

	case CS35L56_IRQ1_MASK_20:

	case CS35L56_GPIO_STATUS1 ... CS35L56_GPIO13_CTRL1:

	case CS35L56_MIXER_NGATE_CH1_CFG:

	case CS35L56_MIXER_NGATE_CH2_CFG:

	case CS35L56_DSP_VIRTUAL1_MBOX_1:
@@ -262,6 +268,8 @@ static bool cs35l56_common_volatile_reg(unsigned int reg) 
	case CS35L56_GLOBAL_ENABLES:		   /* owned by firmware */

	case CS35L56_BLOCK_ENABLES:		   /* owned by firmware */

	case CS35L56_BLOCK_ENABLES2:		   /* owned by firmware */

	case CS35L56_SYNC_GPIO1_CFG ... CS35L56_ASP2_DIO_GPIO13_CFG:

	case CS35L56_UPDATE_REGS:

	case CS35L56_REFCLK_INPUT:		   /* owned by firmware */

	case CS35L56_GLOBAL_SAMPLE_RATE:	   /* owned by firmware */

	case CS35L56_DACPCM1_INPUT:		   /* owned by firmware */
@@ -272,6 +280,7 @@ static bool cs35l56_common_volatile_reg(unsigned int reg) 
	case CS35L56_IRQ1_EINT_1 ... CS35L56_IRQ1_EINT_8:

	case CS35L56_IRQ1_EINT_18:

	case CS35L56_IRQ1_EINT_20:

	case CS35L56_GPIO_STATUS1 ... CS35L56_GPIO13_CTRL1:

	case CS35L56_MIXER_NGATE_CH1_CFG:

	case CS35L56_MIXER_NGATE_CH2_CFG:

	case CS35L56_DSP_VIRTUAL1_MBOX_1:
@@ -1552,6 +1561,169 @@ int cs35l56_get_speaker_id(struct cs35l56_base *cs35l56_base) 
}

EXPORT_SYMBOL_NS_GPL(cs35l56_get_speaker_id, "SND_SOC_CS35L56_SHARED");



int cs35l56_check_and_save_onchip_spkid_gpios(struct cs35l56_base *cs35l56_base,

					      const u32 *gpios, int num_gpios,

					      const u32 *pulls, int num_pulls)

{

	int max_gpio;

	int ret = 0;

	int i;



	if ((num_gpios > ARRAY_SIZE(cs35l56_base->onchip_spkid_gpios)) ||

	    (num_pulls > ARRAY_SIZE(cs35l56_base->onchip_spkid_pulls)))

		return -EOVERFLOW;



	switch (cs35l56_base->type) {

	case 0x54:

	case 0x56:

	case 0x57:

		max_gpio = CS35L56_MAX_GPIO;

		break;

	default:

		max_gpio = CS35L63_MAX_GPIO;

		break;

	}



	for (i = 0; i < num_gpios; i++) {

		if (gpios[i] < 1 || gpios[i] > max_gpio) {

			dev_err(cs35l56_base->dev, "Invalid spkid GPIO %d\n", gpios[i]);

			/* Keep going so we log all bad values */

			ret = -EINVAL;

		}



		/* Change to zero-based */

		cs35l56_base->onchip_spkid_gpios[i] = gpios[i] - 1;

	}



	for (i = 0; i < num_pulls; i++) {

		switch (pulls[i]) {

		case 0:

			cs35l56_base->onchip_spkid_pulls[i] = CS35L56_PAD_PULL_NONE;

			break;

		case 1:

			cs35l56_base->onchip_spkid_pulls[i] = CS35L56_PAD_PULL_UP;

			break;

		case 2:

			cs35l56_base->onchip_spkid_pulls[i] = CS35L56_PAD_PULL_DOWN;

			break;

		default:

			dev_err(cs35l56_base->dev, "Invalid spkid pull %d\n", pulls[i]);

			/* Keep going so we log all bad values */

			ret = -EINVAL;

			break;

		}

	}

	if (ret)

		return ret;



	cs35l56_base->num_onchip_spkid_gpios = num_gpios;

	cs35l56_base->num_onchip_spkid_pulls = num_pulls;



	return 0;

}

EXPORT_SYMBOL_NS_GPL(cs35l56_check_and_save_onchip_spkid_gpios, "SND_SOC_CS35L56_SHARED");



/* Caller must pm_runtime resume before calling this function */

int cs35l56_configure_onchip_spkid_pads(struct cs35l56_base *cs35l56_base)

{

	struct regmap *regmap = cs35l56_base->regmap;

	unsigned int addr_offset, val;

	int num_gpios, num_pulls;

	int i, ret;



	KUNIT_STATIC_STUB_REDIRECT(cs35l56_configure_onchip_spkid_pads, cs35l56_base);



	if (cs35l56_base->num_onchip_spkid_gpios == 0)

		return 0;



	num_gpios = min(cs35l56_base->num_onchip_spkid_gpios,

			ARRAY_SIZE(cs35l56_base->onchip_spkid_gpios));

	num_pulls = min(cs35l56_base->num_onchip_spkid_pulls,

			ARRAY_SIZE(cs35l56_base->onchip_spkid_pulls));



	for (i = 0; i < num_gpios; i++) {

		addr_offset = cs35l56_base->onchip_spkid_gpios[i] * sizeof(u32);



		/* Set unspecified pulls to NONE */

		if (i < num_pulls) {

			val = FIELD_PREP(CS35L56_PAD_GPIO_PULL_MASK,

					 cs35l56_base->onchip_spkid_pulls[i]);

		} else {

			val = FIELD_PREP(CS35L56_PAD_GPIO_PULL_MASK, CS35L56_PAD_PULL_NONE);

		}



		ret = regmap_update_bits(regmap, CS35L56_SYNC_GPIO1_CFG + addr_offset,

					 CS35L56_PAD_GPIO_PULL_MASK | CS35L56_PAD_GPIO_IE,

					 val | CS35L56_PAD_GPIO_IE);

		if (ret) {

			dev_err(cs35l56_base->dev, "GPIO%d set pad fail: %d\n",

				cs35l56_base->onchip_spkid_gpios[i] + 1, ret);

			return ret;

		}

	}



	ret = regmap_write(regmap, CS35L56_UPDATE_REGS, CS35L56_UPDT_GPIO_PRES);

	if (ret) {

		dev_err(cs35l56_base->dev, "UPDT_GPIO_PRES failed:%d\n", ret);

		return ret;

	}



	usleep_range(CS35L56_PAD_PULL_SETTLE_US, CS35L56_PAD_PULL_SETTLE_US * 2);



	return 0;

}

EXPORT_SYMBOL_NS_GPL(cs35l56_configure_onchip_spkid_pads, "SND_SOC_CS35L56_SHARED");



/* Caller must pm_runtime resume before calling this function */

int cs35l56_read_onchip_spkid(struct cs35l56_base *cs35l56_base)

{

	struct regmap *regmap = cs35l56_base->regmap;

	unsigned int addr_offset, val;

	int num_gpios;

	int speaker_id = 0;

	int i, ret;



	KUNIT_STATIC_STUB_REDIRECT(cs35l56_read_onchip_spkid, cs35l56_base);



	if (cs35l56_base->num_onchip_spkid_gpios == 0)

		return -ENOENT;



	num_gpios = min(cs35l56_base->num_onchip_spkid_gpios,

			ARRAY_SIZE(cs35l56_base->onchip_spkid_gpios));



	for (i = 0; i < num_gpios; i++) {

		addr_offset = cs35l56_base->onchip_spkid_gpios[i] * sizeof(u32);



		ret = regmap_update_bits(regmap, CS35L56_GPIO1_CTRL1 + addr_offset,

					 CS35L56_GPIO_DIR_MASK | CS35L56_GPIO_FN_MASK,

					 CS35L56_GPIO_DIR_MASK | CS35L56_GPIO_FN_GPIO);

		if (ret) {

			dev_err(cs35l56_base->dev, "GPIO%u set func fail: %d\n",

				cs35l56_base->onchip_spkid_gpios[i] + 1, ret);

			return ret;

		}

	}



	ret = regmap_read(regmap, CS35L56_GPIO_STATUS1, &val);

	if (ret) {

		dev_err(cs35l56_base->dev, "GPIO%d status read failed: %d\n",

			cs35l56_base->onchip_spkid_gpios[i] + 1, ret);

		return ret;

	}



	for (i = 0; i < num_gpios; i++) {

		speaker_id <<= 1;



		if (val & BIT(cs35l56_base->onchip_spkid_gpios[i]))

			speaker_id |= 1;

	}



	dev_dbg(cs35l56_base->dev, "Onchip GPIO Speaker ID = %d\n", speaker_id);



	return speaker_id;

}

EXPORT_SYMBOL_NS_GPL(cs35l56_read_onchip_spkid, "SND_SOC_CS35L56_SHARED");



static const u32 cs35l56_bclk_valid_for_pll_freq_table[] = {

	[0x0C] = 128000,

	[0x0F] = 256000,