2 * Copyright (c) 1999 Cameron Grant <cg@freebsd.org>
3 * Copyright (c) 1997,1998 Luigi Rizzo
5 * Derived from files in the Voxware 3.5 distribution,
6 * Copyright by Hannu Savolainen 1994, under the same copyright
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #ifdef HAVE_KERNEL_OPTION_HEADERS
36 #include <dev/sound/pcm/sound.h>
38 #include <dev/sound/isa/sb.h>
39 #include <dev/sound/chip.h>
41 #include <isa/isavar.h>
45 SND_DECLARE_FILE("$FreeBSD$");
47 #define SB_DEFAULT_BUFSZ 4096
49 static u_int32_t sb_fmt[] = {
50 SND_FORMAT(AFMT_U8, 1, 0),
53 static struct pcmchan_caps sb200_playcaps = {4000, 23000, sb_fmt, 0};
54 static struct pcmchan_caps sb200_reccaps = {4000, 13000, sb_fmt, 0};
55 static struct pcmchan_caps sb201_playcaps = {4000, 44100, sb_fmt, 0};
56 static struct pcmchan_caps sb201_reccaps = {4000, 15000, sb_fmt, 0};
58 static u_int32_t sbpro_fmt[] = {
59 SND_FORMAT(AFMT_U8, 1, 0),
60 SND_FORMAT(AFMT_U8, 2, 0),
63 static struct pcmchan_caps sbpro_playcaps = {4000, 44100, sbpro_fmt, 0};
64 static struct pcmchan_caps sbpro_reccaps = {4000, 44100, sbpro_fmt, 0};
69 struct sb_info *parent;
70 struct pcm_channel *channel;
71 struct snd_dbuf *buffer;
73 u_int32_t fmt, spd, blksz;
78 struct resource *io_base; /* I/O address for the board */
82 bus_dma_tag_t parent_dmat;
86 u_long bd_flags; /* board-specific flags */
87 struct sb_chinfo pch, rch;
90 static int sb_rd(struct sb_info *sb, int reg);
91 static void sb_wr(struct sb_info *sb, int reg, u_int8_t val);
92 static int sb_dspready(struct sb_info *sb);
93 static int sb_cmd(struct sb_info *sb, u_char val);
94 static int sb_cmd1(struct sb_info *sb, u_char cmd, int val);
95 static int sb_cmd2(struct sb_info *sb, u_char cmd, int val);
96 static u_int sb_get_byte(struct sb_info *sb);
97 static void sb_setmixer(struct sb_info *sb, u_int port, u_int value);
98 static int sb_getmixer(struct sb_info *sb, u_int port);
99 static int sb_reset_dsp(struct sb_info *sb);
101 static void sb_intr(void *arg);
102 static int sb_speed(struct sb_chinfo *ch);
103 static int sb_start(struct sb_chinfo *ch);
104 static int sb_stop(struct sb_chinfo *ch);
107 * Common code for the midi and pcm functions
109 * sb_cmd write a single byte to the CMD port.
110 * sb_cmd1 write a CMD + 1 byte arg
111 * sb_cmd2 write a CMD + 2 byte arg
112 * sb_get_byte returns a single byte from the DSP data port
116 sb_lock(struct sb_info *sb) {
118 sbc_lock(device_get_softc(sb->parent_dev));
122 sb_unlock(struct sb_info *sb) {
124 sbc_unlock(device_get_softc(sb->parent_dev));
128 port_rd(struct resource *port, int off)
130 return bus_space_read_1(rman_get_bustag(port), rman_get_bushandle(port), off);
134 port_wr(struct resource *port, int off, u_int8_t data)
136 bus_space_write_1(rman_get_bustag(port), rman_get_bushandle(port), off, data);
140 sb_rd(struct sb_info *sb, int reg)
142 return port_rd(sb->io_base, reg);
146 sb_wr(struct sb_info *sb, int reg, u_int8_t val)
148 port_wr(sb->io_base, reg, val);
152 sb_dspready(struct sb_info *sb)
154 return ((sb_rd(sb, SBDSP_STATUS) & 0x80) == 0);
158 sb_dspwr(struct sb_info *sb, u_char val)
162 for (i = 0; i < 1000; i++) {
163 if (sb_dspready(sb)) {
164 sb_wr(sb, SBDSP_CMD, val);
167 if (i > 10) DELAY((i > 100)? 1000 : 10);
169 printf("sb_dspwr(0x%02x) timed out.\n", val);
174 sb_cmd(struct sb_info *sb, u_char val)
177 printf("sb_cmd: %x\n", val);
179 return sb_dspwr(sb, val);
183 sb_cmd1(struct sb_info *sb, u_char cmd, int val)
186 printf("sb_cmd1: %x, %x\n", cmd, val);
188 if (sb_dspwr(sb, cmd)) {
189 return sb_dspwr(sb, val & 0xff);
194 sb_cmd2(struct sb_info *sb, u_char cmd, int val)
197 printf("sb_cmd2: %x, %x\n", cmd, val);
199 if (sb_dspwr(sb, cmd)) {
200 return sb_dspwr(sb, val & 0xff) &&
201 sb_dspwr(sb, (val >> 8) & 0xff);
206 * in the SB, there is a set of indirect "mixer" registers with
207 * address at offset 4, data at offset 5
209 * we don't need to interlock these, the mixer lock will suffice.
212 sb_setmixer(struct sb_info *sb, u_int port, u_int value)
214 sb_wr(sb, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */
216 sb_wr(sb, SB_MIX_DATA, (u_char) (value & 0xff));
221 sb_getmixer(struct sb_info *sb, u_int port)
225 sb_wr(sb, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */
227 val = sb_rd(sb, SB_MIX_DATA);
234 sb_get_byte(struct sb_info *sb)
238 for (i = 1000; i > 0; i--) {
239 if (sb_rd(sb, DSP_DATA_AVAIL) & 0x80)
240 return sb_rd(sb, DSP_READ);
248 sb_reset_dsp(struct sb_info *sb)
250 sb_wr(sb, SBDSP_RST, 3);
252 sb_wr(sb, SBDSP_RST, 0);
253 if (sb_get_byte(sb) != 0xAA) {
254 DEB(printf("sb_reset_dsp 0x%lx failed\n",
255 rman_get_start(sb->io_base)));
256 return ENXIO; /* Sorry */
262 sb_release_resources(struct sb_info *sb, device_t dev)
266 bus_teardown_intr(dev, sb->irq, sb->ih);
267 bus_release_resource(dev, SYS_RES_IRQ, 0, sb->irq);
271 isa_dma_release(rman_get_start(sb->drq));
272 bus_release_resource(dev, SYS_RES_DRQ, 0, sb->drq);
276 bus_release_resource(dev, SYS_RES_IOPORT, 0, sb->io_base);
279 if (sb->parent_dmat) {
280 bus_dma_tag_destroy(sb->parent_dmat);
287 sb_alloc_resources(struct sb_info *sb, device_t dev)
293 sb->io_base = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
297 sb->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
301 sb->drq = bus_alloc_resource_any(dev, SYS_RES_DRQ,
304 if (sb->io_base && sb->drq && sb->irq) {
305 isa_dma_acquire(rman_get_start(sb->drq));
306 isa_dmainit(rman_get_start(sb->drq), sb->bufsize);
312 /************************************************************/
315 sbpromix_init(struct snd_mixer *m)
317 struct sb_info *sb = mix_getdevinfo(m);
319 mix_setdevs(m, SOUND_MASK_SYNTH | SOUND_MASK_PCM | SOUND_MASK_LINE |
320 SOUND_MASK_MIC | SOUND_MASK_CD | SOUND_MASK_VOLUME);
322 mix_setrecdevs(m, SOUND_MASK_LINE | SOUND_MASK_MIC | SOUND_MASK_CD);
324 sb_setmixer(sb, 0, 1); /* reset mixer */
330 sbpromix_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
332 struct sb_info *sb = mix_getdevinfo(m);
338 case SOUND_MIXER_PCM:
342 case SOUND_MIXER_MIC:
347 case SOUND_MIXER_VOLUME:
351 case SOUND_MIXER_SYNTH:
359 case SOUND_MIXER_LINE:
367 left = (left * max) / 100;
368 right = (dev == SOUND_MIXER_MIC)? left : ((right * max) / 100);
370 val = (dev == SOUND_MIXER_MIC)? (left << 1) : (left << 5 | right << 1);
371 sb_setmixer(sb, reg, val);
373 left = (left * 100) / max;
374 right = (right * 100) / max;
376 return left | (right << 8);
380 sbpromix_setrecsrc(struct snd_mixer *m, u_int32_t src)
382 struct sb_info *sb = mix_getdevinfo(m);
385 if (src == SOUND_MASK_LINE)
387 else if (src == SOUND_MASK_CD)
389 else { /* default: mic */
390 src = SOUND_MASK_MIC;
393 sb_setmixer(sb, RECORD_SRC, recdev | (sb_getmixer(sb, RECORD_SRC) & ~0x07));
398 static kobj_method_t sbpromix_mixer_methods[] = {
399 KOBJMETHOD(mixer_init, sbpromix_init),
400 KOBJMETHOD(mixer_set, sbpromix_set),
401 KOBJMETHOD(mixer_setrecsrc, sbpromix_setrecsrc),
404 MIXER_DECLARE(sbpromix_mixer);
406 /************************************************************/
409 sbmix_init(struct snd_mixer *m)
411 struct sb_info *sb = mix_getdevinfo(m);
413 mix_setdevs(m, SOUND_MASK_SYNTH | SOUND_MASK_PCM | SOUND_MASK_CD | SOUND_MASK_VOLUME);
415 mix_setrecdevs(m, 0);
417 sb_setmixer(sb, 0, 1); /* reset mixer */
423 sbmix_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
425 struct sb_info *sb = mix_getdevinfo(m);
430 case SOUND_MIXER_VOLUME:
434 case SOUND_MIXER_SYNTH:
442 case SOUND_MIXER_PCM:
451 left = (left * max) / 100;
453 sb_setmixer(sb, reg, left << 1);
455 left = (left * 100) / max;
457 return left | (left << 8);
461 sbmix_setrecsrc(struct snd_mixer *m, u_int32_t src)
466 static kobj_method_t sbmix_mixer_methods[] = {
467 KOBJMETHOD(mixer_init, sbmix_init),
468 KOBJMETHOD(mixer_set, sbmix_set),
469 KOBJMETHOD(mixer_setrecsrc, sbmix_setrecsrc),
472 MIXER_DECLARE(sbmix_mixer);
474 /************************************************************/
479 struct sb_info *sb = (struct sb_info *)arg;
482 if (sndbuf_runsz(sb->pch.buffer) > 0) {
484 chn_intr(sb->pch.channel);
488 if (sndbuf_runsz(sb->rch.buffer) > 0) {
490 chn_intr(sb->rch.channel);
494 sb_rd(sb, DSP_DATA_AVAIL); /* int ack */
499 sb_speed(struct sb_chinfo *ch)
501 struct sb_info *sb = ch->parent;
502 int play = (ch->dir == PCMDIR_PLAY)? 1 : 0;
503 int stereo = (AFMT_CHANNEL(ch->fmt) > 1)? 1 : 0;
504 int speed, tmp, thresh, max;
507 if (sb->bd_id >= 0x300) {
508 thresh = stereo? 11025 : 23000;
509 max = stereo? 22050 : 44100;
510 } else if (sb->bd_id > 0x200) {
511 thresh = play? 23000 : 13000;
512 max = play? 44100 : 15000;
515 max = play? 23000 : 13000;
523 sb->bd_flags &= ~BD_F_HISPEED;
525 sb->bd_flags |= BD_F_HISPEED;
527 tmp = 65536 - (256000000 / (speed << stereo));
530 sb_cmd1(sb, 0x40, tconst); /* set time constant */
532 speed = (256000000 / (65536 - tmp)) >> stereo;
540 sb_start(struct sb_chinfo *ch)
542 struct sb_info *sb = ch->parent;
543 int play = (ch->dir == PCMDIR_PLAY)? 1 : 0;
544 int stereo = (AFMT_CHANNEL(ch->fmt) > 1)? 1 : 0;
552 sb_cmd(sb, DSP_CMD_SPKON);
554 if (sb->bd_flags & BD_F_HISPEED)
555 i = play? 0x90 : 0x98;
557 i = play? 0x1c : 0x2c;
559 sb_setmixer(sb, 0x0e, stereo? 2 : 0);
560 sb_cmd2(sb, 0x48, l);
563 sb->bd_flags |= BD_F_DMARUN;
569 sb_stop(struct sb_chinfo *ch)
571 struct sb_info *sb = ch->parent;
572 int play = (ch->dir == PCMDIR_PLAY)? 1 : 0;
575 if (sb->bd_flags & BD_F_HISPEED)
580 * NOTE: DSP_CMD_DMAEXIT_8 does not work with old
583 sb_cmd(sb, DSP_CMD_DMAEXIT_8);
589 sb_cmd(sb, DSP_CMD_SPKOFF); /* speaker off */
591 sb->bd_flags &= ~BD_F_DMARUN;
595 /* channel interface */
597 sbchan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
599 struct sb_info *sb = devinfo;
600 struct sb_chinfo *ch = (dir == PCMDIR_PLAY)? &sb->pch : &sb->rch;
606 if (sndbuf_alloc(ch->buffer, sb->parent_dmat, 0, sb->bufsize) != 0)
608 sndbuf_dmasetup(ch->buffer, sb->drq);
613 sbchan_setformat(kobj_t obj, void *data, u_int32_t format)
615 struct sb_chinfo *ch = data;
622 sbchan_setspeed(kobj_t obj, void *data, u_int32_t speed)
624 struct sb_chinfo *ch = data;
631 sbchan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
633 struct sb_chinfo *ch = data;
635 ch->blksz = blocksize;
640 sbchan_trigger(kobj_t obj, void *data, int go)
642 struct sb_chinfo *ch = data;
644 if (!PCMTRIG_COMMON(go))
647 sndbuf_dma(ch->buffer, go);
648 if (go == PCMTRIG_START)
656 sbchan_getptr(kobj_t obj, void *data)
658 struct sb_chinfo *ch = data;
660 return sndbuf_dmaptr(ch->buffer);
663 static struct pcmchan_caps *
664 sbchan_getcaps(kobj_t obj, void *data)
666 struct sb_chinfo *ch = data;
667 int p = (ch->dir == PCMDIR_PLAY)? 1 : 0;
669 if (ch->parent->bd_id == 0x200)
670 return p? &sb200_playcaps : &sb200_reccaps;
671 if (ch->parent->bd_id < 0x300)
672 return p? &sb201_playcaps : &sb201_reccaps;
673 return p? &sbpro_playcaps : &sbpro_reccaps;
676 static kobj_method_t sbchan_methods[] = {
677 KOBJMETHOD(channel_init, sbchan_init),
678 KOBJMETHOD(channel_setformat, sbchan_setformat),
679 KOBJMETHOD(channel_setspeed, sbchan_setspeed),
680 KOBJMETHOD(channel_setblocksize, sbchan_setblocksize),
681 KOBJMETHOD(channel_trigger, sbchan_trigger),
682 KOBJMETHOD(channel_getptr, sbchan_getptr),
683 KOBJMETHOD(channel_getcaps, sbchan_getcaps),
686 CHANNEL_DECLARE(sbchan);
688 /************************************************************/
691 sb_probe(device_t dev)
694 uintptr_t func, ver, r, f;
696 /* The parent device has already been probed. */
697 r = BUS_READ_IVAR(device_get_parent(dev), dev, 0, &func);
701 r = BUS_READ_IVAR(device_get_parent(dev), dev, 1, &ver);
702 f = (ver & 0xffff0000) >> 16;
704 if ((f & BD_F_ESS) || (ver >= 0x400))
707 snprintf(buf, sizeof buf, "SB DSP %d.%02d", (int) ver >> 8, (int) ver & 0xff);
709 device_set_desc_copy(dev, buf);
715 sb_attach(device_t dev)
718 char status[SND_STATUSLEN];
721 sb = malloc(sizeof(*sb), M_DEVBUF, M_WAITOK | M_ZERO);
722 sb->parent_dev = device_get_parent(dev);
723 BUS_READ_IVAR(device_get_parent(dev), dev, 1, &ver);
724 sb->bd_id = ver & 0x0000ffff;
725 sb->bd_flags = (ver & 0xffff0000) >> 16;
726 sb->bufsize = pcm_getbuffersize(dev, 4096, SB_DEFAULT_BUFSZ, 65536);
728 if (sb_alloc_resources(sb, dev))
730 if (sb_reset_dsp(sb))
732 if (mixer_init(dev, (sb->bd_id < 0x300)? &sbmix_mixer_class : &sbpromix_mixer_class, sb))
734 if (snd_setup_intr(dev, sb->irq, 0, sb_intr, sb, &sb->ih))
737 pcm_setflags(dev, pcm_getflags(dev) | SD_F_SIMPLEX);
739 if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
741 /*lowaddr*/BUS_SPACE_MAXADDR_24BIT,
742 /*highaddr*/BUS_SPACE_MAXADDR,
743 /*filter*/NULL, /*filterarg*/NULL,
744 /*maxsize*/sb->bufsize, /*nsegments*/1,
745 /*maxsegz*/0x3ffff, /*flags*/0,
746 /*lockfunc*/busdma_lock_mutex, /*lockarg*/&Giant,
747 &sb->parent_dmat) != 0) {
748 device_printf(dev, "unable to create dma tag\n");
752 snprintf(status, SND_STATUSLEN, "at io 0x%lx irq %ld drq %ld bufsz %u %s",
753 rman_get_start(sb->io_base), rman_get_start(sb->irq),
754 rman_get_start(sb->drq), sb->bufsize, PCM_KLDSTRING(snd_sb8));
756 if (pcm_register(dev, sb, 1, 1))
758 pcm_addchan(dev, PCMDIR_REC, &sbchan_class, sb);
759 pcm_addchan(dev, PCMDIR_PLAY, &sbchan_class, sb);
761 pcm_setstatus(dev, status);
766 sb_release_resources(sb, dev);
771 sb_detach(device_t dev)
776 r = pcm_unregister(dev);
780 sb = pcm_getdevinfo(dev);
781 sb_release_resources(sb, dev);
785 static device_method_t sb_methods[] = {
786 /* Device interface */
787 DEVMETHOD(device_probe, sb_probe),
788 DEVMETHOD(device_attach, sb_attach),
789 DEVMETHOD(device_detach, sb_detach),
794 static driver_t sb_driver = {
800 DRIVER_MODULE(snd_sb8, sbc, sb_driver, pcm_devclass, 0, 0);
801 MODULE_DEPEND(snd_sb8, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
802 MODULE_DEPEND(snd_sb8, snd_sbc, 1, 1, 1);
803 MODULE_VERSION(snd_sb8, 1);