2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Cameron Grant <cg@freebsd.org>
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 AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, 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 #ifdef HAVE_KERNEL_OPTION_HEADERS
33 #include <dev/sound/pcm/sound.h>
34 #include <dev/sound/pcm/ac97.h>
35 #include <dev/sound/pci/aureal.h>
37 #include <dev/pci/pcireg.h>
38 #include <dev/pci/pcivar.h>
40 SND_DECLARE_FILE("$FreeBSD$");
42 /* PCI IDs of supported chips */
43 #define AU8820_PCI_ID 0x000112eb
45 /* channel interface */
46 static u_int32_t au_playfmt[] = {
47 SND_FORMAT(AFMT_U8, 1, 0),
48 SND_FORMAT(AFMT_U8, 2, 0),
49 SND_FORMAT(AFMT_S16_LE, 1, 0),
50 SND_FORMAT(AFMT_S16_LE, 2, 0),
53 static struct pcmchan_caps au_playcaps = {4000, 48000, au_playfmt, 0};
55 static u_int32_t au_recfmt[] = {
56 SND_FORMAT(AFMT_U8, 1, 0),
57 SND_FORMAT(AFMT_U8, 2, 0),
58 SND_FORMAT(AFMT_S16_LE, 1, 0),
59 SND_FORMAT(AFMT_S16_LE, 2, 0),
62 static struct pcmchan_caps au_reccaps = {4000, 48000, au_recfmt, 0};
64 /* -------------------------------------------------------------------- */
69 struct au_info *parent;
70 struct pcm_channel *channel;
71 struct snd_dbuf *buffer;
78 bus_space_tag_t st[3];
79 bus_space_handle_t sh[3];
81 bus_dma_tag_t parent_dmat;
84 u_int32_t x[32], y[128];
86 u_int32_t routes[4], interrupts;
90 static int au_init(device_t dev, struct au_info *au);
91 static void au_intr(void *);
93 /* -------------------------------------------------------------------- */
96 au_rd(struct au_info *au, int mapno, int regno, int size)
100 return bus_space_read_1(au->st[mapno], au->sh[mapno], regno);
102 return bus_space_read_2(au->st[mapno], au->sh[mapno], regno);
104 return bus_space_read_4(au->st[mapno], au->sh[mapno], regno);
111 au_wr(struct au_info *au, int mapno, int regno, u_int32_t data, int size)
115 bus_space_write_1(au->st[mapno], au->sh[mapno], regno, data);
118 bus_space_write_2(au->st[mapno], au->sh[mapno], regno, data);
121 bus_space_write_4(au->st[mapno], au->sh[mapno], regno, data);
126 /* -------------------------------------------------------------------- */
129 au_rdcd(kobj_t obj, void *arg, int regno)
131 struct au_info *au = (struct au_info *)arg;
135 au_wr(au, 0, AU_REG_CODECIO, regno, 4);
137 i=au_rd(au, 0, AU_REG_CODECIO, 4);
138 if ((i & 0x00ff0000) == (regno | 0x00800000)) break;
139 DELAY(j * 200 + 2000);
142 if (j==50) printf("pcm%d: codec timeout reading register %x (%x)\n",
143 au->unit, (regno & AU_CDC_REGMASK)>>16, i);
144 return i & AU_CDC_DATAMASK;
148 au_wrcd(kobj_t obj, void *arg, int regno, u_int32_t data)
150 struct au_info *au = (struct au_info *)arg;
154 while (j<50 && (i & AU_CDC_WROK) == 0) {
155 i=au_rd(au, 0, AU_REG_CODECST, 4);
159 if (j==50) printf("codec timeout during write of register %x, data %x\n",
161 au_wr(au, 0, AU_REG_CODECIO, (regno<<16) | AU_CDC_REGSET | data, 4);
163 i=au_rdcd(au, regno);
165 } while (0); /* (i != data && tries < 3); */
167 if (tries == 3) printf("giving up writing 0x%4x to codec reg %2x\n", data, regno);
173 static kobj_method_t au_ac97_methods[] = {
174 KOBJMETHOD(ac97_read, au_rdcd),
175 KOBJMETHOD(ac97_write, au_wrcd),
178 AC97_DECLARE(au_ac97);
180 /* -------------------------------------------------------------------- */
183 au_setbit(u_int32_t *p, char bit, u_int32_t value)
188 *p |= (value << bit);
192 au_addroute(struct au_info *au, int a, int b, int route)
194 int j = 0x1099c+(a<<2);
195 if (au->x[a] != a+0x67) j = AU_REG_RTBASE+(au->x[a]<<2);
197 au_wr(au, 0, AU_REG_RTBASE+(route<<2), 0xffffffff, 4);
198 au_wr(au, 0, j, route | (b<<7), 4);
199 au->y[route]=au->x[a];
201 au->z[route]=a & 0x000000ff;
202 au_setbit(au->routes, route, 1);
206 au_delroute(struct au_info *au, int route)
211 au_setbit(au->routes, route, 0);
213 i=au_rd(au, 0, AU_REG_RTBASE+(route<<2), 4);
214 au_wr(au, 0, AU_REG_RTBASE+(au->y[route]<<2), i, 4);
215 au->y[i & 0x7f]=au->y[route];
216 au_wr(au, 0, AU_REG_RTBASE+(route<<2), 0xfffffffe, 4);
217 if (au->x[j] == route) au->x[j]=au->y[route];
222 au_encodec(struct au_info *au, char channel)
224 au_wr(au, 0, AU_REG_CODECEN,
225 au_rd(au, 0, AU_REG_CODECEN, 4) | (1 << (channel + 8)), 4);
229 au_clrfifo(struct au_info *au, u_int32_t c)
233 for (i=0; i<32; i++) au_wr(au, 0, AU_REG_FIFOBASE+(c<<7)+(i<<2), 0, 4);
237 au_setadb(struct au_info *au, u_int32_t c, u_int32_t enable)
241 x = au_rd(au, 0, AU_REG_ADB, 4);
244 au_wr(au, 0, AU_REG_ADB, x, 4);
248 au_prepareoutput(struct au_chinfo *ch, u_int32_t format)
250 struct au_info *au = ch->parent;
251 int i, stereo = (AFMT_CHANNEL(format) > 1)? 1 : 0;
252 u_int32_t baseaddr = sndbuf_getbufaddr(ch->buffer);
254 au_wr(au, 0, 0x1061c, 0, 4);
255 au_wr(au, 0, 0x10620, 0, 4);
256 au_wr(au, 0, 0x10624, 0, 4);
257 switch(AFMT_ENCODING(format)) {
273 au_wr(au, 0, 0x10200, baseaddr, 4);
274 au_wr(au, 0, 0x10204, baseaddr+0x1000, 4);
275 au_wr(au, 0, 0x10208, baseaddr+0x2000, 4);
276 au_wr(au, 0, 0x1020c, baseaddr+0x3000, 4);
278 au_wr(au, 0, 0x10400, 0xdeffffff, 4);
279 au_wr(au, 0, 0x10404, 0xfcffffff, 4);
281 au_wr(au, 0, 0x10580, i, 4);
283 au_wr(au, 0, 0x10210, baseaddr, 4);
284 au_wr(au, 0, 0x10214, baseaddr+0x1000, 4);
285 au_wr(au, 0, 0x10218, baseaddr+0x2000, 4);
286 au_wr(au, 0, 0x1021c, baseaddr+0x3000, 4);
288 au_wr(au, 0, 0x10408, 0x00fff000 | 0x56000000 | 0x00000fff, 4);
289 au_wr(au, 0, 0x1040c, 0x00fff000 | 0x74000000 | 0x00000fff, 4);
291 au_wr(au, 0, 0x10584, i, 4);
293 au_wr(au, 0, 0x0f800, stereo? 0x00030032 : 0x00030030, 4);
294 au_wr(au, 0, 0x0f804, stereo? 0x00030032 : 0x00030030, 4);
296 au_addroute(au, 0x11, 0, 0x58);
297 au_addroute(au, 0x11, stereo? 0 : 1, 0x59);
300 /* -------------------------------------------------------------------- */
301 /* channel interface */
303 auchan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
305 struct au_info *au = devinfo;
306 struct au_chinfo *ch = (dir == PCMDIR_PLAY)? &au->pch : NULL;
312 if (sndbuf_alloc(ch->buffer, au->parent_dmat, 0, AU_BUFFSIZE) != 0)
318 auchan_setformat(kobj_t obj, void *data, u_int32_t format)
320 struct au_chinfo *ch = data;
322 if (ch->dir == PCMDIR_PLAY) au_prepareoutput(ch, format);
327 auchan_setspeed(kobj_t obj, void *data, u_int32_t speed)
329 struct au_chinfo *ch = data;
330 if (ch->dir == PCMDIR_PLAY) {
337 auchan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
343 auchan_trigger(kobj_t obj, void *data, int go)
345 struct au_chinfo *ch = data;
346 struct au_info *au = ch->parent;
348 if (!PCMTRIG_COMMON(go))
351 if (ch->dir == PCMDIR_PLAY) {
352 au_setadb(au, 0x11, (go)? 1 : 0);
353 if (go != PCMTRIG_START) {
354 au_wr(au, 0, 0xf800, 0, 4);
355 au_wr(au, 0, 0xf804, 0, 4);
356 au_delroute(au, 0x58);
357 au_delroute(au, 0x59);
365 auchan_getptr(kobj_t obj, void *data)
367 struct au_chinfo *ch = data;
368 struct au_info *au = ch->parent;
369 if (ch->dir == PCMDIR_PLAY) {
370 return au_rd(au, 0, AU_REG_UNK2, 4) & (AU_BUFFSIZE-1);
376 static struct pcmchan_caps *
377 auchan_getcaps(kobj_t obj, void *data)
379 struct au_chinfo *ch = data;
380 return (ch->dir == PCMDIR_PLAY)? &au_playcaps : &au_reccaps;
383 static kobj_method_t auchan_methods[] = {
384 KOBJMETHOD(channel_init, auchan_init),
385 KOBJMETHOD(channel_setformat, auchan_setformat),
386 KOBJMETHOD(channel_setspeed, auchan_setspeed),
387 KOBJMETHOD(channel_setblocksize, auchan_setblocksize),
388 KOBJMETHOD(channel_trigger, auchan_trigger),
389 KOBJMETHOD(channel_getptr, auchan_getptr),
390 KOBJMETHOD(channel_getcaps, auchan_getcaps),
393 CHANNEL_DECLARE(auchan);
395 /* -------------------------------------------------------------------- */
396 /* The interrupt handler */
400 struct au_info *au = p;
404 intsrc=au_rd(au, 0, AU_REG_IRQSRC, 4);
405 printf("pcm%d: interrupt with src %x\n", au->unit, intsrc);
406 if (intsrc & AU_IRQ_FATAL) printf("pcm%d: fatal error irq\n", au->unit);
407 if (intsrc & AU_IRQ_PARITY) printf("pcm%d: parity error irq\n", au->unit);
408 if (intsrc & AU_IRQ_UNKNOWN) {
409 (void)au_rd(au, 0, AU_REG_UNK1, 4);
410 au_wr(au, 0, AU_REG_UNK1, 0, 4);
411 au_wr(au, 0, AU_REG_UNK1, 0x10000, 4);
413 if (intsrc & AU_IRQ_PCMOUT) {
414 i=au_rd(au, 0, AU_REG_UNK2, 4) & (AU_BUFFSIZE-1);
415 chn_intr(au->pch.channel);
416 (void)au_rd(au, 0, AU_REG_UNK3, 4);
417 (void)au_rd(au, 0, AU_REG_UNK4, 4);
418 (void)au_rd(au, 0, AU_REG_UNK5, 4);
420 /* don't support midi
421 if (intsrc & AU_IRQ_MIDI) {
422 i=au_rd(au, 0, 0x11004, 4);
426 i=au_rd(au, 0, 0x11000, 4);
427 if ((au->midi_stat & 1) && (au->midi_out))
428 au->midi_out(au->midi_devno, i);
429 i=au_rd(au, 0, 0x11004);
433 au_wr(au, 0, AU_REG_IRQSRC, intsrc & 0x7ff, 4);
434 au_rd(au, 0, AU_REG_IRQSRC, 4);
438 /* -------------------------------------------------------------------- */
440 /* Probe and attach the card */
443 au_init(device_t dev, struct au_info *au)
447 au_wr(au, 0, AU_REG_IRQGLOB, 0xffffffff, 4);
452 for (i=0; i<32; i++) {
453 au_wr(au, 0, AU_REG_CODECCHN+(i<<2), 0, 4);
457 au_wr(au, 0, AU_REG_CODECST, 0x8068, 4);
459 au_wr(au, 0, AU_REG_CODECST, 0x00e8, 4);
462 au_wr(au, 0, AU_REG_CODECST, 0x00a8, 4);
464 au_wr(au, 0, AU_REG_CODECST, 0x80a8, 4);
466 au_wr(au, 0, AU_REG_CODECST, 0x80e8, 4);
468 au_wr(au, 0, AU_REG_CODECST, 0x80a8, 4);
470 au_wr(au, 0, AU_REG_CODECST, 0x00a8, 4);
472 au_wr(au, 0, AU_REG_CODECST, 0x00e8, 4);
477 for (i=0; i<32; i++) {
478 au_wr(au, 0, AU_REG_CODECCHN+(i<<2), 0, 4);
481 au_wr(au, 0, AU_REG_CODECST, 0xe8, 4);
483 au_wr(au, 0, AU_REG_CODECEN, 0, 4);
487 while (j<100 && (i & AU_CDC_READY)==0) {
488 i=au_rd(au, 0, AU_REG_CODECST, 4);
492 if (j==100) device_printf(dev, "codec not ready, status 0x%x\n", i);
496 for (i=0; i<32; i++) au->x[i]=i+0x67;
497 for (i=0; i<128; i++) au->y[i]=0x7f;
498 for (i=0; i<128; i++) au->z[i]=0x1f;
499 au_wr(au, 0, AU_REG_ADB, 0, 4);
500 for (i=0; i<124; i++) au_wr(au, 0, AU_REG_RTBASE+(i<<2), 0xffffffff, 4);
503 i=au_rd(au, 0, 0x107c0, 4);
504 if (i!=0xdeadbeef) device_printf(dev, "dma check failed: 0x%x\n", i);
507 au_wr(au, 0, AU_REG_IRQGLOB,
508 au_rd(au, 0, AU_REG_IRQGLOB, 4) | AU_IRQ_ENABLE, 4);
509 /* braindead but it's what the oss/linux driver does
510 * for (i=0; i<0x80000000; i++) au_wr(au, 0, i<<2, 0, 4);
512 au->routes[0]=au->routes[1]=au->routes[2]=au->routes[3]=0;
516 au_addroute(au, 0x11, 0x48, 0x02);
517 au_addroute(au, 0x11, 0x49, 0x03);
521 for (i=0; i<48; i++) au_wr(au, 0, 0xf800+(i<<2), 0x20, 4);
522 for (i=2; i<6; i++) au_wr(au, 0, 0xf800+(i<<2), 0, 4);
523 au_wr(au, 0, 0xf8c0, 0x0843, 4);
524 for (i=0; i<4; i++) au_clrfifo(au, i);
530 au_testirq(struct au_info *au)
532 au_wr(au, 0, AU_REG_UNK1, 0x80001000, 4);
533 au_wr(au, 0, AU_REG_IRQEN, 0x00001030, 4);
534 au_wr(au, 0, AU_REG_IRQSRC, 0x000007ff, 4);
536 if (au->interrupts==0) printf("pcm%d: irq test failed\n", au->unit);
537 /* this apparently generates an irq */
542 au_pci_probe(device_t dev)
544 if (pci_get_devid(dev) == AU8820_PCI_ID) {
545 device_set_desc(dev, "Aureal Vortex 8820");
546 return BUS_PROBE_DEFAULT;
553 au_pci_attach(device_t dev)
558 struct resource *reg[10];
559 int i, j, mapped = 0;
561 struct resource *irq;
563 struct ac97_info *codec;
564 char status[SND_STATUSLEN];
566 au = malloc(sizeof(*au), M_DEVBUF, M_WAITOK | M_ZERO);
567 au->unit = device_get_unit(dev);
569 pci_enable_busmaster(dev);
574 /* XXX dfr: is this strictly necessary? */
575 for (i=0; i<PCI_MAXMAPS_0; i++) {
577 /* Slapped wrist: config_id and map are private structures */
579 printf("pcm%d: map %d - allocating ", unit, i+1);
580 printf("0x%x bytes of ", 1<<config_id->map[i].ln2size);
581 printf("%s space ", (config_id->map[i].type & PCI_MAPPORT)?
583 printf("at 0x%x...", config_id->map[i].base);
586 regid[j] = PCIR_BAR(i);
587 type[j] = SYS_RES_MEMORY;
588 reg[j] = bus_alloc_resource_any(dev, type[j], ®id[j],
591 type[j] = SYS_RES_IOPORT;
592 reg[j] = bus_alloc_resource_any(dev, type[j],
593 ®id[j], RF_ACTIVE);
596 au->st[i] = rman_get_bustag(reg[j]);
597 au->sh[i] = rman_get_bushandle(reg[j]);
601 if (bootverbose) printf("%s\n", mapped? "ok" : "failed");
606 device_printf(dev, "too many resources");
612 if (j < config_id->nummaps) {
613 printf("pcm%d: unable to map a required resource\n", unit);
619 au_wr(au, 0, AU_REG_IRQEN, 0, 4);
622 irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &irqid,
623 RF_ACTIVE | RF_SHAREABLE);
624 if (!irq || snd_setup_intr(dev, irq, 0, au_intr, au, &ih)) {
625 device_printf(dev, "unable to map interrupt\n");
629 if (au_testirq(au)) device_printf(dev, "irq test failed\n");
631 if (au_init(dev, au) == -1) {
632 device_printf(dev, "unable to initialize the card\n");
636 codec = AC97_CREATE(dev, au, au_ac97);
637 if (codec == NULL) goto bad;
638 if (mixer_init(dev, ac97_getmixerclass(), codec) == -1) goto bad;
640 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
642 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
643 /*highaddr*/BUS_SPACE_MAXADDR,
644 /*filter*/NULL, /*filterarg*/NULL,
645 /*maxsize*/AU_BUFFSIZE, /*nsegments*/1, /*maxsegz*/0x3ffff,
646 /*flags*/0, /*lockfunc*/busdma_lock_mutex,
647 /*lockarg*/&Giant, &au->parent_dmat) != 0) {
648 device_printf(dev, "unable to create dma tag\n");
652 snprintf(status, SND_STATUSLEN, "at %s 0x%jx irq %jd %s",
653 (type[0] == SYS_RES_IOPORT)? "io" : "memory",
654 rman_get_start(reg[0]), rman_get_start(irq),PCM_KLDSTRING(snd_aureal));
656 if (pcm_register(dev, au, 1, 1)) goto bad;
657 /* pcm_addchan(dev, PCMDIR_REC, &au_chantemplate, au); */
658 pcm_addchan(dev, PCMDIR_PLAY, &auchan_class, au);
659 pcm_setstatus(dev, status);
664 if (au) free(au, M_DEVBUF);
665 for (i = 0; i < j; i++)
666 bus_release_resource(dev, type[i], regid[i], reg[i]);
667 if (ih) bus_teardown_intr(dev, irq, ih);
668 if (irq) bus_release_resource(dev, SYS_RES_IRQ, irqid, irq);
672 static device_method_t au_methods[] = {
673 /* Device interface */
674 DEVMETHOD(device_probe, au_pci_probe),
675 DEVMETHOD(device_attach, au_pci_attach),
680 static driver_t au_driver = {
686 DRIVER_MODULE(snd_aureal, pci, au_driver, pcm_devclass, 0, 0);
687 MODULE_DEPEND(snd_aureal, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
688 MODULE_VERSION(snd_aureal, 1);