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
27 #include <dev/sound/pcm/sound.h>
28 #include <dev/sound/pcm/ac97.h>
30 #include <dev/pci/pcireg.h>
31 #include <dev/pci/pcivar.h>
32 #include <sys/sysctl.h>
34 #include <dev/sound/pci/via82c686.h>
36 SND_DECLARE_FILE("$FreeBSD$");
38 #define VIA_PCI_ID 0x30581106
39 #define NSEGS 4 /* Number of segments in SGD table */
41 #define SEGS_PER_CHAN (NSEGS/2)
44 #define VIA_DEFAULT_BUFSZ 0x1000
49 /* we rely on this struct being packed to 64 bits */
53 #define VIA_DMAOP_EOL 0x80000000
54 #define VIA_DMAOP_FLAG 0x40000000
55 #define VIA_DMAOP_STOP 0x20000000
56 #define VIA_DMAOP_COUNT(x) ((x)&0x00FFFFFF)
62 struct via_info *parent;
63 struct pcm_channel *channel;
64 struct snd_dbuf *buffer;
65 struct via_dma_op *sgd_table;
68 int base, count, mode, ctrl;
73 bus_space_handle_t sh;
74 bus_dma_tag_t parent_dmat;
75 bus_dma_tag_t sgd_dmat;
76 bus_dmamap_t sgd_dmamap;
79 struct resource *reg, *irq;
82 struct ac97_info *codec;
86 struct via_chinfo pch, rch;
87 struct via_dma_op *sgd_table;
92 static u_int32_t via_fmt[] = {
94 AFMT_STEREO | AFMT_U8,
96 AFMT_STEREO | AFMT_S16_LE,
99 static struct pcmchan_caps via_vracaps = {4000, 48000, via_fmt, 0};
100 static struct pcmchan_caps via_caps = {48000, 48000, via_fmt, 0};
102 static __inline u_int32_t
103 via_rd(struct via_info *via, int regno, int size)
108 return bus_space_read_1(via->st, via->sh, regno);
110 return bus_space_read_2(via->st, via->sh, regno);
112 return bus_space_read_4(via->st, via->sh, regno);
120 via_wr(struct via_info *via, int regno, u_int32_t data, int size)
125 bus_space_write_1(via->st, via->sh, regno, data);
128 bus_space_write_2(via->st, via->sh, regno, data);
131 bus_space_write_4(via->st, via->sh, regno, data);
136 /* -------------------------------------------------------------------- */
137 /* Codec interface */
140 via_waitready_codec(struct via_info *via)
144 /* poll until codec not busy */
145 for (i = 0; (i < TIMEOUT) &&
146 (via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_BUSY); i++)
149 printf("via: codec busy\n");
158 via_waitvalid_codec(struct via_info *via)
162 /* poll until codec valid */
163 for (i = 0; (i < TIMEOUT) &&
164 !(via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_PRIVALID); i++)
167 printf("via: codec invalid\n");
176 via_write_codec(kobj_t obj, void *addr, int reg, u_int32_t val)
178 struct via_info *via = addr;
180 if (via_waitready_codec(via)) return -1;
182 via_wr(via, VIA_CODEC_CTL, VIA_CODEC_PRIVALID | VIA_CODEC_INDEX(reg) | val, 4);
189 via_read_codec(kobj_t obj, void *addr, int reg)
191 struct via_info *via = addr;
193 if (via_waitready_codec(via))
196 via_wr(via, VIA_CODEC_CTL, VIA_CODEC_PRIVALID | VIA_CODEC_READ | VIA_CODEC_INDEX(reg),4);
198 if (via_waitready_codec(via))
201 if (via_waitvalid_codec(via))
204 return via_rd(via, VIA_CODEC_CTL, 2);
207 static kobj_method_t via_ac97_methods[] = {
208 KOBJMETHOD(ac97_read, via_read_codec),
209 KOBJMETHOD(ac97_write, via_write_codec),
212 AC97_DECLARE(via_ac97);
214 /* -------------------------------------------------------------------- */
217 via_buildsgdt(struct via_chinfo *ch)
219 u_int32_t phys_addr, flag;
220 int i, segs, seg_size;
223 * Build the scatter/gather DMA (SGD) table.
224 * There are four slots in the table: two for play, two for record.
225 * This creates two half-buffers, one of which is playing; the other
228 seg_size = ch->blksz;
229 segs = sndbuf_getsize(ch->buffer) / seg_size;
230 phys_addr = sndbuf_getbufaddr(ch->buffer);
232 for (i = 0; i < segs; i++) {
233 flag = (i == segs - 1)? VIA_DMAOP_EOL : VIA_DMAOP_FLAG;
234 ch->sgd_table[i].ptr = phys_addr + (i * seg_size);
235 ch->sgd_table[i].flags = flag | seg_size;
241 /* channel interface */
243 viachan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
245 struct via_info *via = devinfo;
246 struct via_chinfo *ch;
248 snd_mtxlock(via->lock);
249 if (dir == PCMDIR_PLAY) {
251 ch->base = VIA_PLAY_DMAOPS_BASE;
252 ch->count = VIA_PLAY_DMAOPS_COUNT;
253 ch->ctrl = VIA_PLAY_CONTROL;
254 ch->mode = VIA_PLAY_MODE;
255 ch->sgd_addr = via->sgd_addr;
256 ch->sgd_table = &via->sgd_table[0];
259 ch->base = VIA_RECORD_DMAOPS_BASE;
260 ch->count = VIA_RECORD_DMAOPS_COUNT;
261 ch->ctrl = VIA_RECORD_CONTROL;
262 ch->mode = VIA_RECORD_MODE;
263 ch->sgd_addr = via->sgd_addr + sizeof(struct via_dma_op) * SEGS_PER_CHAN;
264 ch->sgd_table = &via->sgd_table[SEGS_PER_CHAN];
271 snd_mtxunlock(via->lock);
273 if (sndbuf_alloc(ch->buffer, via->parent_dmat, 0, via->bufsz) != 0)
280 viachan_setformat(kobj_t obj, void *data, u_int32_t format)
282 struct via_chinfo *ch = data;
283 struct via_info *via = ch->parent;
287 if (format & AFMT_STEREO)
288 mode_set |= VIA_RPMODE_STEREO;
289 if (format & AFMT_S16_LE)
290 mode_set |= VIA_RPMODE_16BIT;
292 DEB(printf("set format: dir = %d, format=%x\n", ch->dir, format));
293 snd_mtxlock(via->lock);
294 mode = via_rd(via, ch->mode, 1);
295 mode &= ~(VIA_RPMODE_16BIT | VIA_RPMODE_STEREO);
297 via_wr(via, ch->mode, mode, 1);
298 snd_mtxunlock(via->lock);
304 viachan_setspeed(kobj_t obj, void *data, u_int32_t speed)
306 struct via_chinfo *ch = data;
307 struct via_info *via = ch->parent;
311 * Basic AC'97 defines a 48 kHz sample rate only. For other rates,
312 * upsampling is required.
314 * The VT82C686A does not perform upsampling, and neither do we.
315 * If the codec supports variable-rate audio (i.e. does the upsampling
316 * itself), then negotiate the rate with the codec. Otherwise,
317 * return 48 kHz cuz that's all you got.
319 if (via->codec_caps & AC97_EXTCAP_VRA) {
320 reg = (ch->dir == PCMDIR_PLAY)? AC97_REGEXT_FDACRATE : AC97_REGEXT_LADCRATE;
321 return ac97_setrate(via->codec, reg, speed);
327 viachan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
329 struct via_chinfo *ch = data;
331 ch->blksz = blocksize;
332 sndbuf_resize(ch->buffer, SEGS_PER_CHAN, ch->blksz);
338 viachan_trigger(kobj_t obj, void *data, int go)
340 struct via_chinfo *ch = data;
341 struct via_info *via = ch->parent;
342 struct via_dma_op *ado;
343 bus_addr_t sgd_addr = ch->sgd_addr;
345 if (!PCMTRIG_COMMON(go))
349 DEB(printf("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(printf("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 struct via_dma_op *ado;
370 bus_addr_t sgd_addr = ch->sgd_addr;
371 int ptr, base, base1, len, seg;
374 snd_mtxlock(via->lock);
375 base1 = via_rd(via, ch->base, 4);
376 len = via_rd(via, ch->count, 4);
377 base = via_rd(via, ch->base, 4);
378 if (base != base1) /* Avoid race hazard */
379 len = via_rd(via, ch->count, 4);
380 snd_mtxunlock(via->lock);
382 DEB(printf("viachan_getptr: len / base = %x / %x\n", len, base));
384 /* Base points to SGD segment to do, one past current */
386 /* Determine how many segments have been done */
387 seg = (base - sgd_addr) / sizeof(struct via_dma_op);
391 /* Now work out offset: seg less count */
392 ptr = (seg * sndbuf_getsize(ch->buffer) / SEGS_PER_CHAN) - len;
393 if (ch->dir == PCMDIR_REC) {
394 /* DMA appears to operate on memory 'lines' of 32 bytes */
395 /* so don't return any part line - it isn't in RAM yet */
399 DEB(printf("return ptr=%d\n", ptr));
403 static struct pcmchan_caps *
404 viachan_getcaps(kobj_t obj, void *data)
406 struct via_chinfo *ch = data;
407 struct via_info *via = ch->parent;
409 return (via->codec_caps & AC97_EXTCAP_VRA)? &via_vracaps : &via_caps;
412 static kobj_method_t viachan_methods[] = {
413 KOBJMETHOD(channel_init, viachan_init),
414 KOBJMETHOD(channel_setformat, viachan_setformat),
415 KOBJMETHOD(channel_setspeed, viachan_setspeed),
416 KOBJMETHOD(channel_setblocksize, viachan_setblocksize),
417 KOBJMETHOD(channel_trigger, viachan_trigger),
418 KOBJMETHOD(channel_getptr, viachan_getptr),
419 KOBJMETHOD(channel_getcaps, viachan_getcaps),
422 CHANNEL_DECLARE(viachan);
424 /* -------------------------------------------------------------------- */
429 struct via_info *via = p;
431 /* DEB(printf("viachan_intr\n")); */
433 snd_mtxlock(via->lock);
434 if (via_rd(via, VIA_PLAY_STAT, 1) & VIA_RPSTAT_INTR) {
435 via_wr(via, VIA_PLAY_STAT, VIA_RPSTAT_INTR, 1);
436 snd_mtxunlock(via->lock);
437 chn_intr(via->pch.channel);
438 snd_mtxlock(via->lock);
442 if (via_rd(via, VIA_RECORD_STAT, 1) & VIA_RPSTAT_INTR) {
443 via_wr(via, VIA_RECORD_STAT, VIA_RPSTAT_INTR, 1);
444 snd_mtxunlock(via->lock);
445 chn_intr(via->rch.channel);
448 snd_mtxunlock(via->lock);
452 * Probe and attach the card
455 via_probe(device_t dev)
457 if (pci_get_devid(dev) == VIA_PCI_ID) {
458 device_set_desc(dev, "VIA VT82C686A");
459 return BUS_PROBE_DEFAULT;
466 dma_cb(void *p, bus_dma_segment_t *bds, int a, int b)
468 struct via_info *via = (struct via_info *)p;
469 via->sgd_addr = bds->ds_addr;
474 via_attach(device_t dev)
476 struct via_info *via = 0;
477 char status[SND_STATUSLEN];
480 via = malloc(sizeof(*via), M_DEVBUF, M_WAITOK | M_ZERO);
481 via->lock = snd_mtxcreate(device_get_nameunit(dev),
482 "snd_via82c686 softc");
485 data = pci_read_config(dev, PCIR_COMMAND, 2);
486 data |= (PCIM_CMD_PORTEN | PCIM_CMD_BUSMASTEREN);
487 pci_write_config(dev, PCIR_COMMAND, data, 2);
488 data = pci_read_config(dev, PCIR_COMMAND, 2);
490 /* Wake up and reset AC97 if necessary */
491 data = pci_read_config(dev, VIA_AC97STATUS, 1);
493 if ((data & VIA_AC97STATUS_RDY) == 0) {
494 /* Cold reset per ac97r2.3 spec (page 95) */
495 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
496 DELAY(100); /* Wait T_rst_low */
497 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_NRST, 1); /* Assert high */
498 DELAY(5); /* Wait T_rst2clk */
499 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
502 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
504 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_SYNC, 1); /* Sync */
505 DELAY(5); /* Wait T_sync_high */
506 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
507 DELAY(5); /* Wait T_sync2clk */
510 /* Power everything up */
511 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_DESIRED, 1);
513 /* Wait for codec to become ready (largest reported delay here 310ms) */
514 for (cnt = 0; cnt < 2000; cnt++) {
515 data = pci_read_config(dev, VIA_AC97STATUS, 1);
516 if (data & VIA_AC97STATUS_RDY)
521 via->regid = PCIR_BAR(0);
522 via->reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
523 &via->regid, RF_ACTIVE);
525 device_printf(dev, "cannot allocate bus resource.");
528 via->st = rman_get_bustag(via->reg);
529 via->sh = rman_get_bushandle(via->reg);
531 via->bufsz = pcm_getbuffersize(dev, 4096, VIA_DEFAULT_BUFSZ, 65536);
534 via->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &via->irqid,
535 RF_ACTIVE | RF_SHAREABLE);
536 if (!via->irq || snd_setup_intr(dev, via->irq, INTR_MPSAFE, via_intr, via, &via->ih)) {
537 device_printf(dev, "unable to map interrupt\n");
541 via_wr(via, VIA_PLAY_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
542 via_wr(via, VIA_RECORD_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
544 via->codec = AC97_CREATE(dev, via, via_ac97);
548 if (mixer_init(dev, ac97_getmixerclass(), via->codec))
551 via->codec_caps = ac97_getextcaps(via->codec);
552 ac97_setextmode(via->codec,
553 via->codec_caps & (AC97_EXTCAP_VRA | AC97_EXTCAP_VRM));
555 /* DMA tag for buffers */
556 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
558 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
559 /*highaddr*/BUS_SPACE_MAXADDR,
560 /*filter*/NULL, /*filterarg*/NULL,
561 /*maxsize*/via->bufsz, /*nsegments*/1, /*maxsegz*/0x3ffff,
562 /*flags*/0, /*lockfunc*/NULL,
563 /*lockarg*/NULL, &via->parent_dmat) != 0) {
564 device_printf(dev, "unable to create dma tag\n");
569 * DMA tag for SGD table. The 686 uses scatter/gather DMA and
570 * requires a list in memory of work to do. We need only 16 bytes
571 * for this list, and it is wasteful to allocate 16K.
573 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
575 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
576 /*highaddr*/BUS_SPACE_MAXADDR,
577 /*filter*/NULL, /*filterarg*/NULL,
578 /*maxsize*/NSEGS * sizeof(struct via_dma_op),
579 /*nsegments*/1, /*maxsegz*/0x3ffff,
580 /*flags*/0, /*lockfunc*/NULL,
581 /*lockarg*/NULL, &via->sgd_dmat) != 0) {
582 device_printf(dev, "unable to create dma tag\n");
586 if (bus_dmamem_alloc(via->sgd_dmat, (void **)&via->sgd_table,
587 BUS_DMA_NOWAIT, &via->sgd_dmamap) != 0)
589 if (bus_dmamap_load(via->sgd_dmat, via->sgd_dmamap, via->sgd_table,
590 NSEGS * sizeof(struct via_dma_op), dma_cb, via, 0) != 0)
593 snprintf(status, SND_STATUSLEN, "at io 0x%lx irq %ld %s",
594 rman_get_start(via->reg), rman_get_start(via->irq),
595 PCM_KLDSTRING(snd_via82c686));
598 if (pcm_register(dev, via, 1, 1)) goto bad;
599 pcm_addchan(dev, PCMDIR_PLAY, &viachan_class, via);
600 pcm_addchan(dev, PCMDIR_REC, &viachan_class, via);
601 pcm_setstatus(dev, status);
604 if (via->codec) ac97_destroy(via->codec);
605 if (via->reg) bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
606 if (via->ih) bus_teardown_intr(dev, via->irq, via->ih);
607 if (via->irq) bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
608 if (via->parent_dmat) bus_dma_tag_destroy(via->parent_dmat);
609 if (via->sgd_dmamap) bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
610 if (via->sgd_table) bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
611 if (via->sgd_dmat) bus_dma_tag_destroy(via->sgd_dmat);
612 if (via->lock) snd_mtxfree(via->lock);
613 if (via) free(via, M_DEVBUF);
618 via_detach(device_t dev)
621 struct via_info *via = 0;
623 r = pcm_unregister(dev);
627 via = pcm_getdevinfo(dev);
628 bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
629 bus_teardown_intr(dev, via->irq, via->ih);
630 bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
631 bus_dma_tag_destroy(via->parent_dmat);
632 bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
633 bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
634 bus_dma_tag_destroy(via->sgd_dmat);
635 snd_mtxfree(via->lock);
641 static device_method_t via_methods[] = {
642 DEVMETHOD(device_probe, via_probe),
643 DEVMETHOD(device_attach, via_attach),
644 DEVMETHOD(device_detach, via_detach),
648 static driver_t via_driver = {
654 DRIVER_MODULE(snd_via82c686, pci, via_driver, pcm_devclass, 0, 0);
655 MODULE_DEPEND(snd_via82c686, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
656 MODULE_VERSION(snd_via82c686, 1);