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);
126 via_wr(struct via_info *via, int regno, u_int32_t data, int size)
131 bus_space_write_1(via->st, via->sh, regno, data);
134 bus_space_write_2(via->st, via->sh, regno, data);
137 bus_space_write_4(via->st, via->sh, regno, data);
142 /* -------------------------------------------------------------------- */
143 /* Codec interface */
146 via_waitready_codec(struct via_info *via)
150 /* poll until codec not busy */
151 for (i = 0; (i < TIMEOUT) &&
152 (via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_BUSY); i++)
155 printf("via: codec busy\n");
164 via_waitvalid_codec(struct via_info *via)
168 /* poll until codec valid */
169 for (i = 0; (i < TIMEOUT) &&
170 !(via_rd(via, VIA_CODEC_CTL, 4) & VIA_CODEC_PRIVALID); i++)
173 printf("via: codec invalid\n");
182 via_write_codec(kobj_t obj, void *addr, int reg, u_int32_t val)
184 struct via_info *via = addr;
186 if (via_waitready_codec(via)) return -1;
188 via_wr(via, VIA_CODEC_CTL, VIA_CODEC_PRIVALID | VIA_CODEC_INDEX(reg) | val, 4);
195 via_read_codec(kobj_t obj, void *addr, int reg)
197 struct via_info *via = addr;
199 if (via_waitready_codec(via))
202 via_wr(via, VIA_CODEC_CTL, VIA_CODEC_PRIVALID | VIA_CODEC_READ | VIA_CODEC_INDEX(reg),4);
204 if (via_waitready_codec(via))
207 if (via_waitvalid_codec(via))
210 return via_rd(via, VIA_CODEC_CTL, 2);
213 static kobj_method_t via_ac97_methods[] = {
214 KOBJMETHOD(ac97_read, via_read_codec),
215 KOBJMETHOD(ac97_write, via_write_codec),
218 AC97_DECLARE(via_ac97);
220 /* -------------------------------------------------------------------- */
223 via_buildsgdt(struct via_chinfo *ch)
225 u_int32_t phys_addr, flag;
226 int i, segs, seg_size;
229 * Build the scatter/gather DMA (SGD) table.
230 * There are four slots in the table: two for play, two for record.
231 * This creates two half-buffers, one of which is playing; the other
234 seg_size = ch->blksz;
235 segs = sndbuf_getsize(ch->buffer) / seg_size;
236 phys_addr = sndbuf_getbufaddr(ch->buffer);
238 for (i = 0; i < segs; i++) {
239 flag = (i == segs - 1)? VIA_DMAOP_EOL : VIA_DMAOP_FLAG;
240 ch->sgd_table[i].ptr = phys_addr + (i * seg_size);
241 ch->sgd_table[i].flags = flag | seg_size;
247 /* channel interface */
249 viachan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
251 struct via_info *via = devinfo;
252 struct via_chinfo *ch;
254 snd_mtxlock(via->lock);
255 if (dir == PCMDIR_PLAY) {
257 ch->base = VIA_PLAY_DMAOPS_BASE;
258 ch->count = VIA_PLAY_DMAOPS_COUNT;
259 ch->ctrl = VIA_PLAY_CONTROL;
260 ch->mode = VIA_PLAY_MODE;
261 ch->sgd_addr = via->sgd_addr;
262 ch->sgd_table = &via->sgd_table[0];
265 ch->base = VIA_RECORD_DMAOPS_BASE;
266 ch->count = VIA_RECORD_DMAOPS_COUNT;
267 ch->ctrl = VIA_RECORD_CONTROL;
268 ch->mode = VIA_RECORD_MODE;
269 ch->sgd_addr = via->sgd_addr + sizeof(struct via_dma_op) * SEGS_PER_CHAN;
270 ch->sgd_table = &via->sgd_table[SEGS_PER_CHAN];
277 snd_mtxunlock(via->lock);
279 if (sndbuf_alloc(ch->buffer, via->parent_dmat, 0, via->bufsz) != 0)
286 viachan_setformat(kobj_t obj, void *data, u_int32_t format)
288 struct via_chinfo *ch = data;
289 struct via_info *via = ch->parent;
293 if (AFMT_CHANNEL(format) > 1)
294 mode_set |= VIA_RPMODE_STEREO;
295 if (format & AFMT_S16_LE)
296 mode_set |= VIA_RPMODE_16BIT;
298 DEB(printf("set format: dir = %d, format=%x\n", ch->dir, format));
299 snd_mtxlock(via->lock);
300 mode = via_rd(via, ch->mode, 1);
301 mode &= ~(VIA_RPMODE_16BIT | VIA_RPMODE_STEREO);
303 via_wr(via, ch->mode, mode, 1);
304 snd_mtxunlock(via->lock);
310 viachan_setspeed(kobj_t obj, void *data, u_int32_t speed)
312 struct via_chinfo *ch = data;
313 struct via_info *via = ch->parent;
317 * Basic AC'97 defines a 48 kHz sample rate only. For other rates,
318 * upsampling is required.
320 * The VT82C686A does not perform upsampling, and neither do we.
321 * If the codec supports variable-rate audio (i.e. does the upsampling
322 * itself), then negotiate the rate with the codec. Otherwise,
323 * return 48 kHz cuz that's all you got.
325 if (via->codec_caps & AC97_EXTCAP_VRA) {
326 reg = (ch->dir == PCMDIR_PLAY)? AC97_REGEXT_FDACRATE : AC97_REGEXT_LADCRATE;
327 return ac97_setrate(via->codec, reg, speed);
333 viachan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
335 struct via_chinfo *ch = data;
337 ch->blksz = blocksize;
338 sndbuf_resize(ch->buffer, SEGS_PER_CHAN, ch->blksz);
344 viachan_trigger(kobj_t obj, void *data, int go)
346 struct via_chinfo *ch = data;
347 struct via_info *via = ch->parent;
348 struct via_dma_op *ado;
349 bus_addr_t sgd_addr = ch->sgd_addr;
351 if (!PCMTRIG_COMMON(go))
355 DEB(printf("ado located at va=%p pa=%x\n", ado, sgd_addr));
357 snd_mtxlock(via->lock);
358 if (go == PCMTRIG_START) {
360 via_wr(via, ch->base, sgd_addr, 4);
361 via_wr(via, ch->ctrl, VIA_RPCTRL_START, 1);
363 via_wr(via, ch->ctrl, VIA_RPCTRL_TERMINATE, 1);
364 snd_mtxunlock(via->lock);
366 DEB(printf("viachan_trigger: go=%d\n", go));
371 viachan_getptr(kobj_t obj, void *data)
373 struct via_chinfo *ch = data;
374 struct via_info *via = ch->parent;
375 struct via_dma_op *ado;
376 bus_addr_t sgd_addr = ch->sgd_addr;
377 u_int32_t ptr, base, base1, len, seg;
380 snd_mtxlock(via->lock);
381 base1 = via_rd(via, ch->base, 4);
382 len = via_rd(via, ch->count, 4);
383 base = via_rd(via, ch->base, 4);
384 if (base != base1) /* Avoid race hazard */
385 len = via_rd(via, ch->count, 4);
386 snd_mtxunlock(via->lock);
388 DEB(printf("viachan_getptr: len / base = %x / %x\n", len, base));
390 /* Base points to SGD segment to do, one past current */
392 /* Determine how many segments have been done */
393 seg = (base - sgd_addr) / sizeof(struct via_dma_op);
397 /* Now work out offset: seg less count */
398 ptr = (seg * sndbuf_getsize(ch->buffer) / SEGS_PER_CHAN) - len;
399 if (ch->dir == PCMDIR_REC) {
400 /* DMA appears to operate on memory 'lines' of 32 bytes */
401 /* so don't return any part line - it isn't in RAM yet */
405 DEB(printf("return ptr=%u\n", ptr));
409 static struct pcmchan_caps *
410 viachan_getcaps(kobj_t obj, void *data)
412 struct via_chinfo *ch = data;
413 struct via_info *via = ch->parent;
415 return (via->codec_caps & AC97_EXTCAP_VRA)? &via_vracaps : &via_caps;
418 static kobj_method_t viachan_methods[] = {
419 KOBJMETHOD(channel_init, viachan_init),
420 KOBJMETHOD(channel_setformat, viachan_setformat),
421 KOBJMETHOD(channel_setspeed, viachan_setspeed),
422 KOBJMETHOD(channel_setblocksize, viachan_setblocksize),
423 KOBJMETHOD(channel_trigger, viachan_trigger),
424 KOBJMETHOD(channel_getptr, viachan_getptr),
425 KOBJMETHOD(channel_getcaps, viachan_getcaps),
428 CHANNEL_DECLARE(viachan);
430 /* -------------------------------------------------------------------- */
435 struct via_info *via = p;
437 /* DEB(printf("viachan_intr\n")); */
439 snd_mtxlock(via->lock);
440 if (via_rd(via, VIA_PLAY_STAT, 1) & VIA_RPSTAT_INTR) {
441 via_wr(via, VIA_PLAY_STAT, VIA_RPSTAT_INTR, 1);
442 snd_mtxunlock(via->lock);
443 chn_intr(via->pch.channel);
444 snd_mtxlock(via->lock);
448 if (via_rd(via, VIA_RECORD_STAT, 1) & VIA_RPSTAT_INTR) {
449 via_wr(via, VIA_RECORD_STAT, VIA_RPSTAT_INTR, 1);
450 snd_mtxunlock(via->lock);
451 chn_intr(via->rch.channel);
454 snd_mtxunlock(via->lock);
458 * Probe and attach the card
461 via_probe(device_t dev)
463 if (pci_get_devid(dev) == VIA_PCI_ID) {
464 device_set_desc(dev, "VIA VT82C686A");
465 return BUS_PROBE_DEFAULT;
472 dma_cb(void *p, bus_dma_segment_t *bds, int a, int b)
474 struct via_info *via = (struct via_info *)p;
475 via->sgd_addr = bds->ds_addr;
480 via_attach(device_t dev)
482 struct via_info *via = NULL;
483 char status[SND_STATUSLEN];
486 via = malloc(sizeof(*via), M_DEVBUF, M_WAITOK | M_ZERO);
487 via->lock = snd_mtxcreate(device_get_nameunit(dev),
488 "snd_via82c686 softc");
490 pci_enable_busmaster(dev);
492 /* Wake up and reset AC97 if necessary */
493 data = pci_read_config(dev, VIA_AC97STATUS, 1);
495 if ((data & VIA_AC97STATUS_RDY) == 0) {
496 /* Cold reset per ac97r2.3 spec (page 95) */
497 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
498 DELAY(100); /* Wait T_rst_low */
499 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_NRST, 1); /* Assert high */
500 DELAY(5); /* Wait T_rst2clk */
501 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Assert low */
504 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
506 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN | VIA_ACLINK_SYNC, 1); /* Sync */
507 DELAY(5); /* Wait T_sync_high */
508 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_EN, 1); /* Force no sync */
509 DELAY(5); /* Wait T_sync2clk */
512 /* Power everything up */
513 pci_write_config(dev, VIA_ACLINKCTRL, VIA_ACLINK_DESIRED, 1);
515 /* Wait for codec to become ready (largest reported delay here 310ms) */
516 for (cnt = 0; cnt < 2000; cnt++) {
517 data = pci_read_config(dev, VIA_AC97STATUS, 1);
518 if (data & VIA_AC97STATUS_RDY)
523 via->regid = PCIR_BAR(0);
524 via->reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
525 &via->regid, RF_ACTIVE);
527 device_printf(dev, "cannot allocate bus resource.");
530 via->st = rman_get_bustag(via->reg);
531 via->sh = rman_get_bushandle(via->reg);
533 via->bufsz = pcm_getbuffersize(dev, 4096, VIA_DEFAULT_BUFSZ, 65536);
536 via->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &via->irqid,
537 RF_ACTIVE | RF_SHAREABLE);
538 if (!via->irq || snd_setup_intr(dev, via->irq, INTR_MPSAFE, via_intr, via, &via->ih)) {
539 device_printf(dev, "unable to map interrupt\n");
543 via_wr(via, VIA_PLAY_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
544 via_wr(via, VIA_RECORD_MODE, VIA_RPMODE_AUTOSTART | VIA_RPMODE_INTR_FLAG | VIA_RPMODE_INTR_EOL, 1);
546 via->codec = AC97_CREATE(dev, via, via_ac97);
550 if (mixer_init(dev, ac97_getmixerclass(), via->codec))
553 via->codec_caps = ac97_getextcaps(via->codec);
554 ac97_setextmode(via->codec,
555 via->codec_caps & (AC97_EXTCAP_VRA | AC97_EXTCAP_VRM));
557 /* DMA tag for buffers */
558 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
560 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
561 /*highaddr*/BUS_SPACE_MAXADDR,
562 /*filter*/NULL, /*filterarg*/NULL,
563 /*maxsize*/via->bufsz, /*nsegments*/1, /*maxsegz*/0x3ffff,
564 /*flags*/0, /*lockfunc*/NULL,
565 /*lockarg*/NULL, &via->parent_dmat) != 0) {
566 device_printf(dev, "unable to create dma tag\n");
571 * DMA tag for SGD table. The 686 uses scatter/gather DMA and
572 * requires a list in memory of work to do. We need only 16 bytes
573 * for this list, and it is wasteful to allocate 16K.
575 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
577 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
578 /*highaddr*/BUS_SPACE_MAXADDR,
579 /*filter*/NULL, /*filterarg*/NULL,
580 /*maxsize*/NSEGS * sizeof(struct via_dma_op),
581 /*nsegments*/1, /*maxsegz*/0x3ffff,
582 /*flags*/0, /*lockfunc*/NULL,
583 /*lockarg*/NULL, &via->sgd_dmat) != 0) {
584 device_printf(dev, "unable to create dma tag\n");
588 if (bus_dmamem_alloc(via->sgd_dmat, (void **)&via->sgd_table,
589 BUS_DMA_NOWAIT, &via->sgd_dmamap) != 0)
591 if (bus_dmamap_load(via->sgd_dmat, via->sgd_dmamap, via->sgd_table,
592 NSEGS * sizeof(struct via_dma_op), dma_cb, via, 0) != 0)
595 snprintf(status, SND_STATUSLEN, "at io 0x%jx irq %jd %s",
596 rman_get_start(via->reg), rman_get_start(via->irq),
597 PCM_KLDSTRING(snd_via82c686));
600 if (pcm_register(dev, via, 1, 1)) goto bad;
601 pcm_addchan(dev, PCMDIR_PLAY, &viachan_class, via);
602 pcm_addchan(dev, PCMDIR_REC, &viachan_class, via);
603 pcm_setstatus(dev, status);
606 if (via->codec) ac97_destroy(via->codec);
607 if (via->reg) bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
608 if (via->ih) bus_teardown_intr(dev, via->irq, via->ih);
609 if (via->irq) bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
610 if (via->parent_dmat) bus_dma_tag_destroy(via->parent_dmat);
611 if (via->sgd_addr) bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
612 if (via->sgd_table) bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
613 if (via->sgd_dmat) bus_dma_tag_destroy(via->sgd_dmat);
614 if (via->lock) snd_mtxfree(via->lock);
615 if (via) free(via, M_DEVBUF);
620 via_detach(device_t dev)
623 struct via_info *via = NULL;
625 r = pcm_unregister(dev);
629 via = pcm_getdevinfo(dev);
630 bus_release_resource(dev, SYS_RES_IOPORT, via->regid, via->reg);
631 bus_teardown_intr(dev, via->irq, via->ih);
632 bus_release_resource(dev, SYS_RES_IRQ, via->irqid, via->irq);
633 bus_dma_tag_destroy(via->parent_dmat);
634 bus_dmamap_unload(via->sgd_dmat, via->sgd_dmamap);
635 bus_dmamem_free(via->sgd_dmat, via->sgd_table, via->sgd_dmamap);
636 bus_dma_tag_destroy(via->sgd_dmat);
637 snd_mtxfree(via->lock);
643 static device_method_t via_methods[] = {
644 DEVMETHOD(device_probe, via_probe),
645 DEVMETHOD(device_attach, via_attach),
646 DEVMETHOD(device_detach, via_detach),
650 static driver_t via_driver = {
656 DRIVER_MODULE(snd_via82c686, pci, via_driver, pcm_devclass, 0, 0);
657 MODULE_DEPEND(snd_via82c686, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
658 MODULE_VERSION(snd_via82c686, 1);