1 // SPDX-License-Identifier: GPL-2.0-only
3 // rt1019.c -- RT1019 ALSA SoC audio amplifier driver
4 // Author: Jack Yu <jack.yu@realtek.com>
6 // Copyright(c) 2021 Realtek Semiconductor Corp.
10 #include <linux/acpi.h>
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <linux/init.h>
15 #include <linux/delay.h>
17 #include <linux/regmap.h>
18 #include <linux/i2c.h>
19 #include <linux/platform_device.h>
20 #include <linux/firmware.h>
21 #include <linux/gpio.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
28 #include <sound/tlv.h>
33 static const struct reg_default rt1019_reg[] = {
60 static bool rt1019_volatile_register(struct device *dev, unsigned int reg)
63 case RT1019_PWR_STRP_2:
65 case RT1019_VEND_ID_1:
66 case RT1019_VEND_ID_2:
76 static bool rt1019_readable_register(struct device *dev, unsigned int reg)
81 case RT1019_ASEL_CTRL:
82 case RT1019_PWR_STRP_2:
83 case RT1019_BEEP_TONE:
85 case RT1019_VEND_ID_1:
86 case RT1019_VEND_ID_2:
90 case RT1019_CLK_TREE_1:
91 case RT1019_CLK_TREE_2:
92 case RT1019_CLK_TREE_3:
99 case RT1019_DMIX_MONO_1:
100 case RT1019_DMIX_MONO_2:
109 static const DECLARE_TLV_DB_SCALE(dac_vol_tlv, -9525, 75, 0);
111 static const char * const rt1019_din_source_select[] = {
114 "Left + Right average",
117 static SOC_ENUM_SINGLE_DECL(rt1019_mono_lr_sel, RT1019_IDS_CTRL, 0,
118 rt1019_din_source_select);
120 static const struct snd_kcontrol_new rt1019_snd_controls[] = {
121 SOC_SINGLE_TLV("DAC Playback Volume", RT1019_DMIX_MONO_1, 0,
122 127, 0, dac_vol_tlv),
123 SOC_ENUM("Mono LR Select", rt1019_mono_lr_sel),
126 static int r1019_dac_event(struct snd_soc_dapm_widget *w,
127 struct snd_kcontrol *kcontrol, int event)
129 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
132 case SND_SOC_DAPM_PRE_PMU:
133 snd_soc_component_write(component, RT1019_SDB_CTRL, 0xb);
135 case SND_SOC_DAPM_POST_PMD:
136 snd_soc_component_write(component, RT1019_SDB_CTRL, 0xa);
145 static const struct snd_soc_dapm_widget rt1019_dapm_widgets[] = {
146 SND_SOC_DAPM_AIF_IN("AIFRX", "AIF Playback", 0, SND_SOC_NOPM, 0, 0),
147 SND_SOC_DAPM_DAC_E("DAC", NULL, SND_SOC_NOPM, 0, 0,
148 r1019_dac_event, SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
149 SND_SOC_DAPM_OUTPUT("SPO"),
152 static const struct snd_soc_dapm_route rt1019_dapm_routes[] = {
153 { "DAC", NULL, "AIFRX" },
154 { "SPO", NULL, "DAC" },
157 static int rt1019_hw_params(struct snd_pcm_substream *substream,
158 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
160 struct snd_soc_component *component = dai->component;
161 struct rt1019_priv *rt1019 = snd_soc_component_get_drvdata(component);
162 int pre_div, bclk_ms, frame_size;
163 unsigned int val_len = 0, sys_div_da_filter = 0;
164 unsigned int sys_dac_osr = 0, sys_fifo_clk = 0;
165 unsigned int sys_clk_cal = 0, sys_asrc_in = 0;
167 rt1019->lrck = params_rate(params);
168 pre_div = rl6231_get_clk_info(rt1019->sysclk, rt1019->lrck);
170 dev_err(component->dev, "Unsupported clock setting\n");
174 frame_size = snd_soc_params_to_frame_size(params);
175 if (frame_size < 0) {
176 dev_err(component->dev, "Unsupported frame size: %d\n", frame_size);
180 bclk_ms = frame_size > 32;
181 rt1019->bclk = rt1019->lrck * (32 << bclk_ms);
183 dev_dbg(dai->dev, "bclk is %dHz and lrck is %dHz\n",
184 rt1019->bclk, rt1019->lrck);
185 dev_dbg(dai->dev, "bclk_ms is %d and pre_div is %d for iis %d\n",
186 bclk_ms, pre_div, dai->id);
190 sys_div_da_filter = RT1019_SYS_DIV_DA_FIL_DIV1;
191 sys_dac_osr = RT1019_SYS_DA_OSR_DIV1;
192 sys_asrc_in = RT1019_ASRC_256FS_DIV1;
193 sys_fifo_clk = RT1019_SEL_FIFO_DIV1;
194 sys_clk_cal = RT1019_SEL_CLK_CAL_DIV1;
197 sys_div_da_filter = RT1019_SYS_DIV_DA_FIL_DIV2;
198 sys_dac_osr = RT1019_SYS_DA_OSR_DIV2;
199 sys_asrc_in = RT1019_ASRC_256FS_DIV2;
200 sys_fifo_clk = RT1019_SEL_FIFO_DIV2;
201 sys_clk_cal = RT1019_SEL_CLK_CAL_DIV2;
204 sys_div_da_filter = RT1019_SYS_DIV_DA_FIL_DIV4;
205 sys_dac_osr = RT1019_SYS_DA_OSR_DIV4;
206 sys_asrc_in = RT1019_ASRC_256FS_DIV4;
207 sys_fifo_clk = RT1019_SEL_FIFO_DIV4;
208 sys_clk_cal = RT1019_SEL_CLK_CAL_DIV4;
214 switch (params_width(params)) {
218 val_len = RT1019_I2S_DL_20;
221 val_len = RT1019_I2S_DL_24;
224 val_len = RT1019_I2S_DL_32;
227 val_len = RT1019_I2S_DL_8;
233 snd_soc_component_update_bits(component, RT1019_TDM_2, RT1019_I2S_DL_MASK,
235 snd_soc_component_update_bits(component, RT1019_CLK_TREE_1,
236 RT1019_SEL_FIFO_MASK, sys_fifo_clk);
237 snd_soc_component_update_bits(component, RT1019_CLK_TREE_2,
238 RT1019_SYS_DIV_DA_FIL_MASK | RT1019_SYS_DA_OSR_MASK |
239 RT1019_ASRC_256FS_MASK, sys_div_da_filter | sys_dac_osr |
241 snd_soc_component_update_bits(component, RT1019_CLK_TREE_3,
242 RT1019_SEL_CLK_CAL_MASK, sys_clk_cal);
247 static int rt1019_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt)
249 struct snd_soc_component *component = dai->component;
250 unsigned int reg_val = 0, reg_val2 = 0;
252 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
253 case SND_SOC_DAIFMT_NB_NF:
255 case SND_SOC_DAIFMT_IB_NF:
256 reg_val2 |= RT1019_TDM_BCLK_INV;
262 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
263 case SND_SOC_DAIFMT_I2S:
266 case SND_SOC_DAIFMT_LEFT_J:
267 reg_val |= RT1019_I2S_DF_LEFT;
270 case SND_SOC_DAIFMT_DSP_A:
271 reg_val |= RT1019_I2S_DF_PCM_A_R;
274 case SND_SOC_DAIFMT_DSP_B:
275 reg_val |= RT1019_I2S_DF_PCM_B_R;
282 snd_soc_component_update_bits(component, RT1019_TDM_2,
283 RT1019_I2S_DF_MASK, reg_val);
284 snd_soc_component_update_bits(component, RT1019_TDM_1,
285 RT1019_TDM_BCLK_MASK, reg_val2);
290 static int rt1019_set_dai_sysclk(struct snd_soc_dai *dai,
291 int clk_id, unsigned int freq, int dir)
293 struct snd_soc_component *component = dai->component;
294 struct rt1019_priv *rt1019 = snd_soc_component_get_drvdata(component);
295 unsigned int reg_val = 0;
297 if (freq == rt1019->sysclk && clk_id == rt1019->sysclk_src)
301 case RT1019_SCLK_S_BCLK:
302 reg_val |= RT1019_CLK_SYS_PRE_SEL_BCLK;
305 case RT1019_SCLK_S_PLL:
306 reg_val |= RT1019_CLK_SYS_PRE_SEL_PLL;
310 dev_err(component->dev, "Invalid clock id (%d)\n", clk_id);
314 rt1019->sysclk = freq;
315 rt1019->sysclk_src = clk_id;
317 dev_dbg(dai->dev, "Sysclk is %dHz and clock id is %d\n", freq, clk_id);
319 snd_soc_component_update_bits(component, RT1019_CLK_TREE_1,
320 RT1019_CLK_SYS_PRE_SEL_MASK, reg_val);
325 static int rt1019_set_dai_pll(struct snd_soc_dai *dai, int pll_id, int source,
326 unsigned int freq_in, unsigned int freq_out)
328 struct snd_soc_component *component = dai->component;
329 struct rt1019_priv *rt1019 = snd_soc_component_get_drvdata(component);
330 struct rl6231_pll_code pll_code;
333 if (!freq_in || !freq_out) {
334 dev_dbg(component->dev, "PLL disabled\n");
340 if (source == rt1019->pll_src && freq_in == rt1019->pll_in &&
341 freq_out == rt1019->pll_out)
345 case RT1019_PLL_S_BCLK:
346 snd_soc_component_update_bits(component, RT1019_CLK_TREE_1,
347 RT1019_PLL_SRC_MASK, RT1019_PLL_SRC_SEL_BCLK);
350 case RT1019_PLL_S_RC25M:
351 snd_soc_component_update_bits(component, RT1019_CLK_TREE_1,
352 RT1019_PLL_SRC_MASK, RT1019_PLL_SRC_SEL_RC);
356 dev_err(component->dev, "Unknown PLL source %d\n", source);
360 ret = rl6231_pll_calc(freq_in, freq_out, &pll_code);
362 dev_err(component->dev, "Unsupported input clock %d\n", freq_in);
366 dev_dbg(component->dev, "bypass=%d m=%d n=%d k=%d\n",
367 pll_code.m_bp, (pll_code.m_bp ? 0 : pll_code.m_code),
368 pll_code.n_code, pll_code.k_code);
370 snd_soc_component_update_bits(component, RT1019_PWR_STRP_2,
371 RT1019_AUTO_BITS_SEL_MASK | RT1019_AUTO_CLK_SEL_MASK,
372 RT1019_AUTO_BITS_SEL_MANU | RT1019_AUTO_CLK_SEL_MANU);
373 snd_soc_component_update_bits(component, RT1019_PLL_1,
374 RT1019_PLL_M_MASK | RT1019_PLL_M_BP_MASK | RT1019_PLL_Q_8_8_MASK,
375 ((pll_code.m_bp ? 0 : pll_code.m_code) << RT1019_PLL_M_SFT) |
376 (pll_code.m_bp << RT1019_PLL_M_BP_SFT) |
377 ((pll_code.n_code >> 8) & RT1019_PLL_Q_8_8_MASK));
378 snd_soc_component_update_bits(component, RT1019_PLL_2,
379 RT1019_PLL_Q_7_0_MASK, pll_code.n_code & RT1019_PLL_Q_7_0_MASK);
380 snd_soc_component_update_bits(component, RT1019_PLL_3,
381 RT1019_PLL_K_MASK, pll_code.k_code);
383 rt1019->pll_in = freq_in;
384 rt1019->pll_out = freq_out;
385 rt1019->pll_src = source;
390 static int rt1019_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
391 unsigned int rx_mask, int slots, int slot_width)
393 struct snd_soc_component *component = dai->component;
394 unsigned int val = 0, rx_slotnum;
395 int ret = 0, first_bit;
399 val |= RT1019_I2S_TX_4CH;
402 val |= RT1019_I2S_TX_6CH;
405 val |= RT1019_I2S_TX_8CH;
413 switch (slot_width) {
415 val |= RT1019_I2S_DL_20;
418 val |= RT1019_I2S_DL_24;
421 val |= RT1019_I2S_DL_32;
424 val |= RT1019_I2S_DL_8;
432 /* Rx slot configuration */
433 rx_slotnum = hweight_long(rx_mask);
434 if (rx_slotnum != 1) {
436 dev_err(component->dev, "too many rx slots or zero slot\n");
439 /* This is an assumption that the system sends stereo audio to the
440 * amplifier typically. And the stereo audio is placed in slot 0/2/4/6
441 * as the starting slot. The users could select the channel from
442 * L/R/L+R by "Mono LR Select" control.
444 first_bit = __ffs(rx_mask);
450 snd_soc_component_update_bits(component,
452 RT1019_TDM_I2S_TX_L_DAC1_1_MASK |
453 RT1019_TDM_I2S_TX_R_DAC1_1_MASK,
454 (first_bit << RT1019_TDM_I2S_TX_L_DAC1_1_SFT) |
455 ((first_bit + 1) << RT1019_TDM_I2S_TX_R_DAC1_1_SFT));
461 snd_soc_component_update_bits(component,
463 RT1019_TDM_I2S_TX_L_DAC1_1_MASK |
464 RT1019_TDM_I2S_TX_R_DAC1_1_MASK,
465 ((first_bit - 1) << RT1019_TDM_I2S_TX_L_DAC1_1_SFT) |
466 (first_bit << RT1019_TDM_I2S_TX_R_DAC1_1_SFT));
473 snd_soc_component_update_bits(component, RT1019_TDM_2,
474 RT1019_I2S_CH_TX_MASK | RT1019_I2S_DF_MASK, val);
480 static int rt1019_probe(struct snd_soc_component *component)
482 struct rt1019_priv *rt1019 = snd_soc_component_get_drvdata(component);
484 rt1019->component = component;
485 snd_soc_component_write(component, RT1019_SDB_CTRL, 0xa);
490 #define RT1019_STEREO_RATES SNDRV_PCM_RATE_8000_192000
491 #define RT1019_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
492 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S8)
494 static const struct snd_soc_dai_ops rt1019_aif_dai_ops = {
495 .hw_params = rt1019_hw_params,
496 .set_fmt = rt1019_set_dai_fmt,
497 .set_sysclk = rt1019_set_dai_sysclk,
498 .set_pll = rt1019_set_dai_pll,
499 .set_tdm_slot = rt1019_set_tdm_slot,
502 static struct snd_soc_dai_driver rt1019_dai[] = {
504 .name = "rt1019-aif",
507 .stream_name = "AIF Playback",
510 .rates = RT1019_STEREO_RATES,
511 .formats = RT1019_FORMATS,
513 .ops = &rt1019_aif_dai_ops,
517 static const struct snd_soc_component_driver soc_component_dev_rt1019 = {
518 .probe = rt1019_probe,
519 .controls = rt1019_snd_controls,
520 .num_controls = ARRAY_SIZE(rt1019_snd_controls),
521 .dapm_widgets = rt1019_dapm_widgets,
522 .num_dapm_widgets = ARRAY_SIZE(rt1019_dapm_widgets),
523 .dapm_routes = rt1019_dapm_routes,
524 .num_dapm_routes = ARRAY_SIZE(rt1019_dapm_routes),
525 .non_legacy_dai_naming = 1,
528 static const struct regmap_config rt1019_regmap = {
531 .use_single_read = true,
532 .use_single_write = true,
533 .max_register = RT1019_BEEP_2,
534 .volatile_reg = rt1019_volatile_register,
535 .readable_reg = rt1019_readable_register,
536 .cache_type = REGCACHE_RBTREE,
537 .reg_defaults = rt1019_reg,
538 .num_reg_defaults = ARRAY_SIZE(rt1019_reg),
541 static const struct i2c_device_id rt1019_i2c_id[] = {
545 MODULE_DEVICE_TABLE(i2c, rt1019_i2c_id);
547 static const struct of_device_id rt1019_of_match[] = {
548 { .compatible = "realtek,rt1019", },
551 MODULE_DEVICE_TABLE(of, rt1019_of_match);
554 static const struct acpi_device_id rt1019_acpi_match[] = {
558 MODULE_DEVICE_TABLE(acpi, rt1019_acpi_match);
561 static int rt1019_i2c_probe(struct i2c_client *i2c,
562 const struct i2c_device_id *id)
564 struct rt1019_priv *rt1019;
566 unsigned int val, val2, dev_id;
568 rt1019 = devm_kzalloc(&i2c->dev, sizeof(struct rt1019_priv),
573 i2c_set_clientdata(i2c, rt1019);
575 rt1019->regmap = devm_regmap_init_i2c(i2c, &rt1019_regmap);
576 if (IS_ERR(rt1019->regmap)) {
577 ret = PTR_ERR(rt1019->regmap);
578 dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
583 regmap_read(rt1019->regmap, RT1019_DEV_ID_1, &val);
584 regmap_read(rt1019->regmap, RT1019_DEV_ID_2, &val2);
585 dev_id = val << 8 | val2;
586 if (dev_id != RT1019_DEVICE_ID_VAL && dev_id != RT1019_DEVICE_ID_VAL2) {
588 "Device with ID register 0x%x is not rt1019\n", dev_id);
592 return devm_snd_soc_register_component(&i2c->dev,
593 &soc_component_dev_rt1019, rt1019_dai, ARRAY_SIZE(rt1019_dai));
596 static struct i2c_driver rt1019_i2c_driver = {
599 .of_match_table = of_match_ptr(rt1019_of_match),
600 .acpi_match_table = ACPI_PTR(rt1019_acpi_match),
602 .probe = rt1019_i2c_probe,
603 .id_table = rt1019_i2c_id,
605 module_i2c_driver(rt1019_i2c_driver);
607 MODULE_DESCRIPTION("ASoC RT1019 driver");
608 MODULE_AUTHOR("Jack Yu <jack.yu@realtek.com>");
609 MODULE_LICENSE("GPL v2");