Re: [PATCH RESEND 5/7] mfd: cs40l26: Add support for CS40L26 core driver

[Krzysztof Kozlowski <krzk@kernel.org>]

On 05/02/2025 00:18, Fred Treven wrote:
> Introduce support for Cirrus Logic Device CS40L26:
> A boosted haptic driver with integrated DSP and
> waveform memory with advanced closed loop algorithms
> and LRA protection.
> 
Please wrap commit message according to Linux coding style / submission
process (neither too early nor over the limit):
https://elixir.bootlin.com/linux/v6.4-rc1/source/Documentation/process/submitting-patches.rst#L597


> +
> +#include <linux/cleanup.h>
> +#include <linux/mfd/core.h>
> +#include <linux/mfd/cs40l26.h>
> +#include <linux/property.h>
> +#include <linux/regulator/consumer.h>
> +
> +static const struct mfd_cell cs40l26_devs[] = {
> +	{ .name = "cs40l26-codec", },
> +	{ .name = "cs40l26-vibra", },
> +};
> +
> +const struct regmap_config cs40l26_regmap = {
> +	.reg_bits = 32,
> +	.val_bits = 32,
> +	.reg_stride = 4,
> +	.reg_format_endian = REGMAP_ENDIAN_BIG,
> +	.val_format_endian = REGMAP_ENDIAN_BIG,
> +	.max_register = CS40L26_LASTREG,
> +	.cache_type = REGCACHE_NONE,
> +};
> +EXPORT_SYMBOL_GPL(cs40l26_regmap);
> +
> +static const char *const cs40l26_supplies[] = {
> +	"va", "vp",
> +};
> +
> +inline void cs40l26_pm_exit(struct device *dev)

Exported function and inlined? This feels odd. Anyway, don't use any
inline keywords in C units.

> +{
> +	pm_runtime_mark_last_busy(dev);
> +	pm_runtime_put_autosuspend(dev);
> +}
> +EXPORT_SYMBOL_GPL(cs40l26_pm_exit);
> +
> +static int cs40l26_fw_write_raw(struct cs_dsp *dsp, const char *const name,
> +				const unsigned int algo_id, const u32 offset_words,
> +				const size_t len_words, u32 *buf)
> +{
> +	struct cs_dsp_coeff_ctl *ctl;
> +	__be32 *val;
> +	int i, ret;
> +
> +	ctl = cs_dsp_get_ctl(dsp, name, WMFW_ADSP2_XM, algo_id);
> +	if (!ctl) {
> +		dev_err(dsp->dev, "Failed to find FW control %s\n", name);
> +		return -EINVAL;
> +	}
> +
> +	val = kzalloc(len_words * sizeof(u32), GFP_KERNEL);

Looks like an array, so kcalloc

> +	if (!val)
> +		return -ENOMEM;
> +
> +	for (i = 0; i < len_words; i++)
> +		val[i] = cpu_to_be32(buf[i]);
> +
> +	ret = cs_dsp_coeff_write_ctrl(ctl, offset_words, val, len_words * sizeof(u32));
> +	if (ret < 0)
> +		dev_err(dsp->dev, "Failed to write FW control %s\n", name);
> +
> +	kfree(val);
> +
> +	return (ret < 0) ? ret : 0;
> +}
> +
> +inline int cs40l26_fw_write(struct cs_dsp *dsp, const char *const name, const unsigned int algo_id,
> +			    u32 val)
> +{
> +	return cs40l26_fw_write_raw(dsp, name, algo_id, 0, 1, &val);
> +}
> +EXPORT_SYMBOL_GPL(cs40l26_fw_write);
> +
> +static int cs40l26_fw_read_raw(struct cs_dsp *dsp, const char *const name,
> +			       const unsigned int algo_id, const unsigned int offset_words,
> +			       const size_t len_words, u32 *buf)
> +{
> +	struct cs_dsp_coeff_ctl *ctl;
> +	int i, ret;
> +
> +	ctl = cs_dsp_get_ctl(dsp, name, WMFW_ADSP2_XM, algo_id);
> +	if (!ctl) {
> +		dev_err(dsp->dev, "Failed to find FW control %s\n", name);
> +		return -EINVAL;
> +	}
> +
> +	ret = cs_dsp_coeff_read_ctrl(ctl, offset_words, buf, len_words * sizeof(u32));
> +	if (ret) {
> +		dev_err(dsp->dev, "Failed to read FW control %s\n", name);
> +		return ret;
> +	}
> +
> +	for (i = 0; i < len_words; i++)
> +		buf[i] = be32_to_cpu(buf[i]);
> +
> +	return 0;
> +}
> +
> +inline int cs40l26_fw_read(struct cs_dsp *dsp, const char *const name, const unsigned int algo_id,

All your exported functions should have kerneldoc.

> +			   u32 *buf)
> +{
> +	return cs40l26_fw_read_raw(dsp, name, algo_id, 0, 1, buf);
> +}
> +EXPORT_SYMBOL_GPL(cs40l26_fw_read);
> +
> +static struct cs40l26_irq *cs40l26_get_irq(struct cs40l26 *cs40l26, const int num, const int bit);
> +
> +static int cs40l26_gpio1_rise_irq(void *data)
> +{
> +	struct cs40l26 *cs40l26 = data;
> +
> +	if (cs40l26->wksrc_sts & CS40L26_WKSRC_STS_EN)
> +		dev_dbg(cs40l26->dev, "GPIO1 Rising Edge Detected\n");
> +
> +	cs40l26->wksrc_sts |= CS40L26_WKSRC_STS_EN;
> +
> +	return 0;
> +}


...

> +err:
> +	dev_err(cs40l26->dev, "Invalid revision 0x%02X for device 0x%06X\n", cs40l26->revid,
> +		cs40l26->devid);
> +	return -EINVAL;
> +}
> +
> +int cs40l26_set_pll_loop(struct cs40l26 *cs40l26, const u32 pll_loop)
> +{
> +	int i;
> +
> +	/* Retry in case DSP is hibernating */
> +	for (i = 0; i < CS40L26_PLL_NUM_SET_ATTEMPTS; i++) {
> +		if (!regmap_update_bits(cs40l26->regmap, CS40L26_REFCLK_INPUT,
> +					CS40L26_PLL_REFCLK_LOOP_MASK,
> +					pll_loop << CS40L26_PLL_REFCLK_LOOP_SHIFT))
> +			break;
> +	}
> +
> +	if (i == CS40L26_PLL_NUM_SET_ATTEMPTS) {
> +		dev_err(cs40l26->dev, "Failed to configure PLL\n");
> +		return -ETIMEDOUT;
> +	}
> +
> +	return 0;
> +}
> +EXPORT_SYMBOL_GPL(cs40l26_set_pll_loop);
> +

This looks way past simple MFD driver. Not only this - entire file. You
configure there quite a lot and for example setting PLLs is not job for
MFD. This should be placed in appropriate subsystem.


> +
> +static const struct cs_dsp_client_ops cs40l26_cs_dsp_client_ops = {
> +	.pre_run = cs40l26_cs_dsp_pre_run,
> +	.post_run = cs40l26_cs_dsp_post_run,
> +};
> +
> +static void cs40l26_cs_dsp_remove(void *data)
> +{
> +	cs_dsp_remove((struct cs_dsp *)data);
> +}
> +
> +static struct cs_dsp_coeff_desc cs40l26_coeffs[] = {

This cannto be const?

> +	{ .coeff_firmware = NULL, .coeff_filename = "cs40l26.bin" },
> +	{ .coeff_firmware = NULL, .coeff_filename = "cs40l26-svc.bin" },
> +	{ .coeff_firmware = NULL, .coeff_filename = "cs40l26-dvl.bin" },
> +};
> +
> +static int cs40l26_cs_dsp_init(struct cs40l26 *cs40l26)
> +{
> +	struct cs_dsp *dsp = &cs40l26->dsp;
> +	int ret;
> +
> +	dsp->num = 1;
> +	dsp->type = WMFW_HALO;
> +	dsp->dev = cs40l26->dev;
> +	dsp->regmap = cs40l26->regmap;
> +	dsp->base = CS40L26_DSP_CTRL_BASE;
> +	dsp->base_sysinfo = CS40L26_DSP1_SYS_INFO_ID;
> +	dsp->mem = cs40l26_dsp_regions;
> +	dsp->num_mems = ARRAY_SIZE(cs40l26_dsp_regions);
> +	dsp->client_ops = &cs40l26_cs_dsp_client_ops;
> +
> +	ret = cs_dsp_halo_init(dsp);
> +	if (ret) {
> +		dev_err(cs40l26->dev, "Failed to initialize HALO core\n");
> +		return ret;
> +	}
> +

...

> +
> +static int __maybe_unused cs40l26_suspend(struct device *dev)
> +{
> +	struct cs40l26 *cs40l26 = dev_get_drvdata(dev);
> +
> +	guard(mutex)(&cs40l26->lock);
> +
> +	dev_dbg(dev, "%s: Enabling hibernation\n", __func__);

Drop. No need to re-implement tracing.

> +
> +	cs40l26->wksrc_sts = 0x00;
> +
> +	/* Don't poll DSP since reading for ACK will wake the device again */
> +	return regmap_write(cs40l26->regmap, CS40L26_DSP_QUEUE, CS40L26_DSP_CMD_ALLOW_HIBER);
> +}
> +
> +static int __maybe_unused cs40l26_sys_suspend(struct device *dev)
> +{
> +	struct cs40l26 *cs40l26 = dev_get_drvdata(dev);
> +
> +	dev_dbg(dev, "System suspend, disabling IRQ\n");

Drop.

> +
> +	disable_irq(cs40l26->irq);
> +
> +	return 0;
> +}
> +
> +static int __maybe_unused cs40l26_sys_suspend_noirq(struct device *dev)
> +{
> +	struct cs40l26 *cs40l26 = dev_get_drvdata(dev);
> +
> +	dev_dbg(dev, "Late system suspend, re-enabling IRQ\n");


Drop.

> +
> +	enable_irq(cs40l26->irq);
> +
> +	return 0;
> +}
> +
> +static int __maybe_unused cs40l26_resume(struct device *dev)
> +{
> +	struct cs40l26 *cs40l26 = dev_get_drvdata(dev);
> +
> +	dev_dbg(dev, "%s: Disabling hibernation\n", __func__);

Drop.

> +
> +	guard(mutex)(&cs40l26->dsp.pwr_lock);
> +
> +	return cs40l26_prevent_hiber(cs40l26);
> +}
> +
> +static int __maybe_unused cs40l26_sys_resume(struct device *dev)
> +{
> +	struct cs40l26 *cs40l26 = dev_get_drvdata(dev);
> +
> +	dev_dbg(dev, "System resume, re-enabling IRQ\n");

Drop.

> +
> +	enable_irq(cs40l26->irq);
> +
> +	return 0;
> +}
> +
> +static int __maybe_unused cs40l26_sys_resume_noirq(struct device *dev)
> +{
> +	struct cs40l26 *cs40l26 = dev_get_drvdata(dev);
> +
> +	dev_dbg(dev, "Early system resume, disabling IRQ\n");
> +

Drop.
...

> +
> +static int cs40l26_spi_probe(struct spi_device *spi)
> +{
> +	struct cs40l26 *cs40l26;
> +
> +	cs40l26 = devm_kzalloc(&spi->dev, sizeof(struct cs40l26), GFP_KERNEL);

sizeof(*)


> +	if (!cs40l26)
> +		return -ENOMEM;
> +
> +	spi_set_drvdata(spi, cs40l26);
> +
> +	cs40l26->dev = &spi->dev;
> +	cs40l26->irq = spi->irq;
> +	cs40l26->bus = &spi_bus_type;
> +
> +	cs40l26->regmap = devm_regmap_init_spi(spi, &cs40l26_regmap);
> +	if (IS_ERR(cs40l26->regmap))
> +		return dev_err_probe(cs40l26->dev, PTR_ERR(cs40l26->regmap),
> +				     "Failed to allocate register map\n");
> +
> +	return cs40l26_probe(cs40l26);
> +}
> +
> +static const struct spi_device_id cs40l26_id_spi[] = {
> +	{ "cs40l26a", 0 },
> +	{ "cs40l27b", 1 },

What are these 0 and 1?

> +	{}
> +};
> +MODULE_DEVICE_TABLE(spi, cs40l26_id_spi);
> +
> +static const struct of_device_id cs40l26_of_match[] = {
> +	{ .compatible = "cirrus,cs40l26a" },
> +	{ .compatible = "cirrus,cs40l27b" },

So devices are compatible? Or rather this is unsynced with other ID table.

Best regards,
Krzysztof