tumbler.c revision 188259
1/*- 2 * Copyright 2008 by Marco Trillo. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 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. 12 * 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 23 * SUCH DAMAGE. 24 * 25 * $FreeBSD: head/sys/dev/sound/macio/tumbler.c 188259 2009-02-07 01:15:13Z nwhitehorn $ 26 */ 27/*- 28 * Copyright (c) 2002, 2003 Tsubai Masanari. All rights reserved. 29 * 30 * Redistribution and use in source and binary forms, with or without 31 * modification, are permitted provided that the following conditions 32 * are met: 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. 40 * 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. 51 * 52 * NetBSD: tumbler.c,v 1.28 2008/05/16 03:49:54 macallan Exp 53 * Id: tumbler.c,v 1.11 2002/10/31 17:42:13 tsubai Exp 54 */ 55 56/* 57 * Apple I2S audio controller. 58 */ 59 60#include <sys/param.h> 61#include <sys/systm.h> 62#include <sys/kernel.h> 63#include <sys/module.h> 64#include <sys/bus.h> 65#include <sys/malloc.h> 66#include <sys/lock.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> 73#include <sys/rman.h> 74 75#include <dev/iicbus/iicbus.h> 76#include <dev/iicbus/iiconf.h> 77#include <dev/ofw/ofw_bus.h> 78#include <dev/sound/pcm/sound.h> 79#include "mixer_if.h" 80 81extern kobj_class_t i2s_mixer_class; 82extern device_t i2s_mixer; 83 84struct tumbler_softc 85{ 86 device_t sc_dev; 87 uint32_t sc_addr; 88}; 89 90static int tumbler_probe(device_t); 91static int tumbler_attach(device_t); 92static int tumbler_init(struct snd_mixer *m); 93static void tumbler_uninit(struct snd_mixer *m); 94static int tumbler_reinit(struct snd_mixer *m); 95static int tumbler_set(struct snd_mixer *m, unsigned dev, unsigned left, 96 unsigned right); 97static int tumbler_setrecsrc(struct snd_mixer *m, u_int32_t src); 98 99static device_method_t tumbler_methods[] = { 100 /* Device interface. */ 101 DEVMETHOD(device_probe, tumbler_probe), 102 DEVMETHOD(device_attach, tumbler_attach), 103 104 { 0, 0 } 105}; 106 107static driver_t tumbler_driver = { 108 "tumbler", 109 tumbler_methods, 110 sizeof(struct tumbler_softc) 111}; 112static devclass_t tumbler_devclass; 113 114DRIVER_MODULE(tumbler, iicbus, tumbler_driver, tumbler_devclass, 0, 0); 115MODULE_VERSION(tumbler, 1); 116MODULE_DEPEND(tumbler, iicbus, 1, 1, 1); 117 118static kobj_method_t tumbler_mixer_methods[] = { 119 KOBJMETHOD(mixer_init, tumbler_init), 120 KOBJMETHOD(mixer_uninit, tumbler_uninit), 121 KOBJMETHOD(mixer_reinit, tumbler_reinit), 122 KOBJMETHOD(mixer_set, tumbler_set), 123 KOBJMETHOD(mixer_setrecsrc, tumbler_setrecsrc), 124 { 0, 0 } 125}; 126 127MIXER_DECLARE(tumbler_mixer); 128 129#define TUMBLER_IICADDR 0x68 /* Tumbler I2C slave address */ 130 131/* Tumbler (Texas Instruments TAS3001) registers. */ 132#define TUMBLER_MCR 0x01 /* Main control register (1byte) */ 133#define TUMBLER_DRC 0x02 /* Dynamic Range Compression (2bytes) */ 134#define TUMBLER_VOLUME 0x04 /* Volume (6bytes) */ 135#define TUMBLER_TREBLE 0x05 /* Treble control (1byte) */ 136#define TUMBLER_BASS 0x06 /* Bass control (1byte) */ 137#define TUMBLER_MIXER1 0x07 /* Mixer1 (3bytes) */ 138#define TUMBLER_MIXER2 0x08 /* Mixer2 (3bytes) */ 139#define TUMBLER_LB0 0x0a /* Left biquad 0 (15bytes) */ 140#define TUMBLER_LB1 0x0b /* Left biquad 1 (15bytes) */ 141#define TUMBLER_LB2 0x0c /* Left biquad 2 (15bytes) */ 142#define TUMBLER_LB3 0x0d /* Left biquad 3 (15bytes) */ 143#define TUMBLER_LB4 0x0e /* Left biquad 4 (15bytes) */ 144#define TUMBLER_LB5 0x0f /* Left biquad 5 (15bytes) */ 145#define TUMBLER_RB0 0x13 /* Right biquad 0 (15bytes) */ 146#define TUMBLER_RB1 0x14 /* Right biquad 1 (15bytes) */ 147#define TUMBLER_RB2 0x15 /* Right biquad 2 (15bytes) */ 148#define TUMBLER_RB3 0x16 /* Right biquad 3 (15bytes) */ 149#define TUMBLER_RB4 0x17 /* Right biquad 4 (15bytes) */ 150#define TUMBLER_RB5 0x18 /* Right biquad 5 (15bytes) */ 151#define TUMBLER_MCR_FL 0x80 /* Fast load */ 152#define TUMBLER_MCR_SC 0x40 /* SCLK frequency */ 153#define TUMBLER_MCR_SC_32 0x00 /* 32fs */ 154#define TUMBLER_MCR_SC_64 0x40 /* 64fs */ 155#define TUMBLER_MCR_SM 0x30 /* Output serial port mode */ 156#define TUMBLER_MCR_SM_L 0x00 /* Left justified */ 157#define TUMBLER_MCR_SM_R 0x10 /* Right justified */ 158#define TUMBLER_MCR_SM_I2S 0x20 /* I2S */ 159#define TUMBLER_MCR_ISM 0x0C /* Input serial mode */ 160#define TUMBLER_MCR_ISM_L 0x00 161#define TUMBLER_MCR_ISM_R 0x04 162#define TUMBLER_MCR_ISM_I2S 0x08 163#define TUMBLER_MCR_W 0x03 /* Serial port word length */ 164#define TUMBLER_MCR_W_16 0x00 /* 16 bit */ 165#define TUMBLER_MCR_W_18 0x01 /* 18 bit */ 166#define TUMBLER_MCR_W_20 0x02 /* 20 bit */ 167#define TUMBLER_DRC_COMP_31 0xc0 /* 3:1 compression */ 168#define TUMBLER_DRC_ENABLE 0x01 /* enable DRC */ 169#define TUMBLER_DRC_DEFL_TH 0xa0 /* default compression threshold */ 170 171/* 172 * Tumbler codec. 173 */ 174 175struct tumbler_reg { 176 u_char MCR[1]; 177 u_char DRC[2]; 178 u_char VOLUME[6]; 179 u_char TREBLE[1]; 180 u_char BASS[1]; 181 u_char MIXER1[3]; 182 u_char MIXER2[3]; 183 u_char LB0[15]; 184 u_char LB1[15]; 185 u_char LB2[15]; 186 u_char LB3[15]; 187 u_char LB4[15]; 188 u_char LB5[15]; 189 u_char RB0[15]; 190 u_char RB1[15]; 191 u_char RB2[15]; 192 u_char RB3[15]; 193 u_char RB4[15]; 194 u_char RB5[15]; 195}; 196 197const struct tumbler_reg tumbler_initdata = { 198 { TUMBLER_MCR_SC_64 | TUMBLER_MCR_SM_I2S | 199 TUMBLER_MCR_ISM_I2S | TUMBLER_MCR_W_16 }, /* MCR */ 200 { TUMBLER_DRC_COMP_31, TUMBLER_DRC_DEFL_TH }, /* DRC */ 201 { 0, 0, 0, 0, 0, 0 }, /* VOLUME */ 202 { 0x72 }, /* TREBLE */ 203 { 0x3e }, /* BASS */ 204 { 0x10, 0x00, 0x00 }, /* MIXER1 */ 205 { 0x00, 0x00, 0x00 }, /* MIXER2 */ 206 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 207 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 208 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 209 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 210 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 211 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 212 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 213 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 214 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 215 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 216 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* BIQUAD */ 217 { 0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } /* BIQUAD */ 218}; 219 220const char tumbler_regsize[] = { 221 0, /* 0x00 */ 222 sizeof tumbler_initdata.MCR, /* 0x01 */ 223 sizeof tumbler_initdata.DRC, /* 0x02 */ 224 0, /* 0x03 */ 225 sizeof tumbler_initdata.VOLUME, /* 0x04 */ 226 sizeof tumbler_initdata.TREBLE, /* 0x05 */ 227 sizeof tumbler_initdata.BASS, /* 0x06 */ 228 sizeof tumbler_initdata.MIXER1, /* 0x07 */ 229 sizeof tumbler_initdata.MIXER2, /* 0x08 */ 230 0, /* 0x09 */ 231 sizeof tumbler_initdata.LB0, /* 0x0a */ 232 sizeof tumbler_initdata.LB1, /* 0x0b */ 233 sizeof tumbler_initdata.LB2, /* 0x0c */ 234 sizeof tumbler_initdata.LB3, /* 0x0d */ 235 sizeof tumbler_initdata.LB4, /* 0x0e */ 236 sizeof tumbler_initdata.LB5, /* 0x0f */ 237 0, /* 0x10 */ 238 0, /* 0x11 */ 239 0, /* 0x12 */ 240 sizeof tumbler_initdata.RB0, /* 0x13 */ 241 sizeof tumbler_initdata.RB1, /* 0x14 */ 242 sizeof tumbler_initdata.RB2, /* 0x15 */ 243 sizeof tumbler_initdata.RB3, /* 0x16 */ 244 sizeof tumbler_initdata.RB4, /* 0x17 */ 245 sizeof tumbler_initdata.RB5 /* 0x18 */ 246}; 247 248/* dB = 20 * log (x) table. */ 249static u_int tumbler_volume_table[100] = { 250 0x00000148, 0x0000015C, 0x00000171, 0x00000186, // -46.0, -45.5, -45.0, -44.5, 251 0x0000019E, 0x000001B6, 0x000001D0, 0x000001EB, // -44.0, -43.5, -43.0, -42.5, 252 0x00000209, 0x00000227, 0x00000248, 0x0000026B, // -42.0, -41.5, -41.0, -40.5, 253 0x0000028F, 0x000002B6, 0x000002DF, 0x0000030B, // -40.0, -39.5, -39.0, -38.5, 254 0x00000339, 0x0000036A, 0x0000039E, 0x000003D5, // -38.0, -37.5, -37.0, -36.5, 255 0x0000040F, 0x0000044C, 0x0000048D, 0x000004D2, // -36.0, -35.5, -35.0, -34.5, 256 0x0000051C, 0x00000569, 0x000005BB, 0x00000612, // -34.0, -33.5, -33.0, -32.5, 257 0x0000066E, 0x000006D0, 0x00000737, 0x000007A5, // -32.0, -31.5, -31.0, -30.5, 258 0x00000818, 0x00000893, 0x00000915, 0x0000099F, // -30.0, -29.5, -29.0, -28.5, 259 0x00000A31, 0x00000ACC, 0x00000B6F, 0x00000C1D, // -28.0, -27.5, -27.0, -26.5, 260 0x00000CD5, 0x00000D97, 0x00000E65, 0x00000F40, // -26.0, -25.5, -25.0, -24.5, 261 0x00001027, 0x0000111C, 0x00001220, 0x00001333, // -24.0, -23.5, -23.0, -22.5, 262 0x00001456, 0x0000158A, 0x000016D1, 0x0000182B, // -22.0, -21.5, -21.0, -20.5, 263 0x0000199A, 0x00001B1E, 0x00001CB9, 0x00001E6D, // -20.0, -19.5, -19.0, -18.5, 264 0x0000203A, 0x00002223, 0x00002429, 0x0000264E, // -18.0, -17.5, -17.0, -16.5, 265 0x00002893, 0x00002AFA, 0x00002D86, 0x00003039, // -16.0, -15.5, -15.0, -14.5, 266 0x00003314, 0x0000361B, 0x00003950, 0x00003CB5, // -14.0, -13.5, -13.0, -12.5, 267 0x0000404E, 0x0000441D, 0x00004827, 0x00004C6D, // -12.0, -11.5, -11.0, -10.5, 268 0x000050F4, 0x000055C0, 0x00005AD5, 0x00006037, // -10.0, -9.5, -9.0, -8.5, 269 0x000065EA, 0x00006BF4, 0x0000725A, 0x00007920, // -8.0, -7.5, -7.0, -6.5, 270 0x0000804E, 0x000087EF, 0x00008FF6, 0x0000987D, // -6.0, -5.5, -5.0, -4.5, 271 0x0000A186, 0x0000AB19, 0x0000B53C, 0x0000BFF9, // -4.0, -3.5, -3.0, -2.5, 272 0x0000CB59, 0x0000D766, 0x0000E429, 0x0000F1AE, // -2.0, -1.5, -1.0, -0.5, 273 0x00010000, 0x00010F2B, 0x00011F3D, 0x00013042, // 0.0, +0.5, +1.0, +1.5, 274 0x00014249, 0x00015562, 0x0001699C, 0x00017F09 // 2.0, +2.5, +3.0, +3.5, 275}; 276 277static int 278tumbler_write(struct tumbler_softc *sc, uint8_t reg, const void *data) 279{ 280 u_int size; 281 uint8_t buf[16]; 282 283 struct iic_msg msg[] = { 284 { sc->sc_addr, IIC_M_WR, 0, buf } 285 }; 286 287 KASSERT(reg < sizeof(tumbler_regsize), ("bad reg")); 288 size = tumbler_regsize[reg]; 289 msg[0].len = size + 1; 290 buf[0] = reg; 291 memcpy(&buf[1], data, size); 292 293 iicbus_transfer(sc->sc_dev, msg, 1); 294 295 return (0); 296} 297 298static int 299tumbler_probe(device_t dev) 300{ 301 const char *name; 302 303 name = ofw_bus_get_name(dev); 304 if (name == NULL) 305 return (ENXIO); 306 307 if (strcmp(name, "deq") == 0 && iicbus_get_addr(dev) == 308 TUMBLER_IICADDR) { 309 device_set_desc(dev, "Texas Instruments TAS3001 Audio Codec"); 310 return (0); 311 } 312 313 return (ENXIO); 314} 315 316static int 317tumbler_attach(device_t dev) 318{ 319 struct tumbler_softc *sc; 320 321 sc = device_get_softc(dev); 322 sc->sc_dev = dev; 323 sc->sc_addr = iicbus_get_addr(dev); 324 325 i2s_mixer_class = &tumbler_mixer_class; 326 i2s_mixer = dev; 327 328 return (0); 329} 330 331static int 332tumbler_init(struct snd_mixer *m) 333{ 334 struct tumbler_softc *sc; 335 u_int x = 0; 336 337 sc = device_get_softc(mix_getdevinfo(m)); 338 339 tumbler_write(sc, TUMBLER_LB0, tumbler_initdata.LB0); 340 tumbler_write(sc, TUMBLER_LB1, tumbler_initdata.LB1); 341 tumbler_write(sc, TUMBLER_LB2, tumbler_initdata.LB2); 342 tumbler_write(sc, TUMBLER_LB3, tumbler_initdata.LB3); 343 tumbler_write(sc, TUMBLER_LB4, tumbler_initdata.LB4); 344 tumbler_write(sc, TUMBLER_LB5, tumbler_initdata.LB5); 345 tumbler_write(sc, TUMBLER_RB0, tumbler_initdata.RB0); 346 tumbler_write(sc, TUMBLER_RB1, tumbler_initdata.RB1); 347 tumbler_write(sc, TUMBLER_RB1, tumbler_initdata.RB1); 348 tumbler_write(sc, TUMBLER_RB2, tumbler_initdata.RB2); 349 tumbler_write(sc, TUMBLER_RB3, tumbler_initdata.RB3); 350 tumbler_write(sc, TUMBLER_RB4, tumbler_initdata.RB4); 351 tumbler_write(sc, TUMBLER_RB5, tumbler_initdata.RB5); 352 tumbler_write(sc, TUMBLER_MCR, tumbler_initdata.MCR); 353 tumbler_write(sc, TUMBLER_DRC, tumbler_initdata.DRC); 354 tumbler_write(sc, TUMBLER_VOLUME, tumbler_initdata.VOLUME); 355 tumbler_write(sc, TUMBLER_TREBLE, tumbler_initdata.TREBLE); 356 tumbler_write(sc, TUMBLER_BASS, tumbler_initdata.BASS); 357 tumbler_write(sc, TUMBLER_MIXER1, tumbler_initdata.MIXER1); 358 tumbler_write(sc, TUMBLER_MIXER2, tumbler_initdata.MIXER2); 359 360 x |= SOUND_MASK_VOLUME; 361 mix_setdevs(m, x); 362 363 return (0); 364} 365 366static void 367tumbler_uninit(struct snd_mixer *m) 368{ 369 return; 370} 371 372static int 373tumbler_reinit(struct snd_mixer *m) 374{ 375 return (0); 376} 377 378static int 379tumbler_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right) 380{ 381 struct tumbler_softc *sc; 382 struct mtx *mixer_lock; 383 int locked; 384 u_int l, r; 385 u_char reg[6]; 386 387 sc = device_get_softc(mix_getdevinfo(m)); 388 mixer_lock = mixer_get_lock(m); 389 locked = mtx_owned(mixer_lock); 390 391 switch (dev) { 392 case SOUND_MIXER_VOLUME: 393 if (left > 100 || right > 100) 394 return (0); 395 396 l = (left == 0 ? 0 : tumbler_volume_table[left - 1]); 397 r = (right == 0 ? 0 : tumbler_volume_table[right - 1]); 398 399 reg[0] = (l & 0xff0000) >> 16; 400 reg[1] = (l & 0x00ff00) >> 8; 401 reg[2] = l & 0x0000ff; 402 reg[3] = (r & 0xff0000) >> 16; 403 reg[4] = (r & 0x00ff00) >> 8; 404 reg[5] = r & 0x0000ff; 405 406 /* 407 * We need to unlock the mixer lock because iicbus_transfer() 408 * may sleep. The mixer lock itself is unnecessary here 409 * because it is meant to serialize hardware access, which 410 * is taken care of by the I2C layer, so this is safe. 411 */ 412 413 if (locked) 414 mtx_unlock(mixer_lock); 415 416 tumbler_write(sc, TUMBLER_VOLUME, reg); 417 418 if (locked) 419 mtx_lock(mixer_lock); 420 421 return (left | (right << 8)); 422 } 423 424 return (0); 425} 426 427static int 428tumbler_setrecsrc(struct snd_mixer *m, u_int32_t src) 429{ 430 return (0); 431} 432 433