xref: /freebsd/sys/dev/sound/pci/vibes.c (revision 195ebc7e9e4b129de810833791a19dfb4349d6a9)
1 /*-
2  * Copyright (c) 2001 Orion Hodson <O.Hodson@cs.ucl.ac.uk>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  */
26 
27 /*
28  * This card has the annoying habit of "clicking" when attached and
29  * detached, haven't been able to remedy this with any combination of
30  * muting.
31  */
32 
33 #include <dev/sound/pcm/sound.h>
34 #include <dev/sound/pci/vibes.h>
35 
36 #include <dev/pci/pcireg.h>
37 #include <dev/pci/pcivar.h>
38 
39 #include "mixer_if.h"
40 
41 SND_DECLARE_FILE("$FreeBSD$");
42 
43 /* ------------------------------------------------------------------------- */
44 /* Constants */
45 
46 #define SV_PCI_ID		0xca005333
47 #define SV_DEFAULT_BUFSZ	16384
48 #define SV_MIN_BLKSZ		128
49 #define SV_INTR_PER_BUFFER	2
50 
51 #ifndef DEB
52 #define DEB(x) /* (x) */
53 #endif
54 
55 /* ------------------------------------------------------------------------- */
56 /* Structures */
57 
58 struct sc_info;
59 
60 struct sc_chinfo {
61 	struct sc_info	*parent;
62 	struct pcm_channel	*channel;
63 	struct snd_dbuf	*buffer;
64 	u_int32_t	fmt, spd;
65 	int		dir;
66 	int		dma_active, dma_was_active;
67 };
68 
69 struct sc_info {
70 	device_t		dev;
71 
72 	/* DMA buffer allocator */
73 	bus_dma_tag_t		parent_dmat;
74 
75 	/* Enhanced register resources */
76 	struct resource 	*enh_reg;
77 	bus_space_tag_t		enh_st;
78 	bus_space_handle_t	enh_sh;
79 	int			enh_type;
80 	int			enh_rid;
81 
82 	/* DMA configuration */
83 	struct resource		*dmaa_reg, *dmac_reg;
84 	bus_space_tag_t		dmaa_st, dmac_st;
85 	bus_space_handle_t	dmaa_sh, dmac_sh;
86 	int			dmaa_type, dmac_type;
87 	int			dmaa_rid, dmac_rid;
88 
89 	/* Interrupt resources */
90 	struct resource 	*irq;
91 	int			irqid;
92 	void			*ih;
93 
94 	/* User configurable buffer size */
95 	unsigned int		bufsz;
96 
97 	struct sc_chinfo	rch, pch;
98 	u_int8_t		rev;
99 };
100 
101 static u_int32_t sc_fmt[] = {
102 	AFMT_U8,
103 	AFMT_U8 | AFMT_STEREO,
104 	AFMT_S16_LE,
105 	AFMT_S16_LE | AFMT_STEREO,
106 	0
107 };
108 
109 static struct pcmchan_caps sc_caps = {8000, 48000, sc_fmt, 0};
110 
111 /* ------------------------------------------------------------------------- */
112 /* Register Manipulations */
113 
114 #define sv_direct_set(x, y, z) _sv_direct_set(x, y, z, __LINE__)
115 
116 static u_int8_t
117 sv_direct_get(struct sc_info *sc, u_int8_t reg)
118 {
119 	return bus_space_read_1(sc->enh_st, sc->enh_sh, reg);
120 }
121 
122 static void
123 _sv_direct_set(struct sc_info *sc, u_int8_t reg, u_int8_t val, int line)
124 {
125 	u_int8_t n;
126 	bus_space_write_1(sc->enh_st, sc->enh_sh, reg, val);
127 
128 	n = sv_direct_get(sc, reg);
129 	if (n != val) {
130 		device_printf(sc->dev, "sv_direct_set register 0x%02x %d != %d from line %d\n", reg, n, val, line);
131 	}
132 }
133 
134 static u_int8_t
135 sv_indirect_get(struct sc_info *sc, u_int8_t reg)
136 {
137 	if (reg == SV_REG_FORMAT || reg == SV_REG_ANALOG_PWR)
138 		reg |= SV_CM_INDEX_MCE;
139 
140 	bus_space_write_1(sc->enh_st, sc->enh_sh, SV_CM_INDEX, reg);
141 	return bus_space_read_1(sc->enh_st, sc->enh_sh, SV_CM_DATA);
142 }
143 
144 #define sv_indirect_set(x, y, z) _sv_indirect_set(x, y, z, __LINE__)
145 
146 static void
147 _sv_indirect_set(struct sc_info *sc, u_int8_t reg, u_int8_t val, int line)
148 {
149 	if (reg == SV_REG_FORMAT || reg == SV_REG_ANALOG_PWR)
150 		reg |= SV_CM_INDEX_MCE;
151 
152 	bus_space_write_1(sc->enh_st, sc->enh_sh, SV_CM_INDEX, reg);
153 	bus_space_write_1(sc->enh_st, sc->enh_sh, SV_CM_DATA, val);
154 
155 	reg &= ~SV_CM_INDEX_MCE;
156 	if (reg != SV_REG_ADC_PLLM) {
157 		u_int8_t n;
158 		n = sv_indirect_get(sc, reg);
159 		if (n != val) {
160 			device_printf(sc->dev, "sv_indirect_set register 0x%02x %d != %d line %d\n", reg, n, val, line);
161 		}
162 	}
163 }
164 
165 static void
166 sv_dma_set_config(bus_space_tag_t st, bus_space_handle_t sh,
167 		  u_int32_t base, u_int32_t count, u_int8_t mode)
168 {
169 	bus_space_write_4(st, sh, SV_DMA_ADDR, base);
170 	bus_space_write_4(st, sh, SV_DMA_COUNT, count & 0xffffff);
171 	bus_space_write_1(st, sh, SV_DMA_MODE, mode);
172 
173 	DEB(printf("base 0x%08x count %5d mode 0x%02x\n",
174 		   base, count, mode));
175 }
176 
177 static u_int32_t
178 sv_dma_get_count(bus_space_tag_t st, bus_space_handle_t sh)
179 {
180 	return bus_space_read_4(st, sh, SV_DMA_COUNT) & 0xffffff;
181 }
182 
183 /* ------------------------------------------------------------------------- */
184 /* Play / Record Common Interface */
185 
186 static void *
187 svchan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
188 {
189 	struct sc_info		*sc = devinfo;
190 	struct sc_chinfo	*ch;
191 	ch = (dir == PCMDIR_PLAY) ? &sc->pch : &sc->rch;
192 
193 	ch->parent = sc;
194 	ch->channel = c;
195 	ch->dir = dir;
196 
197 	if (sndbuf_alloc(b, sc->parent_dmat, 0, sc->bufsz) != 0) {
198 		DEB(printf("svchan_init failed\n"));
199 		return NULL;
200 	}
201 	ch->buffer = b;
202 	ch->fmt = AFMT_U8;
203 	ch->spd = DSP_DEFAULT_SPEED;
204 	ch->dma_active = ch->dma_was_active = 0;
205 
206 	return ch;
207 }
208 
209 static struct pcmchan_caps *
210 svchan_getcaps(kobj_t obj, void *data)
211 {
212         return &sc_caps;
213 }
214 
215 static int
216 svchan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
217 {
218 	struct sc_chinfo *ch = data;
219 	struct sc_info *sc = ch->parent;
220 
221         /* user has requested interrupts every blocksize bytes */
222 	RANGE(blocksize, SV_MIN_BLKSZ, sc->bufsz / SV_INTR_PER_BUFFER);
223 	sndbuf_resize(ch->buffer, SV_INTR_PER_BUFFER, blocksize);
224 	DEB(printf("svchan_setblocksize: %d\n", blocksize));
225 	return blocksize;
226 }
227 
228 static int
229 svchan_setformat(kobj_t obj, void *data, u_int32_t format)
230 {
231 	struct sc_chinfo *ch = data;
232 	/* NB Just note format here as setting format register
233 	 * generates noise if dma channel is inactive. */
234 	ch->fmt  = (format & AFMT_STEREO) ? SV_AFMT_STEREO : SV_AFMT_MONO;
235 	ch->fmt |= (format & AFMT_16BIT) ? SV_AFMT_S16 : SV_AFMT_U8;
236 	return 0;
237 }
238 
239 static int
240 svchan_setspeed(kobj_t obj, void *data, u_int32_t speed)
241 {
242 	struct sc_chinfo *ch = data;
243 	RANGE(speed, 8000, 48000);
244 	ch->spd = speed;
245 	return speed;
246 }
247 
248 /* ------------------------------------------------------------------------- */
249 /* Recording interface */
250 
251 static int
252 sv_set_recspeed(struct sc_info *sc, u_int32_t speed)
253 {
254 	u_int32_t	f_out, f_actual;
255 	u_int32_t	rs, re, r, best_r = 0, r2, t, n, best_n = 0;
256 	int32_t		m, best_m = 0, ms, me, err, min_err;
257 
258 	/* This algorithm is a variant described in sonicvibes.pdf
259 	 * appendix A.  This search is marginally more extensive and
260 	 * results in (nominally) better sample rate matching. */
261 
262 	f_out = SV_F_SCALE * speed;
263 	min_err = 0x7fffffff;
264 
265 	/* Find bounds of r to examine, rs <= r <= re */
266 	t = 80000000 / f_out;
267 	for (rs = 1; (1 << rs) < t; rs++);
268 
269 	t = 150000000 / f_out;
270 	for (re = 1; (2 << re) < t; re++);
271 	if (re > 7) re = 7;
272 
273 	/* Search over r, n, m */
274 	for (r = rs; r <= re; r++) {
275 		r2 = (1 << r);
276 		for (n = 3; n < 34; n++) {
277 			m = f_out * n / (SV_F_REF / r2);
278 			ms = (m > 3) ? (m - 1) : 3;
279 			me = (m < 129) ? (m + 1) : 129;
280 			for (m = ms; m <= me; m++) {
281 				f_actual = m * SV_F_REF / (n * r2);
282 				if (f_actual > f_out) {
283 					err = f_actual - f_out;
284 				} else {
285 					err = f_out - f_actual;
286 				}
287 				if (err < min_err) {
288 					best_r = r;
289 					best_m = m - 2;
290 					best_n = n - 2;
291 					min_err = err;
292 					if (err == 0) break;
293 				}
294 			}
295 		}
296 	}
297 
298 	sv_indirect_set(sc, SV_REG_ADC_PLLM, best_m);
299 	sv_indirect_set(sc, SV_REG_ADC_PLLN,
300 			SV_ADC_PLLN(best_n) | SV_ADC_PLLR(best_r));
301 	DEB(printf("svrchan_setspeed: %d -> PLLM 0x%02x PLLNR 0x%08x\n",
302 		   speed,
303 		   sv_indirect_get(sc, SV_REG_ADC_PLLM),
304 		   sv_indirect_get(sc, SV_REG_ADC_PLLN)));
305 	return 0;
306 }
307 
308 static int
309 svrchan_trigger(kobj_t obj, void *data, int go)
310 {
311 	struct sc_chinfo	*ch = data;
312 	struct sc_info 		*sc = ch->parent;
313 	u_int32_t		count, enable;
314 	u_int8_t		v;
315 
316 	switch(go) {
317 	case PCMTRIG_START:
318 		/* Set speed */
319 		sv_set_recspeed(sc, ch->spd);
320 
321 		/* Set format */
322 		v  = sv_indirect_get(sc, SV_REG_FORMAT) & ~SV_AFMT_DMAC_MSK;
323 		v |= SV_AFMT_DMAC(ch->fmt);
324 		sv_indirect_set(sc, SV_REG_FORMAT, v);
325 
326 		/* Program DMA */
327 		count = sndbuf_getsize(ch->buffer) / 2; /* DMAC uses words */
328 		sv_dma_set_config(sc->dmac_st, sc->dmac_sh,
329 				  sndbuf_getbufaddr(ch->buffer),
330 				  count - 1,
331 				  SV_DMA_MODE_AUTO | SV_DMA_MODE_RD);
332 		count = count / SV_INTR_PER_BUFFER - 1;
333 		sv_indirect_set(sc, SV_REG_DMAC_COUNT_HI, count >> 8);
334 		sv_indirect_set(sc, SV_REG_DMAC_COUNT_LO, count & 0xff);
335 
336 		/* Enable DMA */
337 		enable = sv_indirect_get(sc, SV_REG_ENABLE) | SV_RECORD_ENABLE;
338 		sv_indirect_set(sc, SV_REG_ENABLE, enable);
339 		ch->dma_active = 1;
340 		break;
341 	case PCMTRIG_STOP:
342 	case PCMTRIG_ABORT:
343 		enable = sv_indirect_get(sc, SV_REG_ENABLE) & ~SV_RECORD_ENABLE;
344 		sv_indirect_set(sc, SV_REG_ENABLE, enable);
345 		ch->dma_active = 0;
346 		break;
347 	}
348 
349 	return 0;
350 }
351 
352 static int
353 svrchan_getptr(kobj_t obj, void *data)
354 {
355 	struct sc_chinfo	*ch = data;
356 	struct sc_info 		*sc = ch->parent;
357 	u_int32_t sz, remain;
358 
359 	sz = sndbuf_getsize(ch->buffer);
360 	/* DMAC uses words */
361 	remain = (sv_dma_get_count(sc->dmac_st, sc->dmac_sh) + 1) * 2;
362 	return sz - remain;
363 }
364 
365 static kobj_method_t svrchan_methods[] = {
366         KOBJMETHOD(channel_init,                svchan_init),
367         KOBJMETHOD(channel_setformat,           svchan_setformat),
368         KOBJMETHOD(channel_setspeed,            svchan_setspeed),
369         KOBJMETHOD(channel_setblocksize,        svchan_setblocksize),
370         KOBJMETHOD(channel_trigger,             svrchan_trigger),
371         KOBJMETHOD(channel_getptr,              svrchan_getptr),
372         KOBJMETHOD(channel_getcaps,             svchan_getcaps),
373         { 0, 0 }
374 };
375 CHANNEL_DECLARE(svrchan);
376 
377 /* ------------------------------------------------------------------------- */
378 /* Playback interface */
379 
380 static int
381 svpchan_trigger(kobj_t obj, void *data, int go)
382 {
383 	struct sc_chinfo	*ch = data;
384 	struct sc_info		*sc = ch->parent;
385 	u_int32_t		count, enable, speed;
386 	u_int8_t		v;
387 
388 	switch(go) {
389 	case PCMTRIG_START:
390 		/* Set speed */
391 		speed = (ch->spd * 65536) / 48000;
392 		if (speed > 65535)
393 			speed = 65535;
394 		sv_indirect_set(sc, SV_REG_PCM_SAMPLING_HI, speed >> 8);
395 		sv_indirect_set(sc, SV_REG_PCM_SAMPLING_LO, speed & 0xff);
396 
397 		/* Set format */
398 		v  = sv_indirect_get(sc, SV_REG_FORMAT) & ~SV_AFMT_DMAA_MSK;
399 		v |= SV_AFMT_DMAA(ch->fmt);
400 		sv_indirect_set(sc, SV_REG_FORMAT, v);
401 
402 		/* Program DMA */
403 		count = sndbuf_getsize(ch->buffer);
404 		sv_dma_set_config(sc->dmaa_st, sc->dmaa_sh,
405 				  sndbuf_getbufaddr(ch->buffer),
406 				  count - 1,
407 				  SV_DMA_MODE_AUTO | SV_DMA_MODE_WR);
408 		count = count / SV_INTR_PER_BUFFER - 1;
409 		sv_indirect_set(sc, SV_REG_DMAA_COUNT_HI, count >> 8);
410 		sv_indirect_set(sc, SV_REG_DMAA_COUNT_LO, count & 0xff);
411 
412 		/* Enable DMA */
413 		enable = sv_indirect_get(sc, SV_REG_ENABLE);
414 		enable = (enable | SV_PLAY_ENABLE) & ~SV_PLAYBACK_PAUSE;
415 		sv_indirect_set(sc, SV_REG_ENABLE, enable);
416 		ch->dma_active = 1;
417 		break;
418 	case PCMTRIG_STOP:
419 	case PCMTRIG_ABORT:
420 		enable = sv_indirect_get(sc, SV_REG_ENABLE) & ~SV_PLAY_ENABLE;
421 		sv_indirect_set(sc, SV_REG_ENABLE, enable);
422 		ch->dma_active = 0;
423 		break;
424 	}
425 
426 	return 0;
427 }
428 
429 static int
430 svpchan_getptr(kobj_t obj, void *data)
431 {
432 	struct sc_chinfo	*ch = data;
433 	struct sc_info 		*sc = ch->parent;
434 	u_int32_t sz, remain;
435 
436 	sz = sndbuf_getsize(ch->buffer);
437 	/* DMAA uses bytes */
438 	remain = sv_dma_get_count(sc->dmaa_st, sc->dmaa_sh) + 1;
439 	return (sz - remain);
440 }
441 
442 static kobj_method_t svpchan_methods[] = {
443         KOBJMETHOD(channel_init,                svchan_init),
444         KOBJMETHOD(channel_setformat,           svchan_setformat),
445         KOBJMETHOD(channel_setspeed,            svchan_setspeed),
446         KOBJMETHOD(channel_setblocksize,        svchan_setblocksize),
447         KOBJMETHOD(channel_trigger,             svpchan_trigger),
448         KOBJMETHOD(channel_getptr,              svpchan_getptr),
449         KOBJMETHOD(channel_getcaps,             svchan_getcaps),
450         { 0, 0 }
451 };
452 CHANNEL_DECLARE(svpchan);
453 
454 /* ------------------------------------------------------------------------- */
455 /* Mixer support */
456 
457 struct sv_mix_props {
458 	u_int8_t	reg;		/* Register */
459 	u_int8_t	stereo:1;	/* Supports 2 channels */
460 	u_int8_t	mute:1;		/* Supports muting */
461 	u_int8_t	neg:1;		/* Negative gain */
462 	u_int8_t	max;		/* Max gain */
463 	u_int8_t	iselect;	/* Input selector */
464 } static const mt [SOUND_MIXER_NRDEVICES] = {
465 	[SOUND_MIXER_LINE1]  = {SV_REG_AUX1,      1, 1, 1, SV_DEFAULT_MAX, SV_INPUT_AUX1},
466 	[SOUND_MIXER_CD]     = {SV_REG_CD,        1, 1, 1, SV_DEFAULT_MAX, SV_INPUT_CD},
467 	[SOUND_MIXER_LINE]   = {SV_REG_LINE,      1, 1, 1, SV_DEFAULT_MAX, SV_INPUT_LINE},
468 	[SOUND_MIXER_MIC]    = {SV_REG_MIC,       0, 1, 1, SV_MIC_MAX,     SV_INPUT_MIC},
469 	[SOUND_MIXER_SYNTH]  = {SV_REG_SYNTH,     0, 1, 1, SV_DEFAULT_MAX, 0},
470 	[SOUND_MIXER_LINE2]  = {SV_REG_AUX2,      1, 1, 1, SV_DEFAULT_MAX, SV_INPUT_AUX2},
471 	[SOUND_MIXER_VOLUME] = {SV_REG_MIX,       1, 1, 1, SV_DEFAULT_MAX, 0},
472 	[SOUND_MIXER_PCM]    = {SV_REG_PCM,       1, 1, 1, SV_PCM_MAX,     0},
473 	[SOUND_MIXER_RECLEV] = {SV_REG_ADC_INPUT, 1, 0, 0, SV_ADC_MAX, 0},
474 };
475 
476 static void
477 sv_channel_gain(struct sc_info *sc, u_int32_t dev, u_int32_t gain, u_int32_t channel)
478 {
479 	u_int8_t	v;
480 	int32_t		g;
481 
482 	g = mt[dev].max * gain / 100;
483 	if (mt[dev].neg)
484 		g = mt[dev].max - g;
485 	v  = sv_indirect_get(sc, mt[dev].reg + channel) & ~mt[dev].max;
486 	v |= g;
487 
488 	if (mt[dev].mute) {
489 		if (gain == 0) {
490 			v |= SV_MUTE;
491 		} else {
492 			v &= ~SV_MUTE;
493 		}
494 	}
495 	sv_indirect_set(sc, mt[dev].reg + channel, v);
496 }
497 
498 static int
499 sv_gain(struct sc_info *sc, u_int32_t dev, u_int32_t left, u_int32_t right)
500 {
501 	sv_channel_gain(sc, dev, left, 0);
502 	if (mt[dev].stereo)
503 		sv_channel_gain(sc, dev, right, 1);
504 	return 0;
505 }
506 
507 static void
508 sv_mix_mute_all(struct sc_info *sc)
509 {
510 	int32_t i;
511 	for (i = 0; i < SOUND_MIXER_NRDEVICES; i++) {
512 		if (mt[i].reg) sv_gain(sc, i, 0, 0);
513 	}
514 }
515 
516 static int
517 sv_mix_init(struct snd_mixer *m)
518 {
519 	u_int32_t 	i, v;
520 
521 	for(i = v = 0; i < SOUND_MIXER_NRDEVICES; i++) {
522 		if (mt[i].max) v |= (1 << i);
523 	}
524 	mix_setdevs(m, v);
525 
526 	for(i = v = 0; i < SOUND_MIXER_NRDEVICES; i++) {
527 		if (mt[i].iselect) v |= (1 << i);
528 	}
529 	mix_setrecdevs(m, v);
530 
531 	return 0;
532 }
533 
534 static int
535 sv_mix_set(struct snd_mixer *m, u_int32_t dev, u_int32_t left, u_int32_t right)
536 {
537 	struct sc_info	*sc = mix_getdevinfo(m);
538 	return sv_gain(sc, dev, left, right);
539 }
540 
541 static int
542 sv_mix_setrecsrc(struct snd_mixer *m, u_int32_t mask)
543 {
544 	struct sc_info	*sc = mix_getdevinfo(m);
545 	u_int32_t	i, v;
546 
547 	v = sv_indirect_get(sc, SV_REG_ADC_INPUT) & SV_INPUT_GAIN_MASK;
548 	for(i = 0; i < SOUND_MIXER_NRDEVICES; i++) {
549 		if ((1 << i) & mask) {
550 			v |= mt[i].iselect;
551 		}
552 	}
553 	DEB(printf("sv_mix_setrecsrc: mask 0x%08x adc_input 0x%02x\n", mask, v));
554 	sv_indirect_set(sc, SV_REG_ADC_INPUT, v);
555 	return mask;
556 }
557 
558 static kobj_method_t sv_mixer_methods[] = {
559         KOBJMETHOD(mixer_init,		sv_mix_init),
560         KOBJMETHOD(mixer_set,		sv_mix_set),
561         KOBJMETHOD(mixer_setrecsrc,	sv_mix_setrecsrc),
562         { 0, 0 }
563 };
564 MIXER_DECLARE(sv_mixer);
565 
566 /* ------------------------------------------------------------------------- */
567 /* Power management and reset */
568 
569 static void
570 sv_power(struct sc_info *sc, int state)
571 {
572 	u_int8_t v;
573 
574         switch (state) {
575         case 0:
576 		/* power on */
577 		v = sv_indirect_get(sc, SV_REG_ANALOG_PWR) &~ SV_ANALOG_OFF;
578 		v |= SV_ANALOG_OFF_SRS | SV_ANALOG_OFF_SPLL;
579 		sv_indirect_set(sc, SV_REG_ANALOG_PWR, v);
580 		v = sv_indirect_get(sc, SV_REG_DIGITAL_PWR) &~ SV_DIGITAL_OFF;
581 		v |= SV_DIGITAL_OFF_SYN | SV_DIGITAL_OFF_MU | SV_DIGITAL_OFF_GP;
582 		sv_indirect_set(sc, SV_REG_DIGITAL_PWR, v);
583                 break;
584         default:
585 		/* power off */
586 		v = sv_indirect_get(sc, SV_REG_ANALOG_PWR) | SV_ANALOG_OFF;
587 		sv_indirect_set(sc, SV_REG_ANALOG_PWR, v);
588 		v = sv_indirect_get(sc, SV_REG_DIGITAL_PWR) | SV_DIGITAL_OFF;
589 		sv_indirect_set(sc, SV_REG_DIGITAL_PWR, SV_DIGITAL_OFF);
590                 break;
591         }
592         DEB(printf("Power state %d\n", state));
593 }
594 
595 static int
596 sv_init(struct sc_info *sc)
597 {
598 	u_int8_t	v;
599 
600 	/* Effect reset */
601 	v  = sv_direct_get(sc, SV_CM_CONTROL) & ~SV_CM_CONTROL_ENHANCED;
602 	v |= SV_CM_CONTROL_RESET;
603 	sv_direct_set(sc, SV_CM_CONTROL, v);
604 	DELAY(50);
605 
606 	v = sv_direct_get(sc, SV_CM_CONTROL) & ~SV_CM_CONTROL_RESET;
607 	sv_direct_set(sc, SV_CM_CONTROL, v);
608 	DELAY(50);
609 
610 	/* Set in enhanced mode */
611 	v = sv_direct_get(sc, SV_CM_CONTROL);
612 	v |= SV_CM_CONTROL_ENHANCED;
613 	sv_direct_set(sc, SV_CM_CONTROL, v);
614 
615 	/* Enable interrupts (UDM and MIDM are superfluous) */
616 	v = sv_direct_get(sc, SV_CM_IMR);
617 	v &= ~(SV_CM_IMR_AMSK | SV_CM_IMR_CMSK | SV_CM_IMR_SMSK);
618 	sv_direct_set(sc, SV_CM_IMR, v);
619 
620 	/* Select ADC PLL for ADC clock */
621 	v = sv_indirect_get(sc, SV_REG_CLOCK_SOURCE) & ~SV_CLOCK_ALTERNATE;
622 	sv_indirect_set(sc, SV_REG_CLOCK_SOURCE, v);
623 
624 	/* Disable loopback - binds ADC and DAC rates */
625 	v = sv_indirect_get(sc, SV_REG_LOOPBACK) & ~SV_LOOPBACK_ENABLE;
626 	sv_indirect_set(sc, SV_REG_LOOPBACK, v);
627 
628 	/* Disable SRS */
629 	v = sv_indirect_get(sc, SV_REG_SRS_SPACE) | SV_SRS_DISABLED;
630 	sv_indirect_set(sc, SV_REG_SRS_SPACE, v);
631 
632 	/* Get revision */
633 	sc->rev = sv_indirect_get(sc, SV_REG_REVISION);
634 
635 	return 0;
636 }
637 
638 static int
639 sv_suspend(device_t dev)
640 {
641 	struct sc_info	*sc = pcm_getdevinfo(dev);
642 
643 	sc->rch.dma_was_active = sc->rch.dma_active;
644 	svrchan_trigger(NULL, &sc->rch, PCMTRIG_ABORT);
645 
646 	sc->pch.dma_was_active = sc->pch.dma_active;
647 	svrchan_trigger(NULL, &sc->pch, PCMTRIG_ABORT);
648 
649 	sv_mix_mute_all(sc);
650 	sv_power(sc, 3);
651 
652 	return 0;
653 }
654 
655 static int
656 sv_resume(device_t dev)
657 {
658 	struct sc_info	*sc = pcm_getdevinfo(dev);
659 
660 	sv_mix_mute_all(sc);
661 	sv_power(sc, 0);
662 	if (sv_init(sc) == -1) {
663 		device_printf(dev, "unable to reinitialize the card\n");
664 		return ENXIO;
665 	}
666 
667 	if (mixer_reinit(dev) == -1) {
668 		device_printf(dev, "unable to reinitialize the mixer\n");
669                 return ENXIO;
670         }
671 
672 	if (sc->rch.dma_was_active) {
673 		svrchan_trigger(0, &sc->rch, PCMTRIG_START);
674 	}
675 
676 	if (sc->pch.dma_was_active) {
677 		svpchan_trigger(0, &sc->pch, PCMTRIG_START);
678 	}
679 
680 	return 0;
681 }
682 
683 /* ------------------------------------------------------------------------- */
684 /* Resource related */
685 
686 static void
687 sv_intr(void *data)
688 {
689 	struct sc_info	*sc = data;
690 	u_int8_t	status;
691 
692 	status = sv_direct_get(sc, SV_CM_STATUS);
693 	if (status & SV_CM_STATUS_AINT)
694 		chn_intr(sc->pch.channel);
695 
696 	if (status & SV_CM_STATUS_CINT)
697 		chn_intr(sc->rch.channel);
698 
699 	status &= ~(SV_CM_STATUS_AINT|SV_CM_STATUS_CINT);
700 	DEB(if (status) printf("intr 0x%02x ?\n", status));
701 
702 	return;
703 }
704 
705 static int
706 sv_probe(device_t dev)
707 {
708 	switch(pci_get_devid(dev)) {
709 	case SV_PCI_ID:
710 		device_set_desc(dev, "S3 Sonicvibes");
711 		return BUS_PROBE_DEFAULT;
712 	default:
713 		return ENXIO;
714 	}
715 }
716 
717 static int
718 sv_attach(device_t dev) {
719 	struct sc_info	*sc;
720 	u_int32_t	data;
721 	char		status[SND_STATUSLEN];
722 	u_long		midi_start, games_start, count, sdmaa, sdmac, ml, mu;
723 
724 	sc = malloc(sizeof(*sc), M_DEVBUF, M_WAITOK | M_ZERO);
725 	sc->dev = dev;
726 
727 	data = pci_read_config(dev, PCIR_COMMAND, 2);
728 	data |= (PCIM_CMD_PORTEN|PCIM_CMD_BUSMASTEREN);
729 	pci_write_config(dev, PCIR_COMMAND, data, 2);
730 	data = pci_read_config(dev, PCIR_COMMAND, 2);
731 
732 #if __FreeBSD_version > 500000
733         if (pci_get_powerstate(dev) != PCI_POWERSTATE_D0) {
734                 device_printf(dev, "chip is in D%d power mode "
735                               "-- setting to D0\n", pci_get_powerstate(dev));
736                 pci_set_powerstate(dev, PCI_POWERSTATE_D0);
737         }
738 #endif
739 	sc->enh_rid  = SV_PCI_ENHANCED;
740 	sc->enh_type = SYS_RES_IOPORT;
741 	sc->enh_reg  = bus_alloc_resource(dev, sc->enh_type,
742 					  &sc->enh_rid, 0, ~0,
743 					  SV_PCI_ENHANCED_SIZE, RF_ACTIVE);
744 	if (sc->enh_reg == NULL) {
745 		device_printf(dev, "sv_attach: cannot allocate enh\n");
746 		return ENXIO;
747 	}
748 	sc->enh_st = rman_get_bustag(sc->enh_reg);
749 	sc->enh_sh = rman_get_bushandle(sc->enh_reg);
750 
751 	data = pci_read_config(dev, SV_PCI_DMAA, 4);
752 	DEB(printf("sv_attach: initial dmaa 0x%08x\n", data));
753 	data = pci_read_config(dev, SV_PCI_DMAC, 4);
754 	DEB(printf("sv_attach: initial dmac 0x%08x\n", data));
755 
756 	/* Initialize DMA_A and DMA_C */
757 	pci_write_config(dev, SV_PCI_DMAA, SV_PCI_DMA_EXTENDED, 4);
758 	pci_write_config(dev, SV_PCI_DMAC, 0, 4);
759 
760 	/* Register IRQ handler */
761 	sc->irqid = 0;
762         sc->irq   = bus_alloc_resource(dev, SYS_RES_IRQ, &sc->irqid,
763 				       0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
764         if (!sc->irq ||
765 	    snd_setup_intr(dev, sc->irq, 0, sv_intr, sc, &sc->ih)) {
766                 device_printf(dev, "sv_attach: Unable to map interrupt\n");
767                 goto fail;
768         }
769 
770 	sc->bufsz = pcm_getbuffersize(dev, 4096, SV_DEFAULT_BUFSZ, 65536);
771         if (bus_dma_tag_create(/*parent*/bus_get_dma_tag(dev), /*alignment*/2,
772 			       /*boundary*/0,
773                                /*lowaddr*/BUS_SPACE_MAXADDR_24BIT,
774                                /*highaddr*/BUS_SPACE_MAXADDR,
775                                /*filter*/NULL, /*filterarg*/NULL,
776                                /*maxsize*/sc->bufsz, /*nsegments*/1,
777                                /*maxsegz*/0x3ffff, /*flags*/0,
778 			       /*lockfunc*/busdma_lock_mutex,
779 			       /*lockarg*/&Giant, &sc->parent_dmat) != 0) {
780                 device_printf(dev, "sv_attach: Unable to create dma tag\n");
781                 goto fail;
782         }
783 
784 	/* Power up and initialize */
785 	sv_mix_mute_all(sc);
786 	sv_power(sc, 0);
787 	sv_init(sc);
788 
789 	if (mixer_init(dev, &sv_mixer_class, sc) != 0) {
790 		device_printf(dev, "sv_attach: Mixer failed to initialize\n");
791 		goto fail;
792 	}
793 
794 	/* XXX This is a hack, and it's ugly.  Okay, the deal is this
795 	 * card has two more io regions that available for automatic
796 	 * configuration by the pci code.  These need to be allocated
797 	 * to used as control registers for the DMA engines.
798 	 * Unfortunately FBSD has no bus_space_foo() functions so we
799 	 * have to grab port space in region of existing resources.  Go
800 	 * for space between midi and game ports.
801 	 */
802 	bus_get_resource(dev, SYS_RES_IOPORT, SV_PCI_MIDI, &midi_start, &count);
803 	bus_get_resource(dev, SYS_RES_IOPORT, SV_PCI_GAMES, &games_start, &count);
804 
805 	if (games_start < midi_start) {
806 		ml = games_start;
807 		mu = midi_start;
808 	} else {
809 		ml = midi_start;
810 		mu = games_start;
811 	}
812 	/* Check assumptions about space availability and
813            alignment. How driver loaded can determine whether
814            games_start > midi_start or vice versa */
815 	if ((mu - ml >= 0x800)  ||
816 	    ((mu - ml) % 0x200)) {
817 		device_printf(dev, "sv_attach: resource assumptions not met "
818 			      "(midi 0x%08lx, games 0x%08lx)\n",
819 			      midi_start, games_start);
820 		goto fail;
821 	}
822 
823 	sdmaa = ml + 0x40;
824 	sdmac = sdmaa + 0x40;
825 
826 	/* Add resources to list of pci resources for this device - from here on
827 	 * they look like normal pci resources. */
828 	bus_set_resource(dev, SYS_RES_IOPORT, SV_PCI_DMAA, sdmaa, SV_PCI_DMAA_SIZE);
829 	bus_set_resource(dev, SYS_RES_IOPORT, SV_PCI_DMAC, sdmac, SV_PCI_DMAC_SIZE);
830 
831 	/* Cache resource short-cuts for dma_a */
832 	sc->dmaa_rid = SV_PCI_DMAA;
833 	sc->dmaa_type = SYS_RES_IOPORT;
834 	sc->dmaa_reg  = bus_alloc_resource(dev, sc->dmaa_type,
835 					   &sc->dmaa_rid, 0, ~0,
836 					   SV_PCI_ENHANCED_SIZE, RF_ACTIVE);
837 	if (sc->dmaa_reg == NULL) {
838 		device_printf(dev, "sv_attach: cannot allocate dmaa\n");
839 		goto fail;
840 	}
841 	sc->dmaa_st = rman_get_bustag(sc->dmaa_reg);
842 	sc->dmaa_sh = rman_get_bushandle(sc->dmaa_reg);
843 
844 	/* Poke port into dma_a configuration, nb bit flags to enable dma */
845 	data = pci_read_config(dev, SV_PCI_DMAA, 4) | SV_PCI_DMA_ENABLE | SV_PCI_DMA_EXTENDED;
846 	data = ((u_int32_t)sdmaa & 0xfffffff0) | (data & 0x0f);
847 	pci_write_config(dev, SV_PCI_DMAA, data, 4);
848 	DEB(printf("dmaa: 0x%x 0x%x\n", data, pci_read_config(dev, SV_PCI_DMAA, 4)));
849 
850 	/* Cache resource short-cuts for dma_c */
851 	sc->dmac_rid = SV_PCI_DMAC;
852 	sc->dmac_type = SYS_RES_IOPORT;
853 	sc->dmac_reg  = bus_alloc_resource(dev, sc->dmac_type,
854 					   &sc->dmac_rid, 0, ~0,
855 					   SV_PCI_ENHANCED_SIZE, RF_ACTIVE);
856 	if (sc->dmac_reg == NULL) {
857 		device_printf(dev, "sv_attach: cannot allocate dmac\n");
858 		goto fail;
859 	}
860 	sc->dmac_st = rman_get_bustag(sc->dmac_reg);
861 	sc->dmac_sh = rman_get_bushandle(sc->dmac_reg);
862 
863 	/* Poke port into dma_c configuration, nb bit flags to enable dma */
864 	data = pci_read_config(dev, SV_PCI_DMAC, 4) | SV_PCI_DMA_ENABLE | SV_PCI_DMA_EXTENDED;
865 	data = ((u_int32_t)sdmac & 0xfffffff0) | (data & 0x0f);
866 	pci_write_config(dev, SV_PCI_DMAC, data, 4);
867 	DEB(printf("dmac: 0x%x 0x%x\n", data, pci_read_config(dev, SV_PCI_DMAC, 4)));
868 
869 	if (bootverbose)
870 		printf("Sonicvibes: revision %d.\n", sc->rev);
871 
872         if (pcm_register(dev, sc, 1, 1)) {
873 		device_printf(dev, "sv_attach: pcm_register fail\n");
874                 goto fail;
875 	}
876 
877         pcm_addchan(dev, PCMDIR_PLAY, &svpchan_class, sc);
878         pcm_addchan(dev, PCMDIR_REC,  &svrchan_class, sc);
879 
880         snprintf(status, SND_STATUSLEN, "at io 0x%lx irq %ld %s",
881                  rman_get_start(sc->enh_reg),  rman_get_start(sc->irq),PCM_KLDSTRING(snd_vibes));
882         pcm_setstatus(dev, status);
883 
884         DEB(printf("sv_attach: succeeded\n"));
885 
886 	return 0;
887 
888  fail:
889 	if (sc->parent_dmat)
890 		bus_dma_tag_destroy(sc->parent_dmat);
891         if (sc->ih)
892 		bus_teardown_intr(dev, sc->irq, sc->ih);
893         if (sc->irq)
894 		bus_release_resource(dev, SYS_RES_IRQ, sc->irqid, sc->irq);
895 	if (sc->enh_reg)
896 		bus_release_resource(dev, sc->enh_type, sc->enh_rid, sc->enh_reg);
897 	if (sc->dmaa_reg)
898 		bus_release_resource(dev, sc->dmaa_type, sc->dmaa_rid, sc->dmaa_reg);
899 	if (sc->dmac_reg)
900 		bus_release_resource(dev, sc->dmac_type, sc->dmac_rid, sc->dmac_reg);
901 	return ENXIO;
902 }
903 
904 static int
905 sv_detach(device_t dev) {
906 	struct sc_info	*sc;
907 	int		r;
908 
909 	r = pcm_unregister(dev);
910 	if (r) return r;
911 
912 	sc = pcm_getdevinfo(dev);
913 	sv_mix_mute_all(sc);
914 	sv_power(sc, 3);
915 
916 	bus_dma_tag_destroy(sc->parent_dmat);
917 	bus_teardown_intr(dev, sc->irq, sc->ih);
918 	bus_release_resource(dev, SYS_RES_IRQ, sc->irqid, sc->irq);
919 	bus_release_resource(dev, sc->enh_type, sc->enh_rid, sc->enh_reg);
920 	bus_release_resource(dev, sc->dmaa_type, sc->dmaa_rid, sc->dmaa_reg);
921 	bus_release_resource(dev, sc->dmac_type, sc->dmac_rid, sc->dmac_reg);
922 
923 	free(sc, M_DEVBUF);
924 
925 	return 0;
926 }
927 
928 static device_method_t sc_methods[] = {
929         DEVMETHOD(device_probe,         sv_probe),
930         DEVMETHOD(device_attach,        sv_attach),
931         DEVMETHOD(device_detach,        sv_detach),
932         DEVMETHOD(device_resume,        sv_resume),
933         DEVMETHOD(device_suspend,       sv_suspend),
934         { 0, 0 }
935 };
936 
937 static driver_t sonicvibes_driver = {
938         "pcm",
939         sc_methods,
940         PCM_SOFTC_SIZE
941 };
942 
943 DRIVER_MODULE(snd_vibes, pci, sonicvibes_driver, pcm_devclass, 0, 0);
944 MODULE_DEPEND(snd_vibes, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
945 MODULE_VERSION(snd_vibes, 1);
946