2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2000 David Jones <dej@ox.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>
36 #include <dev/pci/pcireg.h>
37 #include <dev/pci/pcivar.h>
38 #include <sys/sysctl.h>
40 #include <dev/sound/pci/via82c686.h>
42 SND_DECLARE_FILE("$FreeBSD$");
44 #define VIA_PCI_ID 0x30581106
45 #define NSEGS 4 /* Number of segments in SGD table */
47 #define SEGS_PER_CHAN (NSEGS/2)
50 #define VIA_DEFAULT_BUFSZ 0x1000
55 /* we rely on this struct being packed to 64 bits */
59 #define VIA_DMAOP_EOL 0x80000000
60 #define VIA_DMAOP_FLAG 0x40000000
61 #define VIA_DMAOP_STOP 0x20000000
62 #define VIA_DMAOP_COUNT(x) ((x)&0x00FFFFFF)
68 struct via_info *parent;
69 struct pcm_channel *channel;
70 struct snd_dbuf *buffer;
71 struct via_dma_op *sgd_table;
74 int base, count, mode, ctrl;
79 bus_space_handle_t sh;
80 bus_dma_tag_t parent_dmat;
81 bus_dma_tag_t sgd_dmat;
82 bus_dmamap_t sgd_dmamap;
85 struct resource *reg, *irq;
88 struct ac97_info *codec;
92 struct via_chinfo pch, rch;
93 struct via_dma_op *sgd_table;
98 static u_int32_t via_fmt[] = {
99 SND_FORMAT(AFMT_U8, 1, 0),
100 SND_FORMAT(AFMT_U8, 2, 0),
101 SND_FORMAT(AFMT_S16_LE, 1, 0),
102 SND_FORMAT(AFMT_S16_LE, 2, 0),
105 static struct pcmchan_caps via_vracaps = {4000, 48000, via_fmt, 0};
106 static struct pcmchan_caps via_caps = {48000, 48000, via_fmt, 0};
108 static __inline u_int32_t
109 via_rd(struct via_info *via, int regno, int size)
114 return bus_space_read_1(via->st, via->sh, regno);
116 return bus_space_read_2(via->st, via->sh, regno);
118 return bus_space_read_4(via->st, via->sh, regno);
125 via_wr(struct via_info *via, int regno, u_int32_t data, int size)
130 bus_space_write_1(via->st, via->sh, regno, data);
133 bus_space_write_2(via->st, via->sh, regno, data);
136 bus_space_write_4(via->st, via->sh, regno, data);
141 /* -------------------------------------------------------------------- */
142 /* Codec interface */
145 via_waitready_codec(struct via_info *via)
149 /* poll until codec not busy */
150 for (i = 0; (i < TIMEOUT) &&
151 (via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_BUSY); i++)
154 printf("via: codec busy\n");
162 via_waitvalid_codec(struct via_info *via)
166 /* poll until codec valid */
167 for (i = 0; (i < TIMEOUT) &&
168 !(via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_PRIVALID); i++)
171 printf("via: codec invalid\n");
179 via_write_codec(kobj_t obj, void *addr, int reg, u_int32_t val)
181 struct via_info *via = addr;
183 if (via_waitready_codec(via)) return -1;
185 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, 0, 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 (AFMT_CHANNEL(format) > 1)
290 mode_set |= VIA_RPMODE_STEREO;
291 if (format & AFMT_S16_LE)
292 mode_set |= VIA_RPMODE_16BIT;
294 DEB(printf("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 struct via_dma_op *ado;
345 bus_addr_t sgd_addr = ch->sgd_addr;
347 if (!PCMTRIG_COMMON(go))
351 DEB(printf("ado located at va=%p pa=%x\n", ado, sgd_addr));
353 snd_mtxlock(via->lock);
354 if (go == PCMTRIG_START) {
356 via_wr(via, ch->base, sgd_addr, 4);
357 via_wr(via, ch->ctrl, VIA_RPCTRL_START, 1);
359 via_wr(via, ch->ctrl, VIA_RPCTRL_TERMINATE, 1);
360 snd_mtxunlock(via->lock);
362 DEB(printf("viachan_trigger: go=%d\n", go));
367 viachan_getptr(kobj_t obj, void *data)
369 struct via_chinfo *ch = data;
370 struct via_info *via = ch->parent;
371 struct via_dma_op *ado;
372 bus_addr_t sgd_addr = ch->sgd_addr;
373 u_int32_t ptr, base, base1, len, seg;
376 snd_mtxlock(via->lock);
377 base1 = via_rd(via, ch->base, 4);
378 len = via_rd(via, ch->count, 4);
379 base = via_rd(via, ch->base, 4);
380 if (base != base1) /* Avoid race hazard */
381 len = via_rd(via, ch->count, 4);
382 snd_mtxunlock(via->lock);
384 DEB(printf("viachan_getptr: len / base = %x / %x\n", len, base));
386 /* Base points to SGD segment to do, one past current */
388 /* Determine how many segments have been done */
389 seg = (base - sgd_addr) / sizeof(struct via_dma_op);
393 /* Now work out offset: seg less count */
394 ptr = (seg * sndbuf_getsize(ch->buffer) / SEGS_PER_CHAN) - len;
395 if (ch->dir == PCMDIR_REC) {
396 /* DMA appears to operate on memory 'lines' of 32 bytes */
397 /* so don't return any part line - it isn't in RAM yet */
401 DEB(printf("return ptr=%u\n", ptr));
405 static struct pcmchan_caps *
406 viachan_getcaps(kobj_t obj, void *data)
408 struct via_chinfo *ch = data;
409 struct via_info *via = ch->parent;
411 return (via->codec_caps & AC97_EXTCAP_VRA)? &via_vracaps : &via_caps;
414 static kobj_method_t viachan_methods[] = {
415 KOBJMETHOD(channel_init, viachan_init),
416 KOBJMETHOD(channel_setformat, viachan_setformat),
417 KOBJMETHOD(channel_setspeed, viachan_setspeed),
418 KOBJMETHOD(channel_setblocksize, viachan_setblocksize),
419 KOBJMETHOD(channel_trigger, viachan_trigger),
420 KOBJMETHOD(channel_getptr, viachan_getptr),
421 KOBJMETHOD(channel_getcaps, viachan_getcaps),
424 CHANNEL_DECLARE(viachan);
426 /* -------------------------------------------------------------------- */
431 struct via_info *via = p;
433 /* DEB(printf("viachan_intr\n")); */
435 snd_mtxlock(via->lock);
436 if (via_rd(via, VIA_PLAY_STAT, 1) & VIA_RPSTAT_INTR) {
437 via_wr(via, VIA_PLAY_STAT, VIA_RPSTAT_INTR, 1);
438 snd_mtxunlock(via->lock);
439 chn_intr(via->pch.channel);
440 snd_mtxlock(via->lock);
444 if (via_rd(via, VIA_RECORD_STAT, 1) & VIA_RPSTAT_INTR) {
445 via_wr(via, VIA_RECORD_STAT, VIA_RPSTAT_INTR, 1);
446 snd_mtxunlock(via->lock);
447 chn_intr(via->rch.channel);
450 snd_mtxunlock(via->lock);
454 * Probe and attach the card
457 via_probe(device_t dev)
459 if (pci_get_devid(dev) == VIA_PCI_ID) {
460 device_set_desc(dev, "VIA VT82C686A");
461 return BUS_PROBE_DEFAULT;
467 dma_cb(void *p, bus_dma_segment_t *bds, int a, int b)
469 struct via_info *via = (struct via_info *)p;
470 via->sgd_addr = bds->ds_addr;
474 via_attach(device_t dev)
476 struct via_info *via = NULL;
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");
484 pci_enable_busmaster(dev);
486 /* Wake up and reset AC97 if necessary */
487 data = pci_read_config(dev, VIA_AC97STATUS, 1);
489 if ((data & VIA_AC97STATUS_RDY) == 0) {
490 /* Cold reset per ac97r2.3 spec (page 95) */
491 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
492 DELAY(100); /* Wait T_rst_low */
493 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_NRST, 1); /* Assert high */
494 DELAY(5); /* Wait T_rst2clk */
495 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
498 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
500 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_SYNC, 1); /* Sync */
501 DELAY(5); /* Wait T_sync_high */
502 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
503 DELAY(5); /* Wait T_sync2clk */
506 /* Power everything up */
507 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_DESIRED, 1);
509 /* Wait for codec to become ready (largest reported delay here 310ms) */
510 for (cnt = 0; cnt < 2000; cnt++) {
511 data = pci_read_config(dev, VIA_AC97STATUS, 1);
512 if (data & VIA_AC97STATUS_RDY)
517 via->regid = PCIR_BAR(0);
518 via->reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
519 &via->regid, RF_ACTIVE);
521 device_printf(dev, "cannot allocate bus resource.");
524 via->st = rman_get_bustag(via->reg);
525 via->sh = rman_get_bushandle(via->reg);
527 via->bufsz = pcm_getbuffersize(dev, 4096, VIA_DEFAULT_BUFSZ, 65536);
530 via->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &via->irqid,
531 RF_ACTIVE | RF_SHAREABLE);
532 if (!via->irq || snd_setup_intr(dev, via->irq, INTR_MPSAFE, via_intr, via, &via->ih)) {
533 device_printf(dev, "unable to map interrupt\n");
537 via_wr(via, VIA_PLAY_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
538 via_wr(via, VIA_RECORD_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
540 via->codec = AC97_CREATE(dev, via, via_ac97);
544 if (mixer_init(dev, ac97_getmixerclass(), via->codec))
547 via->codec_caps = ac97_getextcaps(via->codec);
548 ac97_setextmode(via->codec,
549 via->codec_caps & (AC97_EXTCAP_VRA | AC97_EXTCAP_VRM));
551 /* DMA tag for buffers */
552 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
554 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
555 /*highaddr*/BUS_SPACE_MAXADDR,
556 /*filter*/NULL, /*filterarg*/NULL,
557 /*maxsize*/via->bufsz, /*nsegments*/1, /*maxsegz*/0x3ffff,
558 /*flags*/0, /*lockfunc*/NULL,
559 /*lockarg*/NULL, &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*/bus_get_dma_tag(dev), /*alignment*/2,
571 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
572 /*highaddr*/BUS_SPACE_MAXADDR,
573 /*filter*/NULL, /*filterarg*/NULL,
574 /*maxsize*/NSEGS * sizeof(struct via_dma_op),
575 /*nsegments*/1, /*maxsegz*/0x3ffff,
576 /*flags*/0, /*lockfunc*/NULL,
577 /*lockarg*/NULL, &via->sgd_dmat) != 0) {
578 device_printf(dev, "unable to create dma tag\n");
582 if (bus_dmamem_alloc(via->sgd_dmat, (void **)&via->sgd_table,
583 BUS_DMA_NOWAIT, &via->sgd_dmamap) != 0)
585 if (bus_dmamap_load(via->sgd_dmat, via->sgd_dmamap, via->sgd_table,
586 NSEGS * sizeof(struct via_dma_op), dma_cb, via, 0) != 0)
589 snprintf(status, SND_STATUSLEN, "at io 0x%jx irq %jd %s",
590 rman_get_start(via->reg), rman_get_start(via->irq),
591 PCM_KLDSTRING(snd_via82c686));
594 if (pcm_register(dev, via, 1, 1)) goto bad;
595 pcm_addchan(dev, PCMDIR_PLAY, &viachan_class, via);
596 pcm_addchan(dev, PCMDIR_REC, &viachan_class, via);
597 pcm_setstatus(dev, status);
600 if (via->codec) ac97_destroy(via->codec);
601 if (via->reg) bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
602 if (via->ih) bus_teardown_intr(dev, via->irq, via->ih);
603 if (via->irq) bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
604 if (via->parent_dmat) bus_dma_tag_destroy(via->parent_dmat);
605 if (via->sgd_addr) bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
606 if (via->sgd_table) bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
607 if (via->sgd_dmat) bus_dma_tag_destroy(via->sgd_dmat);
608 if (via->lock) snd_mtxfree(via->lock);
609 if (via) free(via, M_DEVBUF);
614 via_detach(device_t dev)
617 struct via_info *via = NULL;
619 r = pcm_unregister(dev);
623 via = pcm_getdevinfo(dev);
624 bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
625 bus_teardown_intr(dev, via->irq, via->ih);
626 bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
627 bus_dma_tag_destroy(via->parent_dmat);
628 bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
629 bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
630 bus_dma_tag_destroy(via->sgd_dmat);
631 snd_mtxfree(via->lock);
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, 0, 0);
650 MODULE_DEPEND(snd_via82c686, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
651 MODULE_VERSION(snd_via82c686, 1);