Unverified Commit 37b4346e authored by Mark Brown's avatar Mark Brown
Browse files

ASoC: codecs: Add aw87390 amplifier driver 

Merge series from wangweidong.a@awinic.com:

The awinic aw87390 is a new high efficiency, low noise,
constant large volume, 6th Smart K audio amplifier.
parents 54ac5120 4717636f

Documentation/devicetree/bindings/sound/awinic,aw87390.yaml

0 → 100644
+58 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/sound/awinic,aw87390.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Awinic Aw87390 Audio Amplifier



maintainers:

  - Weidong Wang <wangweidong.a@awinic.com>



description:

  The awinic aw87390 is specifically designed to improve

  the musical output dynamic range, enhance the overall

  sound quallity, which is a new high efficiency, low

  noise, constant large volume, 6th Smart K audio amplifier.



allOf:

  - $ref: dai-common.yaml#



properties:

  compatible:

    const: awinic,aw87390



  reg:

    maxItems: 1



  "#sound-dai-cells":

    const: 0



  awinic,audio-channel:

    description:

      It is used to distinguish multiple PA devices, so that different

      configurations can be loaded to different PA devices

    $ref: /schemas/types.yaml#/definitions/uint32

    minimum: 0

    maximum: 7



required:

  - compatible

  - reg

  - "#sound-dai-cells"

  - awinic,audio-channel



unevaluatedProperties: false



examples:

  - |

    i2c {

        #address-cells = <1>;

        #size-cells = <0>;

        audio-codec@58 {

            compatible = "awinic,aw87390";

            reg = <0x58>;

            #sound-dai-cells = <0>;

            awinic,audio-channel = <0>;

        };

    };

Documentation/devicetree/bindings/sound/awinic,aw88395.yaml

+16 −0
Original line number Diff line number Diff line
@@ -32,11 +32,25 @@ properties: 
  reset-gpios:

    maxItems: 1



  awinic,audio-channel:

    description:

      It is used to distinguish multiple PA devices, so that different

      configurations can be loaded to different PA devices

    $ref: /schemas/types.yaml#/definitions/uint32

    minimum: 0

    maximum: 7



  awinic,sync-flag:

    description:

      Flag bit used to keep the phase synchronized in the case of multiple PA

    $ref: /schemas/types.yaml#/definitions/flag



required:

  - compatible

  - reg

  - '#sound-dai-cells'

  - reset-gpios

  - awinic,audio-channel



unevaluatedProperties: false
@@ -51,5 +65,7 @@ examples: 
            reg = <0x34>;

            #sound-dai-cells = <0>;

            reset-gpios = <&gpio 10 GPIO_ACTIVE_LOW>;

            awinic,audio-channel = <0>;

            awinic,sync-flag;

        };

    };

sound/soc/codecs/Kconfig

+13 −2
Original line number Diff line number Diff line
@@ -54,6 +54,7 @@ config SND_SOC_ALL_CODECS 
	imply SND_SOC_ALC5632

	imply SND_SOC_AUDIO_IIO_AUX

	imply SND_SOC_AW8738

	imply SND_SOC_AW87390

	imply SND_SOC_AW88395

	imply SND_SOC_AW88261

	imply SND_SOC_BT_SCO
@@ -639,12 +640,12 @@ config SND_SOC_AW8738 
	  operation mode using the Awinic-specific one-wire pulse control.



config SND_SOC_AW88395_LIB

	select CRC8

	tristate



config SND_SOC_AW88395

	tristate "Soc Audio for awinic aw88395"

	depends on I2C

	select CRC8

	select CRC32

	select REGMAP_I2C

	select GPIOLIB
@@ -658,7 +659,6 @@ config SND_SOC_AW88395 
config SND_SOC_AW88261

	tristate "Soc Audio for awinic aw88261"

	depends on I2C

	select CRC8

	select REGMAP_I2C

	select GPIOLIB

	select SND_SOC_AW88395_LIB
@@ -669,6 +669,17 @@ config SND_SOC_AW88261 
	  boost converter can be adjusted smartly according to

	  the input amplitude.



config SND_SOC_AW87390

	tristate "Soc Audio for awinic aw87390"

	depends on I2C

	select REGMAP_I2C

	select SND_SOC_AW88395_LIB

	help

	  The awinic aw87390 is specifically designed to improve

	  the musical output dynamic range, enhance the overall

	  sound quality, which is a new high efficiency, low

	  noise, constant large volume, 6th Smart K audio amplifier.



config SND_SOC_BD28623

	tristate "ROHM BD28623 CODEC"

	help

sound/soc/codecs/Makefile

+2 −0
Original line number Diff line number Diff line
@@ -47,6 +47,7 @@ snd-soc-ak5558-objs := ak5558.o 
snd-soc-arizona-objs := arizona.o arizona-jack.o

snd-soc-audio-iio-aux-objs := audio-iio-aux.o

snd-soc-aw8738-objs := aw8738.o

snd-soc-aw87390-objs := aw87390.o

snd-soc-aw88395-lib-objs := aw88395/aw88395_lib.o

snd-soc-aw88395-objs := aw88395/aw88395.o \

			aw88395/aw88395_device.o
@@ -435,6 +436,7 @@ obj-$(CONFIG_SND_SOC_ALC5632) += snd-soc-alc5632.o 
obj-$(CONFIG_SND_SOC_ARIZONA)	+= snd-soc-arizona.o

obj-$(CONFIG_SND_SOC_AUDIO_IIO_AUX)	+= snd-soc-audio-iio-aux.o

obj-$(CONFIG_SND_SOC_AW8738)	+= snd-soc-aw8738.o

obj-$(CONFIG_SND_SOC_AW87390)	+= snd-soc-aw87390.o

obj-$(CONFIG_SND_SOC_AW88395_LIB) += snd-soc-aw88395-lib.o

obj-$(CONFIG_SND_SOC_AW88395)	+=snd-soc-aw88395.o

obj-$(CONFIG_SND_SOC_AW88261)	+=snd-soc-aw88261.o

sound/soc/codecs/aw87390.c

0 → 100644
+463 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

//

// aw87390.c  --  AW87390 ALSA SoC Audio driver

//

// Copyright (c) 2023 awinic Technology CO., LTD

//

// Author: Weidong Wang <wangweidong.a@awinic.com>

//



#include <linux/i2c.h>

#include <linux/firmware.h>

#include <linux/regmap.h>

#include <sound/soc.h>

#include "aw87390.h"

#include "aw88395/aw88395_data_type.h"

#include "aw88395/aw88395_device.h"



static const struct regmap_config aw87390_remap_config = {

	.val_bits = 8,

	.reg_bits = 8,

	.max_register = AW87390_REG_MAX,

	.reg_format_endian = REGMAP_ENDIAN_LITTLE,

	.val_format_endian = REGMAP_ENDIAN_BIG,

};



static int aw87390_dev_reg_update(struct aw_device *aw_dev,

					unsigned char *data, unsigned int len)

{

	int i, ret;



	if (!data) {

		dev_err(aw_dev->dev, "data is NULL\n");

		return -EINVAL;

	}



	for (i = 0; i < len-1; i += 2) {

		if (data[i] == AW87390_DELAY_REG_ADDR) {

			usleep_range(data[i + 1] * AW87390_REG_DELAY_TIME,

					data[i + 1] * AW87390_REG_DELAY_TIME + 10);

			continue;

		}

		ret = regmap_write(aw_dev->regmap, data[i], data[i + 1]);

		if (ret)

			return ret;

	}



	return 0;

}



static int aw87390_dev_get_prof_name(struct aw_device *aw_dev, int index, char **prof_name)

{

	struct aw_prof_info *prof_info = &aw_dev->prof_info;

	struct aw_prof_desc *prof_desc;



	if ((index >= aw_dev->prof_info.count) || (index < 0)) {

		dev_err(aw_dev->dev, "index[%d] overflow count[%d]\n",

			index, aw_dev->prof_info.count);

		return -EINVAL;

	}



	prof_desc = &aw_dev->prof_info.prof_desc[index];



	*prof_name = prof_info->prof_name_list[prof_desc->id];



	return 0;

}



static int aw87390_dev_get_prof_data(struct aw_device *aw_dev, int index,

			struct aw_prof_desc **prof_desc)

{

	if ((index >= aw_dev->prof_info.count) || (index < 0)) {

		dev_err(aw_dev->dev, "%s: index[%d] overflow count[%d]\n",

				__func__, index, aw_dev->prof_info.count);

		return -EINVAL;

	}



	*prof_desc = &aw_dev->prof_info.prof_desc[index];



	return 0;

}



static int aw87390_dev_fw_update(struct aw_device *aw_dev)

{

	struct aw_prof_desc *prof_index_desc;

	struct aw_sec_data_desc *sec_desc;

	char *prof_name;

	int ret;



	ret = aw87390_dev_get_prof_name(aw_dev, aw_dev->prof_index, &prof_name);

	if (ret) {

		dev_err(aw_dev->dev, "get prof name failed\n");

		return -EINVAL;

	}



	dev_dbg(aw_dev->dev, "start update %s", prof_name);



	ret = aw87390_dev_get_prof_data(aw_dev, aw_dev->prof_index, &prof_index_desc);

	if (ret) {

		dev_err(aw_dev->dev, "aw87390_dev_get_prof_data failed\n");

		return ret;

	}



	/* update reg */

	sec_desc = prof_index_desc->sec_desc;

	ret = aw87390_dev_reg_update(aw_dev, sec_desc[AW88395_DATA_TYPE_REG].data,

					sec_desc[AW88395_DATA_TYPE_REG].len);

	if (ret) {

		dev_err(aw_dev->dev, "update reg failed\n");

		return ret;

	}



	aw_dev->prof_cur = aw_dev->prof_index;



	return 0;

}



static int aw87390_power_off(struct aw_device *aw_dev)

{

	int ret;



	if (aw_dev->status == AW87390_DEV_PW_OFF) {

		dev_dbg(aw_dev->dev, "already power off\n");

		return 0;

	}



	ret = regmap_write(aw_dev->regmap, AW87390_SYSCTRL_REG, AW87390_POWER_DOWN_VALUE);

	if (ret)

		return ret;

	aw_dev->status = AW87390_DEV_PW_OFF;



	return 0;

}



static int aw87390_power_on(struct aw_device *aw_dev)

{

	int ret;



	if (aw_dev->status == AW87390_DEV_PW_ON) {

		dev_dbg(aw_dev->dev, "already power on\n");

		return 0;

	}



	if (!aw_dev->fw_status) {

		dev_err(aw_dev->dev, "fw not load\n");

		return -EINVAL;

	}



	ret = regmap_write(aw_dev->regmap, AW87390_SYSCTRL_REG, AW87390_POWER_DOWN_VALUE);

	if (ret)

		return ret;



	ret = aw87390_dev_fw_update(aw_dev);

	if (ret) {

		dev_err(aw_dev->dev, "%s load profile failed\n", __func__);

		return ret;

	}

	aw_dev->status = AW87390_DEV_PW_ON;



	return 0;

}



static int aw87390_dev_set_profile_index(struct aw_device *aw_dev, int index)

{

	if ((index >= aw_dev->prof_info.count) || (index < 0))

		return -EINVAL;



	if (aw_dev->prof_index == index)

		return -EPERM;



	aw_dev->prof_index = index;



	return 0;

}



static int aw87390_profile_info(struct snd_kcontrol *kcontrol,

			 struct snd_ctl_elem_info *uinfo)

{

	struct snd_soc_component *codec = snd_soc_kcontrol_component(kcontrol);

	struct aw87390 *aw87390 = snd_soc_component_get_drvdata(codec);

	char *prof_name, *name;

	int count, ret;



	uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;

	uinfo->count = 1;



	count = aw87390->aw_pa->prof_info.count;

	if (count <= 0) {

		uinfo->value.enumerated.items = 0;

		return 0;

	}



	uinfo->value.enumerated.items = count;



	if (uinfo->value.enumerated.item >= count)

		uinfo->value.enumerated.item = count - 1;



	name = uinfo->value.enumerated.name;

	count = uinfo->value.enumerated.item;



	ret = aw87390_dev_get_prof_name(aw87390->aw_pa, count, &prof_name);

	if (ret) {

		strscpy(uinfo->value.enumerated.name, "null",

						strlen("null") + 1);

		return 0;

	}



	strscpy(name, prof_name, sizeof(uinfo->value.enumerated.name));



	return 0;

}



static int aw87390_profile_get(struct snd_kcontrol *kcontrol,

			struct snd_ctl_elem_value *ucontrol)

{

	struct snd_soc_component *codec = snd_soc_kcontrol_component(kcontrol);

	struct aw87390 *aw87390 = snd_soc_component_get_drvdata(codec);



	ucontrol->value.integer.value[0] = aw87390->aw_pa->prof_index;



	return 0;

}



static int aw87390_profile_set(struct snd_kcontrol *kcontrol,

		struct snd_ctl_elem_value *ucontrol)

{

	struct snd_soc_component *codec = snd_soc_kcontrol_component(kcontrol);

	struct aw87390 *aw87390 = snd_soc_component_get_drvdata(codec);

	int ret;



	mutex_lock(&aw87390->lock);

	ret = aw87390_dev_set_profile_index(aw87390->aw_pa, ucontrol->value.integer.value[0]);

	if (ret) {

		dev_dbg(codec->dev, "profile index does not change\n");

		mutex_unlock(&aw87390->lock);

		return 0;

	}



	if (aw87390->aw_pa->status == AW87390_DEV_PW_ON) {

		aw87390_power_off(aw87390->aw_pa);

		aw87390_power_on(aw87390->aw_pa);

	}



	mutex_unlock(&aw87390->lock);



	return 1;

}



static const struct snd_kcontrol_new aw87390_controls[] = {

	AW87390_PROFILE_EXT("AW87390 Profile Set", aw87390_profile_info,

		aw87390_profile_get, aw87390_profile_set),

};



static int aw87390_request_firmware_file(struct aw87390 *aw87390)

{

	const struct firmware *cont = NULL;

	int ret;



	aw87390->aw_pa->fw_status = AW87390_DEV_FW_FAILED;



	ret = request_firmware(&cont, AW87390_ACF_FILE, aw87390->aw_pa->dev);

	if (ret)

		return dev_err_probe(aw87390->aw_pa->dev, ret,

					"load [%s] failed!\n", AW87390_ACF_FILE);



	dev_dbg(aw87390->aw_pa->dev, "loaded %s - size: %zu\n",

			AW87390_ACF_FILE, cont ? cont->size : 0);



	aw87390->aw_cfg = devm_kzalloc(aw87390->aw_pa->dev,

				struct_size(aw87390->aw_cfg, data, cont->size), GFP_KERNEL);

	if (!aw87390->aw_cfg) {

		release_firmware(cont);

		return -ENOMEM;

	}



	aw87390->aw_cfg->len = cont->size;

	memcpy(aw87390->aw_cfg->data, cont->data, cont->size);

	release_firmware(cont);



	ret = aw88395_dev_load_acf_check(aw87390->aw_pa, aw87390->aw_cfg);

	if (ret) {

		dev_err(aw87390->aw_pa->dev, "load [%s] failed!\n", AW87390_ACF_FILE);

		return ret;

	}



	mutex_lock(&aw87390->lock);



	ret = aw88395_dev_cfg_load(aw87390->aw_pa, aw87390->aw_cfg);

	if (ret)

		dev_err(aw87390->aw_pa->dev, "aw_dev acf parse failed\n");



	mutex_unlock(&aw87390->lock);



	return ret;

}



static int aw87390_drv_event(struct snd_soc_dapm_widget *w,

				struct snd_kcontrol *kcontrol, int event)

{

	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);

	struct aw87390 *aw87390 = snd_soc_component_get_drvdata(component);

	struct aw_device *aw_dev = aw87390->aw_pa;

	int ret;



	switch (event) {

	case SND_SOC_DAPM_PRE_PMU:

		ret = aw87390_power_on(aw_dev);

		break;

	case SND_SOC_DAPM_POST_PMD:

		ret = aw87390_power_off(aw_dev);

		break;

	default:

		dev_err(aw_dev->dev, "%s: invalid event %d\n", __func__, event);

		ret = -EINVAL;

	}



	return ret;

}



static const struct snd_soc_dapm_widget aw87390_dapm_widgets[] = {

	SND_SOC_DAPM_INPUT("IN"),

	SND_SOC_DAPM_PGA_E("SPK PA", SND_SOC_NOPM, 0, 0, NULL, 0, aw87390_drv_event,

			       SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),

	SND_SOC_DAPM_OUTPUT("OUT"),

};



static const struct snd_soc_dapm_route aw87390_dapm_routes[] = {

	{ "SPK PA", NULL, "IN" },

	{ "OUT", NULL, "SPK PA" },

};



static int aw87390_codec_probe(struct snd_soc_component *component)

{

	struct aw87390 *aw87390 = snd_soc_component_get_drvdata(component);

	int ret;



	ret = aw87390_request_firmware_file(aw87390);

	if (ret)

		return dev_err_probe(aw87390->aw_pa->dev, ret,

				"aw87390_request_firmware_file failed\n");



	return 0;

}



static const struct snd_soc_component_driver soc_codec_dev_aw87390 = {

	.probe = aw87390_codec_probe,

	.dapm_widgets = aw87390_dapm_widgets,

	.num_dapm_widgets = ARRAY_SIZE(aw87390_dapm_widgets),

	.dapm_routes = aw87390_dapm_routes,

	.num_dapm_routes = ARRAY_SIZE(aw87390_dapm_routes),

	.controls = aw87390_controls,

	.num_controls = ARRAY_SIZE(aw87390_controls),

};



static void aw87390_parse_channel_dt(struct aw87390 *aw87390)

{

	struct aw_device *aw_dev = aw87390->aw_pa;

	struct device_node *np = aw_dev->dev->of_node;

	u32 channel_value = AW87390_DEV_DEFAULT_CH;



	of_property_read_u32(np, "awinic,audio-channel", &channel_value);



	aw_dev->channel = channel_value;

}



static int aw87390_init(struct aw87390 **aw87390, struct i2c_client *i2c, struct regmap *regmap)

{

	struct aw_device *aw_dev;

	unsigned int chip_id;

	int ret;



	/* read chip id */

	ret = regmap_read(regmap, AW87390_ID_REG, &chip_id);

	if (ret) {

		dev_err(&i2c->dev, "%s read chipid error. ret = %d\n", __func__, ret);

		return ret;

	}



	if (chip_id != AW87390_CHIP_ID) {

		dev_err(&i2c->dev, "unsupported device\n");

		return -ENXIO;

	}



	dev_dbg(&i2c->dev, "chip id = 0x%x\n", chip_id);



	aw_dev = devm_kzalloc(&i2c->dev, sizeof(*aw_dev), GFP_KERNEL);

	if (!aw_dev)

		return -ENOMEM;



	(*aw87390)->aw_pa = aw_dev;

	aw_dev->i2c = i2c;

	aw_dev->regmap = regmap;

	aw_dev->dev = &i2c->dev;

	aw_dev->chip_id = AW87390_CHIP_ID;

	aw_dev->acf = NULL;

	aw_dev->prof_info.prof_desc = NULL;

	aw_dev->prof_info.count = 0;

	aw_dev->prof_info.prof_type = AW88395_DEV_NONE_TYPE_ID;

	aw_dev->channel = AW87390_DEV_DEFAULT_CH;

	aw_dev->fw_status = AW87390_DEV_FW_FAILED;

	aw_dev->prof_index = AW87390_INIT_PROFILE;

	aw_dev->status = AW87390_DEV_PW_OFF;



	aw87390_parse_channel_dt(*aw87390);



	return 0;

}



static int aw87390_i2c_probe(struct i2c_client *i2c)

{

	struct aw87390 *aw87390;

	int ret;



	ret = i2c_check_functionality(i2c->adapter, I2C_FUNC_I2C);

	if (!ret)

		return dev_err_probe(&i2c->dev, -ENXIO, "check_functionality failed\n");



	aw87390 = devm_kzalloc(&i2c->dev, sizeof(*aw87390), GFP_KERNEL);

	if (!aw87390)

		return -ENOMEM;



	mutex_init(&aw87390->lock);



	i2c_set_clientdata(i2c, aw87390);



	aw87390->regmap = devm_regmap_init_i2c(i2c, &aw87390_remap_config);

	if (IS_ERR(aw87390->regmap))

		return dev_err_probe(&i2c->dev, PTR_ERR(aw87390->regmap),

					"failed to init regmap\n");



	/* aw pa init */

	ret = aw87390_init(&aw87390, i2c, aw87390->regmap);

	if (ret)

		return ret;



	ret = regmap_write(aw87390->regmap, AW87390_ID_REG, AW87390_SOFT_RESET_VALUE);

	if (ret)

		return ret;



	ret = devm_snd_soc_register_component(&i2c->dev,

				&soc_codec_dev_aw87390, NULL, 0);

	if (ret)

		dev_err(&i2c->dev, "failed to register aw87390: %d\n", ret);



	return ret;

}



static const struct i2c_device_id aw87390_i2c_id[] = {

	{ AW87390_I2C_NAME, 0 },

	{ }

};

MODULE_DEVICE_TABLE(i2c, aw87390_i2c_id);



static struct i2c_driver aw87390_i2c_driver = {

	.driver = {

		.name = AW87390_I2C_NAME,

	},

	.probe = aw87390_i2c_probe,

	.id_table = aw87390_i2c_id,

};

module_i2c_driver(aw87390_i2c_driver);



MODULE_DESCRIPTION("ASoC AW87390 PA Driver");

MODULE_LICENSE("GPL v2");