Unverified Commit e1830f66 authored by Richard Fitzgerald's avatar Richard Fitzgerald Committed by Mark Brown
Browse files

ASoC: cs35l56: Add helper functions for amp calibration 



Adds some helper functions and data for applying amp calibration.

1. cs35l56_read_silicon_uid() to get the silicon ID that is used to
   search for the correct calibration data entry.

2. Add the registers for the silicon ID to the readable registers.

3. cs35l56_get_calibration() wrapper around
   cs_amp_get_efi_calibration_data()

4. cs35l56_calibration_controls() table of the firmware controls
   for calibration data.

5. Added members to struct cs35l56_base to store the calibration
   data.

Signed-off-by: default avatarRichard Fitzgerald <rf@opensource.cirrus.com>
Link: https://lore.kernel.org/r/20240223153910.2063698-4-rf@opensource.cirrus.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 1cad8725

include/sound/cs35l56.h

+10 −0
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ 
#include <linux/firmware/cirrus/cs_dsp.h>

#include <linux/regulator/consumer.h>

#include <linux/regmap.h>

#include <sound/cs-amp-lib.h>



#define CS35L56_DEVID					0x0000000

#define CS35L56_REVID					0x0000004
@@ -23,6 +24,9 @@ 
#define CS35L56_BLOCK_ENABLES2				0x000201C

#define CS35L56_REFCLK_INPUT				0x0002C04

#define CS35L56_GLOBAL_SAMPLE_RATE			0x0002C0C

#define CS35L56_OTP_MEM_53				0x00300D4

#define CS35L56_OTP_MEM_54				0x00300D8

#define CS35L56_OTP_MEM_55				0x00300DC

#define CS35L56_ASP1_ENABLES1				0x0004800

#define CS35L56_ASP1_CONTROL1				0x0004804

#define CS35L56_ASP1_CONTROL2				0x0004808
@@ -262,6 +266,9 @@ struct cs35l56_base { 
	bool fw_patched;

	bool secured;

	bool can_hibernate;

	bool cal_data_valid;

	s8 cal_index;

	struct cirrus_amp_cal_data cal_data;

	struct gpio_desc *reset_gpio;

};
@@ -269,6 +276,8 @@ extern struct regmap_config cs35l56_regmap_i2c; 
extern struct regmap_config cs35l56_regmap_spi;

extern struct regmap_config cs35l56_regmap_sdw;



extern const struct cirrus_amp_cal_controls cs35l56_calibration_controls;



extern const char * const cs35l56_tx_input_texts[CS35L56_NUM_INPUT_SRC];

extern const unsigned int cs35l56_tx_input_values[CS35L56_NUM_INPUT_SRC];
@@ -286,6 +295,7 @@ int cs35l56_is_fw_reload_needed(struct cs35l56_base *cs35l56_base); 
int cs35l56_runtime_suspend_common(struct cs35l56_base *cs35l56_base);

int cs35l56_runtime_resume_common(struct cs35l56_base *cs35l56_base, bool is_soundwire);

void cs35l56_init_cs_dsp(struct cs35l56_base *cs35l56_base, struct cs_dsp *cs_dsp);

int cs35l56_get_calibration(struct cs35l56_base *cs35l56_base);

int cs35l56_read_prot_status(struct cs35l56_base *cs35l56_base,

			     bool *fw_missing, unsigned int *fw_version);

int cs35l56_hw_init(struct cs35l56_base *cs35l56_base);

sound/soc/codecs/Kconfig

+1 −0
Original line number Diff line number Diff line
@@ -798,6 +798,7 @@ config SND_SOC_CS35L56 
	tristate



config SND_SOC_CS35L56_SHARED

	select SND_SOC_CS_AMP_LIB

	tristate



config SND_SOC_CS35L56_I2C

sound/soc/codecs/cs35l56-shared.c

+83 −0
Original line number Diff line number Diff line
@@ -5,10 +5,12 @@ 
// Copyright (C) 2023 Cirrus Logic, Inc. and

//                    Cirrus Logic International Semiconductor Ltd.



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

#include <linux/gpio/consumer.h>

#include <linux/regmap.h>

#include <linux/regulator/consumer.h>

#include <linux/types.h>

#include <sound/cs-amp-lib.h>



#include "cs35l56.h"
@@ -36,6 +38,8 @@ int cs35l56_set_patch(struct cs35l56_base *cs35l56_base) 
EXPORT_SYMBOL_NS_GPL(cs35l56_set_patch, SND_SOC_CS35L56_SHARED);



static const struct reg_default cs35l56_reg_defaults[] = {

	/* no defaults for OTP_MEM - first read populates cache */



	{ CS35L56_ASP1_ENABLES1,		0x00000000 },

	{ CS35L56_ASP1_CONTROL1,		0x00000028 },

	{ CS35L56_ASP1_CONTROL2,		0x18180200 },
@@ -91,6 +95,9 @@ static bool cs35l56_readable_reg(struct device *dev, unsigned int reg) 
	case CS35L56_BLOCK_ENABLES2:

	case CS35L56_REFCLK_INPUT:

	case CS35L56_GLOBAL_SAMPLE_RATE:

	case CS35L56_OTP_MEM_53:

	case CS35L56_OTP_MEM_54:

	case CS35L56_OTP_MEM_55:

	case CS35L56_ASP1_ENABLES1:

	case CS35L56_ASP1_CONTROL1:

	case CS35L56_ASP1_CONTROL2:
@@ -628,6 +635,81 @@ void cs35l56_init_cs_dsp(struct cs35l56_base *cs35l56_base, struct cs_dsp *cs_ds 
}

EXPORT_SYMBOL_NS_GPL(cs35l56_init_cs_dsp, SND_SOC_CS35L56_SHARED);



struct cs35l56_pte {

	u8 x;

	u8 wafer_id;

	u8 pte[2];

	u8 lot[3];

	u8 y;

	u8 unused[3];

	u8 dvs;

} __packed;

static_assert((sizeof(struct cs35l56_pte) % sizeof(u32)) == 0);



static int cs35l56_read_silicon_uid(struct cs35l56_base *cs35l56_base, u64 *uid)

{

	struct cs35l56_pte pte;

	u64 unique_id;

	int ret;



	ret = regmap_raw_read(cs35l56_base->regmap, CS35L56_OTP_MEM_53, &pte, sizeof(pte));

	if (ret) {

		dev_err(cs35l56_base->dev, "Failed to read OTP: %d\n", ret);

		return ret;

	}



	unique_id = pte.lot[2] | (pte.lot[1] << 8) | (pte.lot[0] << 16);

	unique_id <<= 32;

	unique_id |= pte.x | (pte.y << 8) | (pte.wafer_id << 16) | (pte.dvs << 24);



	dev_dbg(cs35l56_base->dev, "UniqueID = %#llx\n", unique_id);



	*uid = unique_id;



	return 0;

}



/* Firmware calibration controls */

const struct cirrus_amp_cal_controls cs35l56_calibration_controls = {

	.alg_id =	0x9f210,

	.mem_region =	WMFW_ADSP2_YM,

	.ambient =	"CAL_AMBIENT",

	.calr =		"CAL_R",

	.status =	"CAL_STATUS",

	.checksum =	"CAL_CHECKSUM",

};

EXPORT_SYMBOL_NS_GPL(cs35l56_calibration_controls, SND_SOC_CS35L56_SHARED);



int cs35l56_get_calibration(struct cs35l56_base *cs35l56_base)

{

	u64 silicon_uid;

	int ret;



	/* Driver can't apply calibration to a secured part, so skip */

	if (cs35l56_base->secured)

		return 0;



	ret = cs35l56_read_silicon_uid(cs35l56_base, &silicon_uid);

	if (ret < 0)

		return ret;



	ret = cs_amp_get_efi_calibration_data(cs35l56_base->dev, silicon_uid,

					      cs35l56_base->cal_index,

					      &cs35l56_base->cal_data);



	/* Only return an error status if probe should be aborted */

	if ((ret == -ENOENT) || (ret == -EOVERFLOW))

		return 0;



	if (ret < 0)

		return ret;



	cs35l56_base->cal_data_valid = true;



	return 0;

}

EXPORT_SYMBOL_NS_GPL(cs35l56_get_calibration, SND_SOC_CS35L56_SHARED);



int cs35l56_read_prot_status(struct cs35l56_base *cs35l56_base,

			     bool *fw_missing, unsigned int *fw_version)

{
@@ -922,3 +1004,4 @@ MODULE_DESCRIPTION("ASoC CS35L56 Shared"); 
MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");

MODULE_AUTHOR("Simon Trimmer <simont@opensource.cirrus.com>");

MODULE_LICENSE("GPL");

MODULE_IMPORT_NS(SND_SOC_CS_AMP_LIB);