2 * Copyright 2008 by Marco Trillo. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
18 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
20 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
21 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * Copyright (c) 2002, 2003 Tsubai Masanari. All rights reserved.
30 * Redistribution and use in source and binary forms, with or without
31 * modification, are permitted provided that the following conditions
33 * 1. Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * 2. Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in the
37 * documentation and/or other materials provided with the distribution.
38 * 3. The name of the author may not be used to endorse or promote products
39 * derived from this software without specific prior written permission.
41 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
42 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
44 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
45 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 * NetBSD: snapper.c,v 1.28 2008/05/16 03:49:54 macallan Exp
53 * Id: snapper.c,v 1.11 2002/10/31 17:42:13 tsubai Exp
57 * Apple Snapper audio.
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/kernel.h>
63 #include <sys/module.h>
65 #include <sys/malloc.h>
67 #include <sys/mutex.h>
68 #include <machine/dbdma.h>
69 #include <machine/intr_machdep.h>
70 #include <machine/resource.h>
71 #include <machine/bus.h>
72 #include <machine/pio.h>
75 #include <dev/iicbus/iicbus.h>
76 #include <dev/iicbus/iiconf.h>
77 #include <dev/ofw/ofw_bus.h>
79 #ifdef HAVE_KERNEL_OPTION_HEADERS
83 #include <dev/sound/pcm/sound.h>
87 extern kobj_class_t i2s_mixer_class;
88 extern device_t i2s_mixer;
96 static int snapper_probe(device_t);
97 static int snapper_attach(device_t);
98 static int snapper_init(struct snd_mixer *m);
99 static int snapper_uninit(struct snd_mixer *m);
100 static int snapper_reinit(struct snd_mixer *m);
101 static int snapper_set(struct snd_mixer *m, unsigned dev, unsigned left,
103 static u_int32_t snapper_setrecsrc(struct snd_mixer *m, u_int32_t src);
105 static device_method_t snapper_methods[] = {
106 /* Device interface. */
107 DEVMETHOD(device_probe, snapper_probe),
108 DEVMETHOD(device_attach, snapper_attach),
113 static driver_t snapper_driver = {
116 sizeof(struct snapper_softc)
118 static devclass_t snapper_devclass;
120 DRIVER_MODULE(snapper, iicbus, snapper_driver, snapper_devclass, 0, 0);
121 MODULE_VERSION(snapper, 1);
122 MODULE_DEPEND(snapper, iicbus, 1, 1, 1);
124 static kobj_method_t snapper_mixer_methods[] = {
125 KOBJMETHOD(mixer_init, snapper_init),
126 KOBJMETHOD(mixer_uninit, snapper_uninit),
127 KOBJMETHOD(mixer_reinit, snapper_reinit),
128 KOBJMETHOD(mixer_set, snapper_set),
129 KOBJMETHOD(mixer_setrecsrc, snapper_setrecsrc),
133 MIXER_DECLARE(snapper_mixer);
135 #define SNAPPER_IICADDR 0x6a /* Hard-coded I2C slave addr */
137 /* Snapper (Texas Instruments TAS3004) registers. */
138 #define SNAPPER_MCR1 0x01 /* Main control register 1 (1byte) */
139 #define SNAPPER_DRC 0x02 /* Dynamic range compression (6bytes) */
140 #define SNAPPER_VOLUME 0x04 /* Volume (6bytes) */
141 #define SNAPPER_TREBLE 0x05 /* Treble control (1byte) */
142 #define SNAPPER_BASS 0x06 /* Bass control (1byte) */
143 #define SNAPPER_MIXER_L 0x07 /* Mixer left gain (9bytes) */
144 #define SNAPPER_MIXER_R 0x08 /* Mixer right gain (9bytes) */
145 #define SNAPPER_LB0 0x0a /* Left biquad 0 (15bytes) */
146 #define SNAPPER_LB1 0x0b /* Left biquad 1 (15bytes) */
147 #define SNAPPER_LB2 0x0c /* Left biquad 2 (15bytes) */
148 #define SNAPPER_LB3 0x0d /* Left biquad 3 (15bytes) */
149 #define SNAPPER_LB4 0x0e /* Left biquad 4 (15bytes) */
150 #define SNAPPER_LB5 0x0f /* Left biquad 5 (15bytes) */
151 #define SNAPPER_LB6 0x10 /* Left biquad 6 (15bytes) */
152 #define SNAPPER_RB0 0x13 /* Right biquad 0 (15bytes) */
153 #define SNAPPER_RB1 0x14 /* Right biquad 1 (15bytes) */
154 #define SNAPPER_RB2 0x15 /* Right biquad 2 (15bytes) */
155 #define SNAPPER_RB3 0x16 /* Right biquad 3 (15bytes) */
156 #define SNAPPER_RB4 0x17 /* Right biquad 4 (15bytes) */
157 #define SNAPPER_RB5 0x18 /* Right biquad 5 (15bytes) */
158 #define SNAPPER_RB6 0x19 /* Right biquad 6 (15bytes) */
159 #define SNAPPER_LLB 0x21 /* Left loudness biquad (15bytes) */
160 #define SNAPPER_RLB 0x22 /* Right loudness biquad (15bytes) */
161 #define SNAPPER_LLB_GAIN 0x23 /* Left loudness biquad gain (3bytes) */
162 #define SNAPPER_RLB_GAIN 0x24 /* Right loudness biquad gain (3bytes) */
163 #define SNAPPER_ACR 0x40 /* Analog control register (1byte) */
164 #define SNAPPER_MCR2 0x43 /* Main control register 2 (1byte) */
165 #define SNAPPER_MCR1_FL 0x80 /* Fast load */
166 #define SNAPPER_MCR1_SC 0x40 /* SCLK frequency */
167 #define SNAPPER_MCR1_SC_32 0x00 /* 32fs */
168 #define SNAPPER_MCR1_SC_64 0x40 /* 64fs */
169 #define SNAPPER_MCR1_SM 0x30 /* Output serial port mode */
170 #define SNAPPER_MCR1_SM_L 0x00 /* Left justified */
171 #define SNAPPER_MCR1_SM_R 0x10 /* Right justified */
172 #define SNAPPER_MCR1_SM_I2S 0x20 /* I2S */
173 #define SNAPPER_MCR1_W 0x03 /* Serial port word length */
174 #define SNAPPER_MCR1_W_16 0x00 /* 16 bit */
175 #define SNAPPER_MCR1_W_18 0x01 /* 18 bit */
176 #define SNAPPER_MCR1_W_20 0x02 /* 20 bit */
177 #define SNAPPER_MCR1_W_24 0x03 /* 20 bit */
178 #define SNAPPER_MCR2_DL 0x80 /* Download */
179 #define SNAPPER_MCR2_AP 0x02 /* All pass mode */
180 #define SNAPPER_ACR_ADM 0x80 /* ADC output mode */
181 #define SNAPPER_ACR_LRB 0x40 /* Select B input */
182 #define SNAPPER_ACR_DM 0x0c /* De-emphasis control */
183 #define SNAPPER_ACR_DM_OFF 0x00 /* off */
184 #define SNAPPER_ACR_DM_48 0x04 /* fs = 48kHz */
185 #define SNAPPER_ACR_DM_44 0x08 /* fs = 44.1kHz */
186 #define SNAPPER_ACR_INP 0x02 /* Analog input select */
187 #define SNAPPER_ACR_INP_A 0x00 /* A */
188 #define SNAPPER_ACR_INP_B 0x02 /* B */
189 #define SNAPPER_ACR_APD 0x01 /* Analog power down */
222 static const struct snapper_reg snapper_initdata = {
223 { SNAPPER_MCR1_SC_64 | SNAPPER_MCR1_SM_I2S |
224 SNAPPER_MCR1_W_16 }, /* MCR1 */
225 { 1, 0, 0, 0, 0, 0 }, /* DRC */
226 { 0, 0, 0, 0, 0, 0 }, /* VOLUME */
227 { 0x72 }, /* TREBLE */
229 { 0x10, 0x00, 0x00, 0, 0, 0, 0, 0, 0 }, /* MIXER_L */
230 { 0x10, 0x00, 0x00, 0, 0, 0, 0, 0, 0 }, /* MIXER_R */
231 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
232 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
233 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
234 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
235 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
236 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
237 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
238 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
239 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
240 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
241 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
242 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
243 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
244 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
245 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
246 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */
247 { 0, 0, 0 }, /* LLB_GAIN */
248 { 0, 0, 0 }, /* RLB_GAIN */
249 { SNAPPER_ACR_ADM | SNAPPER_ACR_LRB | SNAPPER_ACR_INP_B },/* ACR */
250 { SNAPPER_MCR2_AP } /* MCR2 */
253 static const char snapper_regsize[] = {
255 sizeof snapper_initdata.MCR1, /* 0x01 */
256 sizeof snapper_initdata.DRC, /* 0x02 */
258 sizeof snapper_initdata.VOLUME, /* 0x04 */
259 sizeof snapper_initdata.TREBLE, /* 0x05 */
260 sizeof snapper_initdata.BASS, /* 0x06 */
261 sizeof snapper_initdata.MIXER_L, /* 0x07 */
262 sizeof snapper_initdata.MIXER_R, /* 0x08 */
264 sizeof snapper_initdata.LB0, /* 0x0a */
265 sizeof snapper_initdata.LB1, /* 0x0b */
266 sizeof snapper_initdata.LB2, /* 0x0c */
267 sizeof snapper_initdata.LB3, /* 0x0d */
268 sizeof snapper_initdata.LB4, /* 0x0e */
269 sizeof snapper_initdata.LB5, /* 0x0f */
270 sizeof snapper_initdata.LB6, /* 0x10 */
273 sizeof snapper_initdata.RB0, /* 0x13 */
274 sizeof snapper_initdata.RB1, /* 0x14 */
275 sizeof snapper_initdata.RB2, /* 0x15 */
276 sizeof snapper_initdata.RB3, /* 0x16 */
277 sizeof snapper_initdata.RB4, /* 0x17 */
278 sizeof snapper_initdata.RB5, /* 0x18 */
279 sizeof snapper_initdata.RB6, /* 0x19 */
282 sizeof snapper_initdata.LLB, /* 0x21 */
283 sizeof snapper_initdata.RLB, /* 0x22 */
284 sizeof snapper_initdata.LLB_GAIN, /* 0x23 */
285 sizeof snapper_initdata.RLB_GAIN, /* 0x24 */
286 0,0,0,0, 0,0,0,0, 0,0,0,
287 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0,
288 sizeof snapper_initdata.ACR, /* 0x40 */
291 sizeof snapper_initdata.MCR2 /* 0x43 */
294 /* dB = 20 * log (x) table. */
295 static u_int snapper_volume_table[100] = {
296 0x00000148, 0x0000015C, 0x00000171, 0x00000186, // -46.0, -45.5, -45.0, -44.5,
297 0x0000019E, 0x000001B6, 0x000001D0, 0x000001EB, // -44.0, -43.5, -43.0, -42.5,
298 0x00000209, 0x00000227, 0x00000248, 0x0000026B, // -42.0, -41.5, -41.0, -40.5,
299 0x0000028F, 0x000002B6, 0x000002DF, 0x0000030B, // -40.0, -39.5, -39.0, -38.5,
300 0x00000339, 0x0000036A, 0x0000039E, 0x000003D5, // -38.0, -37.5, -37.0, -36.5,
301 0x0000040F, 0x0000044C, 0x0000048D, 0x000004D2, // -36.0, -35.5, -35.0, -34.5,
302 0x0000051C, 0x00000569, 0x000005BB, 0x00000612, // -34.0, -33.5, -33.0, -32.5,
303 0x0000066E, 0x000006D0, 0x00000737, 0x000007A5, // -32.0, -31.5, -31.0, -30.5,
304 0x00000818, 0x00000893, 0x00000915, 0x0000099F, // -30.0, -29.5, -29.0, -28.5,
305 0x00000A31, 0x00000ACC, 0x00000B6F, 0x00000C1D, // -28.0, -27.5, -27.0, -26.5,
306 0x00000CD5, 0x00000D97, 0x00000E65, 0x00000F40, // -26.0, -25.5, -25.0, -24.5,
307 0x00001027, 0x0000111C, 0x00001220, 0x00001333, // -24.0, -23.5, -23.0, -22.5,
308 0x00001456, 0x0000158A, 0x000016D1, 0x0000182B, // -22.0, -21.5, -21.0, -20.5,
309 0x0000199A, 0x00001B1E, 0x00001CB9, 0x00001E6D, // -20.0, -19.5, -19.0, -18.5,
310 0x0000203A, 0x00002223, 0x00002429, 0x0000264E, // -18.0, -17.5, -17.0, -16.5,
311 0x00002893, 0x00002AFA, 0x00002D86, 0x00003039, // -16.0, -15.5, -15.0, -14.5,
312 0x00003314, 0x0000361B, 0x00003950, 0x00003CB5, // -14.0, -13.5, -13.0, -12.5,
313 0x0000404E, 0x0000441D, 0x00004827, 0x00004C6D, // -12.0, -11.5, -11.0, -10.5,
314 0x000050F4, 0x000055C0, 0x00005AD5, 0x00006037, // -10.0, -9.5, -9.0, -8.5,
315 0x000065EA, 0x00006BF4, 0x0000725A, 0x00007920, // -8.0, -7.5, -7.0, -6.5,
316 0x0000804E, 0x000087EF, 0x00008FF6, 0x0000987D, // -6.0, -5.5, -5.0, -4.5,
317 0x0000A186, 0x0000AB19, 0x0000B53C, 0x0000BFF9, // -4.0, -3.5, -3.0, -2.5,
318 0x0000CB59, 0x0000D766, 0x0000E429, 0x0000F1AE, // -2.0, -1.5, -1.0, -0.5,
319 0x00010000, 0x00010F2B, 0x00011F3D, 0x00013042, // 0.0, +0.5, +1.0, +1.5,
320 0x00014249, 0x00015562, 0x0001699C, 0x00017F09 // 2.0, +2.5, +3.0, +3.5,
324 snapper_write(struct snapper_softc *sc, uint8_t reg, const void *data)
329 struct iic_msg msg[] = {
330 { sc->sc_addr, IIC_M_WR, 0, buf }
333 KASSERT(reg < sizeof(snapper_regsize), ("bad reg"));
334 size = snapper_regsize[reg];
335 msg[0].len = size + 1;
337 memcpy(&buf[1], data, size);
339 iicbus_transfer(sc->sc_dev, msg, 1);
345 snapper_probe(device_t dev)
347 const char *name, *compat;
349 name = ofw_bus_get_name(dev);
353 if (strcmp(name, "deq") == 0) {
354 if (iicbus_get_addr(dev) != SNAPPER_IICADDR)
356 } else if (strcmp(name, "codec") == 0) {
357 compat = ofw_bus_get_compat(dev);
358 if (compat == NULL || strcmp(compat, "tas3004") != 0)
364 device_set_desc(dev, "Texas Instruments TAS3004 Audio Codec");
369 snapper_attach(device_t dev)
371 struct snapper_softc *sc;
373 sc = device_get_softc(dev);
375 sc->sc_addr = iicbus_get_addr(dev);
377 i2s_mixer_class = &snapper_mixer_class;
384 snapper_init(struct snd_mixer *m)
386 struct snapper_softc *sc;
389 sc = device_get_softc(mix_getdevinfo(m));
391 snapper_write(sc, SNAPPER_LB0, snapper_initdata.LB0);
392 snapper_write(sc, SNAPPER_LB1, snapper_initdata.LB1);
393 snapper_write(sc, SNAPPER_LB2, snapper_initdata.LB2);
394 snapper_write(sc, SNAPPER_LB3, snapper_initdata.LB3);
395 snapper_write(sc, SNAPPER_LB4, snapper_initdata.LB4);
396 snapper_write(sc, SNAPPER_LB5, snapper_initdata.LB5);
397 snapper_write(sc, SNAPPER_LB6, snapper_initdata.LB6);
398 snapper_write(sc, SNAPPER_RB0, snapper_initdata.RB0);
399 snapper_write(sc, SNAPPER_RB1, snapper_initdata.RB1);
400 snapper_write(sc, SNAPPER_RB1, snapper_initdata.RB1);
401 snapper_write(sc, SNAPPER_RB2, snapper_initdata.RB2);
402 snapper_write(sc, SNAPPER_RB3, snapper_initdata.RB3);
403 snapper_write(sc, SNAPPER_RB4, snapper_initdata.RB4);
404 snapper_write(sc, SNAPPER_RB5, snapper_initdata.RB5);
405 snapper_write(sc, SNAPPER_RB6, snapper_initdata.RB6);
406 snapper_write(sc, SNAPPER_MCR1, snapper_initdata.MCR1);
407 snapper_write(sc, SNAPPER_MCR2, snapper_initdata.MCR2);
408 snapper_write(sc, SNAPPER_DRC, snapper_initdata.DRC);
409 snapper_write(sc, SNAPPER_VOLUME, snapper_initdata.VOLUME);
410 snapper_write(sc, SNAPPER_TREBLE, snapper_initdata.TREBLE);
411 snapper_write(sc, SNAPPER_BASS, snapper_initdata.BASS);
412 snapper_write(sc, SNAPPER_MIXER_L, snapper_initdata.MIXER_L);
413 snapper_write(sc, SNAPPER_MIXER_R, snapper_initdata.MIXER_R);
414 snapper_write(sc, SNAPPER_LLB, snapper_initdata.LLB);
415 snapper_write(sc, SNAPPER_RLB, snapper_initdata.RLB);
416 snapper_write(sc, SNAPPER_LLB_GAIN, snapper_initdata.LLB_GAIN);
417 snapper_write(sc, SNAPPER_RLB_GAIN, snapper_initdata.RLB_GAIN);
418 snapper_write(sc, SNAPPER_ACR, snapper_initdata.ACR);
420 x |= SOUND_MASK_VOLUME;
427 snapper_uninit(struct snd_mixer *m)
433 snapper_reinit(struct snd_mixer *m)
439 snapper_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
441 struct snapper_softc *sc;
442 struct mtx *mixer_lock;
447 sc = device_get_softc(mix_getdevinfo(m));
448 mixer_lock = mixer_get_lock(m);
449 locked = mtx_owned(mixer_lock);
451 if (left > 100 || right > 100)
454 l = (left == 0) ? 0 : snapper_volume_table[left - 1];
455 r = (right == 0) ? 0 : snapper_volume_table[right - 1];
458 case SOUND_MIXER_VOLUME:
459 reg[0] = (l & 0xff0000) >> 16;
460 reg[1] = (l & 0x00ff00) >> 8;
461 reg[2] = l & 0x0000ff;
462 reg[3] = (r & 0xff0000) >> 16;
463 reg[4] = (r & 0x00ff00) >> 8;
464 reg[5] = r & 0x0000ff;
467 * We need to unlock the mixer lock because iicbus_transfer()
468 * may sleep. The mixer lock itself is unnecessary here
469 * because it is meant to serialize hardware access, which
470 * is taken care of by the I2C layer, so this is safe.
474 mtx_unlock(mixer_lock);
476 snapper_write(sc, SNAPPER_VOLUME, reg);
479 mtx_lock(mixer_lock);
481 return (left | (right << 8));
488 snapper_setrecsrc(struct snd_mixer *m, u_int32_t src)