xref: /OK3568_Linux_fs/kernel/sound/soc/codecs/pcm1789.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun // Audio driver for PCM1789
3*4882a593Smuzhiyun // Copyright (C) 2018 Bootlin
4*4882a593Smuzhiyun // Mylène Josserand <mylene.josserand@bootlin.com>
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
7*4882a593Smuzhiyun #include <linux/module.h>
8*4882a593Smuzhiyun #include <linux/workqueue.h>
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <sound/pcm_params.h>
11*4882a593Smuzhiyun #include <sound/soc.h>
12*4882a593Smuzhiyun #include <sound/tlv.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include "pcm1789.h"
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #define PCM1789_MUTE_CONTROL	0x10
17*4882a593Smuzhiyun #define PCM1789_FMT_CONTROL	0x11
18*4882a593Smuzhiyun #define PCM1789_SOFT_MUTE	0x14
19*4882a593Smuzhiyun #define PCM1789_DAC_VOL_LEFT	0x18
20*4882a593Smuzhiyun #define PCM1789_DAC_VOL_RIGHT	0x19
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define PCM1789_FMT_MASK	0x07
23*4882a593Smuzhiyun #define PCM1789_MUTE_MASK	0x03
24*4882a593Smuzhiyun #define PCM1789_MUTE_SRET	0x06
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun struct pcm1789_private {
27*4882a593Smuzhiyun 	struct regmap *regmap;
28*4882a593Smuzhiyun 	unsigned int format;
29*4882a593Smuzhiyun 	unsigned int rate;
30*4882a593Smuzhiyun 	struct gpio_desc *reset;
31*4882a593Smuzhiyun 	struct work_struct work;
32*4882a593Smuzhiyun 	struct device *dev;
33*4882a593Smuzhiyun };
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun static const struct reg_default pcm1789_reg_defaults[] = {
36*4882a593Smuzhiyun 	{ PCM1789_FMT_CONTROL, 0x00 },
37*4882a593Smuzhiyun 	{ PCM1789_SOFT_MUTE, 0x00 },
38*4882a593Smuzhiyun 	{ PCM1789_DAC_VOL_LEFT, 0xff },
39*4882a593Smuzhiyun 	{ PCM1789_DAC_VOL_RIGHT, 0xff },
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun 
pcm1789_accessible_reg(struct device * dev,unsigned int reg)42*4882a593Smuzhiyun static bool pcm1789_accessible_reg(struct device *dev, unsigned int reg)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun 	return reg >= PCM1789_MUTE_CONTROL && reg <= PCM1789_DAC_VOL_RIGHT;
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
pcm1789_writeable_reg(struct device * dev,unsigned int reg)47*4882a593Smuzhiyun static bool pcm1789_writeable_reg(struct device *dev, unsigned int reg)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun 	return pcm1789_accessible_reg(dev, reg);
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun 
pcm1789_set_dai_fmt(struct snd_soc_dai * codec_dai,unsigned int format)52*4882a593Smuzhiyun static int pcm1789_set_dai_fmt(struct snd_soc_dai *codec_dai,
53*4882a593Smuzhiyun 			       unsigned int format)
54*4882a593Smuzhiyun {
55*4882a593Smuzhiyun 	struct snd_soc_component *component = codec_dai->component;
56*4882a593Smuzhiyun 	struct pcm1789_private *priv = snd_soc_component_get_drvdata(component);
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 	priv->format = format;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	return 0;
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
pcm1789_mute(struct snd_soc_dai * codec_dai,int mute,int direction)63*4882a593Smuzhiyun static int pcm1789_mute(struct snd_soc_dai *codec_dai, int mute, int direction)
64*4882a593Smuzhiyun {
65*4882a593Smuzhiyun 	struct snd_soc_component *component = codec_dai->component;
66*4882a593Smuzhiyun 	struct pcm1789_private *priv = snd_soc_component_get_drvdata(component);
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	return regmap_update_bits(priv->regmap, PCM1789_SOFT_MUTE,
69*4882a593Smuzhiyun 				  PCM1789_MUTE_MASK,
70*4882a593Smuzhiyun 				  mute ? 0 : PCM1789_MUTE_MASK);
71*4882a593Smuzhiyun }
72*4882a593Smuzhiyun 
pcm1789_hw_params(struct snd_pcm_substream * substream,struct snd_pcm_hw_params * params,struct snd_soc_dai * codec_dai)73*4882a593Smuzhiyun static int pcm1789_hw_params(struct snd_pcm_substream *substream,
74*4882a593Smuzhiyun 			     struct snd_pcm_hw_params *params,
75*4882a593Smuzhiyun 			     struct snd_soc_dai *codec_dai)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun 	struct snd_soc_component *component = codec_dai->component;
78*4882a593Smuzhiyun 	struct pcm1789_private *priv = snd_soc_component_get_drvdata(component);
79*4882a593Smuzhiyun 	int val = 0, ret;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	priv->rate = params_rate(params);
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	switch (priv->format & SND_SOC_DAIFMT_FORMAT_MASK) {
84*4882a593Smuzhiyun 	case SND_SOC_DAIFMT_RIGHT_J:
85*4882a593Smuzhiyun 		switch (params_width(params)) {
86*4882a593Smuzhiyun 		case 24:
87*4882a593Smuzhiyun 			val = 2;
88*4882a593Smuzhiyun 			break;
89*4882a593Smuzhiyun 		case 16:
90*4882a593Smuzhiyun 			val = 3;
91*4882a593Smuzhiyun 			break;
92*4882a593Smuzhiyun 		default:
93*4882a593Smuzhiyun 			return -EINVAL;
94*4882a593Smuzhiyun 		}
95*4882a593Smuzhiyun 		break;
96*4882a593Smuzhiyun 	case SND_SOC_DAIFMT_I2S:
97*4882a593Smuzhiyun 		switch (params_width(params)) {
98*4882a593Smuzhiyun 		case 16:
99*4882a593Smuzhiyun 		case 24:
100*4882a593Smuzhiyun 		case 32:
101*4882a593Smuzhiyun 			val = 0;
102*4882a593Smuzhiyun 			break;
103*4882a593Smuzhiyun 		default:
104*4882a593Smuzhiyun 			return -EINVAL;
105*4882a593Smuzhiyun 		}
106*4882a593Smuzhiyun 		break;
107*4882a593Smuzhiyun 	case SND_SOC_DAIFMT_LEFT_J:
108*4882a593Smuzhiyun 		switch (params_width(params)) {
109*4882a593Smuzhiyun 		case 16:
110*4882a593Smuzhiyun 		case 24:
111*4882a593Smuzhiyun 		case 32:
112*4882a593Smuzhiyun 			val = 1;
113*4882a593Smuzhiyun 			break;
114*4882a593Smuzhiyun 		default:
115*4882a593Smuzhiyun 			return -EINVAL;
116*4882a593Smuzhiyun 		}
117*4882a593Smuzhiyun 		break;
118*4882a593Smuzhiyun 	default:
119*4882a593Smuzhiyun 		dev_err(component->dev, "Invalid DAI format\n");
120*4882a593Smuzhiyun 		return -EINVAL;
121*4882a593Smuzhiyun 	}
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	ret = regmap_update_bits(priv->regmap, PCM1789_FMT_CONTROL,
124*4882a593Smuzhiyun 				 PCM1789_FMT_MASK, val);
125*4882a593Smuzhiyun 	if (ret < 0)
126*4882a593Smuzhiyun 		return ret;
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun 	return 0;
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun 
pcm1789_work_queue(struct work_struct * work)131*4882a593Smuzhiyun static void pcm1789_work_queue(struct work_struct *work)
132*4882a593Smuzhiyun {
133*4882a593Smuzhiyun 	struct pcm1789_private *priv = container_of(work,
134*4882a593Smuzhiyun 						    struct pcm1789_private,
135*4882a593Smuzhiyun 						    work);
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	/* Perform a software reset to remove codec from desynchronized state */
138*4882a593Smuzhiyun 	if (regmap_update_bits(priv->regmap, PCM1789_MUTE_CONTROL,
139*4882a593Smuzhiyun 			       0x3 << PCM1789_MUTE_SRET, 0) < 0)
140*4882a593Smuzhiyun 		dev_err(priv->dev, "Error while setting SRET");
141*4882a593Smuzhiyun }
142*4882a593Smuzhiyun 
pcm1789_trigger(struct snd_pcm_substream * substream,int cmd,struct snd_soc_dai * dai)143*4882a593Smuzhiyun static int pcm1789_trigger(struct snd_pcm_substream *substream, int cmd,
144*4882a593Smuzhiyun 			   struct snd_soc_dai *dai)
145*4882a593Smuzhiyun {
146*4882a593Smuzhiyun 	struct snd_soc_component *component = dai->component;
147*4882a593Smuzhiyun 	struct pcm1789_private *priv = snd_soc_component_get_drvdata(component);
148*4882a593Smuzhiyun 	int ret = 0;
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun 	switch (cmd) {
151*4882a593Smuzhiyun 	case SNDRV_PCM_TRIGGER_START:
152*4882a593Smuzhiyun 	case SNDRV_PCM_TRIGGER_RESUME:
153*4882a593Smuzhiyun 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
154*4882a593Smuzhiyun 		schedule_work(&priv->work);
155*4882a593Smuzhiyun 		break;
156*4882a593Smuzhiyun 	case SNDRV_PCM_TRIGGER_STOP:
157*4882a593Smuzhiyun 	case SNDRV_PCM_TRIGGER_SUSPEND:
158*4882a593Smuzhiyun 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
159*4882a593Smuzhiyun 		break;
160*4882a593Smuzhiyun 	default:
161*4882a593Smuzhiyun 		ret = -EINVAL;
162*4882a593Smuzhiyun 	}
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	return ret;
165*4882a593Smuzhiyun }
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun static const struct snd_soc_dai_ops pcm1789_dai_ops = {
168*4882a593Smuzhiyun 	.set_fmt	= pcm1789_set_dai_fmt,
169*4882a593Smuzhiyun 	.hw_params	= pcm1789_hw_params,
170*4882a593Smuzhiyun 	.mute_stream	= pcm1789_mute,
171*4882a593Smuzhiyun 	.trigger	= pcm1789_trigger,
172*4882a593Smuzhiyun 	.no_capture_mute = 1,
173*4882a593Smuzhiyun };
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun static const DECLARE_TLV_DB_SCALE(pcm1789_dac_tlv, -12000, 50, 1);
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun static const struct snd_kcontrol_new pcm1789_controls[] = {
178*4882a593Smuzhiyun 	SOC_DOUBLE_R_RANGE_TLV("DAC Playback Volume", PCM1789_DAC_VOL_LEFT,
179*4882a593Smuzhiyun 			       PCM1789_DAC_VOL_RIGHT, 0, 0xf, 0xff, 0,
180*4882a593Smuzhiyun 			       pcm1789_dac_tlv),
181*4882a593Smuzhiyun };
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun static const struct snd_soc_dapm_widget pcm1789_dapm_widgets[] = {
184*4882a593Smuzhiyun 	SND_SOC_DAPM_OUTPUT("IOUTL+"),
185*4882a593Smuzhiyun 	SND_SOC_DAPM_OUTPUT("IOUTL-"),
186*4882a593Smuzhiyun 	SND_SOC_DAPM_OUTPUT("IOUTR+"),
187*4882a593Smuzhiyun 	SND_SOC_DAPM_OUTPUT("IOUTR-"),
188*4882a593Smuzhiyun };
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun static const struct snd_soc_dapm_route pcm1789_dapm_routes[] = {
191*4882a593Smuzhiyun 	{ "IOUTL+", NULL, "Playback" },
192*4882a593Smuzhiyun 	{ "IOUTL-", NULL, "Playback" },
193*4882a593Smuzhiyun 	{ "IOUTR+", NULL, "Playback" },
194*4882a593Smuzhiyun 	{ "IOUTR-", NULL, "Playback" },
195*4882a593Smuzhiyun };
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun static struct snd_soc_dai_driver pcm1789_dai = {
198*4882a593Smuzhiyun 	.name = "pcm1789-hifi",
199*4882a593Smuzhiyun 	.playback = {
200*4882a593Smuzhiyun 		.stream_name = "Playback",
201*4882a593Smuzhiyun 		.channels_min = 2,
202*4882a593Smuzhiyun 		.channels_max = 2,
203*4882a593Smuzhiyun 		.rates = SNDRV_PCM_RATE_CONTINUOUS,
204*4882a593Smuzhiyun 		.rate_min = 10000,
205*4882a593Smuzhiyun 		.rate_max = 200000,
206*4882a593Smuzhiyun 		.formats = PCM1789_FORMATS,
207*4882a593Smuzhiyun 	},
208*4882a593Smuzhiyun 	.ops = &pcm1789_dai_ops,
209*4882a593Smuzhiyun };
210*4882a593Smuzhiyun 
211*4882a593Smuzhiyun const struct regmap_config pcm1789_regmap_config = {
212*4882a593Smuzhiyun 	.reg_bits		= 8,
213*4882a593Smuzhiyun 	.val_bits		= 8,
214*4882a593Smuzhiyun 	.max_register		= PCM1789_DAC_VOL_RIGHT,
215*4882a593Smuzhiyun 	.reg_defaults		= pcm1789_reg_defaults,
216*4882a593Smuzhiyun 	.num_reg_defaults	= ARRAY_SIZE(pcm1789_reg_defaults),
217*4882a593Smuzhiyun 	.writeable_reg		= pcm1789_writeable_reg,
218*4882a593Smuzhiyun 	.readable_reg		= pcm1789_accessible_reg,
219*4882a593Smuzhiyun };
220*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(pcm1789_regmap_config);
221*4882a593Smuzhiyun 
222*4882a593Smuzhiyun static const struct snd_soc_component_driver soc_component_dev_pcm1789 = {
223*4882a593Smuzhiyun 	.controls		= pcm1789_controls,
224*4882a593Smuzhiyun 	.num_controls		= ARRAY_SIZE(pcm1789_controls),
225*4882a593Smuzhiyun 	.dapm_widgets		= pcm1789_dapm_widgets,
226*4882a593Smuzhiyun 	.num_dapm_widgets	= ARRAY_SIZE(pcm1789_dapm_widgets),
227*4882a593Smuzhiyun 	.dapm_routes		= pcm1789_dapm_routes,
228*4882a593Smuzhiyun 	.num_dapm_routes	= ARRAY_SIZE(pcm1789_dapm_routes),
229*4882a593Smuzhiyun 	.idle_bias_on		= 1,
230*4882a593Smuzhiyun 	.use_pmdown_time	= 1,
231*4882a593Smuzhiyun 	.endianness		= 1,
232*4882a593Smuzhiyun 	.non_legacy_dai_naming	= 1,
233*4882a593Smuzhiyun };
234*4882a593Smuzhiyun 
pcm1789_common_init(struct device * dev,struct regmap * regmap)235*4882a593Smuzhiyun int pcm1789_common_init(struct device *dev, struct regmap *regmap)
236*4882a593Smuzhiyun {
237*4882a593Smuzhiyun 	struct pcm1789_private *pcm1789;
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	pcm1789 = devm_kzalloc(dev, sizeof(struct pcm1789_private),
240*4882a593Smuzhiyun 			       GFP_KERNEL);
241*4882a593Smuzhiyun 	if (!pcm1789)
242*4882a593Smuzhiyun 		return -ENOMEM;
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun 	pcm1789->regmap = regmap;
245*4882a593Smuzhiyun 	pcm1789->dev = dev;
246*4882a593Smuzhiyun 	dev_set_drvdata(dev, pcm1789);
247*4882a593Smuzhiyun 
248*4882a593Smuzhiyun 	pcm1789->reset = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
249*4882a593Smuzhiyun 	if (IS_ERR(pcm1789->reset))
250*4882a593Smuzhiyun 		return PTR_ERR(pcm1789->reset);
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun 	gpiod_set_value_cansleep(pcm1789->reset, 0);
253*4882a593Smuzhiyun 	msleep(300);
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun 	INIT_WORK(&pcm1789->work, pcm1789_work_queue);
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun 	return devm_snd_soc_register_component(dev, &soc_component_dev_pcm1789,
258*4882a593Smuzhiyun 					       &pcm1789_dai, 1);
259*4882a593Smuzhiyun }
260*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(pcm1789_common_init);
261*4882a593Smuzhiyun 
pcm1789_common_exit(struct device * dev)262*4882a593Smuzhiyun int pcm1789_common_exit(struct device *dev)
263*4882a593Smuzhiyun {
264*4882a593Smuzhiyun 	struct pcm1789_private *priv = dev_get_drvdata(dev);
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun 	flush_work(&priv->work);
267*4882a593Smuzhiyun 
268*4882a593Smuzhiyun 	return 0;
269*4882a593Smuzhiyun }
270*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(pcm1789_common_exit);
271*4882a593Smuzhiyun 
272*4882a593Smuzhiyun MODULE_DESCRIPTION("ASoC PCM1789 driver");
273*4882a593Smuzhiyun MODULE_AUTHOR("Mylène Josserand <mylene.josserand@free-electrons.com>");
274*4882a593Smuzhiyun MODULE_LICENSE("GPL");
275