kernel/sound/soc/codecs/jz4760.c

// SPDX-License-Identifier: GPL-2.0
//
// Ingenic JZ4760 CODEC driver
//
// Copyright (C) 2021, Christophe Branchereau <cbranchereau@gmail.com>
// Copyright (C) 2021, Paul Cercueil <paul@crapouillou.net>

#include <linux/bitfield.h>
#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/iopoll.h>
#include <linux/module.h>
#include <linux/regmap.h>
#include <linux/time64.h>

#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/soc-dai.h>
#include <sound/soc-dapm.h>
#include <sound/tlv.h>

#define ICDC_RGADW_OFFSET		0x00
#define ICDC_RGDATA_OFFSET		0x04

/* ICDC internal register access control register(RGADW) */
#define ICDC_RGADW_RGWR			BIT(16)
#define	ICDC_RGADW_RGADDR_MASK		GENMASK(14, 8)
#define	ICDC_RGADW_RGDIN_MASK		GENMASK(7, 0)

/* ICDC internal register data output register (RGDATA)*/
#define ICDC_RGDATA_IRQ			BIT(8)
#define ICDC_RGDATA_RGDOUT_MASK		GENMASK(7, 0)

/* Internal register space, accessed through regmap */
enum {
	JZ4760_CODEC_REG_SR,
	JZ4760_CODEC_REG_AICR,
	JZ4760_CODEC_REG_CR1,
	JZ4760_CODEC_REG_CR2,
	JZ4760_CODEC_REG_CR3,
	JZ4760_CODEC_REG_CR4,
	JZ4760_CODEC_REG_CCR1,
	JZ4760_CODEC_REG_CCR2,
	JZ4760_CODEC_REG_PMR1,
	JZ4760_CODEC_REG_PMR2,
	JZ4760_CODEC_REG_ICR,
	JZ4760_CODEC_REG_IFR,
	JZ4760_CODEC_REG_GCR1,
	JZ4760_CODEC_REG_GCR2,
	JZ4760_CODEC_REG_GCR3,
	JZ4760_CODEC_REG_GCR4,
	JZ4760_CODEC_REG_GCR5,
	JZ4760_CODEC_REG_GCR6,
	JZ4760_CODEC_REG_GCR7,
	JZ4760_CODEC_REG_GCR8,
	JZ4760_CODEC_REG_GCR9,
	JZ4760_CODEC_REG_AGC1,
	JZ4760_CODEC_REG_AGC2,
	JZ4760_CODEC_REG_AGC3,
	JZ4760_CODEC_REG_AGC4,
	JZ4760_CODEC_REG_AGC5,
	JZ4760_CODEC_REG_MIX1,
	JZ4760_CODEC_REG_MIX2,
};

#define REG_AICR_DAC_ADWL_MASK		GENMASK(7, 6)
#define REG_AICR_DAC_SERIAL		BIT(3)
#define REG_AICR_DAC_I2S		BIT(1)

#define REG_AICR_ADC_ADWL_MASK		GENMASK(5, 4)

#define REG_AICR_ADC_SERIAL		BIT(2)
#define REG_AICR_ADC_I2S		BIT(0)

#define REG_CR1_HP_LOAD			BIT(7)
#define REG_CR1_HP_MUTE			BIT(5)
#define REG_CR1_LO_MUTE_OFFSET		4
#define REG_CR1_BTL_MUTE_OFFSET		3
#define REG_CR1_OUTSEL_OFFSET		0
#define REG_CR1_OUTSEL_MASK		GENMASK(1, REG_CR1_OUTSEL_OFFSET)

#define REG_CR2_DAC_MONO		BIT(7)
#define REG_CR2_DAC_MUTE		BIT(5)
#define REG_CR2_DAC_NOMAD		BIT(1)
#define REG_CR2_DAC_RIGHT_ONLY		BIT(0)

#define REG_CR3_ADC_INSEL_OFFSET	2
#define REG_CR3_ADC_INSEL_MASK		GENMASK(3, REG_CR3_ADC_INSEL_OFFSET)
#define REG_CR3_MICSTEREO_OFFSET	1
#define REG_CR3_MICDIFF_OFFSET		0

#define REG_CR4_ADC_HPF_OFFSET		7
#define REG_CR4_ADC_RIGHT_ONLY		BIT(0)

#define REG_CCR1_CRYSTAL_MASK		GENMASK(3, 0)

#define REG_CCR2_DAC_FREQ_MASK		GENMASK(7, 4)
#define REG_CCR2_ADC_FREQ_MASK		GENMASK(3, 0)

#define REG_PMR1_SB			BIT(7)
#define REG_PMR1_SB_SLEEP		BIT(6)
#define REG_PMR1_SB_AIP_OFFSET		5
#define REG_PMR1_SB_LINE_OFFSET		4
#define REG_PMR1_SB_MIC1_OFFSET		3
#define REG_PMR1_SB_MIC2_OFFSET		2
#define REG_PMR1_SB_BYPASS_OFFSET	1
#define REG_PMR1_SB_MICBIAS_OFFSET	0

#define REG_PMR2_SB_ADC_OFFSET		4
#define REG_PMR2_SB_HP_OFFSET		3
#define REG_PMR2_SB_BTL_OFFSET		2
#define REG_PMR2_SB_LOUT_OFFSET		1
#define REG_PMR2_SB_DAC_OFFSET		0

#define REG_ICR_INT_FORM_MASK		GENMASK(7, 6)
#define REG_ICR_ALL_MASK		GENMASK(5, 0)
#define REG_ICR_JACK_MASK		BIT(5)
#define REG_ICR_SCMC_MASK		BIT(4)
#define REG_ICR_RUP_MASK		BIT(3)
#define REG_ICR_RDO_MASK		BIT(2)
#define REG_ICR_GUP_MASK		BIT(1)
#define REG_ICR_GDO_MASK		BIT(0)

#define REG_IFR_ALL_MASK		GENMASK(5, 0)
#define REG_IFR_JACK			BIT(6)
#define REG_IFR_JACK_EVENT		BIT(5)
#define REG_IFR_SCMC			BIT(4)
#define REG_IFR_RUP			BIT(3)
#define REG_IFR_RDO			BIT(2)
#define REG_IFR_GUP			BIT(1)
#define REG_IFR_GDO			BIT(0)

#define REG_GCR_GAIN_OFFSET		0
#define REG_GCR_GAIN_MAX		0x1f

#define REG_GCR_RL			BIT(7)

#define REG_GCR_GIM1_MASK		GENMASK(5, 3)
#define REG_GCR_GIM2_MASK		GENMASK(2, 0)
#define REG_GCR_GIM_GAIN_MAX		7

#define REG_AGC1_EN			BIT(7)
#define REG_AGC1_TARGET_MASK		GENMASK(5, 2)

#define REG_AGC2_NG_THR_MASK		GENMASK(6, 4)
#define REG_AGC2_HOLD_MASK		GENMASK(3, 0)

#define REG_AGC3_ATK_MASK		GENMASK(7, 4)
#define REG_AGC3_DCY_MASK		GENMASK(3, 0)

#define REG_AGC4_AGC_MAX_MASK		GENMASK(4, 0)

#define REG_AGC5_AGC_MIN_MASK		GENMASK(4, 0)

#define REG_MIX1_MIX_REC_MASK		GENMASK(7, 6)
#define REG_MIX1_GIMIX_MASK		GENMASK(4, 0)

#define REG_MIX2_DAC_MIX_MASK		GENMASK(7, 6)
#define REG_MIX2_GOMIX_MASK		GENMASK(4, 0)

/* codec private data */
struct jz_codec {
	struct device *dev;
	struct regmap *regmap;
	void __iomem *base;
	struct clk *clk;
};

static int jz4760_codec_set_bias_level(struct snd_soc_component *codec,
				       enum snd_soc_bias_level level)
{
	struct jz_codec *jz_codec = snd_soc_component_get_drvdata(codec);
	struct regmap *regmap = jz_codec->regmap;

	switch (level) {
	case SND_SOC_BIAS_PREPARE:
		/* Reset all interrupt flags. */
		regmap_write(regmap, JZ4760_CODEC_REG_IFR, REG_IFR_ALL_MASK);

		regmap_clear_bits(regmap, JZ4760_CODEC_REG_PMR1, REG_PMR1_SB);
		msleep(250);
		regmap_clear_bits(regmap, JZ4760_CODEC_REG_PMR1, REG_PMR1_SB_SLEEP);
		msleep(400);
		break;
	case SND_SOC_BIAS_STANDBY:
		regmap_set_bits(regmap, JZ4760_CODEC_REG_PMR1, REG_PMR1_SB_SLEEP);
		regmap_set_bits(regmap, JZ4760_CODEC_REG_PMR1, REG_PMR1_SB);
		break;
	default:
		break;
	}

	return 0;
}

static int jz4760_codec_startup(struct snd_pcm_substream *substream,
				struct snd_soc_dai *dai)
{
	struct snd_soc_component *codec = dai->component;
	struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(codec);
	int ret = 0;

	/*
	 * SYSCLK output from the codec to the AIC is required to keep the
	 * DMA transfer going during playback when all audible outputs have
	 * been disabled.
	 */
	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
		ret = snd_soc_dapm_force_enable_pin(dapm, "SYSCLK");
	return ret;
}

static void jz4760_codec_shutdown(struct snd_pcm_substream *substream,
				  struct snd_soc_dai *dai)
{
	struct snd_soc_component *codec = dai->component;
	struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(codec);

	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
		snd_soc_dapm_disable_pin(dapm, "SYSCLK");
}


static int jz4760_codec_pcm_trigger(struct snd_pcm_substream *substream,
				    int cmd, struct snd_soc_dai *dai)
{
	struct snd_soc_component *codec = dai->component;
	int ret = 0;

	switch (cmd) {
	case SNDRV_PCM_TRIGGER_START:
	case SNDRV_PCM_TRIGGER_RESUME:
	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
		if (substream->stream != SNDRV_PCM_STREAM_PLAYBACK)
			snd_soc_component_force_bias_level(codec, SND_SOC_BIAS_ON);
		break;
	case SNDRV_PCM_TRIGGER_STOP:
	case SNDRV_PCM_TRIGGER_SUSPEND:
	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
		/* do nothing */
		break;
	default:
		ret = -EINVAL;
	}

	return ret;
}

static int jz4760_codec_mute_stream(struct snd_soc_dai *dai, int mute, int direction)
{
	struct snd_soc_component *codec = dai->component;
	struct jz_codec *jz_codec = snd_soc_component_get_drvdata(codec);
	unsigned int gain_bit = mute ? REG_IFR_GDO : REG_IFR_GUP;
	unsigned int val, reg;
	int change, err;

	change = snd_soc_component_update_bits(codec, JZ4760_CODEC_REG_CR2,
					       REG_CR2_DAC_MUTE,
					       mute ? REG_CR2_DAC_MUTE : 0);
	if (change == 1) {
		regmap_read(jz_codec->regmap, JZ4760_CODEC_REG_PMR2, &val);

		if (val & BIT(REG_PMR2_SB_DAC_OFFSET))
			return 1;

		err = regmap_read_poll_timeout(jz_codec->regmap,
					       JZ4760_CODEC_REG_IFR,
					       val, val & gain_bit,
					       1000, 1 * USEC_PER_SEC);
		if (err) {
			dev_err(jz_codec->dev,
				"Timeout while setting digital mute: %d", err);
			return err;
		}

		/* clear GUP/GDO flag */
		regmap_write(jz_codec->regmap, JZ4760_CODEC_REG_IFR, gain_bit);
	}

	regmap_read(jz_codec->regmap, JZ4760_CODEC_REG_CR2, &reg);

	return 0;
}

/* unit: 0.01dB */
static const DECLARE_TLV_DB_MINMAX_MUTE(dac_tlv, -3100, 100);
static const DECLARE_TLV_DB_SCALE(adc_tlv, 0, 100, 0);
static const DECLARE_TLV_DB_MINMAX(out_tlv, -2500, 100);
static const DECLARE_TLV_DB_SCALE(linein_tlv, -2500, 100, 0);

/* Unconditional controls. */
static const struct snd_kcontrol_new jz4760_codec_snd_controls[] = {
	/* record gain control */
	SOC_DOUBLE_R_TLV("PCM Capture Volume",
			 JZ4760_CODEC_REG_GCR9, JZ4760_CODEC_REG_GCR8,
			 REG_GCR_GAIN_OFFSET, REG_GCR_GAIN_MAX, 0, adc_tlv),

	SOC_DOUBLE_R_TLV("Line In Bypass Playback Volume",
			 JZ4760_CODEC_REG_GCR4, JZ4760_CODEC_REG_GCR3,
			 REG_GCR_GAIN_OFFSET, REG_GCR_GAIN_MAX, 1, linein_tlv),

	SOC_SINGLE("High-Pass Filter Capture Switch",
		   JZ4760_CODEC_REG_CR4,
		   REG_CR4_ADC_HPF_OFFSET, 1, 0),
};

static const struct snd_kcontrol_new jz4760_codec_pcm_playback_controls[] = {
	{
		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
		.name = "Volume",
		.info = snd_soc_info_volsw,
		.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ
			| SNDRV_CTL_ELEM_ACCESS_READWRITE,
		.tlv.p = dac_tlv,
		.get = snd_soc_dapm_get_volsw,
		.put = snd_soc_dapm_put_volsw,
		.private_value = SOC_DOUBLE_R_VALUE(JZ4760_CODEC_REG_GCR6,
						    JZ4760_CODEC_REG_GCR5,
						    REG_GCR_GAIN_OFFSET,
						    REG_GCR_GAIN_MAX, 1),
	},
};

static const struct snd_kcontrol_new jz4760_codec_hp_playback_controls[] = {
	{
		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
		.name = "Volume",
		.info = snd_soc_info_volsw,
		.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ
			| SNDRV_CTL_ELEM_ACCESS_READWRITE,
		.tlv.p = out_tlv,
		.get = snd_soc_dapm_get_volsw,
		.put = snd_soc_dapm_put_volsw,
		.private_value = SOC_DOUBLE_R_VALUE(JZ4760_CODEC_REG_GCR2,
						    JZ4760_CODEC_REG_GCR1,
						    REG_GCR_GAIN_OFFSET,
						    REG_GCR_GAIN_MAX, 1),
	},
};

static int hpout_event(struct snd_soc_dapm_widget *w,
		       struct snd_kcontrol *kcontrol, int event)
{
	struct snd_soc_component *codec = snd_soc_dapm_to_component(w->dapm);
	struct jz_codec *jz_codec = snd_soc_component_get_drvdata(codec);
	unsigned int val;
	int err;

	switch (event) {
	case SND_SOC_DAPM_PRE_PMU:
		/* unmute HP */
		regmap_clear_bits(jz_codec->regmap, JZ4760_CODEC_REG_CR1,
				  REG_CR1_HP_MUTE);
		break;

	case SND_SOC_DAPM_POST_PMU:
		/* wait for ramp-up complete (RUP) */
		err = regmap_read_poll_timeout(jz_codec->regmap,
					       JZ4760_CODEC_REG_IFR,
					       val, val & REG_IFR_RUP,
					       1000, 1 * USEC_PER_SEC);
		if (err) {
			dev_err(jz_codec->dev, "RUP timeout: %d", err);
			return err;
		}

		/* clear RUP flag */
		regmap_set_bits(jz_codec->regmap, JZ4760_CODEC_REG_IFR,
				REG_IFR_RUP);

		break;

	case SND_SOC_DAPM_POST_PMD:
		/* mute HP */
		regmap_set_bits(jz_codec->regmap, JZ4760_CODEC_REG_CR1,
				REG_CR1_HP_MUTE);

		err = regmap_read_poll_timeout(jz_codec->regmap,
					       JZ4760_CODEC_REG_IFR,
					       val, val & REG_IFR_RDO,
					       1000, 1 * USEC_PER_SEC);
		if (err) {
			dev_err(jz_codec->dev, "RDO timeout: %d", err);
			return err;
		}

		/* clear RDO flag */
		regmap_set_bits(jz_codec->regmap, JZ4760_CODEC_REG_IFR,
				REG_IFR_RDO);

		break;
	}

	return 0;
}

static const char * const jz4760_codec_hp_texts[] = {
	"PCM", "Line In", "Mic 1", "Mic 2"
};

static const unsigned int jz4760_codec_hp_values[] = { 3, 2, 0, 1 };

static SOC_VALUE_ENUM_SINGLE_DECL(jz4760_codec_hp_enum,
				  JZ4760_CODEC_REG_CR1,
				  REG_CR1_OUTSEL_OFFSET,
				  REG_CR1_OUTSEL_MASK >> REG_CR1_OUTSEL_OFFSET,
				  jz4760_codec_hp_texts,
				  jz4760_codec_hp_values);
static const struct snd_kcontrol_new jz4760_codec_hp_source =
			SOC_DAPM_ENUM("Route", jz4760_codec_hp_enum);

static const char * const jz4760_codec_cap_texts[] = {
	"Line In", "Mic 1", "Mic 2"
};

static const unsigned int jz4760_codec_cap_values[] = { 2, 0, 1 };

static SOC_VALUE_ENUM_SINGLE_DECL(jz4760_codec_cap_enum,
				  JZ4760_CODEC_REG_CR3,
				  REG_CR3_ADC_INSEL_OFFSET,
				  REG_CR3_ADC_INSEL_MASK >> REG_CR3_ADC_INSEL_OFFSET,
				  jz4760_codec_cap_texts,
				  jz4760_codec_cap_values);
static const struct snd_kcontrol_new jz4760_codec_cap_source =
			SOC_DAPM_ENUM("Route", jz4760_codec_cap_enum);

static const struct snd_kcontrol_new jz4760_codec_mic_controls[] = {
	SOC_DAPM_SINGLE("Stereo Capture Switch", JZ4760_CODEC_REG_CR3,
			REG_CR3_MICSTEREO_OFFSET, 1, 0),
};

static const struct snd_kcontrol_new jz4760_codec_line_out_switch =
	SOC_DAPM_SINGLE("Switch", JZ4760_CODEC_REG_CR1,
			REG_CR1_LO_MUTE_OFFSET, 0, 0);
static const struct snd_kcontrol_new jz4760_codec_btl_out_switch =
	SOC_DAPM_SINGLE("Switch", JZ4760_CODEC_REG_CR1,
			REG_CR1_BTL_MUTE_OFFSET, 0, 0);

static const struct snd_soc_dapm_widget jz4760_codec_dapm_widgets[] = {
	SND_SOC_DAPM_PGA_E("HP Out", JZ4760_CODEC_REG_PMR2,
			   REG_PMR2_SB_HP_OFFSET, 1, NULL, 0, hpout_event,
			   SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU |
			   SND_SOC_DAPM_POST_PMD),

	SND_SOC_DAPM_SWITCH("Line Out", JZ4760_CODEC_REG_PMR2,
			    REG_PMR2_SB_LOUT_OFFSET, 1,
			    &jz4760_codec_line_out_switch),

	SND_SOC_DAPM_SWITCH("BTL Out", JZ4760_CODEC_REG_PMR2,
			    REG_PMR2_SB_BTL_OFFSET, 1,
			    &jz4760_codec_btl_out_switch),

	SND_SOC_DAPM_PGA("Line In", JZ4760_CODEC_REG_PMR1,
			 REG_PMR1_SB_LINE_OFFSET, 1, NULL, 0),

	SND_SOC_DAPM_MUX("Headphones Source", SND_SOC_NOPM, 0, 0,
			 &jz4760_codec_hp_source),

	SND_SOC_DAPM_MUX("Capture Source", SND_SOC_NOPM, 0, 0,
			 &jz4760_codec_cap_source),

	SND_SOC_DAPM_PGA("Mic 1", JZ4760_CODEC_REG_PMR1,
			 REG_PMR1_SB_MIC1_OFFSET, 1, NULL, 0),

	SND_SOC_DAPM_PGA("Mic 2", JZ4760_CODEC_REG_PMR1,
			 REG_PMR1_SB_MIC2_OFFSET, 1, NULL, 0),

	SND_SOC_DAPM_PGA("Mic Diff", JZ4760_CODEC_REG_CR3,
			 REG_CR3_MICDIFF_OFFSET, 0, NULL, 0),

	SND_SOC_DAPM_MIXER("Mic", SND_SOC_NOPM, 0, 0,
			   jz4760_codec_mic_controls,
			   ARRAY_SIZE(jz4760_codec_mic_controls)),

	SND_SOC_DAPM_PGA("Line In Bypass", JZ4760_CODEC_REG_PMR1,
			 REG_PMR1_SB_BYPASS_OFFSET, 1, NULL, 0),

	SND_SOC_DAPM_ADC("ADC", "Capture", JZ4760_CODEC_REG_PMR2,
			 REG_PMR2_SB_ADC_OFFSET, 1),

	SND_SOC_DAPM_DAC("DAC", "Playback", JZ4760_CODEC_REG_PMR2,
			 REG_PMR2_SB_DAC_OFFSET, 1),

	SND_SOC_DAPM_MIXER("PCM Playback", SND_SOC_NOPM, 0, 0,
			   jz4760_codec_pcm_playback_controls,
			   ARRAY_SIZE(jz4760_codec_pcm_playback_controls)),

	SND_SOC_DAPM_MIXER("Headphones Playback", SND_SOC_NOPM, 0, 0,
			   jz4760_codec_hp_playback_controls,
			   ARRAY_SIZE(jz4760_codec_hp_playback_controls)),

	SND_SOC_DAPM_SUPPLY("MICBIAS", JZ4760_CODEC_REG_PMR1,
			    REG_PMR1_SB_MICBIAS_OFFSET, 1, NULL, 0),

	SND_SOC_DAPM_INPUT("MIC1P"),
	SND_SOC_DAPM_INPUT("MIC1N"),
	SND_SOC_DAPM_INPUT("MIC2P"),
	SND_SOC_DAPM_INPUT("MIC2N"),

	SND_SOC_DAPM_INPUT("LLINEIN"),
	SND_SOC_DAPM_INPUT("RLINEIN"),

	SND_SOC_DAPM_OUTPUT("LHPOUT"),
	SND_SOC_DAPM_OUTPUT("RHPOUT"),

	SND_SOC_DAPM_OUTPUT("LOUT"),
	SND_SOC_DAPM_OUTPUT("ROUT"),

	SND_SOC_DAPM_OUTPUT("BTLP"),
	SND_SOC_DAPM_OUTPUT("BTLN"),

	SND_SOC_DAPM_OUTPUT("SYSCLK"),
};

/* Unconditional routes. */
static const struct snd_soc_dapm_route jz4760_codec_dapm_routes[] = {
	{ "Mic 1", NULL, "MIC1P" },
	{ "Mic Diff", NULL, "MIC1N" },
	{ "Mic 1", NULL, "Mic Diff" },
	{ "Mic 2", NULL, "MIC2P" },
	{ "Mic Diff", NULL, "MIC2N" },
	{ "Mic 2", NULL, "Mic Diff" },

	{ "Line In", NULL, "LLINEIN" },
	{ "Line In", NULL, "RLINEIN" },

	{ "Mic", "Stereo Capture Switch", "Mic 1" },
	{ "Mic", "Stereo Capture Switch", "Mic 2" },
	{ "Headphones Source", "Mic 1", "Mic" },
	{ "Headphones Source", "Mic 2", "Mic" },
	{ "Capture Source", "Mic 1", "Mic" },
	{ "Capture Source", "Mic 2", "Mic" },

	{ "Capture Source", "Line In", "Line In" },
	{ "Capture Source", "Mic 1", "Mic 1" },
	{ "Capture Source", "Mic 2", "Mic 2" },
	{ "ADC", NULL, "Capture Source" },

	{ "Line In Bypass", NULL, "Line In" },

	{ "Headphones Source", "Mic 1", "Mic 1" },
	{ "Headphones Source", "Mic 2", "Mic 2" },
	{ "Headphones Source", "Line In", "Line In Bypass" },
	{ "Headphones Source", "PCM", "Headphones Playback" },
	{ "HP Out", NULL, "Headphones Source" },

	{ "LHPOUT", NULL, "HP Out" },
	{ "RHPOUT", NULL, "HP Out" },
	{ "Line Out", "Switch", "HP Out" },

	{ "LOUT", NULL, "Line Out" },
	{ "ROUT", NULL, "Line Out" },
	{ "BTL Out", "Switch", "Line Out" },

	{ "BTLP", NULL, "BTL Out"},
	{ "BTLN", NULL, "BTL Out"},

	{ "PCM Playback", "Volume", "DAC" },
	{ "Headphones Playback", "Volume", "PCM Playback" },

	{ "SYSCLK", NULL, "DAC" },
};

static void jz4760_codec_codec_init_regs(struct snd_soc_component *codec)
{
	struct jz_codec *jz_codec = snd_soc_component_get_drvdata(codec);
	struct regmap *regmap = jz_codec->regmap;

	/* Collect updates for later sending. */
	regcache_cache_only(regmap, true);

	/* default Amp output to PCM */
	regmap_set_bits(regmap, JZ4760_CODEC_REG_CR1, REG_CR1_OUTSEL_MASK);

	/* Disable stereo mic */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_CR3,
			  BIT(REG_CR3_MICSTEREO_OFFSET));

	/* Set mic 1 as default source for ADC */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_CR3,
			  REG_CR3_ADC_INSEL_MASK);

	/* ADC/DAC: serial + i2s */
	regmap_set_bits(regmap, JZ4760_CODEC_REG_AICR,
			REG_AICR_ADC_SERIAL | REG_AICR_ADC_I2S |
			REG_AICR_DAC_SERIAL | REG_AICR_DAC_I2S);

	/* The generated IRQ is a high level */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_ICR, REG_ICR_INT_FORM_MASK);
	regmap_update_bits(regmap, JZ4760_CODEC_REG_ICR, REG_ICR_ALL_MASK,
			   REG_ICR_JACK_MASK | REG_ICR_RUP_MASK |
			   REG_ICR_RDO_MASK  | REG_ICR_GUP_MASK |
			   REG_ICR_GDO_MASK);

	/* 12M oscillator */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_CCR1, REG_CCR1_CRYSTAL_MASK);

	/* 0: 16ohm/220uF, 1: 10kohm/1uF */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_CR1, REG_CR1_HP_LOAD);

	/* default to NOMAD */
	regmap_set_bits(jz_codec->regmap, JZ4760_CODEC_REG_CR2,
			REG_CR2_DAC_NOMAD);

	/* disable automatic gain */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_AGC1, REG_AGC1_EN);

	/* Independent L/R DAC gain control */
	regmap_clear_bits(regmap, JZ4760_CODEC_REG_GCR5,
			  REG_GCR_RL);

	/* Send collected updates. */
	regcache_cache_only(regmap, false);
	regcache_sync(regmap);
}

static int jz4760_codec_codec_probe(struct snd_soc_component *codec)
{
	struct jz_codec *jz_codec = snd_soc_component_get_drvdata(codec);

	clk_prepare_enable(jz_codec->clk);

	jz4760_codec_codec_init_regs(codec);

	return 0;
}

static void jz4760_codec_codec_remove(struct snd_soc_component *codec)
{
	struct jz_codec *jz_codec = snd_soc_component_get_drvdata(codec);

	clk_disable_unprepare(jz_codec->clk);
}

static const struct snd_soc_component_driver jz4760_codec_soc_codec_dev = {
	.probe			= jz4760_codec_codec_probe,
	.remove			= jz4760_codec_codec_remove,
	.set_bias_level		= jz4760_codec_set_bias_level,
	.controls		= jz4760_codec_snd_controls,
	.num_controls		= ARRAY_SIZE(jz4760_codec_snd_controls),
	.dapm_widgets		= jz4760_codec_dapm_widgets,
	.num_dapm_widgets	= ARRAY_SIZE(jz4760_codec_dapm_widgets),
	.dapm_routes		= jz4760_codec_dapm_routes,
	.num_dapm_routes	= ARRAY_SIZE(jz4760_codec_dapm_routes),
	.suspend_bias_off	= 1,
	.use_pmdown_time	= 1,
};

static const unsigned int jz4760_codec_sample_rates[] = {
	96000, 48000, 44100, 32000,
	24000, 22050, 16000, 12000,
	11025, 9600, 8000,
};

static int jz4760_codec_hw_params(struct snd_pcm_substream *substream,
				  struct snd_pcm_hw_params *params,
				  struct snd_soc_dai *dai)
{
	struct jz_codec *codec = snd_soc_component_get_drvdata(dai->component);
	unsigned int rate, bit_width;

	switch (params_format(params)) {
	case SNDRV_PCM_FORMAT_S16_LE:
		bit_width = 0;
		break;
	case SNDRV_PCM_FORMAT_S18_3LE:
		bit_width = 1;
		break;
	case SNDRV_PCM_FORMAT_S20_3LE:
		bit_width = 2;
		break;
	case SNDRV_PCM_FORMAT_S24_3LE:
		bit_width = 3;
		break;
	default:
		return -EINVAL;
	}

	for (rate = 0; rate < ARRAY_SIZE(jz4760_codec_sample_rates); rate++) {
		if (jz4760_codec_sample_rates[rate] == params_rate(params))
			break;
	}

	if (rate == ARRAY_SIZE(jz4760_codec_sample_rates))
		return -EINVAL;

	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
		regmap_update_bits(codec->regmap, JZ4760_CODEC_REG_AICR,
				   REG_AICR_DAC_ADWL_MASK,
				   FIELD_PREP(REG_AICR_DAC_ADWL_MASK, bit_width));
		regmap_update_bits(codec->regmap, JZ4760_CODEC_REG_CCR2,
				   REG_CCR2_DAC_FREQ_MASK,
				   FIELD_PREP(REG_CCR2_DAC_FREQ_MASK, rate));
	} else {
		regmap_update_bits(codec->regmap, JZ4760_CODEC_REG_AICR,
				   REG_AICR_ADC_ADWL_MASK,
				   FIELD_PREP(REG_AICR_ADC_ADWL_MASK, bit_width));
		regmap_update_bits(codec->regmap, JZ4760_CODEC_REG_CCR2,
				   REG_CCR2_ADC_FREQ_MASK,
				   FIELD_PREP(REG_CCR2_ADC_FREQ_MASK, rate));
	}

	return 0;
}

static const struct snd_soc_dai_ops jz4760_codec_dai_ops = {
	.startup	= jz4760_codec_startup,
	.shutdown	= jz4760_codec_shutdown,
	.hw_params	= jz4760_codec_hw_params,
	.trigger	= jz4760_codec_pcm_trigger,
	.mute_stream	= jz4760_codec_mute_stream,
	.no_capture_mute = 1,
};

#define JZ_CODEC_FORMATS (SNDRV_PCM_FMTBIT_S16_LE  | \
			  SNDRV_PCM_FMTBIT_S18_3LE | \
			  SNDRV_PCM_FMTBIT_S20_3LE | \
			  SNDRV_PCM_FMTBIT_S24_3LE)

static struct snd_soc_dai_driver jz4760_codec_dai = {
	.name = "jz4760-hifi",
	.playback = {
		.stream_name = "Playback",
		.channels_min = 2,
		.channels_max = 2,
		.rates = SNDRV_PCM_RATE_8000_96000,
		.formats = JZ_CODEC_FORMATS,
	},
	.capture = {
		.stream_name = "Capture",
		.channels_min = 2,
		.channels_max = 2,
		.rates = SNDRV_PCM_RATE_8000_96000,
		.formats = JZ_CODEC_FORMATS,
	},
	.ops = &jz4760_codec_dai_ops,
};

static bool jz4760_codec_volatile(struct device *dev, unsigned int reg)
{
	return reg == JZ4760_CODEC_REG_SR || reg == JZ4760_CODEC_REG_IFR;
}

static bool jz4760_codec_writeable(struct device *dev, unsigned int reg)
{
	switch (reg) {
	case JZ4760_CODEC_REG_SR:
		return false;
	default:
		return true;
	}
}

static int jz4760_codec_io_wait(struct jz_codec *codec)
{
	u32 reg;

	return readl_poll_timeout(codec->base + ICDC_RGADW_OFFSET, reg,
				  !(reg & ICDC_RGADW_RGWR),
				  1000, 1 * USEC_PER_SEC);
}

static int jz4760_codec_reg_read(void *context, unsigned int reg,
				 unsigned int *val)
{
	struct jz_codec *codec = context;
	unsigned int i;
	u32 tmp;
	int ret;

	ret = jz4760_codec_io_wait(codec);
	if (ret)
		return ret;

	tmp = readl(codec->base + ICDC_RGADW_OFFSET);
	tmp &= ~ICDC_RGADW_RGADDR_MASK;
	tmp |= FIELD_PREP(ICDC_RGADW_RGADDR_MASK, reg);
	writel(tmp, codec->base + ICDC_RGADW_OFFSET);

	/* wait 6+ cycles */
	for (i = 0; i < 6; i++)
		*val = readl(codec->base + ICDC_RGDATA_OFFSET) &
			ICDC_RGDATA_RGDOUT_MASK;

	return 0;
}

static int jz4760_codec_reg_write(void *context, unsigned int reg,
				  unsigned int val)
{
	struct jz_codec *codec = context;
	int ret;

	ret = jz4760_codec_io_wait(codec);
	if (ret)
		return ret;

	writel(ICDC_RGADW_RGWR | FIELD_PREP(ICDC_RGADW_RGADDR_MASK, reg) | val,
	       codec->base + ICDC_RGADW_OFFSET);

	ret = jz4760_codec_io_wait(codec);
	if (ret)
		return ret;

	return 0;
}

static const u8 jz4760_codec_reg_defaults[] = {
	0x00, 0xFC, 0x1B, 0x20, 0x00, 0x80, 0x00, 0x00,
	0xFF, 0x1F, 0x3F, 0x00, 0x06, 0x06, 0x06, 0x06,
	0x00, 0x00, 0x00, 0x00, 0x00, 0x34, 0x07, 0x44,
	0x1F, 0x00, 0x00, 0x00
};

static struct regmap_config jz4760_codec_regmap_config = {
	.reg_bits = 7,
	.val_bits = 8,

	.max_register = JZ4760_CODEC_REG_MIX2,
	.volatile_reg = jz4760_codec_volatile,
	.writeable_reg = jz4760_codec_writeable,

	.reg_read = jz4760_codec_reg_read,
	.reg_write = jz4760_codec_reg_write,

	.reg_defaults_raw = jz4760_codec_reg_defaults,
	.num_reg_defaults_raw = ARRAY_SIZE(jz4760_codec_reg_defaults),
	.cache_type = REGCACHE_FLAT,
};

static int jz4760_codec_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct jz_codec *codec;
	int ret;

	codec = devm_kzalloc(dev, sizeof(*codec), GFP_KERNEL);
	if (!codec)
		return -ENOMEM;

	codec->dev = dev;

	codec->base = devm_platform_ioremap_resource(pdev, 0);
	if (IS_ERR(codec->base))
		return PTR_ERR(codec->base);

	codec->regmap = devm_regmap_init(dev, NULL, codec,
					&jz4760_codec_regmap_config);
	if (IS_ERR(codec->regmap))
		return PTR_ERR(codec->regmap);

	codec->clk = devm_clk_get(dev, "aic");
	if (IS_ERR(codec->clk))
		return PTR_ERR(codec->clk);

	platform_set_drvdata(pdev, codec);

	ret = devm_snd_soc_register_component(dev, &jz4760_codec_soc_codec_dev,
					      &jz4760_codec_dai, 1);
	if (ret) {
		dev_err(dev, "Failed to register codec: %d\n", ret);
		return ret;
	}

	return 0;
}

static const struct of_device_id jz4760_codec_of_matches[] = {
	{ .compatible = "ingenic,jz4760-codec", },
	{ /* sentinel */ }
};
MODULE_DEVICE_TABLE(of, jz4760_codec_of_matches);

static struct platform_driver jz4760_codec_driver = {
	.probe			= jz4760_codec_probe,
	.driver			= {
		.name		= "jz4760-codec",
		.of_match_table = jz4760_codec_of_matches,
	},
};
module_platform_driver(jz4760_codec_driver);

MODULE_DESCRIPTION("JZ4760 SoC internal codec driver");
MODULE_AUTHOR("Christophe Branchereau <cbranchereau@gmail.com>");
MODULE_AUTHOR("Paul Cercueil <paul@crapouillou.net>");
MODULE_LICENSE("GPL v2");