2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2020 Oleksandr Tymoshenko <gonzo@FreeBSD.org>
5 * Copyright (c) 2018 Jared McNeill <jmcneill@invisible.ca>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/param.h>
30 #include <sys/systm.h>
32 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/mutex.h>
37 #include <sys/resource.h>
38 #include <machine/bus.h>
40 #include <dev/ofw/ofw_bus.h>
41 #include <dev/ofw/ofw_bus_subr.h>
43 #include <dev/clk/clk.h>
44 #include <dev/syscon/syscon.h>
46 #include "syscon_if.h"
49 #include <dev/sound/pcm/sound.h>
50 #include <dev/sound/fdt/audio_dai.h>
51 #include "audio_dai_if.h"
54 #define RKCODEC_MIXER_DEVS (1 << SOUND_MIXER_VOLUME)
56 #define GRF_SOC_CON2 0x0408
57 #define SOC_CON2_I2S_ACODEC_EN (1 << 14)
58 #define SOC_CON2_I2S_ACODEC_EN_MASK ((1 << 14) << 16)
59 #define GRF_SOC_CON10 0x0428
60 #define SOC_CON10_GPIOMUT (1 << 1)
61 #define SOC_CON10_GPIOMUT_MASK ((1 << 1) << 16)
62 #define SOC_CON10_GPIOMUT_EN (1 << 0)
63 #define SOC_CON10_GPIOMUT_EN_MASK ((1 << 0) << 16)
65 #define CODEC_RESET 0x00
66 #define RESET_DIG_CORE_RST (1 << 1)
67 #define RESET_SYS_RST (1 << 0)
68 #define CODEC_DAC_INIT_CTRL1 0x0c
69 #define DAC_INIT_CTRL1_DIRECTION_IN (0 << 5)
70 #define DAC_INIT_CTRL1_DIRECTION_OUT (1 << 5)
71 #define DAC_INIT_CTRL1_DAC_I2S_MODE_SLAVE (0 << 4)
72 #define DAC_INIT_CTRL1_DAC_I2S_MODE_MASTER (1 << 4)
73 #define DAC_INIT_CTRL1_MODE_MASK (3 << 4)
74 #define CODEC_DAC_INIT_CTRL2 0x10
75 #define DAC_INIT_CTRL2_DAC_VDL_16BITS (0 << 5)
76 #define DAC_INIT_CTRL2_DAC_VDL_20BITS (1 << 5)
77 #define DAC_INIT_CTRL2_DAC_VDL_24BITS (2 << 5)
78 #define DAC_INIT_CTRL2_DAC_VDL_32BITS (3 << 5)
79 #define DAC_INIT_CTRL2_DAC_VDL_MASK (3 << 5)
80 #define DAC_INIT_CTRL2_DAC_MODE_RJM (0 << 3)
81 #define DAC_INIT_CTRL2_DAC_MODE_LJM (1 << 3)
82 #define DAC_INIT_CTRL2_DAC_MODE_I2S (2 << 3)
83 #define DAC_INIT_CTRL2_DAC_MODE_PCM (3 << 3)
84 #define DAC_INIT_CTRL2_DAC_MODE_MASK (3 << 3)
85 #define CODEC_DAC_INIT_CTRL3 0x14
86 #define DAC_INIT_CTRL3_WL_16BITS (0 << 2)
87 #define DAC_INIT_CTRL3_WL_20BITS (1 << 2)
88 #define DAC_INIT_CTRL3_WL_24BITS (2 << 2)
89 #define DAC_INIT_CTRL3_WL_32BITS (3 << 2)
90 #define DAC_INIT_CTRL3_WL_MASK (3 << 2)
91 #define DAC_INIT_CTRL3_RST_MASK (1 << 1)
92 #define DAC_INIT_CTRL3_RST_DIS (1 << 1)
93 #define DAC_INIT_CTRL3_DAC_BCP_REVERSAL (1 << 0)
94 #define DAC_INIT_CTRL3_DAC_BCP_NORMAL (0 << 0)
95 #define DAC_INIT_CTRL3_DAC_BCP_MASK (1 << 0)
96 #define CODEC_DAC_PRECHARGE_CTRL 0x88
97 #define DAC_PRECHARGE_CTRL_DAC_CHARGE_PRECHARGE (1 << 7)
98 #define DAC_PRECHARGE_CTRL_DAC_CHARGE_CURRENT_I (1 << 0)
99 #define DAC_PRECHARGE_CTRL_DAC_CHARGE_CURRENT_ALL (0x7f)
100 #define CODEC_DAC_PWR_CTRL 0x8c
101 #define DAC_PWR_CTRL_DAC_PWR (1 << 6)
102 #define DAC_PWR_CTRL_DACL_PATH_REFV (1 << 5)
103 #define DAC_PWR_CTRL_HPOUTL_ZERO_CROSSING (1 << 4)
104 #define DAC_PWR_CTRL_DACR_PATH_REFV (1 << 1)
105 #define DAC_PWR_CTRL_HPOUTR_ZERO_CROSSING (1 << 0)
106 #define CODEC_DAC_CLK_CTRL 0x90
107 #define DAC_CLK_CTRL_DACL_REFV_ON (1 << 7)
108 #define DAC_CLK_CTRL_DACL_CLK_ON (1 << 6)
109 #define DAC_CLK_CTRL_DACL_ON (1 << 5)
110 #define DAC_CLK_CTRL_DACL_INIT_ON (1 << 4)
111 #define DAC_CLK_CTRL_DACR_REFV_ON (1 << 3)
112 #define DAC_CLK_CTRL_DACR_CLK_ON (1 << 2)
113 #define DAC_CLK_CTRL_DACR_ON (1 << 1)
114 #define DAC_CLK_CTRL_DACR_INIT_ON (1 << 0)
115 #define CODEC_HPMIX_CTRL 0x94
116 #define HPMIX_CTRL_HPMIXL_EN (1 << 6)
117 #define HPMIX_CTRL_HPMIXL_INIT_EN (1 << 5)
118 #define HPMIX_CTRL_HPMIXL_INIT2_EN (1 << 4)
119 #define HPMIX_CTRL_HPMIXR_EN (1 << 2)
120 #define HPMIX_CTRL_HPMIXR_INIT_EN (1 << 1)
121 #define HPMIX_CTRL_HPMIXR_INIT2_EN (1 << 0)
122 #define CODEC_DAC_SELECT 0x98
123 #define DAC_SELECT_DACL_SELECT (1 << 4)
124 #define DAC_SELECT_DACR_SELECT (1 << 0)
125 #define CODEC_HPOUT_CTRL 0x9c
126 #define HPOUT_CTRL_HPOUTL_EN (1 << 7)
127 #define HPOUT_CTRL_HPOUTL_INIT_EN (1 << 6)
128 #define HPOUT_CTRL_HPOUTL_UNMUTE (1 << 5)
129 #define HPOUT_CTRL_HPOUTR_EN (1 << 4)
130 #define HPOUT_CTRL_HPOUTR_INIT_EN (1 << 3)
131 #define HPOUT_CTRL_HPOUTR_UNMUTE (1 << 2)
132 #define CODEC_HPOUTL_GAIN_CTRL 0xa0
133 #define CODEC_HPOUTR_GAIN_CTRL 0xa4
134 #define CODEC_HPOUT_POP_CTRL 0xa8
135 #define HPOUT_POP_CTRL_HPOUTR_POP (1 << 5)
136 #define HPOUT_POP_CTRL_HPOUTR_POP_XCHARGE (1 << 4)
137 #define HPOUT_POP_CTRL_HPOUTL_POP (1 << 1)
138 #define HPOUT_POP_CTRL_HPOUTL_POP_XCHARGE (1 << 0)
140 #define DEFAULT_RATE (48000 * 256)
142 static struct ofw_compat_data compat_data[] = {
143 { "rockchip,rk3328-codec", 1},
147 struct rkcodec_softc {
149 struct resource *res;
154 u_int regaddr; /* address for the sysctl */
157 #define RKCODEC_LOCK(sc) mtx_lock(&(sc)->mtx)
158 #define RKCODEC_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
159 #define RKCODEC_READ(sc, reg) bus_read_4((sc)->res, (reg))
160 #define RKCODEC_WRITE(sc, reg, val) bus_write_4((sc)->res, (reg), (val))
162 static int rkcodec_probe(device_t dev);
163 static int rkcodec_attach(device_t dev);
164 static int rkcodec_detach(device_t dev);
167 rkcodec_set_power(struct rkcodec_softc *sc, bool poweron)
170 val = RKCODEC_READ(sc, CODEC_DAC_PRECHARGE_CTRL);
172 val |= DAC_PRECHARGE_CTRL_DAC_CHARGE_PRECHARGE;
174 val &= ~(DAC_PRECHARGE_CTRL_DAC_CHARGE_PRECHARGE);
175 RKCODEC_WRITE(sc, CODEC_DAC_PRECHARGE_CTRL, val);
179 val = RKCODEC_READ(sc, CODEC_DAC_PRECHARGE_CTRL);
181 val |= DAC_PRECHARGE_CTRL_DAC_CHARGE_CURRENT_ALL;
183 val &= ~(DAC_PRECHARGE_CTRL_DAC_CHARGE_CURRENT_ALL);
184 RKCODEC_WRITE(sc, CODEC_DAC_PRECHARGE_CTRL, val);
189 rkcodec_set_mute(struct rkcodec_softc *sc, bool muted)
192 val = SOC_CON10_GPIOMUT_MASK;
194 val |= SOC_CON10_GPIOMUT;
195 SYSCON_WRITE_4(sc->grf, GRF_SOC_CON10, val);
199 rkcodec_reset(struct rkcodec_softc *sc)
202 RKCODEC_WRITE(sc, CODEC_RESET, 0);
204 RKCODEC_WRITE(sc, CODEC_RESET, RESET_DIG_CORE_RST | RESET_SYS_RST);
208 rkcodec_probe(device_t dev)
210 if (!ofw_bus_status_okay(dev))
213 if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
216 device_set_desc(dev, "Rockchip RK3328 CODEC");
217 return (BUS_PROBE_DEFAULT);
221 rkcodec_attach(device_t dev)
223 struct rkcodec_softc *sc;
228 sc = device_get_softc(dev);
231 mtx_init(&sc->mtx, device_get_nameunit(dev), NULL, MTX_DEF);
234 sc->res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
236 device_printf(dev, "could not allocate resource for device\n");
241 node = ofw_bus_get_node(dev);
242 if (syscon_get_by_ofw_property(dev, node,
243 "rockchip,grf", &sc->grf) != 0) {
244 device_printf(dev, "cannot get rockchip,grf handle\n");
248 val = SOC_CON2_I2S_ACODEC_EN | SOC_CON2_I2S_ACODEC_EN_MASK;
249 SYSCON_WRITE_4(sc->grf, GRF_SOC_CON2, val);
251 val = 0 | SOC_CON10_GPIOMUT_EN_MASK;
252 SYSCON_WRITE_4(sc->grf, GRF_SOC_CON10, val);
254 error = clk_get_by_ofw_name(dev, 0, "pclk", &sc->pclk);
256 device_printf(dev, "could not get pclk clock\n");
260 error = clk_get_by_ofw_name(dev, 0, "mclk", &sc->mclk);
262 device_printf(dev, "could not get mclk clock\n");
266 error = clk_enable(sc->pclk);
268 device_printf(sc->dev, "could not enable pclk clock\n");
272 error = clk_enable(sc->mclk);
274 device_printf(sc->dev, "could not enable mclk clock\n");
279 error = clk_set_freq(sc->mclk, DEFAULT_RATE, 0);
281 device_printf(sc->dev, "could not set frequency for mclk clock\n");
286 /* TODO: handle mute-gpios */
289 rkcodec_set_power(sc, true);
291 val = RKCODEC_READ(sc, CODEC_DAC_PWR_CTRL);
292 val |= DAC_PWR_CTRL_DAC_PWR;
293 RKCODEC_WRITE(sc, CODEC_DAC_PWR_CTRL, val);
296 val |= DAC_PWR_CTRL_DACL_PATH_REFV |
297 DAC_PWR_CTRL_DACR_PATH_REFV;
298 RKCODEC_WRITE(sc, CODEC_DAC_PWR_CTRL, val);
301 val |= DAC_PWR_CTRL_HPOUTL_ZERO_CROSSING |
302 DAC_PWR_CTRL_HPOUTR_ZERO_CROSSING;
303 RKCODEC_WRITE(sc, CODEC_DAC_PWR_CTRL, val);
306 val = RKCODEC_READ(sc, CODEC_HPOUT_POP_CTRL);
307 val |= HPOUT_POP_CTRL_HPOUTR_POP | HPOUT_POP_CTRL_HPOUTL_POP;
308 val &= ~(HPOUT_POP_CTRL_HPOUTR_POP_XCHARGE | HPOUT_POP_CTRL_HPOUTL_POP_XCHARGE);
309 RKCODEC_WRITE(sc, CODEC_HPOUT_POP_CTRL, val);
312 val = RKCODEC_READ(sc, CODEC_HPMIX_CTRL);
313 val |= HPMIX_CTRL_HPMIXL_EN | HPMIX_CTRL_HPMIXR_EN;
314 RKCODEC_WRITE(sc, CODEC_HPMIX_CTRL, val);
317 val |= HPMIX_CTRL_HPMIXL_INIT_EN | HPMIX_CTRL_HPMIXR_INIT_EN;
318 RKCODEC_WRITE(sc, CODEC_HPMIX_CTRL, val);
321 val = RKCODEC_READ(sc, CODEC_HPOUT_CTRL);
322 val |= HPOUT_CTRL_HPOUTL_EN | HPOUT_CTRL_HPOUTR_EN;
323 RKCODEC_WRITE(sc, CODEC_HPOUT_CTRL, val);
326 val |= HPOUT_CTRL_HPOUTL_INIT_EN | HPOUT_CTRL_HPOUTR_INIT_EN;
327 RKCODEC_WRITE(sc, CODEC_HPOUT_CTRL, val);
330 val = RKCODEC_READ(sc, CODEC_DAC_CLK_CTRL);
331 val |= DAC_CLK_CTRL_DACL_REFV_ON | DAC_CLK_CTRL_DACR_REFV_ON;
332 RKCODEC_WRITE(sc, CODEC_DAC_CLK_CTRL, val);
335 val |= DAC_CLK_CTRL_DACL_CLK_ON | DAC_CLK_CTRL_DACR_CLK_ON;
336 RKCODEC_WRITE(sc, CODEC_DAC_CLK_CTRL, val);
339 val |= DAC_CLK_CTRL_DACL_ON | DAC_CLK_CTRL_DACR_ON;
340 RKCODEC_WRITE(sc, CODEC_DAC_CLK_CTRL, val);
343 val |= DAC_CLK_CTRL_DACL_INIT_ON | DAC_CLK_CTRL_DACR_INIT_ON;
344 RKCODEC_WRITE(sc, CODEC_DAC_CLK_CTRL, val);
347 val = RKCODEC_READ(sc, CODEC_DAC_SELECT);
348 val |= DAC_SELECT_DACL_SELECT | DAC_SELECT_DACR_SELECT;
349 RKCODEC_WRITE(sc, CODEC_DAC_SELECT, val);
352 val = RKCODEC_READ(sc, CODEC_HPMIX_CTRL);
353 val |= HPMIX_CTRL_HPMIXL_INIT2_EN | HPMIX_CTRL_HPMIXR_INIT2_EN;
354 RKCODEC_WRITE(sc, CODEC_HPMIX_CTRL, val);
357 val = RKCODEC_READ(sc, CODEC_HPOUT_CTRL);
358 val |= HPOUT_CTRL_HPOUTL_UNMUTE | HPOUT_CTRL_HPOUTR_UNMUTE;
359 RKCODEC_WRITE(sc, CODEC_HPOUT_CTRL, val);
362 RKCODEC_WRITE(sc, CODEC_HPOUTL_GAIN_CTRL, 0x18);
363 RKCODEC_WRITE(sc, CODEC_HPOUTR_GAIN_CTRL, 0x18);
366 rkcodec_set_mute(sc, false);
368 node = ofw_bus_get_node(dev);
369 OF_device_register_xref(OF_xref_from_node(node), dev);
379 rkcodec_detach(device_t dev)
381 struct rkcodec_softc *sc;
383 sc = device_get_softc(dev);
386 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->res);
387 mtx_destroy(&sc->mtx);
393 rkcodec_mixer_init(struct snd_mixer *m)
396 mix_setdevs(m, RKCODEC_MIXER_DEVS);
402 rkcodec_mixer_uninit(struct snd_mixer *m)
409 rkcodec_mixer_reinit(struct snd_mixer *m)
416 rkcodec_mixer_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
418 struct rkcodec_softc *sc;
419 struct mtx *mixer_lock;
422 sc = device_get_softc(mix_getdevinfo(m));
423 mixer_lock = mixer_get_lock(m);
425 if (mtx_owned(mixer_lock)) {
429 mtx_lock(mixer_lock);
436 case SOUND_MIXER_VOLUME:
437 printf("[%s] %s:%d\n", __func__, __FILE__, __LINE__);
440 case SOUND_MIXER_MIC:
441 printf("[%s] %s:%d\n", __func__, __FILE__, __LINE__);
449 mtx_unlock(mixer_lock);
452 return (left | (right << 8));
456 rkcodec_mixer_setrecsrc(struct snd_mixer *m, unsigned src)
462 static kobj_method_t rkcodec_mixer_methods[] = {
463 KOBJMETHOD(mixer_init, rkcodec_mixer_init),
464 KOBJMETHOD(mixer_uninit, rkcodec_mixer_uninit),
465 KOBJMETHOD(mixer_reinit, rkcodec_mixer_reinit),
466 KOBJMETHOD(mixer_set, rkcodec_mixer_set),
467 KOBJMETHOD(mixer_setrecsrc, rkcodec_mixer_setrecsrc),
471 MIXER_DECLARE(rkcodec_mixer);
474 rkcodec_dai_init(device_t dev, uint32_t format)
476 struct rkcodec_softc *sc;
478 uint32_t ctrl1, ctrl2, ctrl3;
480 sc = device_get_softc(dev);
482 fmt = AUDIO_DAI_FORMAT_FORMAT(format);
483 pol = AUDIO_DAI_FORMAT_POLARITY(format);
484 clk = AUDIO_DAI_FORMAT_CLOCK(format);
486 ctrl1 = RKCODEC_READ(sc, CODEC_DAC_INIT_CTRL1);
487 ctrl2 = RKCODEC_READ(sc, CODEC_DAC_INIT_CTRL2);
488 ctrl3 = RKCODEC_READ(sc, CODEC_DAC_INIT_CTRL3);
490 ctrl3 &= ~(DAC_INIT_CTRL3_DAC_BCP_MASK);
492 case AUDIO_DAI_POLARITY_IB_NF:
493 ctrl3 |= DAC_INIT_CTRL3_DAC_BCP_REVERSAL;
495 case AUDIO_DAI_POLARITY_NB_NF:
496 ctrl3 |= DAC_INIT_CTRL3_DAC_BCP_NORMAL;
502 ctrl1 &= ~(DAC_INIT_CTRL1_MODE_MASK);
504 case AUDIO_DAI_CLOCK_CBM_CFM:
505 ctrl1 |= DAC_INIT_CTRL1_DIRECTION_OUT |
506 DAC_INIT_CTRL1_DAC_I2S_MODE_SLAVE;
508 case AUDIO_DAI_CLOCK_CBS_CFS:
509 ctrl1 |= DAC_INIT_CTRL1_DIRECTION_IN |
510 DAC_INIT_CTRL1_DAC_I2S_MODE_SLAVE;
516 ctrl2 &= ~(DAC_INIT_CTRL2_DAC_VDL_MASK | DAC_INIT_CTRL2_DAC_MODE_MASK);
517 ctrl2 |= DAC_INIT_CTRL2_DAC_VDL_16BITS;
518 ctrl3 &= ~(DAC_INIT_CTRL3_WL_MASK);
519 ctrl3 |= DAC_INIT_CTRL3_WL_32BITS;
521 case AUDIO_DAI_FORMAT_I2S:
522 ctrl2 |= DAC_INIT_CTRL2_DAC_MODE_I2S;
524 case AUDIO_DAI_FORMAT_LJ:
525 ctrl2 |= DAC_INIT_CTRL2_DAC_MODE_LJM;
527 case AUDIO_DAI_FORMAT_RJ:
528 ctrl2 |= DAC_INIT_CTRL2_DAC_MODE_RJM;
534 ctrl3 &= ~(DAC_INIT_CTRL3_RST_MASK);
535 ctrl3 |= DAC_INIT_CTRL3_RST_DIS;
537 RKCODEC_WRITE(sc, CODEC_DAC_INIT_CTRL1, ctrl1);
538 RKCODEC_WRITE(sc, CODEC_DAC_INIT_CTRL2, ctrl2);
539 RKCODEC_WRITE(sc, CODEC_DAC_INIT_CTRL3, ctrl3);
545 rkcodec_dai_trigger(device_t dev, int go, int pcm_dir)
547 // struct rkcodec_softc *sc = device_get_softc(dev);
549 if ((pcm_dir != PCMDIR_PLAY) && (pcm_dir != PCMDIR_REC))
554 if (pcm_dir == PCMDIR_PLAY) {
555 printf("[%s] %s:%d\n", __func__, __FILE__, __LINE__);
557 else if (pcm_dir == PCMDIR_REC) {
558 printf("[%s] %s:%d\n", __func__, __FILE__, __LINE__);
564 if (pcm_dir == PCMDIR_PLAY) {
565 printf("[%s] %s:%d\n", __func__, __FILE__, __LINE__);
567 else if (pcm_dir == PCMDIR_REC) {
568 printf("[%s] %s:%d\n", __func__, __FILE__, __LINE__);
577 rkcodec_dai_setup_mixer(device_t dev, device_t pcmdev)
580 mixer_init(pcmdev, &rkcodec_mixer_class, dev);
585 static device_method_t rkcodec_methods[] = {
586 /* Device interface */
587 DEVMETHOD(device_probe, rkcodec_probe),
588 DEVMETHOD(device_attach, rkcodec_attach),
589 DEVMETHOD(device_detach, rkcodec_detach),
591 DEVMETHOD(audio_dai_init, rkcodec_dai_init),
592 DEVMETHOD(audio_dai_setup_mixer, rkcodec_dai_setup_mixer),
593 DEVMETHOD(audio_dai_trigger, rkcodec_dai_trigger),
598 static driver_t rkcodec_driver = {
601 sizeof(struct rkcodec_softc),
604 DRIVER_MODULE(rkcodec, simplebus, rkcodec_driver, 0, 0);
605 SIMPLEBUS_PNP_INFO(compat_data);