[deliverable/linux.git] / sound / soc / codecs / wm8523.c

/*
 * wm8523.c  --  WM8523 ALSA SoC Audio driver
 *
 * Copyright 2009 Wolfson Microelectronics plc
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/pm.h>
#include <linux/i2c.h>
#include <linux/regmap.h>
#include <linux/regulator/consumer.h>
#include <linux/slab.h>
#include <linux/of_device.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/initval.h>
#include <sound/tlv.h>

#include "wm8523.h"

#define WM8523_NUM_SUPPLIES 2
static const char *wm8523_supply_names[WM8523_NUM_SUPPLIES] = {
	"AVDD",
	"LINEVDD",
};

#define WM8523_NUM_RATES 7

/* codec private data */
struct wm8523_priv {
	struct regmap *regmap;
	struct regulator_bulk_data supplies[WM8523_NUM_SUPPLIES];
	unsigned int sysclk;
	unsigned int rate_constraint_list[WM8523_NUM_RATES];
	struct snd_pcm_hw_constraint_list rate_constraint;
};

static const struct reg_default wm8523_reg_defaults[] = {
	{ 2, 0x0000 },     /* R2 - PSCTRL1 */
	{ 3, 0x1812 },     /* R3 - AIF_CTRL1 */
	{ 4, 0x0000 },     /* R4 - AIF_CTRL2 */
	{ 5, 0x0001 },     /* R5 - DAC_CTRL3 */
	{ 6, 0x0190 },     /* R6 - DAC_GAINL */
	{ 7, 0x0190 },     /* R7 - DAC_GAINR */
	{ 8, 0x0000 },     /* R8 - ZERO_DETECT */
};

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

static const DECLARE_TLV_DB_SCALE(dac_tlv, -10000, 25, 0);

static const char *wm8523_zd_count_text[] = {
	"1024",
	"2048",
};

static SOC_ENUM_SINGLE_DECL(wm8523_zc_count, WM8523_ZERO_DETECT, 0,
			    wm8523_zd_count_text);

static const struct snd_kcontrol_new wm8523_controls[] = {
SOC_DOUBLE_R_TLV("Playback Volume", WM8523_DAC_GAINL, WM8523_DAC_GAINR,
		 0, 448, 0, dac_tlv),
SOC_SINGLE("ZC Switch", WM8523_DAC_CTRL3, 4, 1, 0),
SOC_SINGLE("Playback Deemphasis Switch", WM8523_AIF_CTRL1, 8, 1, 0),
SOC_DOUBLE("Playback Switch", WM8523_DAC_CTRL3, 2, 3, 1, 1),
SOC_SINGLE("Volume Ramp Up Switch", WM8523_DAC_CTRL3, 1, 1, 0),
SOC_SINGLE("Volume Ramp Down Switch", WM8523_DAC_CTRL3, 0, 1, 0),
SOC_ENUM("Zero Detect Count", wm8523_zc_count),
};

static const struct snd_soc_dapm_widget wm8523_dapm_widgets[] = {
SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
SND_SOC_DAPM_OUTPUT("LINEVOUTL"),
SND_SOC_DAPM_OUTPUT("LINEVOUTR"),
};

static const struct snd_soc_dapm_route wm8523_dapm_routes[] = {
	{ "LINEVOUTL", NULL, "DAC" },
	{ "LINEVOUTR", NULL, "DAC" },
};

static struct {
	int value;
	int ratio;
} lrclk_ratios[WM8523_NUM_RATES] = {
	{ 1, 128 },
	{ 2, 192 },
	{ 3, 256 },
	{ 4, 384 },
	{ 5, 512 },
	{ 6, 768 },
	{ 7, 1152 },
};

static struct {
	int value;
	int ratio;
} bclk_ratios[WM8523_NUM_RATES] = {
	{ 2, 32 },
	{ 3, 64 },
	{ 4, 128 },
};

static int wm8523_startup(struct snd_pcm_substream *substream,
			  struct snd_soc_dai *dai)
{
	struct snd_soc_codec *codec = dai->codec;
	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);

	/* The set of sample rates that can be supported depends on the
	 * MCLK supplied to the CODEC - enforce this.
	 */
	if (!wm8523->sysclk) {
		dev_err(codec->dev,
			"No MCLK configured, call set_sysclk() on init\n");
		return -EINVAL;
	}

	snd_pcm_hw_constraint_list(substream->runtime, 0,
				   SNDRV_PCM_HW_PARAM_RATE,
				   &wm8523->rate_constraint);

	return 0;
}

static int wm8523_hw_params(struct snd_pcm_substream *substream,
			    struct snd_pcm_hw_params *params,
			    struct snd_soc_dai *dai)
{
	struct snd_soc_codec *codec = dai->codec;
	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
	int i;
	u16 aifctrl1 = snd_soc_read(codec, WM8523_AIF_CTRL1);
	u16 aifctrl2 = snd_soc_read(codec, WM8523_AIF_CTRL2);

	/* Find a supported LRCLK ratio */
	for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
		if (wm8523->sysclk / params_rate(params) ==
		    lrclk_ratios[i].ratio)
			break;
	}

	/* Should never happen, should be handled by constraints */
	if (i == ARRAY_SIZE(lrclk_ratios)) {
		dev_err(codec->dev, "MCLK/fs ratio %d unsupported\n",
			wm8523->sysclk / params_rate(params));
		return -EINVAL;
	}

	aifctrl2 &= ~WM8523_SR_MASK;
	aifctrl2 |= lrclk_ratios[i].value;

	if (aifctrl1 & WM8523_AIF_MSTR) {
		/* Find a fs->bclk ratio */
		for (i = 0; i < ARRAY_SIZE(bclk_ratios); i++)
			if (params_width(params) * 2 <= bclk_ratios[i].ratio)
				break;

		if (i == ARRAY_SIZE(bclk_ratios)) {
			dev_err(codec->dev,
				"No matching BCLK/fs ratio for word length %d\n",
				params_width(params));
			return -EINVAL;
		}

		aifctrl2 &= ~WM8523_BCLKDIV_MASK;
		aifctrl2 |= bclk_ratios[i].value << WM8523_BCLKDIV_SHIFT;
	}

	aifctrl1 &= ~WM8523_WL_MASK;
	switch (params_width(params)) {
	case 16:
		break;
	case 20:
		aifctrl1 |= 0x8;
		break;
	case 24:
		aifctrl1 |= 0x10;
		break;
	case 32:
		aifctrl1 |= 0x18;
		break;
	}

	snd_soc_write(codec, WM8523_AIF_CTRL1, aifctrl1);
	snd_soc_write(codec, WM8523_AIF_CTRL2, aifctrl2);

	return 0;
}

static int wm8523_set_dai_sysclk(struct snd_soc_dai *codec_dai,
		int clk_id, unsigned int freq, int dir)
{
	struct snd_soc_codec *codec = codec_dai->codec;
	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
	unsigned int val;
	int i;

	wm8523->sysclk = freq;

	wm8523->rate_constraint.count = 0;
	for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
		val = freq / lrclk_ratios[i].ratio;
		/* Check that it's a standard rate since core can't
		 * cope with others and having the odd rates confuses
		 * constraint matching.
		 */
		switch (val) {
		case 8000:
		case 11025:
		case 16000:
		case 22050:
		case 32000:
		case 44100:
		case 48000:
		case 64000:
		case 88200:
		case 96000:
		case 176400:
		case 192000:
			dev_dbg(codec->dev, "Supported sample rate: %dHz\n",
				val);
			wm8523->rate_constraint_list[i] = val;
			wm8523->rate_constraint.count++;
			break;
		default:
			dev_dbg(codec->dev, "Skipping sample rate: %dHz\n",
				val);
		}
	}

	/* Need at least one supported rate... */
	if (wm8523->rate_constraint.count == 0)
		return -EINVAL;

	return 0;
}


static int wm8523_set_dai_fmt(struct snd_soc_dai *codec_dai,
		unsigned int fmt)
{
	struct snd_soc_codec *codec = codec_dai->codec;
	u16 aifctrl1 = snd_soc_read(codec, WM8523_AIF_CTRL1);

	aifctrl1 &= ~(WM8523_BCLK_INV_MASK | WM8523_LRCLK_INV_MASK |
		      WM8523_FMT_MASK | WM8523_AIF_MSTR_MASK);

	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
	case SND_SOC_DAIFMT_CBM_CFM:
		aifctrl1 |= WM8523_AIF_MSTR;
		break;
	case SND_SOC_DAIFMT_CBS_CFS:
		break;
	default:
		return -EINVAL;
	}

	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
	case SND_SOC_DAIFMT_I2S:
		aifctrl1 |= 0x0002;
		break;
	case SND_SOC_DAIFMT_RIGHT_J:
		break;
	case SND_SOC_DAIFMT_LEFT_J:
		aifctrl1 |= 0x0001;
		break;
	case SND_SOC_DAIFMT_DSP_A:
		aifctrl1 |= 0x0003;
		break;
	case SND_SOC_DAIFMT_DSP_B:
		aifctrl1 |= 0x0023;
		break;
	default:
		return -EINVAL;
	}

	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
	case SND_SOC_DAIFMT_NB_NF:
		break;
	case SND_SOC_DAIFMT_IB_IF:
		aifctrl1 |= WM8523_BCLK_INV | WM8523_LRCLK_INV;
		break;
	case SND_SOC_DAIFMT_IB_NF:
		aifctrl1 |= WM8523_BCLK_INV;
		break;
	case SND_SOC_DAIFMT_NB_IF:
		aifctrl1 |= WM8523_LRCLK_INV;
		break;
	default:
		return -EINVAL;
	}

	snd_soc_write(codec, WM8523_AIF_CTRL1, aifctrl1);

	return 0;
}

static int wm8523_set_bias_level(struct snd_soc_codec *codec,
				 enum snd_soc_bias_level level)
{
	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
	int ret;

	switch (level) {
	case SND_SOC_BIAS_ON:
		break;

	case SND_SOC_BIAS_PREPARE:
		/* Full power on */
		snd_soc_update_bits(codec, WM8523_PSCTRL1,
				    WM8523_SYS_ENA_MASK, 3);
		break;

	case SND_SOC_BIAS_STANDBY:
		if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_OFF) {
			ret = regulator_bulk_enable(ARRAY_SIZE(wm8523->supplies),
						    wm8523->supplies);
			if (ret != 0) {
				dev_err(codec->dev,
					"Failed to enable supplies: %d\n",
					ret);
				return ret;
			}

			/* Sync back default/cached values */
			regcache_sync(wm8523->regmap);

			/* Initial power up */
			snd_soc_update_bits(codec, WM8523_PSCTRL1,
					    WM8523_SYS_ENA_MASK, 1);

			msleep(100);
		}

		/* Power up to mute */
		snd_soc_update_bits(codec, WM8523_PSCTRL1,
				    WM8523_SYS_ENA_MASK, 2);

		break;

	case SND_SOC_BIAS_OFF:
		/* The chip runs through the power down sequence for us. */
		snd_soc_update_bits(codec, WM8523_PSCTRL1,
				    WM8523_SYS_ENA_MASK, 0);
		msleep(100);

		regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies),
				       wm8523->supplies);
		break;
	}
	return 0;
}

#define WM8523_RATES SNDRV_PCM_RATE_8000_192000

#define WM8523_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
			SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)

static const struct snd_soc_dai_ops wm8523_dai_ops = {
	.startup	= wm8523_startup,
	.hw_params	= wm8523_hw_params,
	.set_sysclk	= wm8523_set_dai_sysclk,
	.set_fmt	= wm8523_set_dai_fmt,
};

static struct snd_soc_dai_driver wm8523_dai = {
	.name = "wm8523-hifi",
	.playback = {
		.stream_name = "Playback",
		.channels_min = 2,  /* Mono modes not yet supported */
		.channels_max = 2,
		.rates = WM8523_RATES,
		.formats = WM8523_FORMATS,
	},
	.ops = &wm8523_dai_ops,
};

static int wm8523_probe(struct snd_soc_codec *codec)
{
	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);

	wm8523->rate_constraint.list = &wm8523->rate_constraint_list[0];
	wm8523->rate_constraint.count =
		ARRAY_SIZE(wm8523->rate_constraint_list);

	/* Change some default settings - latch VU and enable ZC */
	snd_soc_update_bits(codec, WM8523_DAC_GAINR,
			    WM8523_DACR_VU, WM8523_DACR_VU);
	snd_soc_update_bits(codec, WM8523_DAC_CTRL3, WM8523_ZC, WM8523_ZC);

	return 0;
}

static const struct snd_soc_codec_driver soc_codec_dev_wm8523 = {
	.probe =	wm8523_probe,
	.set_bias_level = wm8523_set_bias_level,
	.suspend_bias_off = true,

	.component_driver = {
		.controls		= wm8523_controls,
		.num_controls		= ARRAY_SIZE(wm8523_controls),
		.dapm_widgets		= wm8523_dapm_widgets,
		.num_dapm_widgets	= ARRAY_SIZE(wm8523_dapm_widgets),
		.dapm_routes		= wm8523_dapm_routes,
		.num_dapm_routes	= ARRAY_SIZE(wm8523_dapm_routes),
	},
};

static const struct of_device_id wm8523_of_match[] = {
	{ .compatible = "wlf,wm8523" },
	{ },
};
MODULE_DEVICE_TABLE(of, wm8523_of_match);

static const struct regmap_config wm8523_regmap = {
	.reg_bits = 8,
	.val_bits = 16,
	.max_register = WM8523_ZERO_DETECT,

	.reg_defaults = wm8523_reg_defaults,
	.num_reg_defaults = ARRAY_SIZE(wm8523_reg_defaults),
	.cache_type = REGCACHE_RBTREE,

	.volatile_reg = wm8523_volatile_register,
};

#if IS_ENABLED(CONFIG_I2C)
static int wm8523_i2c_probe(struct i2c_client *i2c,
			    const struct i2c_device_id *id)
{
	struct wm8523_priv *wm8523;
	unsigned int val;
	int ret, i;

	wm8523 = devm_kzalloc(&i2c->dev, sizeof(struct wm8523_priv),
			      GFP_KERNEL);
	if (wm8523 == NULL)
		return -ENOMEM;

	wm8523->regmap = devm_regmap_init_i2c(i2c, &wm8523_regmap);
	if (IS_ERR(wm8523->regmap)) {
		ret = PTR_ERR(wm8523->regmap);
		dev_err(&i2c->dev, "Failed to create regmap: %d\n", ret);
		return ret;
	}

	for (i = 0; i < ARRAY_SIZE(wm8523->supplies); i++)
		wm8523->supplies[i].supply = wm8523_supply_names[i];

	ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(wm8523->supplies),
				      wm8523->supplies);
	if (ret != 0) {
		dev_err(&i2c->dev, "Failed to request supplies: %d\n", ret);
		return ret;
	}

	ret = regulator_bulk_enable(ARRAY_SIZE(wm8523->supplies),
				    wm8523->supplies);
	if (ret != 0) {
		dev_err(&i2c->dev, "Failed to enable supplies: %d\n", ret);
		return ret;
	}

	ret = regmap_read(wm8523->regmap, WM8523_DEVICE_ID, &val);
	if (ret < 0) {
		dev_err(&i2c->dev, "Failed to read ID register\n");
		goto err_enable;
	}
	if (val != 0x8523) {
		dev_err(&i2c->dev, "Device is not a WM8523, ID is %x\n", ret);
		ret = -EINVAL;
		goto err_enable;
	}

	ret = regmap_read(wm8523->regmap, WM8523_REVISION, &val);
	if (ret < 0) {
		dev_err(&i2c->dev, "Failed to read revision register\n");
		goto err_enable;
	}
	dev_info(&i2c->dev, "revision %c\n",
		 (val & WM8523_CHIP_REV_MASK) + 'A');

	ret = regmap_write(wm8523->regmap, WM8523_DEVICE_ID, 0x8523);
	if (ret != 0) {
		dev_err(&i2c->dev, "Failed to reset device: %d\n", ret);
		goto err_enable;
	}

	regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);

	i2c_set_clientdata(i2c, wm8523);

	ret =  snd_soc_register_codec(&i2c->dev,
			&soc_codec_dev_wm8523, &wm8523_dai, 1);

	return ret;

err_enable:
	regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
	return ret;
}

static int wm8523_i2c_remove(struct i2c_client *client)
{
	snd_soc_unregister_codec(&client->dev);
	return 0;
}

static const struct i2c_device_id wm8523_i2c_id[] = {
	{ "wm8523", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, wm8523_i2c_id);

static struct i2c_driver wm8523_i2c_driver = {
	.driver = {
		.name = "wm8523",
		.of_match_table = wm8523_of_match,
	},
	.probe =    wm8523_i2c_probe,
	.remove =   wm8523_i2c_remove,
	.id_table = wm8523_i2c_id,
};
#endif

static int __init wm8523_modinit(void)
{
	int ret;
#if IS_ENABLED(CONFIG_I2C)
	ret = i2c_add_driver(&wm8523_i2c_driver);
	if (ret != 0) {
		printk(KERN_ERR "Failed to register WM8523 I2C driver: %d\n",
		       ret);
	}
#endif
	return 0;
}
module_init(wm8523_modinit);

static void __exit wm8523_exit(void)
{
#if IS_ENABLED(CONFIG_I2C)
	i2c_del_driver(&wm8523_i2c_driver);
#endif
}
module_exit(wm8523_exit);

MODULE_DESCRIPTION("ASoC WM8523 driver");
MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
1dcf98ff MB	1	/*
	2	* wm8523.c -- WM8523 ALSA SoC Audio driver
	3	*
	4	* Copyright 2009 Wolfson Microelectronics plc
	5	*
	6	* Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
	7	*
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*/
	13
	14	#include <linux/module.h>
	15	#include <linux/moduleparam.h>
	16	#include <linux/init.h>
	17	#include <linux/delay.h>
	18	#include <linux/pm.h>
	19	#include <linux/i2c.h>
b9288f49	20	#include <linux/regmap.h>
1dcf98ff	21	#include <linux/regulator/consumer.h>
5a0e3ad6	22	#include <linux/slab.h>
bf5a85be	23	#include <linux/of_device.h>
1dcf98ff MB	24	#include <sound/core.h>
	25	#include <sound/pcm.h>
	26	#include <sound/pcm_params.h>
	27	#include <sound/soc.h>
1dcf98ff MB	28	#include <sound/initval.h>
	29	#include <sound/tlv.h>
	30
	31	#include "wm8523.h"
	32
1dcf98ff MB	33	#define WM8523_NUM_SUPPLIES 2
	34	static const char *wm8523_supply_names[WM8523_NUM_SUPPLIES] = {
	35	"AVDD",
	36	"LINEVDD",
	37	};
	38
	39	#define WM8523_NUM_RATES 7
	40
	41	/* codec private data */
	42	struct wm8523_priv {
b9288f49	43	struct regmap *regmap;
1dcf98ff MB	44	struct regulator_bulk_data supplies[WM8523_NUM_SUPPLIES];
	45	unsigned int sysclk;
	46	unsigned int rate_constraint_list[WM8523_NUM_RATES];
	47	struct snd_pcm_hw_constraint_list rate_constraint;
	48	};
	49
b9288f49 MB	50	static const struct reg_default wm8523_reg_defaults[] = {
	51	{ 2, 0x0000 }, /* R2 - PSCTRL1 */
	52	{ 3, 0x1812 }, /* R3 - AIF_CTRL1 */
	53	{ 4, 0x0000 }, /* R4 - AIF_CTRL2 */
	54	{ 5, 0x0001 }, /* R5 - DAC_CTRL3 */
	55	{ 6, 0x0190 }, /* R6 - DAC_GAINL */
	56	{ 7, 0x0190 }, /* R7 - DAC_GAINR */
	57	{ 8, 0x0000 }, /* R8 - ZERO_DETECT */
1dcf98ff MB	58	};
1dcf98ff MB	59
b9288f49	60	static bool wm8523_volatile_register(struct device *dev, unsigned int reg)
1dcf98ff MB	61	{
	62	switch (reg) {
	63	case WM8523_DEVICE_ID:
	64	case WM8523_REVISION:
b9288f49	65	return true;
1dcf98ff	66	default:
b9288f49	67	return false;
1dcf98ff MB	68	}
	69	}
	70
1dcf98ff MB	71	static const DECLARE_TLV_DB_SCALE(dac_tlv, -10000, 25, 0);
	72
	73	static const char *wm8523_zd_count_text[] = {
	74	"1024",
	75	"2048",
	76	};
	77
fed08d94 TI	78	static SOC_ENUM_SINGLE_DECL(wm8523_zc_count, WM8523_ZERO_DETECT, 0,
fed08d94 TI	79	wm8523_zd_count_text);
1dcf98ff	80
1661699a	81	static const struct snd_kcontrol_new wm8523_controls[] = {
1dcf98ff MB	82	SOC_DOUBLE_R_TLV("Playback Volume", WM8523_DAC_GAINL, WM8523_DAC_GAINR,
	83	0, 448, 0, dac_tlv),
	84	SOC_SINGLE("ZC Switch", WM8523_DAC_CTRL3, 4, 1, 0),
	85	SOC_SINGLE("Playback Deemphasis Switch", WM8523_AIF_CTRL1, 8, 1, 0),
	86	SOC_DOUBLE("Playback Switch", WM8523_DAC_CTRL3, 2, 3, 1, 1),
	87	SOC_SINGLE("Volume Ramp Up Switch", WM8523_DAC_CTRL3, 1, 1, 0),
	88	SOC_SINGLE("Volume Ramp Down Switch", WM8523_DAC_CTRL3, 0, 1, 0),
	89	SOC_ENUM("Zero Detect Count", wm8523_zc_count),
	90	};
	91
	92	static const struct snd_soc_dapm_widget wm8523_dapm_widgets[] = {
	93	SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
	94	SND_SOC_DAPM_OUTPUT("LINEVOUTL"),
	95	SND_SOC_DAPM_OUTPUT("LINEVOUTR"),
	96	};
	97
1661699a	98	static const struct snd_soc_dapm_route wm8523_dapm_routes[] = {
1dcf98ff MB	99	{ "LINEVOUTL", NULL, "DAC" },
	100	{ "LINEVOUTR", NULL, "DAC" },
	101	};
	102
1dcf98ff MB	103	static struct {
	104	int value;
	105	int ratio;
	106	} lrclk_ratios[WM8523_NUM_RATES] = {
	107	{ 1, 128 },
	108	{ 2, 192 },
	109	{ 3, 256 },
	110	{ 4, 384 },
	111	{ 5, 512 },
	112	{ 6, 768 },
	113	{ 7, 1152 },
	114	};
	115
ef5294fd JS	116	static struct {
	117	int value;
	118	int ratio;
	119	} bclk_ratios[WM8523_NUM_RATES] = {
	120	{ 2, 32 },
	121	{ 3, 64 },
	122	{ 4, 128 },
	123	};
	124
1dcf98ff MB	125	static int wm8523_startup(struct snd_pcm_substream *substream,
	126	struct snd_soc_dai *dai)
	127	{
	128	struct snd_soc_codec *codec = dai->codec;
b2c812e2	129	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
1dcf98ff MB	130
	131	/* The set of sample rates that can be supported depends on the
	132	* MCLK supplied to the CODEC - enforce this.
	133	*/
	134	if (!wm8523->sysclk) {
	135	dev_err(codec->dev,
	136	"No MCLK configured, call set_sysclk() on init\n");
	137	return -EINVAL;
	138	}
	139
1dcf98ff MB	140	snd_pcm_hw_constraint_list(substream->runtime, 0,
	141	SNDRV_PCM_HW_PARAM_RATE,
	142	&wm8523->rate_constraint);
	143
	144	return 0;
	145	}
	146
	147	static int wm8523_hw_params(struct snd_pcm_substream *substream,
	148	struct snd_pcm_hw_params *params,
	149	struct snd_soc_dai *dai)
	150	{
e6968a17	151	struct snd_soc_codec *codec = dai->codec;
b2c812e2	152	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
1dcf98ff	153	int i;
8d50e447 MB	154	u16 aifctrl1 = snd_soc_read(codec, WM8523_AIF_CTRL1);
8d50e447 MB	155	u16 aifctrl2 = snd_soc_read(codec, WM8523_AIF_CTRL2);
1dcf98ff MB	156
	157	/* Find a supported LRCLK ratio */
	158	for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
	159	if (wm8523->sysclk / params_rate(params) ==
	160	lrclk_ratios[i].ratio)
	161	break;
	162	}
	163
	164	/* Should never happen, should be handled by constraints */
	165	if (i == ARRAY_SIZE(lrclk_ratios)) {
	166	dev_err(codec->dev, "MCLK/fs ratio %d unsupported\n",
	167	wm8523->sysclk / params_rate(params));
	168	return -EINVAL;
	169	}
	170
	171	aifctrl2 &= ~WM8523_SR_MASK;
	172	aifctrl2 \|= lrclk_ratios[i].value;
	173
ef5294fd JS	174	if (aifctrl1 & WM8523_AIF_MSTR) {
	175	/* Find a fs->bclk ratio */
	176	for (i = 0; i < ARRAY_SIZE(bclk_ratios); i++)
	177	if (params_width(params) * 2 <= bclk_ratios[i].ratio)
	178	break;
	179
	180	if (i == ARRAY_SIZE(bclk_ratios)) {
	181	dev_err(codec->dev,
	182	"No matching BCLK/fs ratio for word length %d\n",
	183	params_width(params));
	184	return -EINVAL;
	185	}
	186
	187	aifctrl2 &= ~WM8523_BCLKDIV_MASK;
	188	aifctrl2 \|= bclk_ratios[i].value << WM8523_BCLKDIV_SHIFT;
	189	}
	190
1dcf98ff	191	aifctrl1 &= ~WM8523_WL_MASK;
3fafcc8e MB	192	switch (params_width(params)) {
3fafcc8e MB	193	case 16:
1dcf98ff	194	break;
3fafcc8e	195	case 20:
1dcf98ff MB	196	aifctrl1 \|= 0x8;
1dcf98ff MB	197	break;
3fafcc8e	198	case 24:
1dcf98ff MB	199	aifctrl1 \|= 0x10;
1dcf98ff MB	200	break;
3fafcc8e	201	case 32:
1dcf98ff MB	202	aifctrl1 \|= 0x18;
	203	break;
	204	}
	205
8d50e447 MB	206	snd_soc_write(codec, WM8523_AIF_CTRL1, aifctrl1);
8d50e447 MB	207	snd_soc_write(codec, WM8523_AIF_CTRL2, aifctrl2);
1dcf98ff MB	208
	209	return 0;
	210	}
	211
	212	static int wm8523_set_dai_sysclk(struct snd_soc_dai *codec_dai,
	213	int clk_id, unsigned int freq, int dir)
	214	{
	215	struct snd_soc_codec *codec = codec_dai->codec;
b2c812e2	216	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
1dcf98ff MB	217	unsigned int val;
	218	int i;
	219
	220	wm8523->sysclk = freq;
	221
	222	wm8523->rate_constraint.count = 0;
	223	for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
	224	val = freq / lrclk_ratios[i].ratio;
	225	/* Check that it's a standard rate since core can't
	226	* cope with others and having the odd rates confuses
	227	* constraint matching.
	228	*/
	229	switch (val) {
	230	case 8000:
	231	case 11025:
	232	case 16000:
	233	case 22050:
	234	case 32000:
	235	case 44100:
	236	case 48000:
	237	case 64000:
	238	case 88200:
	239	case 96000:
	240	case 176400:
	241	case 192000:
	242	dev_dbg(codec->dev, "Supported sample rate: %dHz\n",
	243	val);
	244	wm8523->rate_constraint_list[i] = val;
	245	wm8523->rate_constraint.count++;
	246	break;
	247	default:
	248	dev_dbg(codec->dev, "Skipping sample rate: %dHz\n",
	249	val);
	250	}
	251	}
	252
	253	/* Need at least one supported rate... */
	254	if (wm8523->rate_constraint.count == 0)
	255	return -EINVAL;
	256
	257	return 0;
	258	}
	259
	260
	261	static int wm8523_set_dai_fmt(struct snd_soc_dai *codec_dai,
	262	unsigned int fmt)
	263	{
	264	struct snd_soc_codec *codec = codec_dai->codec;
8d50e447	265	u16 aifctrl1 = snd_soc_read(codec, WM8523_AIF_CTRL1);
1dcf98ff MB	266
	267	aifctrl1 &= ~(WM8523_BCLK_INV_MASK \| WM8523_LRCLK_INV_MASK \|
	268	WM8523_FMT_MASK \| WM8523_AIF_MSTR_MASK);
	269
	270	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
	271	case SND_SOC_DAIFMT_CBM_CFM:
	272	aifctrl1 \|= WM8523_AIF_MSTR;
	273	break;
	274	case SND_SOC_DAIFMT_CBS_CFS:
	275	break;
	276	default:
	277	return -EINVAL;
	278	}
	279
	280	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
	281	case SND_SOC_DAIFMT_I2S:
	282	aifctrl1 \|= 0x0002;
	283	break;
	284	case SND_SOC_DAIFMT_RIGHT_J:
	285	break;
	286	case SND_SOC_DAIFMT_LEFT_J:
	287	aifctrl1 \|= 0x0001;
	288	break;
	289	case SND_SOC_DAIFMT_DSP_A:
	290	aifctrl1 \|= 0x0003;
	291	break;
	292	case SND_SOC_DAIFMT_DSP_B:
	293	aifctrl1 \|= 0x0023;
	294	break;
	295	default:
	296	return -EINVAL;
	297	}
	298
	299	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
	300	case SND_SOC_DAIFMT_NB_NF:
	301	break;
	302	case SND_SOC_DAIFMT_IB_IF:
	303	aifctrl1 \|= WM8523_BCLK_INV \| WM8523_LRCLK_INV;
	304	break;
	305	case SND_SOC_DAIFMT_IB_NF:
	306	aifctrl1 \|= WM8523_BCLK_INV;
	307	break;
	308	case SND_SOC_DAIFMT_NB_IF:
	309	aifctrl1 \|= WM8523_LRCLK_INV;
	310	break;
	311	default:
	312	return -EINVAL;
	313	}
	314
8d50e447	315	snd_soc_write(codec, WM8523_AIF_CTRL1, aifctrl1);
1dcf98ff MB	316
	317	return 0;
	318	}
	319
	320	static int wm8523_set_bias_level(struct snd_soc_codec *codec,
	321	enum snd_soc_bias_level level)
	322	{
b2c812e2	323	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
b9288f49	324	int ret;
1dcf98ff MB	325
	326	switch (level) {
	327	case SND_SOC_BIAS_ON:
	328	break;
	329
	330	case SND_SOC_BIAS_PREPARE:
	331	/* Full power on */
	332	snd_soc_update_bits(codec, WM8523_PSCTRL1,
	333	WM8523_SYS_ENA_MASK, 3);
	334	break;
	335
	336	case SND_SOC_BIAS_STANDBY:
7db634d9	337	if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_OFF) {
1dcf98ff MB	338	ret = regulator_bulk_enable(ARRAY_SIZE(wm8523->supplies),
	339	wm8523->supplies);
	340	if (ret != 0) {
	341	dev_err(codec->dev,
	342	"Failed to enable supplies: %d\n",
	343	ret);
	344	return ret;
	345	}
	346
b9288f49 MB	347	/* Sync back default/cached values */
	348	regcache_sync(wm8523->regmap);
	349
1dcf98ff MB	350	/* Initial power up */
	351	snd_soc_update_bits(codec, WM8523_PSCTRL1,
	352	WM8523_SYS_ENA_MASK, 1);
	353
1dcf98ff MB	354	msleep(100);
	355	}
	356
	357	/* Power up to mute */
	358	snd_soc_update_bits(codec, WM8523_PSCTRL1,
	359	WM8523_SYS_ENA_MASK, 2);
	360
	361	break;
	362
	363	case SND_SOC_BIAS_OFF:
	364	/* The chip runs through the power down sequence for us. */
	365	snd_soc_update_bits(codec, WM8523_PSCTRL1,
	366	WM8523_SYS_ENA_MASK, 0);
	367	msleep(100);
	368
	369	regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies),
	370	wm8523->supplies);
	371	break;
	372	}
1dcf98ff MB	373	return 0;
	374	}
	375
	376	#define WM8523_RATES SNDRV_PCM_RATE_8000_192000
	377
	378	#define WM8523_FORMATS (SNDRV_PCM_FMTBIT_S16_LE \| SNDRV_PCM_FMTBIT_S20_3LE \|\
	379	SNDRV_PCM_FMTBIT_S24_LE \| SNDRV_PCM_FMTBIT_S32_LE)
	380
85e7652d	381	static const struct snd_soc_dai_ops wm8523_dai_ops = {
1dcf98ff MB	382	.startup = wm8523_startup,
	383	.hw_params = wm8523_hw_params,
	384	.set_sysclk = wm8523_set_dai_sysclk,
	385	.set_fmt = wm8523_set_dai_fmt,
	386	};
	387
f0fba2ad LG	388	static struct snd_soc_dai_driver wm8523_dai = {
f0fba2ad LG	389	.name = "wm8523-hifi",
1dcf98ff MB	390	.playback = {
	391	.stream_name = "Playback",
	392	.channels_min = 2, /* Mono modes not yet supported */
	393	.channels_max = 2,
	394	.rates = WM8523_RATES,
	395	.formats = WM8523_FORMATS,
	396	},
	397	.ops = &wm8523_dai_ops,
	398	};
1dcf98ff	399
f0fba2ad	400	static int wm8523_probe(struct snd_soc_codec *codec)
1dcf98ff	401	{
f0fba2ad	402	struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
1dcf98ff MB	403
	404	wm8523->rate_constraint.list = &wm8523->rate_constraint_list[0];
	405	wm8523->rate_constraint.count =
	406	ARRAY_SIZE(wm8523->rate_constraint_list);
	407
1dcf98ff	408	/* Change some default settings - latch VU and enable ZC */
a1b3b5ee MB	409	snd_soc_update_bits(codec, WM8523_DAC_GAINR,
	410	WM8523_DACR_VU, WM8523_DACR_VU);
	411	snd_soc_update_bits(codec, WM8523_DAC_CTRL3, WM8523_ZC, WM8523_ZC);
1dcf98ff	412
f0fba2ad	413	return 0;
1dcf98ff MB	414	}
1dcf98ff MB	415
f802d6c0	416	static const struct snd_soc_codec_driver soc_codec_dev_wm8523 = {
f0fba2ad	417	.probe = wm8523_probe,
f0fba2ad	418	.set_bias_level = wm8523_set_bias_level,
ca5e7c6a	419	.suspend_bias_off = true,
1661699a	420
f8a5c975 KM	421	.component_driver = {
	422	.controls = wm8523_controls,
	423	.num_controls = ARRAY_SIZE(wm8523_controls),
	424	.dapm_widgets = wm8523_dapm_widgets,
	425	.num_dapm_widgets = ARRAY_SIZE(wm8523_dapm_widgets),
	426	.dapm_routes = wm8523_dapm_routes,
	427	.num_dapm_routes = ARRAY_SIZE(wm8523_dapm_routes),
	428	},
f0fba2ad LG	429	};
f0fba2ad LG	430
bf5a85be MB	431	static const struct of_device_id wm8523_of_match[] = {
	432	{ .compatible = "wlf,wm8523" },
	433	{ },
	434	};
bf08f39e	435	MODULE_DEVICE_TABLE(of, wm8523_of_match);
bf5a85be	436
b9288f49 MB	437	static const struct regmap_config wm8523_regmap = {
	438	.reg_bits = 8,
	439	.val_bits = 16,
	440	.max_register = WM8523_ZERO_DETECT,
	441
	442	.reg_defaults = wm8523_reg_defaults,
	443	.num_reg_defaults = ARRAY_SIZE(wm8523_reg_defaults),
	444	.cache_type = REGCACHE_RBTREE,
	445
	446	.volatile_reg = wm8523_volatile_register,
	447	};
	448
008ef947	449	#if IS_ENABLED(CONFIG_I2C)
7a79e94e BP	450	static int wm8523_i2c_probe(struct i2c_client *i2c,
7a79e94e BP	451	const struct i2c_device_id *id)
1dcf98ff MB	452	{
1dcf98ff MB	453	struct wm8523_priv *wm8523;
59ac2149	454	unsigned int val;
719b0c59	455	int ret, i;
1dcf98ff	456
7d014db8 MB	457	wm8523 = devm_kzalloc(&i2c->dev, sizeof(struct wm8523_priv),
7d014db8 MB	458	GFP_KERNEL);
1dcf98ff MB	459	if (wm8523 == NULL)
	460	return -ENOMEM;
	461
b9288f49 MB	462	wm8523->regmap = devm_regmap_init_i2c(i2c, &wm8523_regmap);
	463	if (IS_ERR(wm8523->regmap)) {
	464	ret = PTR_ERR(wm8523->regmap);
	465	dev_err(&i2c->dev, "Failed to create regmap: %d\n", ret);
	466	return ret;
	467	}
	468
719b0c59 MB	469	for (i = 0; i < ARRAY_SIZE(wm8523->supplies); i++)
	470	wm8523->supplies[i].supply = wm8523_supply_names[i];
	471
	472	ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(wm8523->supplies),
	473	wm8523->supplies);
	474	if (ret != 0) {
	475	dev_err(&i2c->dev, "Failed to request supplies: %d\n", ret);
	476	return ret;
	477	}
	478
59ac2149 MB	479	ret = regulator_bulk_enable(ARRAY_SIZE(wm8523->supplies),
	480	wm8523->supplies);
	481	if (ret != 0) {
	482	dev_err(&i2c->dev, "Failed to enable supplies: %d\n", ret);
	483	return ret;
	484	}
	485
	486	ret = regmap_read(wm8523->regmap, WM8523_DEVICE_ID, &val);
	487	if (ret < 0) {
	488	dev_err(&i2c->dev, "Failed to read ID register\n");
	489	goto err_enable;
	490	}
	491	if (val != 0x8523) {
	492	dev_err(&i2c->dev, "Device is not a WM8523, ID is %x\n", ret);
	493	ret = -EINVAL;
	494	goto err_enable;
	495	}
	496
	497	ret = regmap_read(wm8523->regmap, WM8523_REVISION, &val);
	498	if (ret < 0) {
	499	dev_err(&i2c->dev, "Failed to read revision register\n");
	500	goto err_enable;
	501	}
	502	dev_info(&i2c->dev, "revision %c\n",
	503	(val & WM8523_CHIP_REV_MASK) + 'A');
	504
	505	ret = regmap_write(wm8523->regmap, WM8523_DEVICE_ID, 0x8523);
	506	if (ret != 0) {
	507	dev_err(&i2c->dev, "Failed to reset device: %d\n", ret);
	508	goto err_enable;
	509	}
	510
	511	regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
	512
1dcf98ff	513	i2c_set_clientdata(i2c, wm8523);
1dcf98ff	514
f0fba2ad LG	515	ret = snd_soc_register_codec(&i2c->dev,
f0fba2ad LG	516	&soc_codec_dev_wm8523, &wm8523_dai, 1);
7d014db8	517
f0fba2ad	518	return ret;
1dcf98ff	519
59ac2149 MB	520	err_enable:
	521	regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
	522	return ret;
1dcf98ff MB	523	}
1dcf98ff MB	524
7a79e94e	525	static int wm8523_i2c_remove(struct i2c_client *client)
1dcf98ff	526	{
f0fba2ad	527	snd_soc_unregister_codec(&client->dev);
1dcf98ff MB	528	return 0;
	529	}
	530
1dcf98ff MB	531	static const struct i2c_device_id wm8523_i2c_id[] = {
	532	{ "wm8523", 0 },
	533	{ }
	534	};
	535	MODULE_DEVICE_TABLE(i2c, wm8523_i2c_id);
	536
	537	static struct i2c_driver wm8523_i2c_driver = {
	538	.driver = {
9665408e	539	.name = "wm8523",
bf5a85be	540	.of_match_table = wm8523_of_match,
1dcf98ff MB	541	},
1dcf98ff MB	542	.probe = wm8523_i2c_probe,
7a79e94e	543	.remove = wm8523_i2c_remove,
1dcf98ff MB	544	.id_table = wm8523_i2c_id,
	545	};
	546	#endif
	547
	548	static int __init wm8523_modinit(void)
	549	{
	550	int ret;
008ef947	551	#if IS_ENABLED(CONFIG_I2C)
1dcf98ff MB	552	ret = i2c_add_driver(&wm8523_i2c_driver);
	553	if (ret != 0) {
	554	printk(KERN_ERR "Failed to register WM8523 I2C driver: %d\n",
	555	ret);
	556	}
	557	#endif
	558	return 0;
	559	}
	560	module_init(wm8523_modinit);
	561
	562	static void __exit wm8523_exit(void)
	563	{
008ef947	564	#if IS_ENABLED(CONFIG_I2C)
1dcf98ff MB	565	i2c_del_driver(&wm8523_i2c_driver);
	566	#endif
	567	}
	568	module_exit(wm8523_exit);
	569
	570	MODULE_DESCRIPTION("ASoC WM8523 driver");
	571	MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
	572	MODULE_LICENSE("GPL");