xref: /dragonfly/sys/dev/sound/pci/cmi.c (revision fcf53d9b)
1 /*-
2  * Copyright (c) 2000 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, WHETHERIN 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 THEPOSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * This driver exists largely as a result of other people's efforts.
27  * Much of register handling is based on NetBSD CMI8x38 audio driver
28  * by Takuya Shiozaki <AoiMoe@imou.to>.  Chen-Li Tien
29  * <cltien@cmedia.com.tw> clarified points regarding the DMA related
30  * registers and the 8738 mixer devices.  His Linux driver was also a
31  * useful reference point.
32  *
33  * TODO: MIDI
34  *
35  * SPDIF contributed by Gerhard Gonter <gonter@whisky.wu-wien.ac.at>.
36  *
37  * This card/code does not always manage to sample at 44100 - actual
38  * rate drifts slightly between recordings (usually 0-3%).  No
39  * differences visible in register dumps between times that work and
40  * those that don't.
41  *
42  * $FreeBSD: src/sys/dev/sound/pci/cmi.c,v 1.32.2.2 2006/01/24 18:54:22 joel Exp $
43  */
44 
45 #include <dev/sound/pcm/sound.h>
46 #include <dev/sound/pci/cmireg.h>
47 #include <dev/sound/isa/sb.h>
48 
49 #include <bus/pci/pcireg.h>
50 #include <bus/pci/pcivar.h>
51 
52 #include <sys/sysctl.h>
53 
54 #include "mixer_if.h"
55 
56 /* Supported chip ID's */
57 #define CMI8338A_PCI_ID   0x010013f6
58 #define CMI8338B_PCI_ID   0x010113f6
59 #define CMI8738_PCI_ID    0x011113f6
60 #define CMI8738B_PCI_ID   0x011213f6
61 
62 /* Buffer size max is 64k for permitted DMA boundaries */
63 #define CMI_DEFAULT_BUFSZ      16384
64 
65 /* Interrupts per length of buffer */
66 #define CMI_INTR_PER_BUFFER      2
67 
68 /* Clarify meaning of named defines in cmireg.h */
69 #define CMPCI_REG_DMA0_MAX_SAMPLES  CMPCI_REG_DMA0_BYTES
70 #define CMPCI_REG_DMA0_INTR_SAMPLES CMPCI_REG_DMA0_SAMPLES
71 #define CMPCI_REG_DMA1_MAX_SAMPLES  CMPCI_REG_DMA1_BYTES
72 #define CMPCI_REG_DMA1_INTR_SAMPLES CMPCI_REG_DMA1_SAMPLES
73 
74 /* Our indication of custom mixer control */
75 #define CMPCI_NON_SB16_CONTROL		0xff
76 
77 /* Debugging macro's */
78 #undef DEB
79 #ifndef DEB
80 #define DEB(x) /* x */
81 #endif /* DEB */
82 
83 #ifndef DEBMIX
84 #define DEBMIX(x) /* x */
85 #endif  /* DEBMIX */
86 
87 /* ------------------------------------------------------------------------- */
88 /* Structures */
89 
90 struct sc_info;
91 
92 struct sc_chinfo {
93 	struct sc_info		*parent;
94 	struct pcm_channel	*channel;
95 	struct snd_dbuf		*buffer;
96 	u_int32_t		fmt, spd, phys_buf, bps;
97 	u_int32_t		dma_active:1, dma_was_active:1;
98 	int			dir;
99 };
100 
101 struct sc_info {
102 	device_t		dev;
103 
104 	bus_space_tag_t		st;
105 	bus_space_handle_t	sh;
106 	bus_dma_tag_t		parent_dmat;
107 	struct resource		*reg, *irq;
108 	int			regid, irqid;
109 	void 			*ih;
110 	sndlock_t		lock;
111 
112 	int			spdif_enabled;
113 	unsigned int		bufsz;
114 	struct sc_chinfo 	pch, rch;
115 };
116 
117 /* Channel caps */
118 
119 static u_int32_t cmi_fmt[] = {
120 	AFMT_U8,
121 	AFMT_STEREO | AFMT_U8,
122 	AFMT_S16_LE,
123 	AFMT_STEREO | AFMT_S16_LE,
124 	0
125 };
126 
127 static struct pcmchan_caps cmi_caps = {5512, 48000, cmi_fmt, 0};
128 
129 /* ------------------------------------------------------------------------- */
130 /* Register Utilities */
131 
132 static u_int32_t
133 cmi_rd(struct sc_info *sc, int regno, int size)
134 {
135 	switch (size) {
136 	case 1:
137 		return bus_space_read_1(sc->st, sc->sh, regno);
138 	case 2:
139 		return bus_space_read_2(sc->st, sc->sh, regno);
140 	case 4:
141 		return bus_space_read_4(sc->st, sc->sh, regno);
142 	default:
143 		DEB(kprintf("cmi_rd: failed 0x%04x %d\n", regno, size));
144 		return 0xFFFFFFFF;
145 	}
146 }
147 
148 static void
149 cmi_wr(struct sc_info *sc, int regno, u_int32_t data, int size)
150 {
151 	switch (size) {
152 	case 1:
153 		bus_space_write_1(sc->st, sc->sh, regno, data);
154 		break;
155 	case 2:
156 		bus_space_write_2(sc->st, sc->sh, regno, data);
157 		break;
158 	case 4:
159 		bus_space_write_4(sc->st, sc->sh, regno, data);
160 		break;
161 	}
162 }
163 
164 static void
165 cmi_partial_wr4(struct sc_info *sc,
166 		int reg, int shift, u_int32_t mask, u_int32_t val)
167 {
168 	u_int32_t r;
169 
170 	r = cmi_rd(sc, reg, 4);
171 	r &= ~(mask << shift);
172 	r |= val << shift;
173 	cmi_wr(sc, reg, r, 4);
174 }
175 
176 static void
177 cmi_clr4(struct sc_info *sc, int reg, u_int32_t mask)
178 {
179 	u_int32_t r;
180 
181 	r = cmi_rd(sc, reg, 4);
182 	r &= ~mask;
183 	cmi_wr(sc, reg, r, 4);
184 }
185 
186 static void
187 cmi_set4(struct sc_info *sc, int reg, u_int32_t mask)
188 {
189 	u_int32_t r;
190 
191 	r = cmi_rd(sc, reg, 4);
192 	r |= mask;
193 	cmi_wr(sc, reg, r, 4);
194 }
195 
196 /* ------------------------------------------------------------------------- */
197 /* Rate Mapping */
198 
199 static int cmi_rates[] = {5512, 8000, 11025, 16000,
200 			  22050, 32000, 44100, 48000};
201 #define NUM_CMI_RATES NELEM(cmi_rates)
202 
203 /* cmpci_rate_to_regvalue returns sampling freq selector for FCR1
204  * register - reg order is 5k,11k,22k,44k,8k,16k,32k,48k */
205 
206 static u_int32_t
207 cmpci_rate_to_regvalue(int rate)
208 {
209 	int i, r;
210 
211 	for(i = 0; i < NUM_CMI_RATES - 1; i++) {
212 		if (rate < ((cmi_rates[i] + cmi_rates[i + 1]) / 2)) {
213 			break;
214 		}
215 	}
216 
217 	DEB(kprintf("cmpci_rate_to_regvalue: %d -> %d\n", rate, cmi_rates[i]));
218 
219 	r = ((i >> 1) | (i << 2)) & 0x07;
220 	return r;
221 }
222 
223 static int
224 cmpci_regvalue_to_rate(u_int32_t r)
225 {
226 	int i;
227 
228 	i = ((r << 1) | (r >> 2)) & 0x07;
229 	DEB(kprintf("cmpci_regvalue_to_rate: %d -> %d\n", r, i));
230 	return cmi_rates[i];
231 }
232 
233 /* ------------------------------------------------------------------------- */
234 /* ADC/DAC control - there are 2 dma channels on 8738, either can be
235  * playback or capture.  We use ch0 for playback and ch1 for capture. */
236 
237 static void
238 cmi_dma_prog(struct sc_info *sc, struct sc_chinfo *ch, u_int32_t base)
239 {
240 	u_int32_t s, i, sz;
241 
242 	ch->phys_buf = sndbuf_getbufaddr(ch->buffer);
243 
244 	cmi_wr(sc, base, ch->phys_buf, 4);
245 	sz = (u_int32_t)sndbuf_getsize(ch->buffer);
246 
247 	s = sz / ch->bps - 1;
248 	cmi_wr(sc, base + 4, s, 2);
249 
250 	i = sz / (ch->bps * CMI_INTR_PER_BUFFER) - 1;
251 	cmi_wr(sc, base + 6, i, 2);
252 }
253 
254 
255 static void
256 cmi_ch0_start(struct sc_info *sc, struct sc_chinfo *ch)
257 {
258 	cmi_dma_prog(sc, ch, CMPCI_REG_DMA0_BASE);
259 
260 	cmi_set4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH0_ENABLE);
261 	cmi_set4(sc, CMPCI_REG_INTR_CTRL,
262 		 CMPCI_REG_CH0_INTR_ENABLE);
263 
264 	ch->dma_active = 1;
265 }
266 
267 static u_int32_t
268 cmi_ch0_stop(struct sc_info *sc, struct sc_chinfo *ch)
269 {
270 	u_int32_t r = ch->dma_active;
271 
272 	cmi_clr4(sc, CMPCI_REG_INTR_CTRL, CMPCI_REG_CH0_INTR_ENABLE);
273 	cmi_clr4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH0_ENABLE);
274         cmi_set4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH0_RESET);
275         cmi_clr4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH0_RESET);
276 	ch->dma_active = 0;
277 	return r;
278 }
279 
280 static void
281 cmi_ch1_start(struct sc_info *sc, struct sc_chinfo *ch)
282 {
283 	cmi_dma_prog(sc, ch, CMPCI_REG_DMA1_BASE);
284 	cmi_set4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH1_ENABLE);
285 	/* Enable Interrupts */
286 	cmi_set4(sc, CMPCI_REG_INTR_CTRL,
287 		 CMPCI_REG_CH1_INTR_ENABLE);
288 	DEB(kprintf("cmi_ch1_start: dma prog\n"));
289 	ch->dma_active = 1;
290 }
291 
292 static u_int32_t
293 cmi_ch1_stop(struct sc_info *sc, struct sc_chinfo *ch)
294 {
295 	u_int32_t r = ch->dma_active;
296 
297 	cmi_clr4(sc, CMPCI_REG_INTR_CTRL, CMPCI_REG_CH1_INTR_ENABLE);
298 	cmi_clr4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH1_ENABLE);
299         cmi_set4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH1_RESET);
300         cmi_clr4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH1_RESET);
301 	ch->dma_active = 0;
302 	return r;
303 }
304 
305 static void
306 cmi_spdif_speed(struct sc_info *sc, int speed) {
307 	u_int32_t fcr1, lcr, mcr;
308 
309 	if (speed >= 44100) {
310 		fcr1 = CMPCI_REG_SPDIF0_ENABLE;
311 		lcr  = CMPCI_REG_XSPDIF_ENABLE;
312 		mcr  = (speed == 48000) ?
313 			CMPCI_REG_W_SPDIF_48L | CMPCI_REG_SPDIF_48K : 0;
314 	} else {
315 		fcr1 = mcr = lcr = 0;
316 	}
317 
318 	cmi_partial_wr4(sc, CMPCI_REG_MISC, 0,
319 			CMPCI_REG_W_SPDIF_48L | CMPCI_REG_SPDIF_48K, mcr);
320 	cmi_partial_wr4(sc, CMPCI_REG_FUNC_1, 0,
321 			CMPCI_REG_SPDIF0_ENABLE, fcr1);
322 	cmi_partial_wr4(sc, CMPCI_REG_LEGACY_CTRL, 0,
323 			CMPCI_REG_XSPDIF_ENABLE, lcr);
324 }
325 
326 /* ------------------------------------------------------------------------- */
327 /* Channel Interface implementation */
328 
329 static void *
330 cmichan_init(kobj_t obj, void *devinfo,
331 	     struct snd_dbuf *b, struct pcm_channel *c, int dir)
332 {
333 	struct sc_info   *sc = devinfo;
334 	struct sc_chinfo *ch = (dir == PCMDIR_PLAY) ? &sc->pch : &sc->rch;
335 
336 	ch->parent     = sc;
337 	ch->channel    = c;
338 	ch->bps        = 1;
339 	ch->fmt        = AFMT_U8;
340 	ch->spd        = DSP_DEFAULT_SPEED;
341 	ch->buffer     = b;
342 	ch->dma_active = 0;
343 	if (sndbuf_alloc(ch->buffer, sc->parent_dmat, sc->bufsz) != 0) {
344 		DEB(kprintf("cmichan_init failed\n"));
345 		return NULL;
346 	}
347 
348 	ch->dir = dir;
349 	snd_mtxlock(sc->lock);
350 	if (ch->dir == PCMDIR_PLAY) {
351 		cmi_dma_prog(sc, ch, CMPCI_REG_DMA0_BASE);
352 	} else {
353 		cmi_dma_prog(sc, ch, CMPCI_REG_DMA1_BASE);
354 	}
355 	snd_mtxunlock(sc->lock);
356 
357 	return ch;
358 }
359 
360 static int
361 cmichan_setformat(kobj_t obj, void *data, u_int32_t format)
362 {
363 	struct sc_chinfo *ch = data;
364 	struct sc_info	*sc = ch->parent;
365 	u_int32_t f;
366 
367 	if (format & AFMT_S16_LE) {
368 		f = CMPCI_REG_FORMAT_16BIT;
369 		ch->bps = 2;
370 	} else {
371 		f = CMPCI_REG_FORMAT_8BIT;
372 		ch->bps = 1;
373 	}
374 
375 	if (format & AFMT_STEREO) {
376 		f |= CMPCI_REG_FORMAT_STEREO;
377 		ch->bps *= 2;
378 	} else {
379 		f |= CMPCI_REG_FORMAT_MONO;
380 	}
381 
382 	snd_mtxlock(sc->lock);
383 	if (ch->dir == PCMDIR_PLAY) {
384 		cmi_partial_wr4(ch->parent,
385 				CMPCI_REG_CHANNEL_FORMAT,
386 				CMPCI_REG_CH0_FORMAT_SHIFT,
387 				CMPCI_REG_CH0_FORMAT_MASK,
388 				f);
389 	} else {
390 		cmi_partial_wr4(ch->parent,
391 				CMPCI_REG_CHANNEL_FORMAT,
392 				CMPCI_REG_CH1_FORMAT_SHIFT,
393 				CMPCI_REG_CH1_FORMAT_MASK,
394 				f);
395 	}
396 	snd_mtxunlock(sc->lock);
397 	ch->fmt = format;
398 
399 	return 0;
400 }
401 
402 static int
403 cmichan_setspeed(kobj_t obj, void *data, u_int32_t speed)
404 {
405 	struct sc_chinfo *ch = data;
406 	struct sc_info	*sc = ch->parent;
407 	u_int32_t r, rsp;
408 
409 	r = cmpci_rate_to_regvalue(speed);
410 	snd_mtxlock(sc->lock);
411 	if (ch->dir == PCMDIR_PLAY) {
412 		if (speed < 44100) {
413 			/* disable if req before rate change */
414 			cmi_spdif_speed(ch->parent, speed);
415 		}
416 		cmi_partial_wr4(ch->parent,
417 				CMPCI_REG_FUNC_1,
418 				CMPCI_REG_DAC_FS_SHIFT,
419 				CMPCI_REG_DAC_FS_MASK,
420 				r);
421 		if (speed >= 44100 && ch->parent->spdif_enabled) {
422 			/* enable if req after rate change */
423 			cmi_spdif_speed(ch->parent, speed);
424 		}
425 		rsp = cmi_rd(ch->parent, CMPCI_REG_FUNC_1, 4);
426 		rsp >>= CMPCI_REG_DAC_FS_SHIFT;
427 		rsp &= 	CMPCI_REG_DAC_FS_MASK;
428 	} else {
429 		cmi_partial_wr4(ch->parent,
430 				CMPCI_REG_FUNC_1,
431 				CMPCI_REG_ADC_FS_SHIFT,
432 				CMPCI_REG_ADC_FS_MASK,
433 				r);
434 		rsp = cmi_rd(ch->parent, CMPCI_REG_FUNC_1, 4);
435 		rsp >>= CMPCI_REG_ADC_FS_SHIFT;
436 		rsp &= 	CMPCI_REG_ADC_FS_MASK;
437 	}
438 	snd_mtxunlock(sc->lock);
439 	ch->spd = cmpci_regvalue_to_rate(r);
440 
441 	DEB(kprintf("cmichan_setspeed (%s) %d -> %d (%d)\n",
442 		   (ch->dir == PCMDIR_PLAY) ? "play" : "rec",
443 		   speed, ch->spd, cmpci_regvalue_to_rate(rsp)));
444 
445 	return ch->spd;
446 }
447 
448 static int
449 cmichan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
450 {
451 	struct sc_chinfo *ch = data;
452 	struct sc_info	 *sc = ch->parent;
453 
454 	/* user has requested interrupts every blocksize bytes */
455 	if (blocksize > sc->bufsz / CMI_INTR_PER_BUFFER) {
456 		blocksize = sc->bufsz / CMI_INTR_PER_BUFFER;
457 	}
458 	sndbuf_resize(ch->buffer, CMI_INTR_PER_BUFFER, blocksize);
459 
460 	return blocksize;
461 }
462 
463 static int
464 cmichan_trigger(kobj_t obj, void *data, int go)
465 {
466 	struct sc_chinfo	*ch = data;
467 	struct sc_info		*sc = ch->parent;
468 
469 	snd_mtxlock(sc->lock);
470 	if (ch->dir == PCMDIR_PLAY) {
471 		switch(go) {
472 		case PCMTRIG_START:
473 			cmi_ch0_start(sc, ch);
474 			break;
475 		case PCMTRIG_ABORT:
476 			cmi_ch0_stop(sc, ch);
477 			break;
478 		}
479 	} else {
480 		switch(go) {
481 		case PCMTRIG_START:
482 			cmi_ch1_start(sc, ch);
483 			break;
484 		case PCMTRIG_ABORT:
485 			cmi_ch1_stop(sc, ch);
486 			break;
487 		}
488 	}
489 	snd_mtxunlock(sc->lock);
490 	return 0;
491 }
492 
493 static int
494 cmichan_getptr(kobj_t obj, void *data)
495 {
496 	struct sc_chinfo	*ch = data;
497 	struct sc_info		*sc = ch->parent;
498 	u_int32_t physptr, bufptr, sz;
499 
500 	snd_mtxlock(sc->lock);
501 	if (ch->dir == PCMDIR_PLAY) {
502 		physptr = cmi_rd(sc, CMPCI_REG_DMA0_BASE, 4);
503 	} else {
504 		physptr = cmi_rd(sc, CMPCI_REG_DMA1_BASE, 4);
505 	}
506 	snd_mtxunlock(sc->lock);
507 
508 	sz = sndbuf_getsize(ch->buffer);
509 	bufptr = (physptr - ch->phys_buf + sz - ch->bps) % sz;
510 
511 	return bufptr;
512 }
513 
514 static void
515 cmi_intr(void *data)
516 {
517 	struct sc_info *sc = data;
518 	u_int32_t intrstat;
519 	u_int32_t toclear;
520 
521 	snd_mtxlock(sc->lock);
522 	intrstat = cmi_rd(sc, CMPCI_REG_INTR_STATUS, 4);
523 	if ((intrstat & CMPCI_REG_ANY_INTR) != 0) {
524 
525 		toclear = 0;
526 		if (intrstat & CMPCI_REG_CH0_INTR) {
527 			toclear |= CMPCI_REG_CH0_INTR_ENABLE;
528 			/* cmi_clr4(sc, CMPCI_REG_INTR_CTRL, CMPCI_REG_CH0_INTR_ENABLE); */
529 		}
530 
531 		if (intrstat & CMPCI_REG_CH1_INTR) {
532 			toclear |= CMPCI_REG_CH1_INTR_ENABLE;
533 			/* cmi_clr4(sc, CMPCI_REG_INTR_CTRL, CMPCI_REG_CH1_INTR_ENABLE); */
534 		}
535 
536 		if (toclear) {
537 			cmi_clr4(sc, CMPCI_REG_INTR_CTRL, toclear);
538 			snd_mtxunlock(sc->lock);
539 
540 			/* Signal interrupts to channel */
541 			if (intrstat & CMPCI_REG_CH0_INTR) {
542 				chn_intr(sc->pch.channel);
543 			}
544 
545 			if (intrstat & CMPCI_REG_CH1_INTR) {
546 				chn_intr(sc->rch.channel);
547 			}
548 
549 			snd_mtxlock(sc->lock);
550 			cmi_set4(sc, CMPCI_REG_INTR_CTRL, toclear);
551 
552 		}
553 	}
554 	snd_mtxunlock(sc->lock);
555 	return;
556 }
557 
558 static struct pcmchan_caps *
559 cmichan_getcaps(kobj_t obj, void *data)
560 {
561 	return &cmi_caps;
562 }
563 
564 static kobj_method_t cmichan_methods[] = {
565     	KOBJMETHOD(channel_init,		cmichan_init),
566     	KOBJMETHOD(channel_setformat,		cmichan_setformat),
567     	KOBJMETHOD(channel_setspeed,		cmichan_setspeed),
568     	KOBJMETHOD(channel_setblocksize,	cmichan_setblocksize),
569     	KOBJMETHOD(channel_trigger,		cmichan_trigger),
570     	KOBJMETHOD(channel_getptr,		cmichan_getptr),
571     	KOBJMETHOD(channel_getcaps,		cmichan_getcaps),
572 	{ 0, 0 }
573 };
574 CHANNEL_DECLARE(cmichan);
575 
576 /* ------------------------------------------------------------------------- */
577 /* Mixer - sb16 with kinks */
578 
579 static void
580 cmimix_wr(struct sc_info *sc, u_int8_t port, u_int8_t val)
581 {
582 	cmi_wr(sc, CMPCI_REG_SBADDR, port, 1);
583 	cmi_wr(sc, CMPCI_REG_SBDATA, val, 1);
584 }
585 
586 static u_int8_t
587 cmimix_rd(struct sc_info *sc, u_int8_t port)
588 {
589 	cmi_wr(sc, CMPCI_REG_SBADDR, port, 1);
590 	return (u_int8_t)cmi_rd(sc, CMPCI_REG_SBDATA, 1);
591 }
592 
593 struct sb16props {
594 	u_int8_t  rreg;     /* right reg chan register */
595 	u_int8_t  stereo:1; /* (no explanation needed, honest) */
596 	u_int8_t  rec:1;    /* recording source */
597 	u_int8_t  bits:3;   /* num bits to represent maximum gain rep */
598 	u_int8_t  oselect;  /* output select mask */
599 	u_int8_t  iselect;  /* right input select mask */
600 } static const cmt[SOUND_MIXER_NRDEVICES] = {
601 	[SOUND_MIXER_SYNTH]   = {CMPCI_SB16_MIXER_FM_R,      1, 1, 5,
602 				 CMPCI_SB16_SW_FM,   CMPCI_SB16_MIXER_FM_SRC_R},
603 	[SOUND_MIXER_CD]      = {CMPCI_SB16_MIXER_CDDA_R,    1, 1, 5,
604 				 CMPCI_SB16_SW_CD,   CMPCI_SB16_MIXER_CD_SRC_R},
605 	[SOUND_MIXER_LINE]    = {CMPCI_SB16_MIXER_LINE_R,    1, 1, 5,
606 				 CMPCI_SB16_SW_LINE, CMPCI_SB16_MIXER_LINE_SRC_R},
607 	[SOUND_MIXER_MIC]     = {CMPCI_SB16_MIXER_MIC,       0, 1, 5,
608 				 CMPCI_SB16_SW_MIC,  CMPCI_SB16_MIXER_MIC_SRC},
609 	[SOUND_MIXER_SPEAKER] = {CMPCI_SB16_MIXER_SPEAKER,  0, 0, 2, 0, 0},
610 	[SOUND_MIXER_PCM]     = {CMPCI_SB16_MIXER_VOICE_R,  1, 0, 5, 0, 0},
611 	[SOUND_MIXER_VOLUME]  = {CMPCI_SB16_MIXER_MASTER_R, 1, 0, 5, 0, 0},
612 	/* These controls are not implemented in CMI8738, but maybe at a
613 	   future date.  They are not documented in C-Media documentation,
614 	   though appear in other drivers for future h/w (ALSA, Linux, NetBSD).
615 	*/
616 	[SOUND_MIXER_IGAIN]   = {CMPCI_SB16_MIXER_INGAIN_R,  1, 0, 2, 0, 0},
617 	[SOUND_MIXER_OGAIN]   = {CMPCI_SB16_MIXER_OUTGAIN_R, 1, 0, 2, 0, 0},
618 	[SOUND_MIXER_BASS]    = {CMPCI_SB16_MIXER_BASS_R,    1, 0, 4, 0, 0},
619 	[SOUND_MIXER_TREBLE]  = {CMPCI_SB16_MIXER_TREBLE_R,  1, 0, 4, 0, 0},
620 	/* The mic pre-amp is implemented with non-SB16 compatible
621 	   registers. */
622 	[SOUND_MIXER_MONITOR]  = {CMPCI_NON_SB16_CONTROL,     0, 1, 4, 0},
623 };
624 
625 #define MIXER_GAIN_REG_RTOL(r) (r - 1)
626 
627 static int
628 cmimix_init(struct snd_mixer *m)
629 {
630 	struct sc_info	*sc = mix_getdevinfo(m);
631 	u_int32_t	i,v;
632 
633 	for(i = v = 0; i < SOUND_MIXER_NRDEVICES; i++) {
634 		if (cmt[i].bits) v |= 1 << i;
635 	}
636 	mix_setdevs(m, v);
637 
638 	for(i = v = 0; i < SOUND_MIXER_NRDEVICES; i++) {
639 		if (cmt[i].rec) v |= 1 << i;
640 	}
641 	mix_setrecdevs(m, v);
642 
643 	cmimix_wr(sc, CMPCI_SB16_MIXER_RESET, 0);
644 	cmimix_wr(sc, CMPCI_SB16_MIXER_ADCMIX_L, 0);
645 	cmimix_wr(sc, CMPCI_SB16_MIXER_ADCMIX_R, 0);
646 	cmimix_wr(sc, CMPCI_SB16_MIXER_OUTMIX,
647 		  CMPCI_SB16_SW_CD | CMPCI_SB16_SW_MIC | CMPCI_SB16_SW_LINE);
648 	return 0;
649 }
650 
651 static int
652 cmimix_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
653 {
654 	struct sc_info *sc = mix_getdevinfo(m);
655 	u_int32_t r, l, max;
656 	u_int8_t  v;
657 
658 	max = (1 << cmt[dev].bits) - 1;
659 
660 	if (cmt[dev].rreg == CMPCI_NON_SB16_CONTROL) {
661 		/* For time being this can only be one thing (mic in
662 		 * mic/aux reg) */
663 		v = cmi_rd(sc, CMPCI_REG_AUX_MIC, 1) & 0xf0;
664 		l = left * max / 100;
665 		/* 3 bit gain with LSB MICGAIN off(1),on(1) -> 4 bit value */
666 		v |= ((l << 1) | (~l >> 3)) & 0x0f;
667 		cmi_wr(sc, CMPCI_REG_AUX_MIC, v, 1);
668 		return 0;
669 	}
670 
671 	l  = (left * max / 100) << (8 - cmt[dev].bits);
672 	if (cmt[dev].stereo) {
673 		r = (right * max / 100) << (8 - cmt[dev].bits);
674 		cmimix_wr(sc, MIXER_GAIN_REG_RTOL(cmt[dev].rreg), l);
675 		cmimix_wr(sc, cmt[dev].rreg, r);
676 		DEBMIX(kprintf("Mixer stereo write dev %d reg 0x%02x "\
677 			      "value 0x%02x:0x%02x\n",
678 			      dev, MIXER_GAIN_REG_RTOL(cmt[dev].rreg), l, r));
679 	} else {
680 		r = l;
681 		cmimix_wr(sc, cmt[dev].rreg, l);
682 		DEBMIX(kprintf("Mixer mono write dev %d reg 0x%02x " \
683 			      "value 0x%02x:0x%02x\n",
684 			      dev, cmt[dev].rreg, l, l));
685 	}
686 
687 	/* Zero gain does not mute channel from output, but this does... */
688 	v = cmimix_rd(sc, CMPCI_SB16_MIXER_OUTMIX);
689 	if (l == 0 && r == 0) {
690 		v &= ~cmt[dev].oselect;
691 	} else {
692 		v |= cmt[dev].oselect;
693 	}
694 	cmimix_wr(sc,  CMPCI_SB16_MIXER_OUTMIX, v);
695 
696 	return 0;
697 }
698 
699 static int
700 cmimix_setrecsrc(struct snd_mixer *m, u_int32_t src)
701 {
702 	struct sc_info *sc = mix_getdevinfo(m);
703 	u_int32_t i, ml, sl;
704 
705 	ml = sl = 0;
706 	for(i = 0; i < SOUND_MIXER_NRDEVICES; i++) {
707 		if ((1<<i) & src) {
708 			if (cmt[i].stereo) {
709 				sl |= cmt[i].iselect;
710 			} else {
711 				ml |= cmt[i].iselect;
712 			}
713 		}
714 	}
715 	cmimix_wr(sc, CMPCI_SB16_MIXER_ADCMIX_R, sl|ml);
716 	DEBMIX(kprintf("cmimix_setrecsrc: reg 0x%02x val 0x%02x\n",
717 		      CMPCI_SB16_MIXER_ADCMIX_R, sl|ml));
718 	ml = CMPCI_SB16_MIXER_SRC_R_TO_L(ml);
719 	cmimix_wr(sc, CMPCI_SB16_MIXER_ADCMIX_L, sl|ml);
720 	DEBMIX(kprintf("cmimix_setrecsrc: reg 0x%02x val 0x%02x\n",
721 		      CMPCI_SB16_MIXER_ADCMIX_L, sl|ml));
722 
723 	return src;
724 }
725 
726 /* Optional SPDIF support. */
727 
728 static int
729 cmi_initsys(struct sc_info* sc)
730 {
731 #ifdef SND_DYNSYSCTL
732 	SYSCTL_ADD_INT(snd_sysctl_tree(sc->dev),
733 		       SYSCTL_CHILDREN(snd_sysctl_tree_top(sc->dev)),
734 		       OID_AUTO, "spdif_enabled", CTLFLAG_RW,
735 		       &sc->spdif_enabled, 0,
736 		       "enable SPDIF output at 44.1 kHz and above");
737 #endif /* SND_DYNSYSCTL */
738 	return 0;
739 }
740 
741 /* ------------------------------------------------------------------------- */
742 static kobj_method_t cmi_mixer_methods[] = {
743 	KOBJMETHOD(mixer_init,	cmimix_init),
744 	KOBJMETHOD(mixer_set,	cmimix_set),
745 	KOBJMETHOD(mixer_setrecsrc,	cmimix_setrecsrc),
746 	{ 0, 0 }
747 };
748 MIXER_DECLARE(cmi_mixer);
749 
750 /* ------------------------------------------------------------------------- */
751 /* Power and reset */
752 
753 static void
754 cmi_power(struct sc_info *sc, int state)
755 {
756 	switch (state) {
757 	case 0: /* full power */
758 		cmi_clr4(sc, CMPCI_REG_MISC, CMPCI_REG_POWER_DOWN);
759 		break;
760 	default:
761 		/* power off */
762 		cmi_set4(sc, CMPCI_REG_MISC, CMPCI_REG_POWER_DOWN);
763 		break;
764 	}
765 }
766 
767 static int
768 cmi_init(struct sc_info *sc)
769 {
770 	/* Effect reset */
771 	cmi_set4(sc, CMPCI_REG_MISC, CMPCI_REG_BUS_AND_DSP_RESET);
772 	DELAY(100);
773 	cmi_clr4(sc, CMPCI_REG_MISC, CMPCI_REG_BUS_AND_DSP_RESET);
774 
775 	/* Disable interrupts and channels */
776 	cmi_clr4(sc, CMPCI_REG_FUNC_0,
777 		 CMPCI_REG_CH0_ENABLE | CMPCI_REG_CH1_ENABLE);
778 	cmi_clr4(sc, CMPCI_REG_INTR_CTRL,
779 		 CMPCI_REG_CH0_INTR_ENABLE | CMPCI_REG_CH1_INTR_ENABLE);
780 
781 	/* Configure DMA channels, ch0 = play, ch1 = capture */
782 	cmi_clr4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH0_DIR);
783 	cmi_set4(sc, CMPCI_REG_FUNC_0, CMPCI_REG_CH1_DIR);
784 
785 	/* Attempt to enable 4 Channel output */
786 	cmi_set4(sc, CMPCI_REG_MISC, CMPCI_REG_N4SPK3D);
787 
788 	/* Disable SPDIF1 - not compatible with config */
789 	cmi_clr4(sc, CMPCI_REG_FUNC_1, CMPCI_REG_SPDIF1_ENABLE);
790 	cmi_clr4(sc, CMPCI_REG_FUNC_1, CMPCI_REG_SPDIF_LOOP);
791 
792 	return 0;
793 }
794 
795 static void
796 cmi_uninit(struct sc_info *sc)
797 {
798 	/* Disable interrupts and channels */
799 	cmi_clr4(sc, CMPCI_REG_INTR_CTRL,
800 		 CMPCI_REG_CH0_INTR_ENABLE |
801 		 CMPCI_REG_CH1_INTR_ENABLE |
802 		 CMPCI_REG_TDMA_INTR_ENABLE);
803 	cmi_clr4(sc, CMPCI_REG_FUNC_0,
804 		 CMPCI_REG_CH0_ENABLE | CMPCI_REG_CH1_ENABLE);
805 }
806 
807 /* ------------------------------------------------------------------------- */
808 /* Bus and device registration */
809 static int
810 cmi_probe(device_t dev)
811 {
812 	switch(pci_get_devid(dev)) {
813 	case CMI8338A_PCI_ID:
814 		device_set_desc(dev, "CMedia CMI8338A");
815 		return BUS_PROBE_DEFAULT;
816 	case CMI8338B_PCI_ID:
817 		device_set_desc(dev, "CMedia CMI8338B");
818 		return BUS_PROBE_DEFAULT;
819 	case CMI8738_PCI_ID:
820 		device_set_desc(dev, "CMedia CMI8738");
821 		return BUS_PROBE_DEFAULT;
822 	case CMI8738B_PCI_ID:
823 		device_set_desc(dev, "CMedia CMI8738B");
824 		return BUS_PROBE_DEFAULT;
825 	default:
826 		return ENXIO;
827 	}
828 }
829 
830 static int
831 cmi_attach(device_t dev)
832 {
833 	struct sc_info		*sc;
834 	u_int32_t		data;
835 	char			status[SND_STATUSLEN];
836 
837 	sc = kmalloc(sizeof(struct sc_info), M_DEVBUF, M_WAITOK | M_ZERO);
838 	sc->lock = snd_mtxcreate(device_get_nameunit(dev), "sound softc");
839 	data = pci_read_config(dev, PCIR_COMMAND, 2);
840 	data |= (PCIM_CMD_PORTEN|PCIM_CMD_BUSMASTEREN);
841 	pci_write_config(dev, PCIR_COMMAND, data, 2);
842 	data = pci_read_config(dev, PCIR_COMMAND, 2);
843 
844 	sc->dev = dev;
845 	sc->regid = PCIR_BAR(0);
846 	sc->reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &sc->regid,
847 					 RF_ACTIVE);
848 	if (!sc->reg) {
849 		device_printf(dev, "cmi_attach: Cannot allocate bus resource\n");
850 		goto bad;
851 	}
852 	sc->st = rman_get_bustag(sc->reg);
853 	sc->sh = rman_get_bushandle(sc->reg);
854 
855 	sc->irqid = 0;
856 	sc->irq   = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irqid,
857 					   RF_ACTIVE | RF_SHAREABLE);
858 	if (!sc->irq ||
859 	    snd_setup_intr(dev, sc->irq, INTR_MPSAFE, cmi_intr, sc, &sc->ih)) {
860 		device_printf(dev, "cmi_attach: Unable to map interrupt\n");
861 		goto bad;
862 	}
863 
864 	sc->bufsz = pcm_getbuffersize(dev, 4096, CMI_DEFAULT_BUFSZ, 65536);
865 
866 	if (bus_dma_tag_create(/*parent*/NULL, /*alignment*/2, /*boundary*/0,
867 			       /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
868 			       /*highaddr*/BUS_SPACE_MAXADDR,
869 			       /*filter*/NULL, /*filterarg*/NULL,
870 			       /*maxsize*/sc->bufsz, /*nsegments*/1,
871 			       /*maxsegz*/0x3ffff, /*flags*/0,
872 			       &sc->parent_dmat) != 0) {
873 		device_printf(dev, "cmi_attach: Unable to create dma tag\n");
874 		goto bad;
875 	}
876 
877 	cmi_power(sc, 0);
878 	if (cmi_init(sc))
879 		goto bad;
880 
881 	if (mixer_init(dev, &cmi_mixer_class, sc))
882 		goto bad;
883 
884 	if (pcm_register(dev, sc, 1, 1))
885 		goto bad;
886 
887 	cmi_initsys(sc);
888 
889 	pcm_addchan(dev, PCMDIR_PLAY, &cmichan_class, sc);
890 	pcm_addchan(dev, PCMDIR_REC, &cmichan_class, sc);
891 
892 	ksnprintf(status, SND_STATUSLEN, "at io 0x%lx irq %ld %s",
893 		 rman_get_start(sc->reg), rman_get_start(sc->irq),PCM_KLDSTRING(snd_cmi));
894 	pcm_setstatus(dev, status);
895 
896 	DEB(kprintf("cmi_attach: succeeded\n"));
897 	return 0;
898 
899  bad:
900 	if (sc->parent_dmat)
901 		bus_dma_tag_destroy(sc->parent_dmat);
902 	if (sc->ih)
903 		bus_teardown_intr(dev, sc->irq, sc->ih);
904 	if (sc->irq)
905 		bus_release_resource(dev, SYS_RES_IRQ, sc->irqid, sc->irq);
906 	if (sc->reg)
907 		bus_release_resource(dev, SYS_RES_IOPORT, sc->regid, sc->reg);
908 	if (sc->lock)
909 		snd_mtxfree(sc->lock);
910 	if (sc)
911 		kfree(sc, M_DEVBUF);
912 
913 	return ENXIO;
914 }
915 
916 static int
917 cmi_detach(device_t dev)
918 {
919 	struct sc_info *sc;
920 	int r;
921 
922 	r = pcm_unregister(dev);
923 	if (r) return r;
924 
925 	sc = pcm_getdevinfo(dev);
926 	cmi_uninit(sc);
927 	cmi_power(sc, 3);
928 
929 	bus_dma_tag_destroy(sc->parent_dmat);
930 	bus_teardown_intr(dev, sc->irq, sc->ih);
931 	bus_release_resource(dev, SYS_RES_IRQ, sc->irqid, sc->irq);
932 	bus_release_resource(dev, SYS_RES_IOPORT, sc->regid, sc->reg);
933 	snd_mtxfree(sc->lock);
934 	kfree(sc, M_DEVBUF);
935 
936 	return 0;
937 }
938 
939 static int
940 cmi_suspend(device_t dev)
941 {
942 	struct sc_info *sc = pcm_getdevinfo(dev);
943 
944 	snd_mtxlock(sc->lock);
945 	sc->pch.dma_was_active = cmi_ch0_stop(sc, &sc->pch);
946 	sc->rch.dma_was_active = cmi_ch1_stop(sc, &sc->rch);
947 	cmi_power(sc, 3);
948 	snd_mtxunlock(sc->lock);
949 	return 0;
950 }
951 
952 static int
953 cmi_resume(device_t dev)
954 {
955 	struct sc_info *sc = pcm_getdevinfo(dev);
956 
957 	snd_mtxlock(sc->lock);
958 	cmi_power(sc, 0);
959 	if (cmi_init(sc) != 0) {
960 		device_printf(dev, "unable to reinitialize the card\n");
961 		snd_mtxunlock(sc->lock);
962 		return ENXIO;
963 	}
964 
965 	if (mixer_reinit(dev) == -1) {
966 		device_printf(dev, "unable to reinitialize the mixer\n");
967 		snd_mtxunlock(sc->lock);
968                 return ENXIO;
969         }
970 
971 	if (sc->pch.dma_was_active) {
972 		cmichan_setspeed(NULL, &sc->pch, sc->pch.spd);
973 		cmichan_setformat(NULL, &sc->pch, sc->pch.fmt);
974 		cmi_ch0_start(sc, &sc->pch);
975 	}
976 
977 	if (sc->rch.dma_was_active) {
978 		cmichan_setspeed(NULL, &sc->rch, sc->rch.spd);
979 		cmichan_setformat(NULL, &sc->rch, sc->rch.fmt);
980 		cmi_ch1_start(sc, &sc->rch);
981 	}
982 	snd_mtxunlock(sc->lock);
983 	return 0;
984 }
985 
986 static device_method_t cmi_methods[] = {
987 	DEVMETHOD(device_probe,         cmi_probe),
988 	DEVMETHOD(device_attach,        cmi_attach),
989 	DEVMETHOD(device_detach,        cmi_detach),
990 	DEVMETHOD(device_resume,        cmi_resume),
991 	DEVMETHOD(device_suspend,       cmi_suspend),
992 	{ 0, 0 }
993 };
994 
995 static driver_t cmi_driver = {
996 	"pcm",
997 	cmi_methods,
998 	PCM_SOFTC_SIZE
999 };
1000 
1001 DRIVER_MODULE(snd_cmi, pci, cmi_driver, pcm_devclass, 0, 0);
1002 MODULE_DEPEND(snd_cmi, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
1003 MODULE_VERSION(snd_cmi, 1);
1004