xref: /openbmc/linux/sound/soc/codecs/rt5682-i2c.c (revision a1117495)
1 // SPDX-License-Identifier: GPL-2.0-only
2 //
3 // rt5682.c  --  RT5682 ALSA SoC audio component driver
4 //
5 // Copyright 2018 Realtek Semiconductor Corp.
6 // Author: Bard Liao <bardliao@realtek.com>
7 //
8 
9 #include <linux/module.h>
10 #include <linux/moduleparam.h>
11 #include <linux/init.h>
12 #include <linux/delay.h>
13 #include <linux/pm.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/i2c.h>
16 #include <linux/platform_device.h>
17 #include <linux/spi/spi.h>
18 #include <linux/acpi.h>
19 #include <linux/gpio.h>
20 #include <linux/of_gpio.h>
21 #include <linux/mutex.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/jack.h>
26 #include <sound/soc.h>
27 #include <sound/soc-dapm.h>
28 #include <sound/initval.h>
29 #include <sound/tlv.h>
30 #include <sound/rt5682.h>
31 
32 #include "rl6231.h"
33 #include "rt5682.h"
34 
35 static const struct rt5682_platform_data i2s_default_platform_data = {
36 	.dmic1_data_pin = RT5682_DMIC1_DATA_GPIO2,
37 	.dmic1_clk_pin = RT5682_DMIC1_CLK_GPIO3,
38 	.jd_src = RT5682_JD1,
39 	.btndet_delay = 16,
40 	.dai_clk_names[RT5682_DAI_WCLK_IDX] = "rt5682-dai-wclk",
41 	.dai_clk_names[RT5682_DAI_BCLK_IDX] = "rt5682-dai-bclk",
42 };
43 
44 static const struct regmap_config rt5682_regmap = {
45 	.reg_bits = 16,
46 	.val_bits = 16,
47 	.max_register = RT5682_I2C_MODE,
48 	.volatile_reg = rt5682_volatile_register,
49 	.readable_reg = rt5682_readable_register,
50 	.cache_type = REGCACHE_RBTREE,
51 	.reg_defaults = rt5682_reg,
52 	.num_reg_defaults = RT5682_REG_NUM,
53 	.use_single_read = true,
54 	.use_single_write = true,
55 };
56 
57 static void rt5682_jd_check_handler(struct work_struct *work)
58 {
59 	struct rt5682_priv *rt5682 = container_of(work, struct rt5682_priv,
60 		jd_check_work.work);
61 
62 	if (snd_soc_component_read(rt5682->component, RT5682_AJD1_CTRL)
63 		& RT5682_JDH_RS_MASK) {
64 		/* jack out */
65 		rt5682->jack_type = rt5682_headset_detect(rt5682->component, 0);
66 
67 		snd_soc_jack_report(rt5682->hs_jack, rt5682->jack_type,
68 			SND_JACK_HEADSET |
69 			SND_JACK_BTN_0 | SND_JACK_BTN_1 |
70 			SND_JACK_BTN_2 | SND_JACK_BTN_3);
71 	} else {
72 		schedule_delayed_work(&rt5682->jd_check_work, 500);
73 	}
74 }
75 
76 static irqreturn_t rt5682_irq(int irq, void *data)
77 {
78 	struct rt5682_priv *rt5682 = data;
79 
80 	mod_delayed_work(system_power_efficient_wq,
81 		&rt5682->jack_detect_work, msecs_to_jiffies(rt5682->irq_work_delay_time));
82 
83 	return IRQ_HANDLED;
84 }
85 
86 static struct snd_soc_dai_driver rt5682_dai[] = {
87 	{
88 		.name = "rt5682-aif1",
89 		.id = RT5682_AIF1,
90 		.playback = {
91 			.stream_name = "AIF1 Playback",
92 			.channels_min = 1,
93 			.channels_max = 2,
94 			.rates = RT5682_STEREO_RATES,
95 			.formats = RT5682_FORMATS,
96 		},
97 		.capture = {
98 			.stream_name = "AIF1 Capture",
99 			.channels_min = 1,
100 			.channels_max = 2,
101 			.rates = RT5682_STEREO_RATES,
102 			.formats = RT5682_FORMATS,
103 		},
104 		.ops = &rt5682_aif1_dai_ops,
105 	},
106 	{
107 		.name = "rt5682-aif2",
108 		.id = RT5682_AIF2,
109 		.capture = {
110 			.stream_name = "AIF2 Capture",
111 			.channels_min = 1,
112 			.channels_max = 2,
113 			.rates = RT5682_STEREO_RATES,
114 			.formats = RT5682_FORMATS,
115 		},
116 		.ops = &rt5682_aif2_dai_ops,
117 	},
118 };
119 
120 static void rt5682_i2c_disable_regulators(void *data)
121 {
122 	struct rt5682_priv *rt5682 = data;
123 
124 	regulator_bulk_disable(ARRAY_SIZE(rt5682->supplies), rt5682->supplies);
125 }
126 
127 static int rt5682_i2c_probe(struct i2c_client *i2c,
128 		const struct i2c_device_id *id)
129 {
130 	struct rt5682_platform_data *pdata = dev_get_platdata(&i2c->dev);
131 	struct rt5682_priv *rt5682;
132 	int i, ret;
133 	unsigned int val;
134 
135 	rt5682 = devm_kzalloc(&i2c->dev, sizeof(struct rt5682_priv),
136 		GFP_KERNEL);
137 	if (!rt5682)
138 		return -ENOMEM;
139 
140 	i2c_set_clientdata(i2c, rt5682);
141 
142 	rt5682->i2c_dev = &i2c->dev;
143 
144 	rt5682->pdata = i2s_default_platform_data;
145 
146 	if (pdata)
147 		rt5682->pdata = *pdata;
148 	else
149 		rt5682_parse_dt(rt5682, &i2c->dev);
150 
151 	rt5682->regmap = devm_regmap_init_i2c(i2c, &rt5682_regmap);
152 	if (IS_ERR(rt5682->regmap)) {
153 		ret = PTR_ERR(rt5682->regmap);
154 		dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
155 			ret);
156 		return ret;
157 	}
158 
159 	for (i = 0; i < ARRAY_SIZE(rt5682->supplies); i++)
160 		rt5682->supplies[i].supply = rt5682_supply_names[i];
161 
162 	ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(rt5682->supplies),
163 				      rt5682->supplies);
164 	if (ret) {
165 		dev_err(&i2c->dev, "Failed to request supplies: %d\n", ret);
166 		return ret;
167 	}
168 
169 	ret = devm_add_action_or_reset(&i2c->dev, rt5682_i2c_disable_regulators,
170 				       rt5682);
171 	if (ret)
172 		return ret;
173 
174 	ret = regulator_bulk_enable(ARRAY_SIZE(rt5682->supplies),
175 				    rt5682->supplies);
176 	if (ret) {
177 		dev_err(&i2c->dev, "Failed to enable supplies: %d\n", ret);
178 		return ret;
179 	}
180 
181 	if (gpio_is_valid(rt5682->pdata.ldo1_en)) {
182 		if (devm_gpio_request_one(&i2c->dev, rt5682->pdata.ldo1_en,
183 					  GPIOF_OUT_INIT_HIGH, "rt5682"))
184 			dev_err(&i2c->dev, "Fail gpio_request gpio_ldo\n");
185 	}
186 
187 	/* Sleep for 300 ms miniumum */
188 	usleep_range(300000, 350000);
189 
190 	regmap_write(rt5682->regmap, RT5682_I2C_MODE, 0x1);
191 	usleep_range(10000, 15000);
192 
193 	regmap_read(rt5682->regmap, RT5682_DEVICE_ID, &val);
194 	if (val != DEVICE_ID) {
195 		dev_err(&i2c->dev,
196 			"Device with ID register %x is not rt5682\n", val);
197 		return -ENODEV;
198 	}
199 
200 	mutex_init(&rt5682->calibrate_mutex);
201 	rt5682_calibrate(rt5682);
202 
203 	rt5682_apply_patch_list(rt5682, &i2c->dev);
204 
205 	regmap_write(rt5682->regmap, RT5682_DEPOP_1, 0x0000);
206 
207 	/* DMIC pin*/
208 	if (rt5682->pdata.dmic1_data_pin != RT5682_DMIC1_NULL) {
209 		switch (rt5682->pdata.dmic1_data_pin) {
210 		case RT5682_DMIC1_DATA_GPIO2: /* share with LRCK2 */
211 			regmap_update_bits(rt5682->regmap, RT5682_DMIC_CTRL_1,
212 				RT5682_DMIC_1_DP_MASK, RT5682_DMIC_1_DP_GPIO2);
213 			regmap_update_bits(rt5682->regmap, RT5682_GPIO_CTRL_1,
214 				RT5682_GP2_PIN_MASK, RT5682_GP2_PIN_DMIC_SDA);
215 			break;
216 
217 		case RT5682_DMIC1_DATA_GPIO5: /* share with DACDAT1 */
218 			regmap_update_bits(rt5682->regmap, RT5682_DMIC_CTRL_1,
219 				RT5682_DMIC_1_DP_MASK, RT5682_DMIC_1_DP_GPIO5);
220 			regmap_update_bits(rt5682->regmap, RT5682_GPIO_CTRL_1,
221 				RT5682_GP5_PIN_MASK, RT5682_GP5_PIN_DMIC_SDA);
222 			break;
223 
224 		default:
225 			dev_warn(&i2c->dev, "invalid DMIC_DAT pin\n");
226 			break;
227 		}
228 
229 		switch (rt5682->pdata.dmic1_clk_pin) {
230 		case RT5682_DMIC1_CLK_GPIO1: /* share with IRQ */
231 			regmap_update_bits(rt5682->regmap, RT5682_GPIO_CTRL_1,
232 				RT5682_GP1_PIN_MASK, RT5682_GP1_PIN_DMIC_CLK);
233 			break;
234 
235 		case RT5682_DMIC1_CLK_GPIO3: /* share with BCLK2 */
236 			regmap_update_bits(rt5682->regmap, RT5682_GPIO_CTRL_1,
237 				RT5682_GP3_PIN_MASK, RT5682_GP3_PIN_DMIC_CLK);
238 			if (rt5682->pdata.dmic_clk_driving_high)
239 				regmap_update_bits(rt5682->regmap,
240 					RT5682_PAD_DRIVING_CTRL,
241 					RT5682_PAD_DRV_GP3_MASK,
242 					2 << RT5682_PAD_DRV_GP3_SFT);
243 			break;
244 
245 		default:
246 			dev_warn(&i2c->dev, "invalid DMIC_CLK pin\n");
247 			break;
248 		}
249 	}
250 
251 	regmap_update_bits(rt5682->regmap, RT5682_PWR_ANLG_1,
252 		RT5682_LDO1_DVO_MASK | RT5682_HP_DRIVER_MASK,
253 		RT5682_LDO1_DVO_12 | RT5682_HP_DRIVER_5X);
254 	regmap_write(rt5682->regmap, RT5682_MICBIAS_2, 0x0080);
255 	regmap_update_bits(rt5682->regmap, RT5682_GPIO_CTRL_1,
256 		RT5682_GP4_PIN_MASK | RT5682_GP5_PIN_MASK,
257 		RT5682_GP4_PIN_ADCDAT1 | RT5682_GP5_PIN_DACDAT1);
258 	regmap_write(rt5682->regmap, RT5682_TEST_MODE_CTRL_1, 0x0000);
259 	regmap_update_bits(rt5682->regmap, RT5682_BIAS_CUR_CTRL_8,
260 		RT5682_HPA_CP_BIAS_CTRL_MASK, RT5682_HPA_CP_BIAS_3UA);
261 	regmap_update_bits(rt5682->regmap, RT5682_CHARGE_PUMP_1,
262 		RT5682_CP_CLK_HP_MASK, RT5682_CP_CLK_HP_300KHZ);
263 	regmap_update_bits(rt5682->regmap, RT5682_HP_CHARGE_PUMP_1,
264 		RT5682_PM_HP_MASK, RT5682_PM_HP_HV);
265 	regmap_update_bits(rt5682->regmap, RT5682_DMIC_CTRL_1,
266 		RT5682_FIFO_CLK_DIV_MASK, RT5682_FIFO_CLK_DIV_2);
267 
268 	INIT_DELAYED_WORK(&rt5682->jack_detect_work,
269 		rt5682_jack_detect_handler);
270 	INIT_DELAYED_WORK(&rt5682->jd_check_work,
271 		rt5682_jd_check_handler);
272 
273 	if (i2c->irq) {
274 		ret = devm_request_threaded_irq(&i2c->dev, i2c->irq, NULL,
275 			rt5682_irq, IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING
276 			| IRQF_ONESHOT, "rt5682", rt5682);
277 		if (ret)
278 			dev_err(&i2c->dev, "Failed to reguest IRQ: %d\n", ret);
279 	}
280 
281 #ifdef CONFIG_COMMON_CLK
282 	/* Check if MCLK provided */
283 	rt5682->mclk = devm_clk_get_optional(&i2c->dev, "mclk");
284 	if (IS_ERR(rt5682->mclk))
285 		return PTR_ERR(rt5682->mclk);
286 
287 	/* Register CCF DAI clock control */
288 	ret = rt5682_register_dai_clks(rt5682);
289 	if (ret)
290 		return ret;
291 
292 	/* Initial setup for CCF */
293 	rt5682->lrck[RT5682_AIF1] = 48000;
294 #endif
295 
296 	return devm_snd_soc_register_component(&i2c->dev,
297 					       &rt5682_soc_component_dev,
298 					       rt5682_dai, ARRAY_SIZE(rt5682_dai));
299 }
300 
301 static void rt5682_i2c_shutdown(struct i2c_client *client)
302 {
303 	struct rt5682_priv *rt5682 = i2c_get_clientdata(client);
304 
305 	disable_irq(client->irq);
306 	cancel_delayed_work_sync(&rt5682->jack_detect_work);
307 	cancel_delayed_work_sync(&rt5682->jd_check_work);
308 
309 	rt5682_reset(rt5682);
310 }
311 
312 static int rt5682_i2c_remove(struct i2c_client *client)
313 {
314 	rt5682_i2c_shutdown(client);
315 
316 	return 0;
317 }
318 
319 static const struct of_device_id rt5682_of_match[] = {
320 	{.compatible = "realtek,rt5682i"},
321 	{},
322 };
323 MODULE_DEVICE_TABLE(of, rt5682_of_match);
324 
325 static const struct acpi_device_id rt5682_acpi_match[] = {
326 	{"10EC5682", 0,},
327 	{},
328 };
329 MODULE_DEVICE_TABLE(acpi, rt5682_acpi_match);
330 
331 static const struct i2c_device_id rt5682_i2c_id[] = {
332 	{"rt5682", 0},
333 	{}
334 };
335 MODULE_DEVICE_TABLE(i2c, rt5682_i2c_id);
336 
337 static struct i2c_driver rt5682_i2c_driver = {
338 	.driver = {
339 		.name = "rt5682",
340 		.of_match_table = rt5682_of_match,
341 		.acpi_match_table = rt5682_acpi_match,
342 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
343 	},
344 	.probe = rt5682_i2c_probe,
345 	.remove = rt5682_i2c_remove,
346 	.shutdown = rt5682_i2c_shutdown,
347 	.id_table = rt5682_i2c_id,
348 };
349 module_i2c_driver(rt5682_i2c_driver);
350 
351 MODULE_DESCRIPTION("ASoC RT5682 driver");
352 MODULE_AUTHOR("Bard Liao <bardliao@realtek.com>");
353 MODULE_LICENSE("GPL v2");
354