2 * Copyright (c) 2000 David Jones <dej@ox.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/sound/pci/via82c686.c,v 1.34.2.2 2007/04/26 08:21:44 ariff Exp $
29 #include <dev/sound/pcm/sound.h>
30 #include <dev/sound/pcm/ac97.h>
32 #include <bus/pci/pcireg.h>
33 #include <bus/pci/pcivar.h>
34 #include <sys/sysctl.h>
36 #include <dev/sound/pci/via82c686.h>
38 SND_DECLARE_FILE("$DragonFly: src/sys/dev/sound/pci/via82c686.c,v 1.10 2007/06/16 20:07:19 dillon Exp $");
40 #define VIA_PCI_ID 0x30581106
41 #define NSEGS 4 /* Number of segments in SGD table */
43 #define SEGS_PER_CHAN (NSEGS/2)
46 #define VIA_DEFAULT_BUFSZ 0x1000
51 /* we rely on this struct being packed to 64 bits */
55 #define VIA_DMAOP_EOL 0x80000000
56 #define VIA_DMAOP_FLAG 0x40000000
57 #define VIA_DMAOP_STOP 0x20000000
58 #define VIA_DMAOP_COUNT(x) ((x)&0x00FFFFFF)
64 struct via_info *parent;
65 struct pcm_channel *channel;
66 struct snd_dbuf *buffer;
67 struct via_dma_op *sgd_table;
70 int base, count, mode, ctrl;
75 bus_space_handle_t sh;
76 bus_dma_tag_t parent_dmat;
77 bus_dma_tag_t sgd_dmat;
78 bus_dmamap_t sgd_dmamap;
81 struct resource *reg, *irq;
84 struct ac97_info *codec;
88 struct via_chinfo pch, rch;
89 struct via_dma_op *sgd_table;
94 static u_int32_t via_fmt[] = {
96 AFMT_STEREO | AFMT_U8,
98 AFMT_STEREO | AFMT_S16_LE,
101 static struct pcmchan_caps via_vracaps = {4000, 48000, via_fmt, 0};
102 static struct pcmchan_caps via_caps = {48000, 48000, via_fmt, 0};
104 static __inline u_int32_t
105 via_rd(struct via_info *via, int regno, int size)
110 return bus_space_read_1(via->st, via->sh, regno);
112 return bus_space_read_2(via->st, via->sh, regno);
114 return bus_space_read_4(via->st, via->sh, regno);
122 via_wr(struct via_info *via, int regno, u_int32_t data, int size)
127 bus_space_write_1(via->st, via->sh, regno, data);
130 bus_space_write_2(via->st, via->sh, regno, data);
133 bus_space_write_4(via->st, via->sh, regno, data);
138 /* -------------------------------------------------------------------- */
139 /* Codec interface */
142 via_waitready_codec(struct via_info *via)
146 /* poll until codec not busy */
147 for (i = 0; (i < TIMEOUT) &&
148 (via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_BUSY); i++)
151 kprintf("via: codec busy\n");
160 via_waitvalid_codec(struct via_info *via)
164 /* poll until codec valid */
165 for (i = 0; (i < TIMEOUT) &&
166 !(via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_PRIVALID); i++)
169 kprintf("via: codec invalid\n");
178 via_write_codec(kobj_t obj, void *addr, int reg, u_int32_t val)
180 struct via_info *via = addr;
182 if (via_waitready_codec(via)) return -1;
184 via_wr(via, VIA_CODEC_CTL, VIA_CODEC_PRIVALID | VIA_CODEC_INDEX(reg) | val, 4);
191 via_read_codec(kobj_t obj, void *addr, int reg)
193 struct via_info *via = addr;
195 if (via_waitready_codec(via))
198 via_wr(via, VIA_CODEC_CTL, VIA_CODEC_PRIVALID | VIA_CODEC_READ | VIA_CODEC_INDEX(reg),4);
200 if (via_waitready_codec(via))
203 if (via_waitvalid_codec(via))
206 return via_rd(via, VIA_CODEC_CTL, 2);
209 static kobj_method_t via_ac97_methods[] = {
210 KOBJMETHOD(ac97_read, via_read_codec),
211 KOBJMETHOD(ac97_write, via_write_codec),
214 AC97_DECLARE(via_ac97);
216 /* -------------------------------------------------------------------- */
219 via_buildsgdt(struct via_chinfo *ch)
221 u_int32_t phys_addr, flag;
222 int i, segs, seg_size;
225 * Build the scatter/gather DMA (SGD) table.
226 * There are four slots in the table: two for play, two for record.
227 * This creates two half-buffers, one of which is playing; the other
230 seg_size = ch->blksz;
231 segs = sndbuf_getsize(ch->buffer) / seg_size;
232 phys_addr = sndbuf_getbufaddr(ch->buffer);
234 for (i = 0; i < segs; i++) {
235 flag = (i == segs - 1)? VIA_DMAOP_EOL : VIA_DMAOP_FLAG;
236 ch->sgd_table[i].ptr = phys_addr + (i * seg_size);
237 ch->sgd_table[i].flags = flag | seg_size;
243 /* channel interface */
245 viachan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
247 struct via_info *via = devinfo;
248 struct via_chinfo *ch;
250 snd_mtxlock(via->lock);
251 if (dir == PCMDIR_PLAY) {
253 ch->base = VIA_PLAY_DMAOPS_BASE;
254 ch->count = VIA_PLAY_DMAOPS_COUNT;
255 ch->ctrl = VIA_PLAY_CONTROL;
256 ch->mode = VIA_PLAY_MODE;
257 ch->sgd_addr = via->sgd_addr;
258 ch->sgd_table = &via->sgd_table[0];
261 ch->base = VIA_RECORD_DMAOPS_BASE;
262 ch->count = VIA_RECORD_DMAOPS_COUNT;
263 ch->ctrl = VIA_RECORD_CONTROL;
264 ch->mode = VIA_RECORD_MODE;
265 ch->sgd_addr = via->sgd_addr + sizeof(struct via_dma_op) * SEGS_PER_CHAN;
266 ch->sgd_table = &via->sgd_table[SEGS_PER_CHAN];
273 snd_mtxunlock(via->lock);
275 if (sndbuf_alloc(ch->buffer, via->parent_dmat, via->bufsz) != 0)
282 viachan_setformat(kobj_t obj, void *data, u_int32_t format)
284 struct via_chinfo *ch = data;
285 struct via_info *via = ch->parent;
289 if (format & AFMT_STEREO)
290 mode_set |= VIA_RPMODE_STEREO;
291 if (format & AFMT_S16_LE)
292 mode_set |= VIA_RPMODE_16BIT;
294 DEB(kprintf("set format: dir = %d, format=%x\n", ch->dir, format));
295 snd_mtxlock(via->lock);
296 mode = via_rd(via, ch->mode, 1);
297 mode &= ~(VIA_RPMODE_16BIT | VIA_RPMODE_STEREO);
299 via_wr(via, ch->mode, mode, 1);
300 snd_mtxunlock(via->lock);
306 viachan_setspeed(kobj_t obj, void *data, u_int32_t speed)
308 struct via_chinfo *ch = data;
309 struct via_info *via = ch->parent;
313 * Basic AC'97 defines a 48 kHz sample rate only. For other rates,
314 * upsampling is required.
316 * The VT82C686A does not perform upsampling, and neither do we.
317 * If the codec supports variable-rate audio (i.e. does the upsampling
318 * itself), then negotiate the rate with the codec. Otherwise,
319 * return 48 kHz cuz that's all you got.
321 if (via->codec_caps & AC97_EXTCAP_VRA) {
322 reg = (ch->dir == PCMDIR_PLAY)? AC97_REGEXT_FDACRATE : AC97_REGEXT_LADCRATE;
323 return ac97_setrate(via->codec, reg, speed);
329 viachan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
331 struct via_chinfo *ch = data;
333 ch->blksz = blocksize;
334 sndbuf_resize(ch->buffer, SEGS_PER_CHAN, ch->blksz);
340 viachan_trigger(kobj_t obj, void *data, int go)
342 struct via_chinfo *ch = data;
343 struct via_info *via = ch->parent;
344 bus_addr_t sgd_addr = ch->sgd_addr;
346 if (go == PCMTRIG_EMLDMAWR || go == PCMTRIG_EMLDMARD)
349 DEB(kprintf("ado located at va=%p pa=%x\n", ado, sgd_addr));
351 snd_mtxlock(via->lock);
352 if (go == PCMTRIG_START) {
354 via_wr(via, ch->base, sgd_addr, 4);
355 via_wr(via, ch->ctrl, VIA_RPCTRL_START, 1);
357 via_wr(via, ch->ctrl, VIA_RPCTRL_TERMINATE, 1);
358 snd_mtxunlock(via->lock);
360 DEB(kprintf("viachan_trigger: go=%d\n", go));
365 viachan_getptr(kobj_t obj, void *data)
367 struct via_chinfo *ch = data;
368 struct via_info *via = ch->parent;
369 bus_addr_t sgd_addr = ch->sgd_addr;
370 int ptr, base, base1, len, seg;
372 snd_mtxlock(via->lock);
373 base1 = via_rd(via, ch->base, 4);
374 len = via_rd(via, ch->count, 4);
375 base = via_rd(via, ch->base, 4);
376 if (base != base1) /* Avoid race hazard */
377 len = via_rd(via, ch->count, 4);
378 snd_mtxunlock(via->lock);
380 DEB(kprintf("viachan_getptr: len / base = %x / %x\n", len, base));
382 /* Base points to SGD segment to do, one past current */
384 /* Determine how many segments have been done */
385 seg = (base - sgd_addr) / sizeof(struct via_dma_op);
389 /* Now work out offset: seg less count */
390 ptr = (seg * sndbuf_getsize(ch->buffer) / SEGS_PER_CHAN) - len;
391 if (ch->dir == PCMDIR_REC) {
392 /* DMA appears to operate on memory 'lines' of 32 bytes */
393 /* so don't return any part line - it isn't in RAM yet */
397 DEB(kprintf("return ptr=%d\n", ptr));
401 static struct pcmchan_caps *
402 viachan_getcaps(kobj_t obj, void *data)
404 struct via_chinfo *ch = data;
405 struct via_info *via = ch->parent;
407 return (via->codec_caps & AC97_EXTCAP_VRA)? &via_vracaps : &via_caps;
410 static kobj_method_t viachan_methods[] = {
411 KOBJMETHOD(channel_init, viachan_init),
412 KOBJMETHOD(channel_setformat, viachan_setformat),
413 KOBJMETHOD(channel_setspeed, viachan_setspeed),
414 KOBJMETHOD(channel_setblocksize, viachan_setblocksize),
415 KOBJMETHOD(channel_trigger, viachan_trigger),
416 KOBJMETHOD(channel_getptr, viachan_getptr),
417 KOBJMETHOD(channel_getcaps, viachan_getcaps),
420 CHANNEL_DECLARE(viachan);
422 /* -------------------------------------------------------------------- */
427 struct via_info *via = p;
429 /* DEB(kprintf("viachan_intr\n")); */
431 snd_mtxlock(via->lock);
432 if (via_rd(via, VIA_PLAY_STAT, 1) & VIA_RPSTAT_INTR) {
433 via_wr(via, VIA_PLAY_STAT, VIA_RPSTAT_INTR, 1);
434 snd_mtxunlock(via->lock);
435 chn_intr(via->pch.channel);
436 snd_mtxlock(via->lock);
440 if (via_rd(via, VIA_RECORD_STAT, 1) & VIA_RPSTAT_INTR) {
441 via_wr(via, VIA_RECORD_STAT, VIA_RPSTAT_INTR, 1);
442 snd_mtxunlock(via->lock);
443 chn_intr(via->rch.channel);
446 snd_mtxunlock(via->lock);
450 * Probe and attach the card
453 via_probe(device_t dev)
455 if (pci_get_devid(dev) == VIA_PCI_ID) {
456 device_set_desc(dev, "VIA VT82C686A");
457 return BUS_PROBE_DEFAULT;
464 dma_cb(void *p, bus_dma_segment_t *bds, int a, int b)
466 struct via_info *via = (struct via_info *)p;
467 via->sgd_addr = bds->ds_addr;
472 via_attach(device_t dev)
474 struct via_info *via = NULL;
475 char status[SND_STATUSLEN];
478 via = kmalloc(sizeof *via, M_DEVBUF, M_WAITOK | M_ZERO);
479 via->lock = snd_mtxcreate(device_get_nameunit(dev), "sound softc");
482 data = pci_read_config(dev, PCIR_COMMAND, 2);
483 data |= (PCIM_CMD_PORTEN | PCIM_CMD_BUSMASTEREN);
484 pci_write_config(dev, PCIR_COMMAND, data, 2);
485 data = pci_read_config(dev, PCIR_COMMAND, 2);
487 /* Wake up and reset AC97 if necessary */
488 data = pci_read_config(dev, VIA_AC97STATUS, 1);
490 if ((data & VIA_AC97STATUS_RDY) == 0) {
491 /* Cold reset per ac97r2.3 spec (page 95) */
492 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
493 DELAY(100); /* Wait T_rst_low */
494 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_NRST, 1); /* Assert high */
495 DELAY(5); /* Wait T_rst2clk */
496 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
499 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
501 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_SYNC, 1); /* Sync */
502 DELAY(5); /* Wait T_sync_high */
503 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
504 DELAY(5); /* Wait T_sync2clk */
507 /* Power everything up */
508 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_DESIRED, 1);
510 /* Wait for codec to become ready (largest reported delay here 310ms) */
511 for (cnt = 0; cnt < 2000; cnt++) {
512 data = pci_read_config(dev, VIA_AC97STATUS, 1);
513 if (data & VIA_AC97STATUS_RDY)
518 via->regid = PCIR_BAR(0);
519 via->reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
520 &via->regid, RF_ACTIVE);
522 device_printf(dev, "cannot allocate bus resource.");
525 via->st = rman_get_bustag(via->reg);
526 via->sh = rman_get_bushandle(via->reg);
528 via->bufsz = pcm_getbuffersize(dev, 4096, VIA_DEFAULT_BUFSZ, 65536);
531 via->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &via->irqid,
532 RF_ACTIVE | RF_SHAREABLE);
533 if (!via->irq || snd_setup_intr(dev, via->irq, INTR_MPSAFE, via_intr, via, &via->ih)) {
534 device_printf(dev, "unable to map interrupt\n");
538 via_wr(via, VIA_PLAY_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
539 via_wr(via, VIA_RECORD_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
541 via->codec = AC97_CREATE(dev, via, via_ac97);
545 if (mixer_init(dev, ac97_getmixerclass(), via->codec))
548 via->codec_caps = ac97_getextcaps(via->codec);
549 ac97_setextmode(via->codec,
550 via->codec_caps & (AC97_EXTCAP_VRA | AC97_EXTCAP_VRM));
552 /* DMA tag for buffers */
553 if (bus_dma_tag_create(/*parent*/NULL, /*alignment*/2, /*boundary*/0,
554 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
555 /*highaddr*/BUS_SPACE_MAXADDR,
556 /*filter*/NULL, /*filterarg*/NULL,
557 /*maxsize*/via->bufsz, /*nsegments*/1, /*maxsegz*/0x3ffff,
559 &via->parent_dmat) != 0) {
560 device_printf(dev, "unable to create dma tag\n");
565 * DMA tag for SGD table. The 686 uses scatter/gather DMA and
566 * requires a list in memory of work to do. We need only 16 bytes
567 * for this list, and it is wasteful to allocate 16K.
569 if (bus_dma_tag_create(/*parent*/NULL, /*alignment*/2, /*boundary*/0,
570 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
571 /*highaddr*/BUS_SPACE_MAXADDR,
572 /*filter*/NULL, /*filterarg*/NULL,
573 /*maxsize*/NSEGS * sizeof(struct via_dma_op),
574 /*nsegments*/1, /*maxsegz*/0x3ffff,
576 &via->sgd_dmat) != 0) {
577 device_printf(dev, "unable to create dma tag\n");
581 if (bus_dmamem_alloc(via->sgd_dmat, (void **)&via->sgd_table,
582 BUS_DMA_NOWAIT, &via->sgd_dmamap) != 0)
584 if (bus_dmamap_load(via->sgd_dmat, via->sgd_dmamap, via->sgd_table,
585 NSEGS * sizeof(struct via_dma_op), dma_cb, via, 0) != 0)
588 ksnprintf(status, SND_STATUSLEN, "at io 0x%lx irq %ld %s",
589 rman_get_start(via->reg), rman_get_start(via->irq),
590 PCM_KLDSTRING(snd_via82c686));
593 if (pcm_register(dev, via, 1, 1)) goto bad;
594 pcm_addchan(dev, PCMDIR_PLAY, &viachan_class, via);
595 pcm_addchan(dev, PCMDIR_REC, &viachan_class, via);
596 pcm_setstatus(dev, status);
599 if (via->codec) ac97_destroy(via->codec);
600 if (via->reg) bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
601 if (via->ih) bus_teardown_intr(dev, via->irq, via->ih);
602 if (via->irq) bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
603 if (via->parent_dmat) bus_dma_tag_destroy(via->parent_dmat);
604 if (via->sgd_dmamap) bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
605 if (via->sgd_table) bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
606 if (via->sgd_dmat) bus_dma_tag_destroy(via->sgd_dmat);
607 if (via->lock) snd_mtxfree(via->lock);
608 if (via) kfree(via, M_DEVBUF);
613 via_detach(device_t dev)
616 struct via_info *via = NULL;
618 r = pcm_unregister(dev);
622 via = pcm_getdevinfo(dev);
623 bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
624 bus_teardown_intr(dev, via->irq, via->ih);
625 bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
626 bus_dma_tag_destroy(via->parent_dmat);
627 bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
628 bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
629 bus_dma_tag_destroy(via->sgd_dmat);
630 snd_mtxfree(via->lock);
631 kfree(via, M_DEVBUF);
636 static device_method_t via_methods[] = {
637 DEVMETHOD(device_probe, via_probe),
638 DEVMETHOD(device_attach, via_attach),
639 DEVMETHOD(device_detach, via_detach),
643 static driver_t via_driver = {
649 DRIVER_MODULE(snd_via82c686, pci, via_driver, pcm_devclass, NULL, NULL);
650 MODULE_DEPEND(snd_via82c686, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
651 MODULE_VERSION(snd_via82c686, 1);