1 // SPDX-License-Identifier: (GPL-2.0 OR MIT)
3 // Copyright (c) 2018 BayLibre, SAS.
4 // Author: Jerome Brunet <jbrunet@baylibre.com>
6 #include <linux/bitfield.h>
8 #include <linux/module.h>
9 #include <linux/of_platform.h>
10 #include <linux/regmap.h>
11 #include <sound/soc.h>
12 #include <sound/soc-dai.h>
13 #include <sound/pcm_params.h>
15 #define SPDIFIN_CTRL0 0x00
16 #define SPDIFIN_CTRL0_EN BIT(31)
17 #define SPDIFIN_CTRL0_RST_OUT BIT(29)
18 #define SPDIFIN_CTRL0_RST_IN BIT(28)
19 #define SPDIFIN_CTRL0_WIDTH_SEL BIT(24)
20 #define SPDIFIN_CTRL0_STATUS_CH_SHIFT 11
21 #define SPDIFIN_CTRL0_STATUS_SEL GENMASK(10, 8)
22 #define SPDIFIN_CTRL0_SRC_SEL GENMASK(5, 4)
23 #define SPDIFIN_CTRL0_CHK_VALID BIT(3)
24 #define SPDIFIN_CTRL1 0x04
25 #define SPDIFIN_CTRL1_BASE_TIMER GENMASK(19, 0)
26 #define SPDIFIN_CTRL1_IRQ_MASK GENMASK(27, 20)
27 #define SPDIFIN_CTRL2 0x08
28 #define SPDIFIN_THRES_PER_REG 3
29 #define SPDIFIN_THRES_WIDTH 10
30 #define SPDIFIN_CTRL3 0x0c
31 #define SPDIFIN_CTRL4 0x10
32 #define SPDIFIN_TIMER_PER_REG 4
33 #define SPDIFIN_TIMER_WIDTH 8
34 #define SPDIFIN_CTRL5 0x14
35 #define SPDIFIN_CTRL6 0x18
36 #define SPDIFIN_STAT0 0x1c
37 #define SPDIFIN_STAT0_MODE GENMASK(30, 28)
38 #define SPDIFIN_STAT0_MAXW GENMASK(17, 8)
39 #define SPDIFIN_STAT0_IRQ GENMASK(7, 0)
40 #define SPDIFIN_IRQ_MODE_CHANGED BIT(2)
41 #define SPDIFIN_STAT1 0x20
42 #define SPDIFIN_STAT2 0x24
43 #define SPDIFIN_MUTE_VAL 0x28
45 #define SPDIFIN_MODE_NUM 7
47 struct axg_spdifin_cfg
{
48 const unsigned int *mode_rates
;
49 unsigned int ref_rate
;
53 const struct axg_spdifin_cfg
*conf
;
61 * It would have been nice to check the actual rate against the sample rate
62 * requested in hw_params(). Unfortunately, I was not able to make the mode
63 * detection and IRQ work reliably:
65 * 1. IRQs are generated on mode change only, so there is no notification
66 * on transition between no signal and mode 0 (32kHz).
67 * 2. Mode detection very often has glitches, and may detects the
68 * lowest or the highest mode before zeroing in on the actual mode.
70 * This makes calling snd_pcm_stop() difficult to get right. Even notifying
71 * the kcontrol would be very unreliable at this point.
72 * Let's keep things simple until the magic spell that makes this work is
76 static unsigned int axg_spdifin_get_rate(struct axg_spdifin
*priv
)
78 unsigned int stat
, mode
, rate
= 0;
80 regmap_read(priv
->map
, SPDIFIN_STAT0
, &stat
);
81 mode
= FIELD_GET(SPDIFIN_STAT0_MODE
, stat
);
84 * If max width is zero, we are not capturing anything.
85 * Also Sometimes, when the capture is on but there is no data,
86 * mode is SPDIFIN_MODE_NUM, but not always ...
88 if (FIELD_GET(SPDIFIN_STAT0_MAXW
, stat
) &&
89 mode
< SPDIFIN_MODE_NUM
)
90 rate
= priv
->conf
->mode_rates
[mode
];
95 static int axg_spdifin_prepare(struct snd_pcm_substream
*substream
,
96 struct snd_soc_dai
*dai
)
98 struct axg_spdifin
*priv
= snd_soc_dai_get_drvdata(dai
);
100 /* Apply both reset */
101 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
,
102 SPDIFIN_CTRL0_RST_OUT
|
103 SPDIFIN_CTRL0_RST_IN
,
106 /* Clear out reset before in reset */
107 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
,
108 SPDIFIN_CTRL0_RST_OUT
, SPDIFIN_CTRL0_RST_OUT
);
109 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
,
110 SPDIFIN_CTRL0_RST_IN
, SPDIFIN_CTRL0_RST_IN
);
115 static void axg_spdifin_write_mode_param(struct regmap
*map
, int mode
,
117 unsigned int num_per_reg
,
118 unsigned int base_reg
,
121 uint64_t offset
= mode
;
122 unsigned int reg
, shift
, rem
;
124 rem
= do_div(offset
, num_per_reg
);
126 reg
= offset
* regmap_get_reg_stride(map
) + base_reg
;
127 shift
= width
* (num_per_reg
- 1 - rem
);
129 regmap_update_bits(map
, reg
, GENMASK(width
- 1, 0) << shift
,
133 static void axg_spdifin_write_timer(struct regmap
*map
, int mode
,
136 axg_spdifin_write_mode_param(map
, mode
, val
, SPDIFIN_TIMER_PER_REG
,
137 SPDIFIN_CTRL4
, SPDIFIN_TIMER_WIDTH
);
140 static void axg_spdifin_write_threshold(struct regmap
*map
, int mode
,
143 axg_spdifin_write_mode_param(map
, mode
, val
, SPDIFIN_THRES_PER_REG
,
144 SPDIFIN_CTRL2
, SPDIFIN_THRES_WIDTH
);
147 static unsigned int axg_spdifin_mode_timer(struct axg_spdifin
*priv
,
152 * Number of period of the reference clock during a period of the
153 * input signal reference clock
155 return rate
/ (128 * priv
->conf
->mode_rates
[mode
]);
158 static int axg_spdifin_sample_mode_config(struct snd_soc_dai
*dai
,
159 struct axg_spdifin
*priv
)
161 unsigned int rate
, t_next
;
162 int ret
, i
= SPDIFIN_MODE_NUM
- 1;
164 /* Set spdif input reference clock */
165 ret
= clk_set_rate(priv
->refclk
, priv
->conf
->ref_rate
);
167 dev_err(dai
->dev
, "reference clock rate set failed\n");
172 * The rate actually set might be slightly different, get
173 * the actual rate for the following mode calculation
175 rate
= clk_get_rate(priv
->refclk
);
177 /* HW will update mode every 1ms */
178 regmap_update_bits(priv
->map
, SPDIFIN_CTRL1
,
179 SPDIFIN_CTRL1_BASE_TIMER
,
180 FIELD_PREP(SPDIFIN_CTRL1_BASE_TIMER
, rate
/ 1000));
182 /* Threshold based on the minimum width between two edges */
183 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
,
184 SPDIFIN_CTRL0_WIDTH_SEL
, SPDIFIN_CTRL0_WIDTH_SEL
);
186 /* Calculate the last timer which has no threshold */
187 t_next
= axg_spdifin_mode_timer(priv
, i
, rate
);
188 axg_spdifin_write_timer(priv
->map
, i
, t_next
);
195 /* Calculate the timer */
196 t
= axg_spdifin_mode_timer(priv
, i
, rate
);
198 /* Set the timer value */
199 axg_spdifin_write_timer(priv
->map
, i
, t
);
201 /* Set the threshold value */
202 axg_spdifin_write_threshold(priv
->map
, i
, t
+ t_next
);
204 /* Save the current timer for the next threshold calculation */
212 static int axg_spdifin_dai_probe(struct snd_soc_dai
*dai
)
214 struct axg_spdifin
*priv
= snd_soc_dai_get_drvdata(dai
);
217 ret
= clk_prepare_enable(priv
->pclk
);
219 dev_err(dai
->dev
, "failed to enable pclk\n");
223 ret
= axg_spdifin_sample_mode_config(dai
, priv
);
225 dev_err(dai
->dev
, "mode configuration failed\n");
229 ret
= clk_prepare_enable(priv
->refclk
);
232 "failed to enable spdifin reference clock\n");
236 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
, SPDIFIN_CTRL0_EN
,
242 clk_disable_unprepare(priv
->pclk
);
246 static int axg_spdifin_dai_remove(struct snd_soc_dai
*dai
)
248 struct axg_spdifin
*priv
= snd_soc_dai_get_drvdata(dai
);
250 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
, SPDIFIN_CTRL0_EN
, 0);
251 clk_disable_unprepare(priv
->refclk
);
252 clk_disable_unprepare(priv
->pclk
);
256 static const struct snd_soc_dai_ops axg_spdifin_ops
= {
257 .probe
= axg_spdifin_dai_probe
,
258 .remove
= axg_spdifin_dai_remove
,
259 .prepare
= axg_spdifin_prepare
,
262 static int axg_spdifin_iec958_info(struct snd_kcontrol
*kcontrol
,
263 struct snd_ctl_elem_info
*uinfo
)
265 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_IEC958
;
271 static int axg_spdifin_get_status_mask(struct snd_kcontrol
*kcontrol
,
272 struct snd_ctl_elem_value
*ucontrol
)
276 for (i
= 0; i
< 24; i
++)
277 ucontrol
->value
.iec958
.status
[i
] = 0xff;
282 static int axg_spdifin_get_status(struct snd_kcontrol
*kcontrol
,
283 struct snd_ctl_elem_value
*ucontrol
)
285 struct snd_soc_component
*c
= snd_kcontrol_chip(kcontrol
);
286 struct axg_spdifin
*priv
= snd_soc_component_get_drvdata(c
);
289 for (i
= 0; i
< 6; i
++) {
292 regmap_update_bits(priv
->map
, SPDIFIN_CTRL0
,
293 SPDIFIN_CTRL0_STATUS_SEL
,
294 FIELD_PREP(SPDIFIN_CTRL0_STATUS_SEL
, i
));
296 regmap_read(priv
->map
, SPDIFIN_STAT1
, &val
);
298 for (j
= 0; j
< 4; j
++) {
299 unsigned int offset
= i
* 4 + j
;
301 ucontrol
->value
.iec958
.status
[offset
] =
302 (val
>> (j
* 8)) & 0xff;
309 #define AXG_SPDIFIN_IEC958_MASK \
311 .access = SNDRV_CTL_ELEM_ACCESS_READ, \
312 .iface = SNDRV_CTL_ELEM_IFACE_PCM, \
313 .name = SNDRV_CTL_NAME_IEC958("", CAPTURE, MASK), \
314 .info = axg_spdifin_iec958_info, \
315 .get = axg_spdifin_get_status_mask, \
318 #define AXG_SPDIFIN_IEC958_STATUS \
320 .access = (SNDRV_CTL_ELEM_ACCESS_READ | \
321 SNDRV_CTL_ELEM_ACCESS_VOLATILE), \
322 .iface = SNDRV_CTL_ELEM_IFACE_PCM, \
323 .name = SNDRV_CTL_NAME_IEC958("", CAPTURE, NONE), \
324 .info = axg_spdifin_iec958_info, \
325 .get = axg_spdifin_get_status, \
328 static const char * const spdifin_chsts_src_texts
[] = {
332 static SOC_ENUM_SINGLE_DECL(axg_spdifin_chsts_src_enum
, SPDIFIN_CTRL0
,
333 SPDIFIN_CTRL0_STATUS_CH_SHIFT
,
334 spdifin_chsts_src_texts
);
336 static int axg_spdifin_rate_lock_info(struct snd_kcontrol
*kcontrol
,
337 struct snd_ctl_elem_info
*uinfo
)
339 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
341 uinfo
->value
.integer
.min
= 0;
342 uinfo
->value
.integer
.max
= 192000;
347 static int axg_spdifin_rate_lock_get(struct snd_kcontrol
*kcontrol
,
348 struct snd_ctl_elem_value
*ucontrol
)
350 struct snd_soc_component
*c
= snd_kcontrol_chip(kcontrol
);
351 struct axg_spdifin
*priv
= snd_soc_component_get_drvdata(c
);
353 ucontrol
->value
.integer
.value
[0] = axg_spdifin_get_rate(priv
);
358 #define AXG_SPDIFIN_LOCK_RATE(xname) \
360 .iface = SNDRV_CTL_ELEM_IFACE_PCM, \
361 .access = (SNDRV_CTL_ELEM_ACCESS_READ | \
362 SNDRV_CTL_ELEM_ACCESS_VOLATILE), \
363 .get = axg_spdifin_rate_lock_get, \
364 .info = axg_spdifin_rate_lock_info, \
368 static const struct snd_kcontrol_new axg_spdifin_controls
[] = {
369 AXG_SPDIFIN_LOCK_RATE("Capture Rate Lock"),
370 SOC_DOUBLE("Capture Switch", SPDIFIN_CTRL0
, 7, 6, 1, 1),
371 SOC_ENUM(SNDRV_CTL_NAME_IEC958("", CAPTURE
, NONE
) "Src",
372 axg_spdifin_chsts_src_enum
),
373 AXG_SPDIFIN_IEC958_MASK
,
374 AXG_SPDIFIN_IEC958_STATUS
,
377 static const struct snd_soc_component_driver axg_spdifin_component_drv
= {
378 .controls
= axg_spdifin_controls
,
379 .num_controls
= ARRAY_SIZE(axg_spdifin_controls
),
380 .legacy_dai_naming
= 1,
383 static const struct regmap_config axg_spdifin_regmap_cfg
= {
387 .max_register
= SPDIFIN_MUTE_VAL
,
390 static const unsigned int axg_spdifin_mode_rates
[SPDIFIN_MODE_NUM
] = {
391 32000, 44100, 48000, 88200, 96000, 176400, 192000,
394 static const struct axg_spdifin_cfg axg_cfg
= {
395 .mode_rates
= axg_spdifin_mode_rates
,
396 .ref_rate
= 333333333,
399 static const struct of_device_id axg_spdifin_of_match
[] = {
401 .compatible
= "amlogic,axg-spdifin",
405 MODULE_DEVICE_TABLE(of
, axg_spdifin_of_match
);
407 static struct snd_soc_dai_driver
*
408 axg_spdifin_get_dai_drv(struct device
*dev
, struct axg_spdifin
*priv
)
410 struct snd_soc_dai_driver
*drv
;
413 drv
= devm_kzalloc(dev
, sizeof(*drv
), GFP_KERNEL
);
415 return ERR_PTR(-ENOMEM
);
417 drv
->name
= "SPDIF Input";
418 drv
->ops
= &axg_spdifin_ops
;
419 drv
->capture
.stream_name
= "Capture";
420 drv
->capture
.channels_min
= 1;
421 drv
->capture
.channels_max
= 2;
422 drv
->capture
.formats
= SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
;
424 for (i
= 0; i
< SPDIFIN_MODE_NUM
; i
++) {
426 snd_pcm_rate_to_rate_bit(priv
->conf
->mode_rates
[i
]);
428 if (rb
== SNDRV_PCM_RATE_KNOT
)
429 return ERR_PTR(-EINVAL
);
431 drv
->capture
.rates
|= rb
;
437 static int axg_spdifin_probe(struct platform_device
*pdev
)
439 struct device
*dev
= &pdev
->dev
;
440 struct axg_spdifin
*priv
;
441 struct snd_soc_dai_driver
*dai_drv
;
444 priv
= devm_kzalloc(dev
, sizeof(*priv
), GFP_KERNEL
);
447 platform_set_drvdata(pdev
, priv
);
449 priv
->conf
= of_device_get_match_data(dev
);
451 dev_err(dev
, "failed to match device\n");
455 regs
= devm_platform_ioremap_resource(pdev
, 0);
457 return PTR_ERR(regs
);
459 priv
->map
= devm_regmap_init_mmio(dev
, regs
, &axg_spdifin_regmap_cfg
);
460 if (IS_ERR(priv
->map
)) {
461 dev_err(dev
, "failed to init regmap: %ld\n",
463 return PTR_ERR(priv
->map
);
466 priv
->pclk
= devm_clk_get(dev
, "pclk");
467 if (IS_ERR(priv
->pclk
))
468 return dev_err_probe(dev
, PTR_ERR(priv
->pclk
), "failed to get pclk\n");
470 priv
->refclk
= devm_clk_get(dev
, "refclk");
471 if (IS_ERR(priv
->refclk
))
472 return dev_err_probe(dev
, PTR_ERR(priv
->refclk
), "failed to get mclk\n");
474 dai_drv
= axg_spdifin_get_dai_drv(dev
, priv
);
475 if (IS_ERR(dai_drv
)) {
476 dev_err(dev
, "failed to get dai driver: %ld\n",
478 return PTR_ERR(dai_drv
);
481 return devm_snd_soc_register_component(dev
, &axg_spdifin_component_drv
,
485 static struct platform_driver axg_spdifin_pdrv
= {
486 .probe
= axg_spdifin_probe
,
488 .name
= "axg-spdifin",
489 .of_match_table
= axg_spdifin_of_match
,
492 module_platform_driver(axg_spdifin_pdrv
);
494 MODULE_DESCRIPTION("Amlogic AXG SPDIF Input driver");
495 MODULE_AUTHOR("Jerome Brunet <jbrunet@baylibre.com>");
496 MODULE_LICENSE("GPL v2");