xref: /openbmc/linux/sound/pci/emu10k1/emu10k1_main.c (revision 85250a24)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4  *                   Creative Labs, Inc.
5  *  Routines for control of EMU10K1 chips
6  *
7  *  Copyright (c) by James Courtier-Dutton <James@superbug.co.uk>
8  *      Added support for Audigy 2 Value.
9  *  	Added EMU 1010 support.
10  *  	General bug fixes and enhancements.
11  *
12  *  BUGS:
13  *    --
14  *
15  *  TODO:
16  *    --
17  */
18 
19 #include <linux/sched.h>
20 #include <linux/delay.h>
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/interrupt.h>
24 #include <linux/iommu.h>
25 #include <linux/pci.h>
26 #include <linux/slab.h>
27 #include <linux/vmalloc.h>
28 #include <linux/mutex.h>
29 
30 
31 #include <sound/core.h>
32 #include <sound/emu10k1.h>
33 #include <linux/firmware.h>
34 #include "p16v.h"
35 #include "tina2.h"
36 #include "p17v.h"
37 
38 
39 #define HANA_FILENAME "emu/hana.fw"
40 #define DOCK_FILENAME "emu/audio_dock.fw"
41 #define EMU1010B_FILENAME "emu/emu1010b.fw"
42 #define MICRO_DOCK_FILENAME "emu/micro_dock.fw"
43 #define EMU0404_FILENAME "emu/emu0404.fw"
44 #define EMU1010_NOTEBOOK_FILENAME "emu/emu1010_notebook.fw"
45 
46 MODULE_FIRMWARE(HANA_FILENAME);
47 MODULE_FIRMWARE(DOCK_FILENAME);
48 MODULE_FIRMWARE(EMU1010B_FILENAME);
49 MODULE_FIRMWARE(MICRO_DOCK_FILENAME);
50 MODULE_FIRMWARE(EMU0404_FILENAME);
51 MODULE_FIRMWARE(EMU1010_NOTEBOOK_FILENAME);
52 
53 
54 /*************************************************************************
55  * EMU10K1 init / done
56  *************************************************************************/
57 
58 void snd_emu10k1_voice_init(struct snd_emu10k1 *emu, int ch)
59 {
60 	snd_emu10k1_ptr_write(emu, DCYSUSV, ch, 0);
61 	snd_emu10k1_ptr_write(emu, IP, ch, 0);
62 	snd_emu10k1_ptr_write(emu, VTFT, ch, 0xffff);
63 	snd_emu10k1_ptr_write(emu, CVCF, ch, 0xffff);
64 	snd_emu10k1_ptr_write(emu, PTRX, ch, 0);
65 	snd_emu10k1_ptr_write(emu, CPF, ch, 0);
66 	snd_emu10k1_ptr_write(emu, CCR, ch, 0);
67 
68 	snd_emu10k1_ptr_write(emu, PSST, ch, 0);
69 	snd_emu10k1_ptr_write(emu, DSL, ch, 0x10);
70 	snd_emu10k1_ptr_write(emu, CCCA, ch, 0);
71 	snd_emu10k1_ptr_write(emu, Z1, ch, 0);
72 	snd_emu10k1_ptr_write(emu, Z2, ch, 0);
73 	snd_emu10k1_ptr_write(emu, FXRT, ch, 0x32100000);
74 
75 	snd_emu10k1_ptr_write(emu, ATKHLDM, ch, 0);
76 	snd_emu10k1_ptr_write(emu, DCYSUSM, ch, 0);
77 	snd_emu10k1_ptr_write(emu, IFATN, ch, 0xffff);
78 	snd_emu10k1_ptr_write(emu, PEFE, ch, 0);
79 	snd_emu10k1_ptr_write(emu, FMMOD, ch, 0);
80 	snd_emu10k1_ptr_write(emu, TREMFRQ, ch, 24);	/* 1 Hz */
81 	snd_emu10k1_ptr_write(emu, FM2FRQ2, ch, 24);	/* 1 Hz */
82 	snd_emu10k1_ptr_write(emu, TEMPENV, ch, 0);
83 
84 	/*** these are last so OFF prevents writing ***/
85 	snd_emu10k1_ptr_write(emu, LFOVAL2, ch, 0);
86 	snd_emu10k1_ptr_write(emu, LFOVAL1, ch, 0);
87 	snd_emu10k1_ptr_write(emu, ATKHLDV, ch, 0);
88 	snd_emu10k1_ptr_write(emu, ENVVOL, ch, 0);
89 	snd_emu10k1_ptr_write(emu, ENVVAL, ch, 0);
90 
91 	/* Audigy extra stuffs */
92 	if (emu->audigy) {
93 		snd_emu10k1_ptr_write(emu, 0x4c, ch, 0); /* ?? */
94 		snd_emu10k1_ptr_write(emu, 0x4d, ch, 0); /* ?? */
95 		snd_emu10k1_ptr_write(emu, 0x4e, ch, 0); /* ?? */
96 		snd_emu10k1_ptr_write(emu, 0x4f, ch, 0); /* ?? */
97 		snd_emu10k1_ptr_write(emu, A_FXRT1, ch, 0x03020100);
98 		snd_emu10k1_ptr_write(emu, A_FXRT2, ch, 0x3f3f3f3f);
99 		snd_emu10k1_ptr_write(emu, A_SENDAMOUNTS, ch, 0);
100 	}
101 }
102 
103 static const unsigned int spi_dac_init[] = {
104 		0x00ff,
105 		0x02ff,
106 		0x0400,
107 		0x0520,
108 		0x0600,
109 		0x08ff,
110 		0x0aff,
111 		0x0cff,
112 		0x0eff,
113 		0x10ff,
114 		0x1200,
115 		0x1400,
116 		0x1480,
117 		0x1800,
118 		0x1aff,
119 		0x1cff,
120 		0x1e00,
121 		0x0530,
122 		0x0602,
123 		0x0622,
124 		0x1400,
125 };
126 
127 static const unsigned int i2c_adc_init[][2] = {
128 	{ 0x17, 0x00 }, /* Reset */
129 	{ 0x07, 0x00 }, /* Timeout */
130 	{ 0x0b, 0x22 },  /* Interface control */
131 	{ 0x0c, 0x22 },  /* Master mode control */
132 	{ 0x0d, 0x08 },  /* Powerdown control */
133 	{ 0x0e, 0xcf },  /* Attenuation Left  0x01 = -103dB, 0xff = 24dB */
134 	{ 0x0f, 0xcf },  /* Attenuation Right 0.5dB steps */
135 	{ 0x10, 0x7b },  /* ALC Control 1 */
136 	{ 0x11, 0x00 },  /* ALC Control 2 */
137 	{ 0x12, 0x32 },  /* ALC Control 3 */
138 	{ 0x13, 0x00 },  /* Noise gate control */
139 	{ 0x14, 0xa6 },  /* Limiter control */
140 	{ 0x15, ADC_MUX_2 },  /* ADC Mixer control. Mic for A2ZS Notebook */
141 };
142 
143 static int snd_emu10k1_init(struct snd_emu10k1 *emu, int enable_ir, int resume)
144 {
145 	unsigned int silent_page;
146 	int ch;
147 	u32 tmp;
148 
149 	/* disable audio and lock cache */
150 	outl(HCFG_LOCKSOUNDCACHE | HCFG_LOCKTANKCACHE_MASK |
151 		HCFG_MUTEBUTTONENABLE, emu->port + HCFG);
152 
153 	/* reset recording buffers */
154 	snd_emu10k1_ptr_write(emu, MICBS, 0, ADCBS_BUFSIZE_NONE);
155 	snd_emu10k1_ptr_write(emu, MICBA, 0, 0);
156 	snd_emu10k1_ptr_write(emu, FXBS, 0, ADCBS_BUFSIZE_NONE);
157 	snd_emu10k1_ptr_write(emu, FXBA, 0, 0);
158 	snd_emu10k1_ptr_write(emu, ADCBS, 0, ADCBS_BUFSIZE_NONE);
159 	snd_emu10k1_ptr_write(emu, ADCBA, 0, 0);
160 
161 	/* disable channel interrupt */
162 	outl(0, emu->port + INTE);
163 	snd_emu10k1_ptr_write(emu, CLIEL, 0, 0);
164 	snd_emu10k1_ptr_write(emu, CLIEH, 0, 0);
165 	snd_emu10k1_ptr_write(emu, SOLEL, 0, 0);
166 	snd_emu10k1_ptr_write(emu, SOLEH, 0, 0);
167 
168 	if (emu->audigy) {
169 		/* set SPDIF bypass mode */
170 		snd_emu10k1_ptr_write(emu, SPBYPASS, 0, SPBYPASS_FORMAT);
171 		/* enable rear left + rear right AC97 slots */
172 		snd_emu10k1_ptr_write(emu, AC97SLOT, 0, AC97SLOT_REAR_RIGHT |
173 				      AC97SLOT_REAR_LEFT);
174 	}
175 
176 	/* init envelope engine */
177 	for (ch = 0; ch < NUM_G; ch++)
178 		snd_emu10k1_voice_init(emu, ch);
179 
180 	snd_emu10k1_ptr_write(emu, SPCS0, 0, emu->spdif_bits[0]);
181 	snd_emu10k1_ptr_write(emu, SPCS1, 0, emu->spdif_bits[1]);
182 	snd_emu10k1_ptr_write(emu, SPCS2, 0, emu->spdif_bits[2]);
183 
184 	if (emu->card_capabilities->ca0151_chip) { /* audigy2 */
185 		/* Hacks for Alice3 to work independent of haP16V driver */
186 		/* Setup SRCMulti_I2S SamplingRate */
187 		tmp = snd_emu10k1_ptr_read(emu, A_SPDIF_SAMPLERATE, 0);
188 		tmp &= 0xfffff1ff;
189 		tmp |= (0x2<<9);
190 		snd_emu10k1_ptr_write(emu, A_SPDIF_SAMPLERATE, 0, tmp);
191 
192 		/* Setup SRCSel (Enable Spdif,I2S SRCMulti) */
193 		snd_emu10k1_ptr20_write(emu, SRCSel, 0, 0x14);
194 		/* Setup SRCMulti Input Audio Enable */
195 		/* Use 0xFFFFFFFF to enable P16V sounds. */
196 		snd_emu10k1_ptr20_write(emu, SRCMULTI_ENABLE, 0, 0xFFFFFFFF);
197 
198 		/* Enabled Phased (8-channel) P16V playback */
199 		outl(0x0201, emu->port + HCFG2);
200 		/* Set playback routing. */
201 		snd_emu10k1_ptr20_write(emu, CAPTURE_P16V_SOURCE, 0, 0x78e4);
202 	}
203 	if (emu->card_capabilities->ca0108_chip) { /* audigy2 Value */
204 		/* Hacks for Alice3 to work independent of haP16V driver */
205 		dev_info(emu->card->dev, "Audigy2 value: Special config.\n");
206 		/* Setup SRCMulti_I2S SamplingRate */
207 		tmp = snd_emu10k1_ptr_read(emu, A_SPDIF_SAMPLERATE, 0);
208 		tmp &= 0xfffff1ff;
209 		tmp |= (0x2<<9);
210 		snd_emu10k1_ptr_write(emu, A_SPDIF_SAMPLERATE, 0, tmp);
211 
212 		/* Setup SRCSel (Enable Spdif,I2S SRCMulti) */
213 		outl(0x600000, emu->port + 0x20);
214 		outl(0x14, emu->port + 0x24);
215 
216 		/* Setup SRCMulti Input Audio Enable */
217 		outl(0x7b0000, emu->port + 0x20);
218 		outl(0xFF000000, emu->port + 0x24);
219 
220 		/* Setup SPDIF Out Audio Enable */
221 		/* The Audigy 2 Value has a separate SPDIF out,
222 		 * so no need for a mixer switch
223 		 */
224 		outl(0x7a0000, emu->port + 0x20);
225 		outl(0xFF000000, emu->port + 0x24);
226 		tmp = inl(emu->port + A_IOCFG) & ~0x8; /* Clear bit 3 */
227 		outl(tmp, emu->port + A_IOCFG);
228 	}
229 	if (emu->card_capabilities->spi_dac) { /* Audigy 2 ZS Notebook with DAC Wolfson WM8768/WM8568 */
230 		int size, n;
231 
232 		size = ARRAY_SIZE(spi_dac_init);
233 		for (n = 0; n < size; n++)
234 			snd_emu10k1_spi_write(emu, spi_dac_init[n]);
235 
236 		snd_emu10k1_ptr20_write(emu, 0x60, 0, 0x10);
237 		/* Enable GPIOs
238 		 * GPIO0: Unknown
239 		 * GPIO1: Speakers-enabled.
240 		 * GPIO2: Unknown
241 		 * GPIO3: Unknown
242 		 * GPIO4: IEC958 Output on.
243 		 * GPIO5: Unknown
244 		 * GPIO6: Unknown
245 		 * GPIO7: Unknown
246 		 */
247 		outl(0x76, emu->port + A_IOCFG); /* Windows uses 0x3f76 */
248 	}
249 	if (emu->card_capabilities->i2c_adc) { /* Audigy 2 ZS Notebook with ADC Wolfson WM8775 */
250 		int size, n;
251 
252 		snd_emu10k1_ptr20_write(emu, P17V_I2S_SRC_SEL, 0, 0x2020205f);
253 		tmp = inl(emu->port + A_IOCFG);
254 		outl(tmp | 0x4, emu->port + A_IOCFG);  /* Set bit 2 for mic input */
255 		tmp = inl(emu->port + A_IOCFG);
256 		size = ARRAY_SIZE(i2c_adc_init);
257 		for (n = 0; n < size; n++)
258 			snd_emu10k1_i2c_write(emu, i2c_adc_init[n][0], i2c_adc_init[n][1]);
259 		for (n = 0; n < 4; n++) {
260 			emu->i2c_capture_volume[n][0] = 0xcf;
261 			emu->i2c_capture_volume[n][1] = 0xcf;
262 		}
263 	}
264 
265 
266 	snd_emu10k1_ptr_write(emu, PTB, 0, emu->ptb_pages.addr);
267 	snd_emu10k1_ptr_write(emu, TCB, 0, 0);	/* taken from original driver */
268 	snd_emu10k1_ptr_write(emu, TCBS, 0, 4);	/* taken from original driver */
269 
270 	silent_page = (emu->silent_page.addr << emu->address_mode) | (emu->address_mode ? MAP_PTI_MASK1 : MAP_PTI_MASK0);
271 	for (ch = 0; ch < NUM_G; ch++) {
272 		snd_emu10k1_ptr_write(emu, MAPA, ch, silent_page);
273 		snd_emu10k1_ptr_write(emu, MAPB, ch, silent_page);
274 	}
275 
276 	if (emu->card_capabilities->emu_model) {
277 		outl(HCFG_AUTOMUTE_ASYNC |
278 			HCFG_EMU32_SLAVE |
279 			HCFG_AUDIOENABLE, emu->port + HCFG);
280 	/*
281 	 *  Hokay, setup HCFG
282 	 *   Mute Disable Audio = 0
283 	 *   Lock Tank Memory = 1
284 	 *   Lock Sound Memory = 0
285 	 *   Auto Mute = 1
286 	 */
287 	} else if (emu->audigy) {
288 		if (emu->revision == 4) /* audigy2 */
289 			outl(HCFG_AUDIOENABLE |
290 			     HCFG_AC3ENABLE_CDSPDIF |
291 			     HCFG_AC3ENABLE_GPSPDIF |
292 			     HCFG_AUTOMUTE | HCFG_JOYENABLE, emu->port + HCFG);
293 		else
294 			outl(HCFG_AUTOMUTE | HCFG_JOYENABLE, emu->port + HCFG);
295 	/* FIXME: Remove all these emu->model and replace it with a card recognition parameter,
296 	 * e.g. card_capabilities->joystick */
297 	} else if (emu->model == 0x20 ||
298 	    emu->model == 0xc400 ||
299 	    (emu->model == 0x21 && emu->revision < 6))
300 		outl(HCFG_LOCKTANKCACHE_MASK | HCFG_AUTOMUTE, emu->port + HCFG);
301 	else
302 		/* With on-chip joystick */
303 		outl(HCFG_LOCKTANKCACHE_MASK | HCFG_AUTOMUTE | HCFG_JOYENABLE, emu->port + HCFG);
304 
305 	if (enable_ir) {	/* enable IR for SB Live */
306 		if (emu->card_capabilities->emu_model) {
307 			;  /* Disable all access to A_IOCFG for the emu1010 */
308 		} else if (emu->card_capabilities->i2c_adc) {
309 			;  /* Disable A_IOCFG for Audigy 2 ZS Notebook */
310 		} else if (emu->audigy) {
311 			unsigned int reg = inl(emu->port + A_IOCFG);
312 			outl(reg | A_IOCFG_GPOUT2, emu->port + A_IOCFG);
313 			udelay(500);
314 			outl(reg | A_IOCFG_GPOUT1 | A_IOCFG_GPOUT2, emu->port + A_IOCFG);
315 			udelay(100);
316 			outl(reg, emu->port + A_IOCFG);
317 		} else {
318 			unsigned int reg = inl(emu->port + HCFG);
319 			outl(reg | HCFG_GPOUT2, emu->port + HCFG);
320 			udelay(500);
321 			outl(reg | HCFG_GPOUT1 | HCFG_GPOUT2, emu->port + HCFG);
322 			udelay(100);
323 			outl(reg, emu->port + HCFG);
324 		}
325 	}
326 
327 	if (emu->card_capabilities->emu_model) {
328 		;  /* Disable all access to A_IOCFG for the emu1010 */
329 	} else if (emu->card_capabilities->i2c_adc) {
330 		;  /* Disable A_IOCFG for Audigy 2 ZS Notebook */
331 	} else if (emu->audigy) {	/* enable analog output */
332 		unsigned int reg = inl(emu->port + A_IOCFG);
333 		outl(reg | A_IOCFG_GPOUT0, emu->port + A_IOCFG);
334 	}
335 
336 	if (emu->address_mode == 0) {
337 		/* use 16M in 4G */
338 		outl(inl(emu->port + HCFG) | HCFG_EXPANDED_MEM, emu->port + HCFG);
339 	}
340 
341 	return 0;
342 }
343 
344 static void snd_emu10k1_audio_enable(struct snd_emu10k1 *emu)
345 {
346 	/*
347 	 *  Enable the audio bit
348 	 */
349 	outl(inl(emu->port + HCFG) | HCFG_AUDIOENABLE, emu->port + HCFG);
350 
351 	/* Enable analog/digital outs on audigy */
352 	if (emu->card_capabilities->emu_model) {
353 		;  /* Disable all access to A_IOCFG for the emu1010 */
354 	} else if (emu->card_capabilities->i2c_adc) {
355 		;  /* Disable A_IOCFG for Audigy 2 ZS Notebook */
356 	} else if (emu->audigy) {
357 		outl(inl(emu->port + A_IOCFG) & ~0x44, emu->port + A_IOCFG);
358 
359 		if (emu->card_capabilities->ca0151_chip) { /* audigy2 */
360 			/* Unmute Analog now.  Set GPO6 to 1 for Apollo.
361 			 * This has to be done after init ALice3 I2SOut beyond 48KHz.
362 			 * So, sequence is important. */
363 			outl(inl(emu->port + A_IOCFG) | 0x0040, emu->port + A_IOCFG);
364 		} else if (emu->card_capabilities->ca0108_chip) { /* audigy2 value */
365 			/* Unmute Analog now. */
366 			outl(inl(emu->port + A_IOCFG) | 0x0060, emu->port + A_IOCFG);
367 		} else {
368 			/* Disable routing from AC97 line out to Front speakers */
369 			outl(inl(emu->port + A_IOCFG) | 0x0080, emu->port + A_IOCFG);
370 		}
371 	}
372 
373 #if 0
374 	{
375 	unsigned int tmp;
376 	/* FIXME: the following routine disables LiveDrive-II !! */
377 	/* TOSLink detection */
378 	emu->tos_link = 0;
379 	tmp = inl(emu->port + HCFG);
380 	if (tmp & (HCFG_GPINPUT0 | HCFG_GPINPUT1)) {
381 		outl(tmp|0x800, emu->port + HCFG);
382 		udelay(50);
383 		if (tmp != (inl(emu->port + HCFG) & ~0x800)) {
384 			emu->tos_link = 1;
385 			outl(tmp, emu->port + HCFG);
386 		}
387 	}
388 	}
389 #endif
390 
391 	snd_emu10k1_intr_enable(emu, INTE_PCIERRORENABLE);
392 }
393 
394 int snd_emu10k1_done(struct snd_emu10k1 *emu)
395 {
396 	int ch;
397 
398 	outl(0, emu->port + INTE);
399 
400 	/*
401 	 *  Shutdown the chip
402 	 */
403 	for (ch = 0; ch < NUM_G; ch++)
404 		snd_emu10k1_ptr_write(emu, DCYSUSV, ch, 0);
405 	for (ch = 0; ch < NUM_G; ch++) {
406 		snd_emu10k1_ptr_write(emu, VTFT, ch, 0);
407 		snd_emu10k1_ptr_write(emu, CVCF, ch, 0);
408 		snd_emu10k1_ptr_write(emu, PTRX, ch, 0);
409 		snd_emu10k1_ptr_write(emu, CPF, ch, 0);
410 	}
411 
412 	/* reset recording buffers */
413 	snd_emu10k1_ptr_write(emu, MICBS, 0, 0);
414 	snd_emu10k1_ptr_write(emu, MICBA, 0, 0);
415 	snd_emu10k1_ptr_write(emu, FXBS, 0, 0);
416 	snd_emu10k1_ptr_write(emu, FXBA, 0, 0);
417 	snd_emu10k1_ptr_write(emu, FXWC, 0, 0);
418 	snd_emu10k1_ptr_write(emu, ADCBS, 0, ADCBS_BUFSIZE_NONE);
419 	snd_emu10k1_ptr_write(emu, ADCBA, 0, 0);
420 	snd_emu10k1_ptr_write(emu, TCBS, 0, TCBS_BUFFSIZE_16K);
421 	snd_emu10k1_ptr_write(emu, TCB, 0, 0);
422 	if (emu->audigy)
423 		snd_emu10k1_ptr_write(emu, A_DBG, 0, A_DBG_SINGLE_STEP);
424 	else
425 		snd_emu10k1_ptr_write(emu, DBG, 0, EMU10K1_DBG_SINGLE_STEP);
426 
427 	/* disable channel interrupt */
428 	snd_emu10k1_ptr_write(emu, CLIEL, 0, 0);
429 	snd_emu10k1_ptr_write(emu, CLIEH, 0, 0);
430 	snd_emu10k1_ptr_write(emu, SOLEL, 0, 0);
431 	snd_emu10k1_ptr_write(emu, SOLEH, 0, 0);
432 
433 	/* disable audio and lock cache */
434 	outl(HCFG_LOCKSOUNDCACHE | HCFG_LOCKTANKCACHE_MASK | HCFG_MUTEBUTTONENABLE, emu->port + HCFG);
435 	snd_emu10k1_ptr_write(emu, PTB, 0, 0);
436 
437 	return 0;
438 }
439 
440 /*************************************************************************
441  * ECARD functional implementation
442  *************************************************************************/
443 
444 /* In A1 Silicon, these bits are in the HC register */
445 #define HOOKN_BIT		(1L << 12)
446 #define HANDN_BIT		(1L << 11)
447 #define PULSEN_BIT		(1L << 10)
448 
449 #define EC_GDI1			(1 << 13)
450 #define EC_GDI0			(1 << 14)
451 
452 #define EC_NUM_CONTROL_BITS	20
453 
454 #define EC_AC3_DATA_SELN	0x0001L
455 #define EC_EE_DATA_SEL		0x0002L
456 #define EC_EE_CNTRL_SELN	0x0004L
457 #define EC_EECLK		0x0008L
458 #define EC_EECS			0x0010L
459 #define EC_EESDO		0x0020L
460 #define EC_TRIM_CSN		0x0040L
461 #define EC_TRIM_SCLK		0x0080L
462 #define EC_TRIM_SDATA		0x0100L
463 #define EC_TRIM_MUTEN		0x0200L
464 #define EC_ADCCAL		0x0400L
465 #define EC_ADCRSTN		0x0800L
466 #define EC_DACCAL		0x1000L
467 #define EC_DACMUTEN		0x2000L
468 #define EC_LEDN			0x4000L
469 
470 #define EC_SPDIF0_SEL_SHIFT	15
471 #define EC_SPDIF1_SEL_SHIFT	17
472 #define EC_SPDIF0_SEL_MASK	(0x3L << EC_SPDIF0_SEL_SHIFT)
473 #define EC_SPDIF1_SEL_MASK	(0x7L << EC_SPDIF1_SEL_SHIFT)
474 #define EC_SPDIF0_SELECT(_x)	(((_x) << EC_SPDIF0_SEL_SHIFT) & EC_SPDIF0_SEL_MASK)
475 #define EC_SPDIF1_SELECT(_x)	(((_x) << EC_SPDIF1_SEL_SHIFT) & EC_SPDIF1_SEL_MASK)
476 #define EC_CURRENT_PROM_VERSION 0x01	/* Self-explanatory.  This should
477 					 * be incremented any time the EEPROM's
478 					 * format is changed.  */
479 
480 #define EC_EEPROM_SIZE		0x40	/* ECARD EEPROM has 64 16-bit words */
481 
482 /* Addresses for special values stored in to EEPROM */
483 #define EC_PROM_VERSION_ADDR	0x20	/* Address of the current prom version */
484 #define EC_BOARDREV0_ADDR	0x21	/* LSW of board rev */
485 #define EC_BOARDREV1_ADDR	0x22	/* MSW of board rev */
486 
487 #define EC_LAST_PROMFILE_ADDR	0x2f
488 
489 #define EC_SERIALNUM_ADDR	0x30	/* First word of serial number.  The
490 					 * can be up to 30 characters in length
491 					 * and is stored as a NULL-terminated
492 					 * ASCII string.  Any unused bytes must be
493 					 * filled with zeros */
494 #define EC_CHECKSUM_ADDR	0x3f	/* Location at which checksum is stored */
495 
496 
497 /* Most of this stuff is pretty self-evident.  According to the hardware
498  * dudes, we need to leave the ADCCAL bit low in order to avoid a DC
499  * offset problem.  Weird.
500  */
501 #define EC_RAW_RUN_MODE		(EC_DACMUTEN | EC_ADCRSTN | EC_TRIM_MUTEN | \
502 				 EC_TRIM_CSN)
503 
504 
505 #define EC_DEFAULT_ADC_GAIN	0xC4C4
506 #define EC_DEFAULT_SPDIF0_SEL	0x0
507 #define EC_DEFAULT_SPDIF1_SEL	0x4
508 
509 /**************************************************************************
510  * @func Clock bits into the Ecard's control latch.  The Ecard uses a
511  *  control latch will is loaded bit-serially by toggling the Modem control
512  *  lines from function 2 on the E8010.  This function hides these details
513  *  and presents the illusion that we are actually writing to a distinct
514  *  register.
515  */
516 
517 static void snd_emu10k1_ecard_write(struct snd_emu10k1 *emu, unsigned int value)
518 {
519 	unsigned short count;
520 	unsigned int data;
521 	unsigned long hc_port;
522 	unsigned int hc_value;
523 
524 	hc_port = emu->port + HCFG;
525 	hc_value = inl(hc_port) & ~(HOOKN_BIT | HANDN_BIT | PULSEN_BIT);
526 	outl(hc_value, hc_port);
527 
528 	for (count = 0; count < EC_NUM_CONTROL_BITS; count++) {
529 
530 		/* Set up the value */
531 		data = ((value & 0x1) ? PULSEN_BIT : 0);
532 		value >>= 1;
533 
534 		outl(hc_value | data, hc_port);
535 
536 		/* Clock the shift register */
537 		outl(hc_value | data | HANDN_BIT, hc_port);
538 		outl(hc_value | data, hc_port);
539 	}
540 
541 	/* Latch the bits */
542 	outl(hc_value | HOOKN_BIT, hc_port);
543 	outl(hc_value, hc_port);
544 }
545 
546 /**************************************************************************
547  * @func Set the gain of the ECARD's CS3310 Trim/gain controller.  The
548  * trim value consists of a 16bit value which is composed of two
549  * 8 bit gain/trim values, one for the left channel and one for the
550  * right channel.  The following table maps from the Gain/Attenuation
551  * value in decibels into the corresponding bit pattern for a single
552  * channel.
553  */
554 
555 static void snd_emu10k1_ecard_setadcgain(struct snd_emu10k1 *emu,
556 					 unsigned short gain)
557 {
558 	unsigned int bit;
559 
560 	/* Enable writing to the TRIM registers */
561 	snd_emu10k1_ecard_write(emu, emu->ecard_ctrl & ~EC_TRIM_CSN);
562 
563 	/* Do it again to insure that we meet hold time requirements */
564 	snd_emu10k1_ecard_write(emu, emu->ecard_ctrl & ~EC_TRIM_CSN);
565 
566 	for (bit = (1 << 15); bit; bit >>= 1) {
567 		unsigned int value;
568 
569 		value = emu->ecard_ctrl & ~(EC_TRIM_CSN | EC_TRIM_SDATA);
570 
571 		if (gain & bit)
572 			value |= EC_TRIM_SDATA;
573 
574 		/* Clock the bit */
575 		snd_emu10k1_ecard_write(emu, value);
576 		snd_emu10k1_ecard_write(emu, value | EC_TRIM_SCLK);
577 		snd_emu10k1_ecard_write(emu, value);
578 	}
579 
580 	snd_emu10k1_ecard_write(emu, emu->ecard_ctrl);
581 }
582 
583 static int snd_emu10k1_ecard_init(struct snd_emu10k1 *emu)
584 {
585 	unsigned int hc_value;
586 
587 	/* Set up the initial settings */
588 	emu->ecard_ctrl = EC_RAW_RUN_MODE |
589 			  EC_SPDIF0_SELECT(EC_DEFAULT_SPDIF0_SEL) |
590 			  EC_SPDIF1_SELECT(EC_DEFAULT_SPDIF1_SEL);
591 
592 	/* Step 0: Set the codec type in the hardware control register
593 	 * and enable audio output */
594 	hc_value = inl(emu->port + HCFG);
595 	outl(hc_value | HCFG_AUDIOENABLE | HCFG_CODECFORMAT_I2S, emu->port + HCFG);
596 	inl(emu->port + HCFG);
597 
598 	/* Step 1: Turn off the led and deassert TRIM_CS */
599 	snd_emu10k1_ecard_write(emu, EC_ADCCAL | EC_LEDN | EC_TRIM_CSN);
600 
601 	/* Step 2: Calibrate the ADC and DAC */
602 	snd_emu10k1_ecard_write(emu, EC_DACCAL | EC_LEDN | EC_TRIM_CSN);
603 
604 	/* Step 3: Wait for awhile;   XXX We can't get away with this
605 	 * under a real operating system; we'll need to block and wait that
606 	 * way. */
607 	snd_emu10k1_wait(emu, 48000);
608 
609 	/* Step 4: Switch off the DAC and ADC calibration.  Note
610 	 * That ADC_CAL is actually an inverted signal, so we assert
611 	 * it here to stop calibration.  */
612 	snd_emu10k1_ecard_write(emu, EC_ADCCAL | EC_LEDN | EC_TRIM_CSN);
613 
614 	/* Step 4: Switch into run mode */
615 	snd_emu10k1_ecard_write(emu, emu->ecard_ctrl);
616 
617 	/* Step 5: Set the analog input gain */
618 	snd_emu10k1_ecard_setadcgain(emu, EC_DEFAULT_ADC_GAIN);
619 
620 	return 0;
621 }
622 
623 static int snd_emu10k1_cardbus_init(struct snd_emu10k1 *emu)
624 {
625 	unsigned long special_port;
626 	__always_unused unsigned int value;
627 
628 	/* Special initialisation routine
629 	 * before the rest of the IO-Ports become active.
630 	 */
631 	special_port = emu->port + 0x38;
632 	value = inl(special_port);
633 	outl(0x00d00000, special_port);
634 	value = inl(special_port);
635 	outl(0x00d00001, special_port);
636 	value = inl(special_port);
637 	outl(0x00d0005f, special_port);
638 	value = inl(special_port);
639 	outl(0x00d0007f, special_port);
640 	value = inl(special_port);
641 	outl(0x0090007f, special_port);
642 	value = inl(special_port);
643 
644 	snd_emu10k1_ptr20_write(emu, TINA2_VOLUME, 0, 0xfefefefe); /* Defaults to 0x30303030 */
645 	/* Delay to give time for ADC chip to switch on. It needs 113ms */
646 	msleep(200);
647 	return 0;
648 }
649 
650 static int snd_emu1010_load_firmware_entry(struct snd_emu10k1 *emu,
651 				     const struct firmware *fw_entry)
652 {
653 	int n, i;
654 	int reg;
655 	int value;
656 	__always_unused unsigned int write_post;
657 	unsigned long flags;
658 
659 	if (!fw_entry)
660 		return -EIO;
661 
662 	/* The FPGA is a Xilinx Spartan IIE XC2S50E */
663 	/* GPIO7 -> FPGA PGMN
664 	 * GPIO6 -> FPGA CCLK
665 	 * GPIO5 -> FPGA DIN
666 	 * FPGA CONFIG OFF -> FPGA PGMN
667 	 */
668 	spin_lock_irqsave(&emu->emu_lock, flags);
669 	outl(0x00, emu->port + A_IOCFG); /* Set PGMN low for 1uS. */
670 	write_post = inl(emu->port + A_IOCFG);
671 	udelay(100);
672 	outl(0x80, emu->port + A_IOCFG); /* Leave bit 7 set during netlist setup. */
673 	write_post = inl(emu->port + A_IOCFG);
674 	udelay(100); /* Allow FPGA memory to clean */
675 	for (n = 0; n < fw_entry->size; n++) {
676 		value = fw_entry->data[n];
677 		for (i = 0; i < 8; i++) {
678 			reg = 0x80;
679 			if (value & 0x1)
680 				reg = reg | 0x20;
681 			value = value >> 1;
682 			outl(reg, emu->port + A_IOCFG);
683 			write_post = inl(emu->port + A_IOCFG);
684 			outl(reg | 0x40, emu->port + A_IOCFG);
685 			write_post = inl(emu->port + A_IOCFG);
686 		}
687 	}
688 	/* After programming, set GPIO bit 4 high again. */
689 	outl(0x10, emu->port + A_IOCFG);
690 	write_post = inl(emu->port + A_IOCFG);
691 	spin_unlock_irqrestore(&emu->emu_lock, flags);
692 
693 	return 0;
694 }
695 
696 /* firmware file names, per model, init-fw and dock-fw (optional) */
697 static const char * const firmware_names[5][2] = {
698 	[EMU_MODEL_EMU1010] = {
699 		HANA_FILENAME, DOCK_FILENAME
700 	},
701 	[EMU_MODEL_EMU1010B] = {
702 		EMU1010B_FILENAME, MICRO_DOCK_FILENAME
703 	},
704 	[EMU_MODEL_EMU1616] = {
705 		EMU1010_NOTEBOOK_FILENAME, MICRO_DOCK_FILENAME
706 	},
707 	[EMU_MODEL_EMU0404] = {
708 		EMU0404_FILENAME, NULL
709 	},
710 };
711 
712 static int snd_emu1010_load_firmware(struct snd_emu10k1 *emu, int dock,
713 				     const struct firmware **fw)
714 {
715 	const char *filename;
716 	int err;
717 
718 	if (!*fw) {
719 		filename = firmware_names[emu->card_capabilities->emu_model][dock];
720 		if (!filename)
721 			return 0;
722 		err = request_firmware(fw, filename, &emu->pci->dev);
723 		if (err)
724 			return err;
725 	}
726 
727 	return snd_emu1010_load_firmware_entry(emu, *fw);
728 }
729 
730 static void emu1010_firmware_work(struct work_struct *work)
731 {
732 	struct snd_emu10k1 *emu;
733 	u32 tmp, tmp2, reg;
734 	int err;
735 
736 	emu = container_of(work, struct snd_emu10k1,
737 			   emu1010.firmware_work.work);
738 	if (emu->card->shutdown)
739 		return;
740 #ifdef CONFIG_PM_SLEEP
741 	if (emu->suspend)
742 		return;
743 #endif
744 	snd_emu1010_fpga_read(emu, EMU_HANA_IRQ_STATUS, &tmp); /* IRQ Status */
745 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTION_CARDS, &reg); /* OPTIONS: Which cards are attached to the EMU */
746 	if (reg & EMU_HANA_OPTION_DOCK_OFFLINE) {
747 		/* Audio Dock attached */
748 		/* Return to Audio Dock programming mode */
749 		dev_info(emu->card->dev,
750 			 "emu1010: Loading Audio Dock Firmware\n");
751 		snd_emu1010_fpga_write(emu, EMU_HANA_FPGA_CONFIG,
752 				       EMU_HANA_FPGA_CONFIG_AUDIODOCK);
753 		err = snd_emu1010_load_firmware(emu, 1, &emu->dock_fw);
754 		if (err < 0)
755 			goto next;
756 
757 		snd_emu1010_fpga_write(emu, EMU_HANA_FPGA_CONFIG, 0);
758 		snd_emu1010_fpga_read(emu, EMU_HANA_IRQ_STATUS, &tmp);
759 		dev_info(emu->card->dev,
760 			 "emu1010: EMU_HANA+DOCK_IRQ_STATUS = 0x%x\n", tmp);
761 		/* ID, should read & 0x7f = 0x55 when FPGA programmed. */
762 		snd_emu1010_fpga_read(emu, EMU_HANA_ID, &tmp);
763 		dev_info(emu->card->dev,
764 			 "emu1010: EMU_HANA+DOCK_ID = 0x%x\n", tmp);
765 		if ((tmp & 0x1f) != 0x15) {
766 			/* FPGA failed to be programmed */
767 			dev_info(emu->card->dev,
768 				 "emu1010: Loading Audio Dock Firmware file failed, reg = 0x%x\n",
769 				 tmp);
770 			goto next;
771 		}
772 		dev_info(emu->card->dev,
773 			 "emu1010: Audio Dock Firmware loaded\n");
774 		snd_emu1010_fpga_read(emu, EMU_DOCK_MAJOR_REV, &tmp);
775 		snd_emu1010_fpga_read(emu, EMU_DOCK_MINOR_REV, &tmp2);
776 		dev_info(emu->card->dev, "Audio Dock ver: %u.%u\n", tmp, tmp2);
777 		/* Sync clocking between 1010 and Dock */
778 		/* Allow DLL to settle */
779 		msleep(10);
780 		/* Unmute all. Default is muted after a firmware load */
781 		snd_emu1010_fpga_write(emu, EMU_HANA_UNMUTE, EMU_UNMUTE);
782 	} else if (!reg && emu->emu1010.last_reg) {
783 		/* Audio Dock removed */
784 		dev_info(emu->card->dev, "emu1010: Audio Dock detached\n");
785 		/* Unmute all */
786 		snd_emu1010_fpga_write(emu, EMU_HANA_UNMUTE, EMU_UNMUTE);
787 	}
788 
789  next:
790 	emu->emu1010.last_reg = reg;
791 	if (!emu->card->shutdown)
792 		schedule_delayed_work(&emu->emu1010.firmware_work,
793 				      msecs_to_jiffies(1000));
794 }
795 
796 /*
797  * EMU-1010 - details found out from this driver, official MS Win drivers,
798  * testing the card:
799  *
800  * Audigy2 (aka Alice2):
801  * ---------------------
802  * 	* communication over PCI
803  * 	* conversion of 32-bit data coming over EMU32 links from HANA FPGA
804  *	  to 2 x 16-bit, using internal DSP instructions
805  * 	* slave mode, clock supplied by HANA
806  * 	* linked to HANA using:
807  * 		32 x 32-bit serial EMU32 output channels
808  * 		16 x EMU32 input channels
809  * 		(?) x I2S I/O channels (?)
810  *
811  * FPGA (aka HANA):
812  * ---------------
813  * 	* provides all (?) physical inputs and outputs of the card
814  * 		(ADC, DAC, SPDIF I/O, ADAT I/O, etc.)
815  * 	* provides clock signal for the card and Alice2
816  * 	* two crystals - for 44.1kHz and 48kHz multiples
817  * 	* provides internal routing of signal sources to signal destinations
818  * 	* inputs/outputs to Alice2 - see above
819  *
820  * Current status of the driver:
821  * ----------------------------
822  * 	* only 44.1/48kHz supported (the MS Win driver supports up to 192 kHz)
823  * 	* PCM device nb. 2:
824  *		16 x 16-bit playback - snd_emu10k1_fx8010_playback_ops
825  * 		16 x 32-bit capture - snd_emu10k1_capture_efx_ops
826  */
827 static int snd_emu10k1_emu1010_init(struct snd_emu10k1 *emu)
828 {
829 	unsigned int i;
830 	u32 tmp, tmp2, reg;
831 	int err;
832 
833 	dev_info(emu->card->dev, "emu1010: Special config.\n");
834 	/* AC97 2.1, Any 16Meg of 4Gig address, Auto-Mute, EMU32 Slave,
835 	 * Lock Sound Memory Cache, Lock Tank Memory Cache,
836 	 * Mute all codecs.
837 	 */
838 	outl(0x0005a00c, emu->port + HCFG);
839 	/* AC97 2.1, Any 16Meg of 4Gig address, Auto-Mute, EMU32 Slave,
840 	 * Lock Tank Memory Cache,
841 	 * Mute all codecs.
842 	 */
843 	outl(0x0005a004, emu->port + HCFG);
844 	/* AC97 2.1, Any 16Meg of 4Gig address, Auto-Mute, EMU32 Slave,
845 	 * Mute all codecs.
846 	 */
847 	outl(0x0005a000, emu->port + HCFG);
848 	/* AC97 2.1, Any 16Meg of 4Gig address, Auto-Mute, EMU32 Slave,
849 	 * Mute all codecs.
850 	 */
851 	outl(0x0005a000, emu->port + HCFG);
852 
853 	/* Disable 48Volt power to Audio Dock */
854 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_PWR, 0);
855 
856 	/* ID, should read & 0x7f = 0x55. (Bit 7 is the IRQ bit) */
857 	snd_emu1010_fpga_read(emu, EMU_HANA_ID, &reg);
858 	dev_dbg(emu->card->dev, "reg1 = 0x%x\n", reg);
859 	if ((reg & 0x3f) == 0x15) {
860 		/* FPGA netlist already present so clear it */
861 		/* Return to programming mode */
862 
863 		snd_emu1010_fpga_write(emu, EMU_HANA_FPGA_CONFIG, 0x02);
864 	}
865 	snd_emu1010_fpga_read(emu, EMU_HANA_ID, &reg);
866 	dev_dbg(emu->card->dev, "reg2 = 0x%x\n", reg);
867 	if ((reg & 0x3f) == 0x15) {
868 		/* FPGA failed to return to programming mode */
869 		dev_info(emu->card->dev,
870 			 "emu1010: FPGA failed to return to programming mode\n");
871 		return -ENODEV;
872 	}
873 	dev_info(emu->card->dev, "emu1010: EMU_HANA_ID = 0x%x\n", reg);
874 
875 	err = snd_emu1010_load_firmware(emu, 0, &emu->firmware);
876 	if (err < 0) {
877 		dev_info(emu->card->dev, "emu1010: Loading Firmware failed\n");
878 		return err;
879 	}
880 
881 	/* ID, should read & 0x7f = 0x55 when FPGA programmed. */
882 	snd_emu1010_fpga_read(emu, EMU_HANA_ID, &reg);
883 	if ((reg & 0x3f) != 0x15) {
884 		/* FPGA failed to be programmed */
885 		dev_info(emu->card->dev,
886 			 "emu1010: Loading Hana Firmware file failed, reg = 0x%x\n",
887 			 reg);
888 		return -ENODEV;
889 	}
890 
891 	dev_info(emu->card->dev, "emu1010: Hana Firmware loaded\n");
892 	snd_emu1010_fpga_read(emu, EMU_HANA_MAJOR_REV, &tmp);
893 	snd_emu1010_fpga_read(emu, EMU_HANA_MINOR_REV, &tmp2);
894 	dev_info(emu->card->dev, "emu1010: Hana version: %u.%u\n", tmp, tmp2);
895 	/* Enable 48Volt power to Audio Dock */
896 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_PWR, EMU_HANA_DOCK_PWR_ON);
897 
898 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTION_CARDS, &reg);
899 	dev_info(emu->card->dev, "emu1010: Card options = 0x%x\n", reg);
900 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTION_CARDS, &reg);
901 	dev_info(emu->card->dev, "emu1010: Card options = 0x%x\n", reg);
902 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTICAL_TYPE, &tmp);
903 	/* Optical -> ADAT I/O  */
904 	/* 0 : SPDIF
905 	 * 1 : ADAT
906 	 */
907 	emu->emu1010.optical_in = 1; /* IN_ADAT */
908 	emu->emu1010.optical_out = 1; /* IN_ADAT */
909 	tmp = 0;
910 	tmp = (emu->emu1010.optical_in ? EMU_HANA_OPTICAL_IN_ADAT : 0) |
911 		(emu->emu1010.optical_out ? EMU_HANA_OPTICAL_OUT_ADAT : 0);
912 	snd_emu1010_fpga_write(emu, EMU_HANA_OPTICAL_TYPE, tmp);
913 	snd_emu1010_fpga_read(emu, EMU_HANA_ADC_PADS, &tmp);
914 	/* Set no attenuation on Audio Dock pads. */
915 	snd_emu1010_fpga_write(emu, EMU_HANA_ADC_PADS, 0x00);
916 	emu->emu1010.adc_pads = 0x00;
917 	snd_emu1010_fpga_read(emu, EMU_HANA_DOCK_MISC, &tmp);
918 	/* Unmute Audio dock DACs, Headphone source DAC-4. */
919 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_MISC, 0x30);
920 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_LEDS_2, 0x12);
921 	snd_emu1010_fpga_read(emu, EMU_HANA_DAC_PADS, &tmp);
922 	/* DAC PADs. */
923 	snd_emu1010_fpga_write(emu, EMU_HANA_DAC_PADS, 0x0f);
924 	emu->emu1010.dac_pads = 0x0f;
925 	snd_emu1010_fpga_read(emu, EMU_HANA_DOCK_MISC, &tmp);
926 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_MISC, 0x30);
927 	snd_emu1010_fpga_read(emu, EMU_HANA_SPDIF_MODE, &tmp);
928 	/* SPDIF Format. Set Consumer mode, 24bit, copy enable */
929 	snd_emu1010_fpga_write(emu, EMU_HANA_SPDIF_MODE, 0x10);
930 	/* MIDI routing */
931 	snd_emu1010_fpga_write(emu, EMU_HANA_MIDI_IN, 0x19);
932 	/* Unknown. */
933 	snd_emu1010_fpga_write(emu, EMU_HANA_MIDI_OUT, 0x0c);
934 	/* IRQ Enable: All on */
935 	/* snd_emu1010_fpga_write(emu, 0x09, 0x0f ); */
936 	/* IRQ Enable: All off */
937 	snd_emu1010_fpga_write(emu, EMU_HANA_IRQ_ENABLE, 0x00);
938 
939 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTION_CARDS, &reg);
940 	dev_info(emu->card->dev, "emu1010: Card options3 = 0x%x\n", reg);
941 	/* Default WCLK set to 48kHz. */
942 	snd_emu1010_fpga_write(emu, EMU_HANA_DEFCLOCK, 0x00);
943 	/* Word Clock source, Internal 48kHz x1 */
944 	snd_emu1010_fpga_write(emu, EMU_HANA_WCLOCK, EMU_HANA_WCLOCK_INT_48K);
945 	/* snd_emu1010_fpga_write(emu, EMU_HANA_WCLOCK, EMU_HANA_WCLOCK_INT_48K | EMU_HANA_WCLOCK_4X); */
946 	/* Audio Dock LEDs. */
947 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_LEDS_2, 0x12);
948 
949 #if 0
950 	/* For 96kHz */
951 	snd_emu1010_fpga_link_dst_src_write(emu,
952 		EMU_DST_ALICE2_EMU32_0, EMU_SRC_HAMOA_ADC_LEFT1);
953 	snd_emu1010_fpga_link_dst_src_write(emu,
954 		EMU_DST_ALICE2_EMU32_1, EMU_SRC_HAMOA_ADC_RIGHT1);
955 	snd_emu1010_fpga_link_dst_src_write(emu,
956 		EMU_DST_ALICE2_EMU32_4, EMU_SRC_HAMOA_ADC_LEFT2);
957 	snd_emu1010_fpga_link_dst_src_write(emu,
958 		EMU_DST_ALICE2_EMU32_5, EMU_SRC_HAMOA_ADC_RIGHT2);
959 #endif
960 #if 0
961 	/* For 192kHz */
962 	snd_emu1010_fpga_link_dst_src_write(emu,
963 		EMU_DST_ALICE2_EMU32_0, EMU_SRC_HAMOA_ADC_LEFT1);
964 	snd_emu1010_fpga_link_dst_src_write(emu,
965 		EMU_DST_ALICE2_EMU32_1, EMU_SRC_HAMOA_ADC_RIGHT1);
966 	snd_emu1010_fpga_link_dst_src_write(emu,
967 		EMU_DST_ALICE2_EMU32_2, EMU_SRC_HAMOA_ADC_LEFT2);
968 	snd_emu1010_fpga_link_dst_src_write(emu,
969 		EMU_DST_ALICE2_EMU32_3, EMU_SRC_HAMOA_ADC_RIGHT2);
970 	snd_emu1010_fpga_link_dst_src_write(emu,
971 		EMU_DST_ALICE2_EMU32_4, EMU_SRC_HAMOA_ADC_LEFT3);
972 	snd_emu1010_fpga_link_dst_src_write(emu,
973 		EMU_DST_ALICE2_EMU32_5, EMU_SRC_HAMOA_ADC_RIGHT3);
974 	snd_emu1010_fpga_link_dst_src_write(emu,
975 		EMU_DST_ALICE2_EMU32_6, EMU_SRC_HAMOA_ADC_LEFT4);
976 	snd_emu1010_fpga_link_dst_src_write(emu,
977 		EMU_DST_ALICE2_EMU32_7, EMU_SRC_HAMOA_ADC_RIGHT4);
978 #endif
979 #if 1
980 	/* For 48kHz */
981 	snd_emu1010_fpga_link_dst_src_write(emu,
982 		EMU_DST_ALICE2_EMU32_0, EMU_SRC_DOCK_MIC_A1);
983 	snd_emu1010_fpga_link_dst_src_write(emu,
984 		EMU_DST_ALICE2_EMU32_1, EMU_SRC_DOCK_MIC_B1);
985 	snd_emu1010_fpga_link_dst_src_write(emu,
986 		EMU_DST_ALICE2_EMU32_2, EMU_SRC_HAMOA_ADC_LEFT2);
987 	snd_emu1010_fpga_link_dst_src_write(emu,
988 		EMU_DST_ALICE2_EMU32_3, EMU_SRC_HAMOA_ADC_LEFT2);
989 	snd_emu1010_fpga_link_dst_src_write(emu,
990 		EMU_DST_ALICE2_EMU32_4, EMU_SRC_DOCK_ADC1_LEFT1);
991 	snd_emu1010_fpga_link_dst_src_write(emu,
992 		EMU_DST_ALICE2_EMU32_5, EMU_SRC_DOCK_ADC1_RIGHT1);
993 	snd_emu1010_fpga_link_dst_src_write(emu,
994 		EMU_DST_ALICE2_EMU32_6, EMU_SRC_DOCK_ADC2_LEFT1);
995 	snd_emu1010_fpga_link_dst_src_write(emu,
996 		EMU_DST_ALICE2_EMU32_7, EMU_SRC_DOCK_ADC2_RIGHT1);
997 	/* Pavel Hofman - setting defaults for 8 more capture channels
998 	 * Defaults only, users will set their own values anyways, let's
999 	 * just copy/paste.
1000 	 */
1001 
1002 	snd_emu1010_fpga_link_dst_src_write(emu,
1003 		EMU_DST_ALICE2_EMU32_8, EMU_SRC_DOCK_MIC_A1);
1004 	snd_emu1010_fpga_link_dst_src_write(emu,
1005 		EMU_DST_ALICE2_EMU32_9, EMU_SRC_DOCK_MIC_B1);
1006 	snd_emu1010_fpga_link_dst_src_write(emu,
1007 		EMU_DST_ALICE2_EMU32_A, EMU_SRC_HAMOA_ADC_LEFT2);
1008 	snd_emu1010_fpga_link_dst_src_write(emu,
1009 		EMU_DST_ALICE2_EMU32_B, EMU_SRC_HAMOA_ADC_LEFT2);
1010 	snd_emu1010_fpga_link_dst_src_write(emu,
1011 		EMU_DST_ALICE2_EMU32_C, EMU_SRC_DOCK_ADC1_LEFT1);
1012 	snd_emu1010_fpga_link_dst_src_write(emu,
1013 		EMU_DST_ALICE2_EMU32_D, EMU_SRC_DOCK_ADC1_RIGHT1);
1014 	snd_emu1010_fpga_link_dst_src_write(emu,
1015 		EMU_DST_ALICE2_EMU32_E, EMU_SRC_DOCK_ADC2_LEFT1);
1016 	snd_emu1010_fpga_link_dst_src_write(emu,
1017 		EMU_DST_ALICE2_EMU32_F, EMU_SRC_DOCK_ADC2_RIGHT1);
1018 #endif
1019 #if 0
1020 	/* Original */
1021 	snd_emu1010_fpga_link_dst_src_write(emu,
1022 		EMU_DST_ALICE2_EMU32_4, EMU_SRC_HANA_ADAT);
1023 	snd_emu1010_fpga_link_dst_src_write(emu,
1024 		EMU_DST_ALICE2_EMU32_5, EMU_SRC_HANA_ADAT + 1);
1025 	snd_emu1010_fpga_link_dst_src_write(emu,
1026 		EMU_DST_ALICE2_EMU32_6, EMU_SRC_HANA_ADAT + 2);
1027 	snd_emu1010_fpga_link_dst_src_write(emu,
1028 		EMU_DST_ALICE2_EMU32_7, EMU_SRC_HANA_ADAT + 3);
1029 	snd_emu1010_fpga_link_dst_src_write(emu,
1030 		EMU_DST_ALICE2_EMU32_8, EMU_SRC_HANA_ADAT + 4);
1031 	snd_emu1010_fpga_link_dst_src_write(emu,
1032 		EMU_DST_ALICE2_EMU32_9, EMU_SRC_HANA_ADAT + 5);
1033 	snd_emu1010_fpga_link_dst_src_write(emu,
1034 		EMU_DST_ALICE2_EMU32_A, EMU_SRC_HANA_ADAT + 6);
1035 	snd_emu1010_fpga_link_dst_src_write(emu,
1036 		EMU_DST_ALICE2_EMU32_B, EMU_SRC_HANA_ADAT + 7);
1037 	snd_emu1010_fpga_link_dst_src_write(emu,
1038 		EMU_DST_ALICE2_EMU32_C, EMU_SRC_DOCK_MIC_A1);
1039 	snd_emu1010_fpga_link_dst_src_write(emu,
1040 		EMU_DST_ALICE2_EMU32_D, EMU_SRC_DOCK_MIC_B1);
1041 	snd_emu1010_fpga_link_dst_src_write(emu,
1042 		EMU_DST_ALICE2_EMU32_E, EMU_SRC_HAMOA_ADC_LEFT2);
1043 	snd_emu1010_fpga_link_dst_src_write(emu,
1044 		EMU_DST_ALICE2_EMU32_F, EMU_SRC_HAMOA_ADC_LEFT2);
1045 #endif
1046 	for (i = 0; i < 0x20; i++) {
1047 		/* AudioDock Elink <- Silence */
1048 		snd_emu1010_fpga_link_dst_src_write(emu, 0x0100 + i, EMU_SRC_SILENCE);
1049 	}
1050 	for (i = 0; i < 4; i++) {
1051 		/* Hana SPDIF Out <- Silence */
1052 		snd_emu1010_fpga_link_dst_src_write(emu, 0x0200 + i, EMU_SRC_SILENCE);
1053 	}
1054 	for (i = 0; i < 7; i++) {
1055 		/* Hamoa DAC <- Silence */
1056 		snd_emu1010_fpga_link_dst_src_write(emu, 0x0300 + i, EMU_SRC_SILENCE);
1057 	}
1058 	for (i = 0; i < 7; i++) {
1059 		/* Hana ADAT Out <- Silence */
1060 		snd_emu1010_fpga_link_dst_src_write(emu, EMU_DST_HANA_ADAT + i, EMU_SRC_SILENCE);
1061 	}
1062 	snd_emu1010_fpga_link_dst_src_write(emu,
1063 		EMU_DST_ALICE_I2S0_LEFT, EMU_SRC_DOCK_ADC1_LEFT1);
1064 	snd_emu1010_fpga_link_dst_src_write(emu,
1065 		EMU_DST_ALICE_I2S0_RIGHT, EMU_SRC_DOCK_ADC1_RIGHT1);
1066 	snd_emu1010_fpga_link_dst_src_write(emu,
1067 		EMU_DST_ALICE_I2S1_LEFT, EMU_SRC_DOCK_ADC2_LEFT1);
1068 	snd_emu1010_fpga_link_dst_src_write(emu,
1069 		EMU_DST_ALICE_I2S1_RIGHT, EMU_SRC_DOCK_ADC2_RIGHT1);
1070 	snd_emu1010_fpga_link_dst_src_write(emu,
1071 		EMU_DST_ALICE_I2S2_LEFT, EMU_SRC_DOCK_ADC3_LEFT1);
1072 	snd_emu1010_fpga_link_dst_src_write(emu,
1073 		EMU_DST_ALICE_I2S2_RIGHT, EMU_SRC_DOCK_ADC3_RIGHT1);
1074 	snd_emu1010_fpga_write(emu, EMU_HANA_UNMUTE, 0x01); /* Unmute all */
1075 
1076 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTION_CARDS, &tmp);
1077 
1078 	/* AC97 1.03, Any 32Meg of 2Gig address, Auto-Mute, EMU32 Slave,
1079 	 * Lock Sound Memory Cache, Lock Tank Memory Cache,
1080 	 * Mute all codecs.
1081 	 */
1082 	outl(0x0000a000, emu->port + HCFG);
1083 	/* AC97 1.03, Any 32Meg of 2Gig address, Auto-Mute, EMU32 Slave,
1084 	 * Lock Sound Memory Cache, Lock Tank Memory Cache,
1085 	 * Un-Mute all codecs.
1086 	 */
1087 	outl(0x0000a001, emu->port + HCFG);
1088 
1089 	/* Initial boot complete. Now patches */
1090 
1091 	snd_emu1010_fpga_read(emu, EMU_HANA_OPTION_CARDS, &tmp);
1092 	snd_emu1010_fpga_write(emu, EMU_HANA_MIDI_IN, 0x19); /* MIDI Route */
1093 	snd_emu1010_fpga_write(emu, EMU_HANA_MIDI_OUT, 0x0c); /* Unknown */
1094 	snd_emu1010_fpga_write(emu, EMU_HANA_MIDI_IN, 0x19); /* MIDI Route */
1095 	snd_emu1010_fpga_write(emu, EMU_HANA_MIDI_OUT, 0x0c); /* Unknown */
1096 	snd_emu1010_fpga_read(emu, EMU_HANA_SPDIF_MODE, &tmp);
1097 	snd_emu1010_fpga_write(emu, EMU_HANA_SPDIF_MODE, 0x10); /* SPDIF Format spdif  (or 0x11 for aes/ebu) */
1098 
1099 #if 0
1100 	snd_emu1010_fpga_link_dst_src_write(emu,
1101 		EMU_DST_HAMOA_DAC_LEFT1, EMU_SRC_ALICE_EMU32B + 2); /* ALICE2 bus 0xa2 */
1102 	snd_emu1010_fpga_link_dst_src_write(emu,
1103 		EMU_DST_HAMOA_DAC_RIGHT1, EMU_SRC_ALICE_EMU32B + 3); /* ALICE2 bus 0xa3 */
1104 	snd_emu1010_fpga_link_dst_src_write(emu,
1105 		EMU_DST_HANA_SPDIF_LEFT1, EMU_SRC_ALICE_EMU32A + 2); /* ALICE2 bus 0xb2 */
1106 	snd_emu1010_fpga_link_dst_src_write(emu,
1107 		EMU_DST_HANA_SPDIF_RIGHT1, EMU_SRC_ALICE_EMU32A + 3); /* ALICE2 bus 0xb3 */
1108 #endif
1109 	/* Default outputs */
1110 	if (emu->card_capabilities->emu_model == EMU_MODEL_EMU1616) {
1111 		/* 1616(M) cardbus default outputs */
1112 		/* ALICE2 bus 0xa0 */
1113 		snd_emu1010_fpga_link_dst_src_write(emu,
1114 			EMU_DST_DOCK_DAC1_LEFT1, EMU_SRC_ALICE_EMU32A + 0);
1115 		emu->emu1010.output_source[0] = 17;
1116 		snd_emu1010_fpga_link_dst_src_write(emu,
1117 			EMU_DST_DOCK_DAC1_RIGHT1, EMU_SRC_ALICE_EMU32A + 1);
1118 		emu->emu1010.output_source[1] = 18;
1119 		snd_emu1010_fpga_link_dst_src_write(emu,
1120 			EMU_DST_DOCK_DAC2_LEFT1, EMU_SRC_ALICE_EMU32A + 2);
1121 		emu->emu1010.output_source[2] = 19;
1122 		snd_emu1010_fpga_link_dst_src_write(emu,
1123 			EMU_DST_DOCK_DAC2_RIGHT1, EMU_SRC_ALICE_EMU32A + 3);
1124 		emu->emu1010.output_source[3] = 20;
1125 		snd_emu1010_fpga_link_dst_src_write(emu,
1126 			EMU_DST_DOCK_DAC3_LEFT1, EMU_SRC_ALICE_EMU32A + 4);
1127 		emu->emu1010.output_source[4] = 21;
1128 		snd_emu1010_fpga_link_dst_src_write(emu,
1129 			EMU_DST_DOCK_DAC3_RIGHT1, EMU_SRC_ALICE_EMU32A + 5);
1130 		emu->emu1010.output_source[5] = 22;
1131 		/* ALICE2 bus 0xa0 */
1132 		snd_emu1010_fpga_link_dst_src_write(emu,
1133 			EMU_DST_MANA_DAC_LEFT, EMU_SRC_ALICE_EMU32A + 0);
1134 		emu->emu1010.output_source[16] = 17;
1135 		snd_emu1010_fpga_link_dst_src_write(emu,
1136 			EMU_DST_MANA_DAC_RIGHT, EMU_SRC_ALICE_EMU32A + 1);
1137 		emu->emu1010.output_source[17] = 18;
1138 	} else {
1139 		/* ALICE2 bus 0xa0 */
1140 		snd_emu1010_fpga_link_dst_src_write(emu,
1141 			EMU_DST_DOCK_DAC1_LEFT1, EMU_SRC_ALICE_EMU32A + 0);
1142 		emu->emu1010.output_source[0] = 21;
1143 		snd_emu1010_fpga_link_dst_src_write(emu,
1144 			EMU_DST_DOCK_DAC1_RIGHT1, EMU_SRC_ALICE_EMU32A + 1);
1145 		emu->emu1010.output_source[1] = 22;
1146 		snd_emu1010_fpga_link_dst_src_write(emu,
1147 			EMU_DST_DOCK_DAC2_LEFT1, EMU_SRC_ALICE_EMU32A + 2);
1148 		emu->emu1010.output_source[2] = 23;
1149 		snd_emu1010_fpga_link_dst_src_write(emu,
1150 			EMU_DST_DOCK_DAC2_RIGHT1, EMU_SRC_ALICE_EMU32A + 3);
1151 		emu->emu1010.output_source[3] = 24;
1152 		snd_emu1010_fpga_link_dst_src_write(emu,
1153 			EMU_DST_DOCK_DAC3_LEFT1, EMU_SRC_ALICE_EMU32A + 4);
1154 		emu->emu1010.output_source[4] = 25;
1155 		snd_emu1010_fpga_link_dst_src_write(emu,
1156 			EMU_DST_DOCK_DAC3_RIGHT1, EMU_SRC_ALICE_EMU32A + 5);
1157 		emu->emu1010.output_source[5] = 26;
1158 		snd_emu1010_fpga_link_dst_src_write(emu,
1159 			EMU_DST_DOCK_DAC4_LEFT1, EMU_SRC_ALICE_EMU32A + 6);
1160 		emu->emu1010.output_source[6] = 27;
1161 		snd_emu1010_fpga_link_dst_src_write(emu,
1162 			EMU_DST_DOCK_DAC4_RIGHT1, EMU_SRC_ALICE_EMU32A + 7);
1163 		emu->emu1010.output_source[7] = 28;
1164 		/* ALICE2 bus 0xa0 */
1165 		snd_emu1010_fpga_link_dst_src_write(emu,
1166 			EMU_DST_DOCK_PHONES_LEFT1, EMU_SRC_ALICE_EMU32A + 0);
1167 		emu->emu1010.output_source[8] = 21;
1168 		snd_emu1010_fpga_link_dst_src_write(emu,
1169 			EMU_DST_DOCK_PHONES_RIGHT1, EMU_SRC_ALICE_EMU32A + 1);
1170 		emu->emu1010.output_source[9] = 22;
1171 		/* ALICE2 bus 0xa0 */
1172 		snd_emu1010_fpga_link_dst_src_write(emu,
1173 			EMU_DST_DOCK_SPDIF_LEFT1, EMU_SRC_ALICE_EMU32A + 0);
1174 		emu->emu1010.output_source[10] = 21;
1175 		snd_emu1010_fpga_link_dst_src_write(emu,
1176 			EMU_DST_DOCK_SPDIF_RIGHT1, EMU_SRC_ALICE_EMU32A + 1);
1177 		emu->emu1010.output_source[11] = 22;
1178 		/* ALICE2 bus 0xa0 */
1179 		snd_emu1010_fpga_link_dst_src_write(emu,
1180 			EMU_DST_HANA_SPDIF_LEFT1, EMU_SRC_ALICE_EMU32A + 0);
1181 		emu->emu1010.output_source[12] = 21;
1182 		snd_emu1010_fpga_link_dst_src_write(emu,
1183 			EMU_DST_HANA_SPDIF_RIGHT1, EMU_SRC_ALICE_EMU32A + 1);
1184 		emu->emu1010.output_source[13] = 22;
1185 		/* ALICE2 bus 0xa0 */
1186 		snd_emu1010_fpga_link_dst_src_write(emu,
1187 			EMU_DST_HAMOA_DAC_LEFT1, EMU_SRC_ALICE_EMU32A + 0);
1188 		emu->emu1010.output_source[14] = 21;
1189 		snd_emu1010_fpga_link_dst_src_write(emu,
1190 			EMU_DST_HAMOA_DAC_RIGHT1, EMU_SRC_ALICE_EMU32A + 1);
1191 		emu->emu1010.output_source[15] = 22;
1192 		/* ALICE2 bus 0xa0 */
1193 		snd_emu1010_fpga_link_dst_src_write(emu,
1194 			EMU_DST_HANA_ADAT, EMU_SRC_ALICE_EMU32A + 0);
1195 		emu->emu1010.output_source[16] = 21;
1196 		snd_emu1010_fpga_link_dst_src_write(emu,
1197 			EMU_DST_HANA_ADAT + 1, EMU_SRC_ALICE_EMU32A + 1);
1198 		emu->emu1010.output_source[17] = 22;
1199 		snd_emu1010_fpga_link_dst_src_write(emu,
1200 			EMU_DST_HANA_ADAT + 2, EMU_SRC_ALICE_EMU32A + 2);
1201 		emu->emu1010.output_source[18] = 23;
1202 		snd_emu1010_fpga_link_dst_src_write(emu,
1203 			EMU_DST_HANA_ADAT + 3, EMU_SRC_ALICE_EMU32A + 3);
1204 		emu->emu1010.output_source[19] = 24;
1205 		snd_emu1010_fpga_link_dst_src_write(emu,
1206 			EMU_DST_HANA_ADAT + 4, EMU_SRC_ALICE_EMU32A + 4);
1207 		emu->emu1010.output_source[20] = 25;
1208 		snd_emu1010_fpga_link_dst_src_write(emu,
1209 			EMU_DST_HANA_ADAT + 5, EMU_SRC_ALICE_EMU32A + 5);
1210 		emu->emu1010.output_source[21] = 26;
1211 		snd_emu1010_fpga_link_dst_src_write(emu,
1212 			EMU_DST_HANA_ADAT + 6, EMU_SRC_ALICE_EMU32A + 6);
1213 		emu->emu1010.output_source[22] = 27;
1214 		snd_emu1010_fpga_link_dst_src_write(emu,
1215 			EMU_DST_HANA_ADAT + 7, EMU_SRC_ALICE_EMU32A + 7);
1216 		emu->emu1010.output_source[23] = 28;
1217 	}
1218 	/* TEMP: Select SPDIF in/out */
1219 	/* snd_emu1010_fpga_write(emu, EMU_HANA_OPTICAL_TYPE, 0x0); */ /* Output spdif */
1220 
1221 	/* TEMP: Select 48kHz SPDIF out */
1222 	snd_emu1010_fpga_write(emu, EMU_HANA_UNMUTE, 0x0); /* Mute all */
1223 	snd_emu1010_fpga_write(emu, EMU_HANA_DEFCLOCK, 0x0); /* Default fallback clock 48kHz */
1224 	/* Word Clock source, Internal 48kHz x1 */
1225 	snd_emu1010_fpga_write(emu, EMU_HANA_WCLOCK, EMU_HANA_WCLOCK_INT_48K);
1226 	/* snd_emu1010_fpga_write(emu, EMU_HANA_WCLOCK, EMU_HANA_WCLOCK_INT_48K | EMU_HANA_WCLOCK_4X); */
1227 	emu->emu1010.internal_clock = 1; /* 48000 */
1228 	snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_LEDS_2, 0x12); /* Set LEDs on Audio Dock */
1229 	snd_emu1010_fpga_write(emu, EMU_HANA_UNMUTE, 0x1); /* Unmute all */
1230 	/* snd_emu1010_fpga_write(emu, 0x7, 0x0); */ /* Mute all */
1231 	/* snd_emu1010_fpga_write(emu, 0x7, 0x1); */ /* Unmute all */
1232 	/* snd_emu1010_fpga_write(emu, 0xe, 0x12); */ /* Set LEDs on Audio Dock */
1233 
1234 	return 0;
1235 }
1236 /*
1237  *  Create the EMU10K1 instance
1238  */
1239 
1240 #ifdef CONFIG_PM_SLEEP
1241 static int alloc_pm_buffer(struct snd_emu10k1 *emu);
1242 static void free_pm_buffer(struct snd_emu10k1 *emu);
1243 #endif
1244 
1245 static void snd_emu10k1_free(struct snd_card *card)
1246 {
1247 	struct snd_emu10k1 *emu = card->private_data;
1248 
1249 	if (emu->port) {	/* avoid access to already used hardware */
1250 		snd_emu10k1_fx8010_tram_setup(emu, 0);
1251 		snd_emu10k1_done(emu);
1252 		snd_emu10k1_free_efx(emu);
1253 	}
1254 	if (emu->card_capabilities->emu_model == EMU_MODEL_EMU1010) {
1255 		/* Disable 48Volt power to Audio Dock */
1256 		snd_emu1010_fpga_write(emu, EMU_HANA_DOCK_PWR, 0);
1257 	}
1258 	cancel_delayed_work_sync(&emu->emu1010.firmware_work);
1259 	release_firmware(emu->firmware);
1260 	release_firmware(emu->dock_fw);
1261 	snd_util_memhdr_free(emu->memhdr);
1262 	if (emu->silent_page.area)
1263 		snd_dma_free_pages(&emu->silent_page);
1264 	if (emu->ptb_pages.area)
1265 		snd_dma_free_pages(&emu->ptb_pages);
1266 	vfree(emu->page_ptr_table);
1267 	vfree(emu->page_addr_table);
1268 #ifdef CONFIG_PM_SLEEP
1269 	free_pm_buffer(emu);
1270 #endif
1271 }
1272 
1273 static const struct snd_emu_chip_details emu_chip_details[] = {
1274 	/* Audigy 5/Rx SB1550 */
1275 	/* Tested by michael@gernoth.net 28 Mar 2015 */
1276 	/* DSP: CA10300-IAT LF
1277 	 * DAC: Cirrus Logic CS4382-KQZ
1278 	 * ADC: Philips 1361T
1279 	 * AC97: Sigmatel STAC9750
1280 	 * CA0151: None
1281 	 */
1282 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x10241102,
1283 	 .driver = "Audigy2", .name = "SB Audigy 5/Rx [SB1550]",
1284 	 .id = "Audigy2",
1285 	 .emu10k2_chip = 1,
1286 	 .ca0108_chip = 1,
1287 	 .spk71 = 1,
1288 	 .adc_1361t = 1,  /* 24 bit capture instead of 16bit */
1289 	 .ac97_chip = 1},
1290 	/* Audigy4 (Not PRO) SB0610 */
1291 	/* Tested by James@superbug.co.uk 4th April 2006 */
1292 	/* A_IOCFG bits
1293 	 * Output
1294 	 * 0: ?
1295 	 * 1: ?
1296 	 * 2: ?
1297 	 * 3: 0 - Digital Out, 1 - Line in
1298 	 * 4: ?
1299 	 * 5: ?
1300 	 * 6: ?
1301 	 * 7: ?
1302 	 * Input
1303 	 * 8: ?
1304 	 * 9: ?
1305 	 * A: Green jack sense (Front)
1306 	 * B: ?
1307 	 * C: Black jack sense (Rear/Side Right)
1308 	 * D: Yellow jack sense (Center/LFE/Side Left)
1309 	 * E: ?
1310 	 * F: ?
1311 	 *
1312 	 * Digital Out/Line in switch using A_IOCFG bit 3 (0x08)
1313 	 * 0 - Digital Out
1314 	 * 1 - Line in
1315 	 */
1316 	/* Mic input not tested.
1317 	 * Analog CD input not tested
1318 	 * Digital Out not tested.
1319 	 * Line in working.
1320 	 * Audio output 5.1 working. Side outputs not working.
1321 	 */
1322 	/* DSP: CA10300-IAT LF
1323 	 * DAC: Cirrus Logic CS4382-KQZ
1324 	 * ADC: Philips 1361T
1325 	 * AC97: Sigmatel STAC9750
1326 	 * CA0151: None
1327 	 */
1328 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x10211102,
1329 	 .driver = "Audigy2", .name = "SB Audigy 4 [SB0610]",
1330 	 .id = "Audigy2",
1331 	 .emu10k2_chip = 1,
1332 	 .ca0108_chip = 1,
1333 	 .spk71 = 1,
1334 	 .adc_1361t = 1,  /* 24 bit capture instead of 16bit */
1335 	 .ac97_chip = 1} ,
1336 	/* Audigy 2 Value AC3 out does not work yet.
1337 	 * Need to find out how to turn off interpolators.
1338 	 */
1339 	/* Tested by James@superbug.co.uk 3rd July 2005 */
1340 	/* DSP: CA0108-IAT
1341 	 * DAC: CS4382-KQ
1342 	 * ADC: Philips 1361T
1343 	 * AC97: STAC9750
1344 	 * CA0151: None
1345 	 */
1346 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x10011102,
1347 	 .driver = "Audigy2", .name = "SB Audigy 2 Value [SB0400]",
1348 	 .id = "Audigy2",
1349 	 .emu10k2_chip = 1,
1350 	 .ca0108_chip = 1,
1351 	 .spk71 = 1,
1352 	 .ac97_chip = 1} ,
1353 	/* Audigy 2 ZS Notebook Cardbus card.*/
1354 	/* Tested by James@superbug.co.uk 6th November 2006 */
1355 	/* Audio output 7.1/Headphones working.
1356 	 * Digital output working. (AC3 not checked, only PCM)
1357 	 * Audio Mic/Line inputs working.
1358 	 * Digital input not tested.
1359 	 */
1360 	/* DSP: Tina2
1361 	 * DAC: Wolfson WM8768/WM8568
1362 	 * ADC: Wolfson WM8775
1363 	 * AC97: None
1364 	 * CA0151: None
1365 	 */
1366 	/* Tested by James@superbug.co.uk 4th April 2006 */
1367 	/* A_IOCFG bits
1368 	 * Output
1369 	 * 0: Not Used
1370 	 * 1: 0 = Mute all the 7.1 channel out. 1 = unmute.
1371 	 * 2: Analog input 0 = line in, 1 = mic in
1372 	 * 3: Not Used
1373 	 * 4: Digital output 0 = off, 1 = on.
1374 	 * 5: Not Used
1375 	 * 6: Not Used
1376 	 * 7: Not Used
1377 	 * Input
1378 	 *      All bits 1 (0x3fxx) means nothing plugged in.
1379 	 * 8-9: 0 = Line in/Mic, 2 = Optical in, 3 = Nothing.
1380 	 * A-B: 0 = Headphones, 2 = Optical out, 3 = Nothing.
1381 	 * C-D: 2 = Front/Rear/etc, 3 = nothing.
1382 	 * E-F: Always 0
1383 	 *
1384 	 */
1385 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x20011102,
1386 	 .driver = "Audigy2", .name = "Audigy 2 ZS Notebook [SB0530]",
1387 	 .id = "Audigy2",
1388 	 .emu10k2_chip = 1,
1389 	 .ca0108_chip = 1,
1390 	 .ca_cardbus_chip = 1,
1391 	 .spi_dac = 1,
1392 	 .i2c_adc = 1,
1393 	 .spk71 = 1} ,
1394 	/* Tested by James@superbug.co.uk 4th Nov 2007. */
1395 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x42011102,
1396 	 .driver = "Audigy2", .name = "E-mu 1010 Notebook [MAEM8950]",
1397 	 .id = "EMU1010",
1398 	 .emu10k2_chip = 1,
1399 	 .ca0108_chip = 1,
1400 	 .ca_cardbus_chip = 1,
1401 	 .spk71 = 1 ,
1402 	 .emu_model = EMU_MODEL_EMU1616},
1403 	/* Tested by James@superbug.co.uk 4th Nov 2007. */
1404 	/* This is MAEM8960, 0202 is MAEM 8980 */
1405 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x40041102,
1406 	 .driver = "Audigy2", .name = "E-mu 1010b PCI [MAEM8960]",
1407 	 .id = "EMU1010",
1408 	 .emu10k2_chip = 1,
1409 	 .ca0108_chip = 1,
1410 	 .spk71 = 1,
1411 	 .emu_model = EMU_MODEL_EMU1010B}, /* EMU 1010 new revision */
1412 	/* Tested by Maxim Kachur <mcdebugger@duganet.ru> 17th Oct 2012. */
1413 	/* This is MAEM8986, 0202 is MAEM8980 */
1414 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x40071102,
1415 	 .driver = "Audigy2", .name = "E-mu 1010 PCIe [MAEM8986]",
1416 	 .id = "EMU1010",
1417 	 .emu10k2_chip = 1,
1418 	 .ca0108_chip = 1,
1419 	 .spk71 = 1,
1420 	 .emu_model = EMU_MODEL_EMU1010B}, /* EMU 1010 PCIe */
1421 	/* Tested by James@superbug.co.uk 8th July 2005. */
1422 	/* This is MAEM8810, 0202 is MAEM8820 */
1423 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x40011102,
1424 	 .driver = "Audigy2", .name = "E-mu 1010 [MAEM8810]",
1425 	 .id = "EMU1010",
1426 	 .emu10k2_chip = 1,
1427 	 .ca0102_chip = 1,
1428 	 .spk71 = 1,
1429 	 .emu_model = EMU_MODEL_EMU1010}, /* EMU 1010 old revision */
1430 	/* EMU0404b */
1431 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x40021102,
1432 	 .driver = "Audigy2", .name = "E-mu 0404b PCI [MAEM8852]",
1433 	 .id = "EMU0404",
1434 	 .emu10k2_chip = 1,
1435 	 .ca0108_chip = 1,
1436 	 .spk71 = 1,
1437 	 .emu_model = EMU_MODEL_EMU0404}, /* EMU 0404 new revision */
1438 	/* Tested by James@superbug.co.uk 20-3-2007. */
1439 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x40021102,
1440 	 .driver = "Audigy2", .name = "E-mu 0404 [MAEM8850]",
1441 	 .id = "EMU0404",
1442 	 .emu10k2_chip = 1,
1443 	 .ca0102_chip = 1,
1444 	 .spk71 = 1,
1445 	 .emu_model = EMU_MODEL_EMU0404}, /* EMU 0404 */
1446 	/* EMU0404 PCIe */
1447 	{.vendor = 0x1102, .device = 0x0008, .subsystem = 0x40051102,
1448 	 .driver = "Audigy2", .name = "E-mu 0404 PCIe [MAEM8984]",
1449 	 .id = "EMU0404",
1450 	 .emu10k2_chip = 1,
1451 	 .ca0108_chip = 1,
1452 	 .spk71 = 1,
1453 	 .emu_model = EMU_MODEL_EMU0404}, /* EMU 0404 PCIe ver_03 */
1454 	/* Note that all E-mu cards require kernel 2.6 or newer. */
1455 	{.vendor = 0x1102, .device = 0x0008,
1456 	 .driver = "Audigy2", .name = "SB Audigy 2 Value [Unknown]",
1457 	 .id = "Audigy2",
1458 	 .emu10k2_chip = 1,
1459 	 .ca0108_chip = 1,
1460 	 .ac97_chip = 1} ,
1461 	/* Tested by James@superbug.co.uk 3rd July 2005 */
1462 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x20071102,
1463 	 .driver = "Audigy2", .name = "SB Audigy 4 PRO [SB0380]",
1464 	 .id = "Audigy2",
1465 	 .emu10k2_chip = 1,
1466 	 .ca0102_chip = 1,
1467 	 .ca0151_chip = 1,
1468 	 .spk71 = 1,
1469 	 .spdif_bug = 1,
1470 	 .ac97_chip = 1} ,
1471 	/* Tested by shane-alsa@cm.nu 5th Nov 2005 */
1472 	/* The 0x20061102 does have SB0350 written on it
1473 	 * Just like 0x20021102
1474 	 */
1475 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x20061102,
1476 	 .driver = "Audigy2", .name = "SB Audigy 2 [SB0350b]",
1477 	 .id = "Audigy2",
1478 	 .emu10k2_chip = 1,
1479 	 .ca0102_chip = 1,
1480 	 .ca0151_chip = 1,
1481 	 .spk71 = 1,
1482 	 .spdif_bug = 1,
1483 	 .invert_shared_spdif = 1,	/* digital/analog switch swapped */
1484 	 .ac97_chip = 1} ,
1485 	/* 0x20051102 also has SB0350 written on it, treated as Audigy 2 ZS by
1486 	   Creative's Windows driver */
1487 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x20051102,
1488 	 .driver = "Audigy2", .name = "SB Audigy 2 ZS [SB0350a]",
1489 	 .id = "Audigy2",
1490 	 .emu10k2_chip = 1,
1491 	 .ca0102_chip = 1,
1492 	 .ca0151_chip = 1,
1493 	 .spk71 = 1,
1494 	 .spdif_bug = 1,
1495 	 .invert_shared_spdif = 1,	/* digital/analog switch swapped */
1496 	 .ac97_chip = 1} ,
1497 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x20021102,
1498 	 .driver = "Audigy2", .name = "SB Audigy 2 ZS [SB0350]",
1499 	 .id = "Audigy2",
1500 	 .emu10k2_chip = 1,
1501 	 .ca0102_chip = 1,
1502 	 .ca0151_chip = 1,
1503 	 .spk71 = 1,
1504 	 .spdif_bug = 1,
1505 	 .invert_shared_spdif = 1,	/* digital/analog switch swapped */
1506 	 .ac97_chip = 1} ,
1507 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x20011102,
1508 	 .driver = "Audigy2", .name = "SB Audigy 2 ZS [SB0360]",
1509 	 .id = "Audigy2",
1510 	 .emu10k2_chip = 1,
1511 	 .ca0102_chip = 1,
1512 	 .ca0151_chip = 1,
1513 	 .spk71 = 1,
1514 	 .spdif_bug = 1,
1515 	 .invert_shared_spdif = 1,	/* digital/analog switch swapped */
1516 	 .ac97_chip = 1} ,
1517 	/* Audigy 2 */
1518 	/* Tested by James@superbug.co.uk 3rd July 2005 */
1519 	/* DSP: CA0102-IAT
1520 	 * DAC: CS4382-KQ
1521 	 * ADC: Philips 1361T
1522 	 * AC97: STAC9721
1523 	 * CA0151: Yes
1524 	 */
1525 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x10071102,
1526 	 .driver = "Audigy2", .name = "SB Audigy 2 [SB0240]",
1527 	 .id = "Audigy2",
1528 	 .emu10k2_chip = 1,
1529 	 .ca0102_chip = 1,
1530 	 .ca0151_chip = 1,
1531 	 .spk71 = 1,
1532 	 .spdif_bug = 1,
1533 	 .adc_1361t = 1,  /* 24 bit capture instead of 16bit */
1534 	 .ac97_chip = 1} ,
1535 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x10051102,
1536 	 .driver = "Audigy2", .name = "Audigy 2 Platinum EX [SB0280]",
1537 	 .id = "Audigy2",
1538 	 .emu10k2_chip = 1,
1539 	 .ca0102_chip = 1,
1540 	 .ca0151_chip = 1,
1541 	 .spk71 = 1,
1542 	 .spdif_bug = 1} ,
1543 	/* Dell OEM/Creative Labs Audigy 2 ZS */
1544 	/* See ALSA bug#1365 */
1545 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x10031102,
1546 	 .driver = "Audigy2", .name = "SB Audigy 2 ZS [SB0353]",
1547 	 .id = "Audigy2",
1548 	 .emu10k2_chip = 1,
1549 	 .ca0102_chip = 1,
1550 	 .ca0151_chip = 1,
1551 	 .spk71 = 1,
1552 	 .spdif_bug = 1,
1553 	 .invert_shared_spdif = 1,	/* digital/analog switch swapped */
1554 	 .ac97_chip = 1} ,
1555 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x10021102,
1556 	 .driver = "Audigy2", .name = "SB Audigy 2 Platinum [SB0240P]",
1557 	 .id = "Audigy2",
1558 	 .emu10k2_chip = 1,
1559 	 .ca0102_chip = 1,
1560 	 .ca0151_chip = 1,
1561 	 .spk71 = 1,
1562 	 .spdif_bug = 1,
1563 	 .invert_shared_spdif = 1,	/* digital/analog switch swapped */
1564 	 .adc_1361t = 1,  /* 24 bit capture instead of 16bit. Fixes ALSA bug#324 */
1565 	 .ac97_chip = 1} ,
1566 	{.vendor = 0x1102, .device = 0x0004, .revision = 0x04,
1567 	 .driver = "Audigy2", .name = "SB Audigy 2 [Unknown]",
1568 	 .id = "Audigy2",
1569 	 .emu10k2_chip = 1,
1570 	 .ca0102_chip = 1,
1571 	 .ca0151_chip = 1,
1572 	 .spdif_bug = 1,
1573 	 .ac97_chip = 1} ,
1574 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x00531102,
1575 	 .driver = "Audigy", .name = "SB Audigy 1 [SB0092]",
1576 	 .id = "Audigy",
1577 	 .emu10k2_chip = 1,
1578 	 .ca0102_chip = 1,
1579 	 .ac97_chip = 1} ,
1580 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x00521102,
1581 	 .driver = "Audigy", .name = "SB Audigy 1 ES [SB0160]",
1582 	 .id = "Audigy",
1583 	 .emu10k2_chip = 1,
1584 	 .ca0102_chip = 1,
1585 	 .spdif_bug = 1,
1586 	 .ac97_chip = 1} ,
1587 	{.vendor = 0x1102, .device = 0x0004, .subsystem = 0x00511102,
1588 	 .driver = "Audigy", .name = "SB Audigy 1 [SB0090]",
1589 	 .id = "Audigy",
1590 	 .emu10k2_chip = 1,
1591 	 .ca0102_chip = 1,
1592 	 .ac97_chip = 1} ,
1593 	{.vendor = 0x1102, .device = 0x0004,
1594 	 .driver = "Audigy", .name = "Audigy 1 [Unknown]",
1595 	 .id = "Audigy",
1596 	 .emu10k2_chip = 1,
1597 	 .ca0102_chip = 1,
1598 	 .ac97_chip = 1} ,
1599 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x100a1102,
1600 	 .driver = "EMU10K1", .name = "SB Live! 5.1 [SB0220]",
1601 	 .id = "Live",
1602 	 .emu10k1_chip = 1,
1603 	 .ac97_chip = 1,
1604 	 .sblive51 = 1} ,
1605 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x806b1102,
1606 	 .driver = "EMU10K1", .name = "SB Live! [SB0105]",
1607 	 .id = "Live",
1608 	 .emu10k1_chip = 1,
1609 	 .ac97_chip = 1,
1610 	 .sblive51 = 1} ,
1611 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x806a1102,
1612 	 .driver = "EMU10K1", .name = "SB Live! Value [SB0103]",
1613 	 .id = "Live",
1614 	 .emu10k1_chip = 1,
1615 	 .ac97_chip = 1,
1616 	 .sblive51 = 1} ,
1617 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80691102,
1618 	 .driver = "EMU10K1", .name = "SB Live! Value [SB0101]",
1619 	 .id = "Live",
1620 	 .emu10k1_chip = 1,
1621 	 .ac97_chip = 1,
1622 	 .sblive51 = 1} ,
1623 	/* Tested by ALSA bug#1680 26th December 2005 */
1624 	/* note: It really has SB0220 written on the card, */
1625 	/* but it's SB0228 according to kx.inf */
1626 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80661102,
1627 	 .driver = "EMU10K1", .name = "SB Live! 5.1 Dell OEM [SB0228]",
1628 	 .id = "Live",
1629 	 .emu10k1_chip = 1,
1630 	 .ac97_chip = 1,
1631 	 .sblive51 = 1} ,
1632 	/* Tested by Thomas Zehetbauer 27th Aug 2005 */
1633 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80651102,
1634 	 .driver = "EMU10K1", .name = "SB Live! 5.1 [SB0220]",
1635 	 .id = "Live",
1636 	 .emu10k1_chip = 1,
1637 	 .ac97_chip = 1,
1638 	 .sblive51 = 1} ,
1639 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80641102,
1640 	 .driver = "EMU10K1", .name = "SB Live! 5.1",
1641 	 .id = "Live",
1642 	 .emu10k1_chip = 1,
1643 	 .ac97_chip = 1,
1644 	 .sblive51 = 1} ,
1645 	/* Tested by alsa bugtrack user "hus" bug #1297 12th Aug 2005 */
1646 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80611102,
1647 	 .driver = "EMU10K1", .name = "SB Live! 5.1 [SB0060]",
1648 	 .id = "Live",
1649 	 .emu10k1_chip = 1,
1650 	 .ac97_chip = 2, /* ac97 is optional; both SBLive 5.1 and platinum
1651 			  * share the same IDs!
1652 			  */
1653 	 .sblive51 = 1} ,
1654 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80511102,
1655 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4850]",
1656 	 .id = "Live",
1657 	 .emu10k1_chip = 1,
1658 	 .ac97_chip = 1,
1659 	 .sblive51 = 1} ,
1660 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80401102,
1661 	 .driver = "EMU10K1", .name = "SB Live! Platinum [CT4760P]",
1662 	 .id = "Live",
1663 	 .emu10k1_chip = 1,
1664 	 .ac97_chip = 1} ,
1665 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80321102,
1666 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4871]",
1667 	 .id = "Live",
1668 	 .emu10k1_chip = 1,
1669 	 .ac97_chip = 1,
1670 	 .sblive51 = 1} ,
1671 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80311102,
1672 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4831]",
1673 	 .id = "Live",
1674 	 .emu10k1_chip = 1,
1675 	 .ac97_chip = 1,
1676 	 .sblive51 = 1} ,
1677 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80281102,
1678 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4870]",
1679 	 .id = "Live",
1680 	 .emu10k1_chip = 1,
1681 	 .ac97_chip = 1,
1682 	 .sblive51 = 1} ,
1683 	/* Tested by James@superbug.co.uk 3rd July 2005 */
1684 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80271102,
1685 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4832]",
1686 	 .id = "Live",
1687 	 .emu10k1_chip = 1,
1688 	 .ac97_chip = 1,
1689 	 .sblive51 = 1} ,
1690 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80261102,
1691 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4830]",
1692 	 .id = "Live",
1693 	 .emu10k1_chip = 1,
1694 	 .ac97_chip = 1,
1695 	 .sblive51 = 1} ,
1696 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80231102,
1697 	 .driver = "EMU10K1", .name = "SB PCI512 [CT4790]",
1698 	 .id = "Live",
1699 	 .emu10k1_chip = 1,
1700 	 .ac97_chip = 1,
1701 	 .sblive51 = 1} ,
1702 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x80221102,
1703 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4780]",
1704 	 .id = "Live",
1705 	 .emu10k1_chip = 1,
1706 	 .ac97_chip = 1,
1707 	 .sblive51 = 1} ,
1708 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x40011102,
1709 	 .driver = "EMU10K1", .name = "E-mu APS [PC545]",
1710 	 .id = "APS",
1711 	 .emu10k1_chip = 1,
1712 	 .ecard = 1} ,
1713 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x00211102,
1714 	 .driver = "EMU10K1", .name = "SB Live! [CT4620]",
1715 	 .id = "Live",
1716 	 .emu10k1_chip = 1,
1717 	 .ac97_chip = 1,
1718 	 .sblive51 = 1} ,
1719 	{.vendor = 0x1102, .device = 0x0002, .subsystem = 0x00201102,
1720 	 .driver = "EMU10K1", .name = "SB Live! Value [CT4670]",
1721 	 .id = "Live",
1722 	 .emu10k1_chip = 1,
1723 	 .ac97_chip = 1,
1724 	 .sblive51 = 1} ,
1725 	{.vendor = 0x1102, .device = 0x0002,
1726 	 .driver = "EMU10K1", .name = "SB Live! [Unknown]",
1727 	 .id = "Live",
1728 	 .emu10k1_chip = 1,
1729 	 .ac97_chip = 1,
1730 	 .sblive51 = 1} ,
1731 	{ } /* terminator */
1732 };
1733 
1734 /*
1735  * The chip (at least the Audigy 2 CA0102 chip, but most likely others, too)
1736  * has a problem that from time to time it likes to do few DMA reads a bit
1737  * beyond its normal allocation and gets very confused if these reads get
1738  * blocked by a IOMMU.
1739  *
1740  * This behaviour has been observed for the first (reserved) page
1741  * (for which it happens multiple times at every playback), often for various
1742  * synth pages and sometimes for PCM playback buffers and the page table
1743  * memory itself.
1744  *
1745  * As a workaround let's widen these DMA allocations by an extra page if we
1746  * detect that the device is behind a non-passthrough IOMMU.
1747  */
1748 static void snd_emu10k1_detect_iommu(struct snd_emu10k1 *emu)
1749 {
1750 	struct iommu_domain *domain;
1751 
1752 	emu->iommu_workaround = false;
1753 
1754 	domain = iommu_get_domain_for_dev(emu->card->dev);
1755 	if (!domain || domain->type == IOMMU_DOMAIN_IDENTITY)
1756 		return;
1757 
1758 	dev_notice(emu->card->dev,
1759 		   "non-passthrough IOMMU detected, widening DMA allocations");
1760 	emu->iommu_workaround = true;
1761 }
1762 
1763 int snd_emu10k1_create(struct snd_card *card,
1764 		       struct pci_dev *pci,
1765 		       unsigned short extin_mask,
1766 		       unsigned short extout_mask,
1767 		       long max_cache_bytes,
1768 		       int enable_ir,
1769 		       uint subsystem)
1770 {
1771 	struct snd_emu10k1 *emu = card->private_data;
1772 	int idx, err;
1773 	int is_audigy;
1774 	size_t page_table_size;
1775 	__le32 *pgtbl;
1776 	unsigned int silent_page;
1777 	const struct snd_emu_chip_details *c;
1778 
1779 	/* enable PCI device */
1780 	err = pcim_enable_device(pci);
1781 	if (err < 0)
1782 		return err;
1783 
1784 	card->private_free = snd_emu10k1_free;
1785 	emu->card = card;
1786 	spin_lock_init(&emu->reg_lock);
1787 	spin_lock_init(&emu->emu_lock);
1788 	spin_lock_init(&emu->spi_lock);
1789 	spin_lock_init(&emu->i2c_lock);
1790 	spin_lock_init(&emu->voice_lock);
1791 	spin_lock_init(&emu->synth_lock);
1792 	spin_lock_init(&emu->memblk_lock);
1793 	mutex_init(&emu->fx8010.lock);
1794 	INIT_LIST_HEAD(&emu->mapped_link_head);
1795 	INIT_LIST_HEAD(&emu->mapped_order_link_head);
1796 	emu->pci = pci;
1797 	emu->irq = -1;
1798 	emu->synth = NULL;
1799 	emu->get_synth_voice = NULL;
1800 	INIT_DELAYED_WORK(&emu->emu1010.firmware_work, emu1010_firmware_work);
1801 	/* read revision & serial */
1802 	emu->revision = pci->revision;
1803 	pci_read_config_dword(pci, PCI_SUBSYSTEM_VENDOR_ID, &emu->serial);
1804 	pci_read_config_word(pci, PCI_SUBSYSTEM_ID, &emu->model);
1805 	dev_dbg(card->dev,
1806 		"vendor = 0x%x, device = 0x%x, subsystem_vendor_id = 0x%x, subsystem_id = 0x%x\n",
1807 		pci->vendor, pci->device, emu->serial, emu->model);
1808 
1809 	for (c = emu_chip_details; c->vendor; c++) {
1810 		if (c->vendor == pci->vendor && c->device == pci->device) {
1811 			if (subsystem) {
1812 				if (c->subsystem && (c->subsystem == subsystem))
1813 					break;
1814 				else
1815 					continue;
1816 			} else {
1817 				if (c->subsystem && (c->subsystem != emu->serial))
1818 					continue;
1819 				if (c->revision && c->revision != emu->revision)
1820 					continue;
1821 			}
1822 			break;
1823 		}
1824 	}
1825 	if (c->vendor == 0) {
1826 		dev_err(card->dev, "emu10k1: Card not recognised\n");
1827 		return -ENOENT;
1828 	}
1829 	emu->card_capabilities = c;
1830 	if (c->subsystem && !subsystem)
1831 		dev_dbg(card->dev, "Sound card name = %s\n", c->name);
1832 	else if (subsystem)
1833 		dev_dbg(card->dev, "Sound card name = %s, "
1834 			"vendor = 0x%x, device = 0x%x, subsystem = 0x%x. "
1835 			"Forced to subsystem = 0x%x\n",	c->name,
1836 			pci->vendor, pci->device, emu->serial, c->subsystem);
1837 	else
1838 		dev_dbg(card->dev, "Sound card name = %s, "
1839 			"vendor = 0x%x, device = 0x%x, subsystem = 0x%x.\n",
1840 			c->name, pci->vendor, pci->device,
1841 			emu->serial);
1842 
1843 	if (!*card->id && c->id)
1844 		strscpy(card->id, c->id, sizeof(card->id));
1845 
1846 	is_audigy = emu->audigy = c->emu10k2_chip;
1847 
1848 	snd_emu10k1_detect_iommu(emu);
1849 
1850 	/* set addressing mode */
1851 	emu->address_mode = is_audigy ? 0 : 1;
1852 	/* set the DMA transfer mask */
1853 	emu->dma_mask = emu->address_mode ? EMU10K1_DMA_MASK : AUDIGY_DMA_MASK;
1854 	if (dma_set_mask_and_coherent(&pci->dev, emu->dma_mask) < 0) {
1855 		dev_err(card->dev,
1856 			"architecture does not support PCI busmaster DMA with mask 0x%lx\n",
1857 			emu->dma_mask);
1858 		return -ENXIO;
1859 	}
1860 	if (is_audigy)
1861 		emu->gpr_base = A_FXGPREGBASE;
1862 	else
1863 		emu->gpr_base = FXGPREGBASE;
1864 
1865 	err = pci_request_regions(pci, "EMU10K1");
1866 	if (err < 0)
1867 		return err;
1868 	emu->port = pci_resource_start(pci, 0);
1869 
1870 	emu->max_cache_pages = max_cache_bytes >> PAGE_SHIFT;
1871 
1872 	page_table_size = sizeof(u32) * (emu->address_mode ? MAXPAGES1 :
1873 					 MAXPAGES0);
1874 	if (snd_emu10k1_alloc_pages_maybe_wider(emu, page_table_size,
1875 						&emu->ptb_pages) < 0)
1876 		return -ENOMEM;
1877 	dev_dbg(card->dev, "page table address range is %.8lx:%.8lx\n",
1878 		(unsigned long)emu->ptb_pages.addr,
1879 		(unsigned long)(emu->ptb_pages.addr + emu->ptb_pages.bytes));
1880 
1881 	emu->page_ptr_table = vmalloc(array_size(sizeof(void *),
1882 						 emu->max_cache_pages));
1883 	emu->page_addr_table = vmalloc(array_size(sizeof(unsigned long),
1884 						  emu->max_cache_pages));
1885 	if (!emu->page_ptr_table || !emu->page_addr_table)
1886 		return -ENOMEM;
1887 
1888 	if (snd_emu10k1_alloc_pages_maybe_wider(emu, EMUPAGESIZE,
1889 						&emu->silent_page) < 0)
1890 		return -ENOMEM;
1891 	dev_dbg(card->dev, "silent page range is %.8lx:%.8lx\n",
1892 		(unsigned long)emu->silent_page.addr,
1893 		(unsigned long)(emu->silent_page.addr +
1894 				emu->silent_page.bytes));
1895 
1896 	emu->memhdr = snd_util_memhdr_new(emu->max_cache_pages * PAGE_SIZE);
1897 	if (!emu->memhdr)
1898 		return -ENOMEM;
1899 	emu->memhdr->block_extra_size = sizeof(struct snd_emu10k1_memblk) -
1900 		sizeof(struct snd_util_memblk);
1901 
1902 	pci_set_master(pci);
1903 
1904 	emu->fx8010.fxbus_mask = 0x303f;
1905 	if (extin_mask == 0)
1906 		extin_mask = 0x3fcf;
1907 	if (extout_mask == 0)
1908 		extout_mask = 0x7fff;
1909 	emu->fx8010.extin_mask = extin_mask;
1910 	emu->fx8010.extout_mask = extout_mask;
1911 	emu->enable_ir = enable_ir;
1912 
1913 	if (emu->card_capabilities->ca_cardbus_chip) {
1914 		err = snd_emu10k1_cardbus_init(emu);
1915 		if (err < 0)
1916 			return err;
1917 	}
1918 	if (emu->card_capabilities->ecard) {
1919 		err = snd_emu10k1_ecard_init(emu);
1920 		if (err < 0)
1921 			return err;
1922 	} else if (emu->card_capabilities->emu_model) {
1923 		err = snd_emu10k1_emu1010_init(emu);
1924 		if (err < 0)
1925 			return err;
1926 	} else {
1927 		/* 5.1: Enable the additional AC97 Slots. If the emu10k1 version
1928 			does not support this, it shouldn't do any harm */
1929 		snd_emu10k1_ptr_write(emu, AC97SLOT, 0,
1930 					AC97SLOT_CNTR|AC97SLOT_LFE);
1931 	}
1932 
1933 	/* initialize TRAM setup */
1934 	emu->fx8010.itram_size = (16 * 1024)/2;
1935 	emu->fx8010.etram_pages.area = NULL;
1936 	emu->fx8010.etram_pages.bytes = 0;
1937 
1938 	/* irq handler must be registered after I/O ports are activated */
1939 	if (devm_request_irq(&pci->dev, pci->irq, snd_emu10k1_interrupt,
1940 			     IRQF_SHARED, KBUILD_MODNAME, emu))
1941 		return -EBUSY;
1942 	emu->irq = pci->irq;
1943 	card->sync_irq = emu->irq;
1944 
1945 	/*
1946 	 *  Init to 0x02109204 :
1947 	 *  Clock accuracy    = 0     (1000ppm)
1948 	 *  Sample Rate       = 2     (48kHz)
1949 	 *  Audio Channel     = 1     (Left of 2)
1950 	 *  Source Number     = 0     (Unspecified)
1951 	 *  Generation Status = 1     (Original for Cat Code 12)
1952 	 *  Cat Code          = 12    (Digital Signal Mixer)
1953 	 *  Mode              = 0     (Mode 0)
1954 	 *  Emphasis          = 0     (None)
1955 	 *  CP                = 1     (Copyright unasserted)
1956 	 *  AN                = 0     (Audio data)
1957 	 *  P                 = 0     (Consumer)
1958 	 */
1959 	emu->spdif_bits[0] = emu->spdif_bits[1] =
1960 		emu->spdif_bits[2] = SPCS_CLKACCY_1000PPM | SPCS_SAMPLERATE_48 |
1961 		SPCS_CHANNELNUM_LEFT | SPCS_SOURCENUM_UNSPEC |
1962 		SPCS_GENERATIONSTATUS | 0x00001200 |
1963 		0x00000000 | SPCS_EMPHASIS_NONE | SPCS_COPYRIGHT;
1964 
1965 	/* Clear silent pages and set up pointers */
1966 	memset(emu->silent_page.area, 0, emu->silent_page.bytes);
1967 	silent_page = emu->silent_page.addr << emu->address_mode;
1968 	pgtbl = (__le32 *)emu->ptb_pages.area;
1969 	for (idx = 0; idx < (emu->address_mode ? MAXPAGES1 : MAXPAGES0); idx++)
1970 		pgtbl[idx] = cpu_to_le32(silent_page | idx);
1971 
1972 	/* set up voice indices */
1973 	for (idx = 0; idx < NUM_G; idx++) {
1974 		emu->voices[idx].emu = emu;
1975 		emu->voices[idx].number = idx;
1976 	}
1977 
1978 	err = snd_emu10k1_init(emu, enable_ir, 0);
1979 	if (err < 0)
1980 		return err;
1981 #ifdef CONFIG_PM_SLEEP
1982 	err = alloc_pm_buffer(emu);
1983 	if (err < 0)
1984 		return err;
1985 #endif
1986 
1987 	/*  Initialize the effect engine */
1988 	err = snd_emu10k1_init_efx(emu);
1989 	if (err < 0)
1990 		return err;
1991 	snd_emu10k1_audio_enable(emu);
1992 
1993 #ifdef CONFIG_SND_PROC_FS
1994 	snd_emu10k1_proc_init(emu);
1995 #endif
1996 	return 0;
1997 }
1998 
1999 #ifdef CONFIG_PM_SLEEP
2000 static const unsigned char saved_regs[] = {
2001 	CPF, PTRX, CVCF, VTFT, Z1, Z2, PSST, DSL, CCCA, CCR, CLP,
2002 	FXRT, MAPA, MAPB, ENVVOL, ATKHLDV, DCYSUSV, LFOVAL1, ENVVAL,
2003 	ATKHLDM, DCYSUSM, LFOVAL2, IP, IFATN, PEFE, FMMOD, TREMFRQ, FM2FRQ2,
2004 	TEMPENV, ADCCR, FXWC, MICBA, ADCBA, FXBA,
2005 	MICBS, ADCBS, FXBS, CDCS, GPSCS, SPCS0, SPCS1, SPCS2,
2006 	SPBYPASS, AC97SLOT, CDSRCS, GPSRCS, ZVSRCS, MICIDX, ADCIDX, FXIDX,
2007 	0xff /* end */
2008 };
2009 static const unsigned char saved_regs_audigy[] = {
2010 	A_ADCIDX, A_MICIDX, A_FXWC1, A_FXWC2, A_SAMPLE_RATE,
2011 	A_FXRT2, A_SENDAMOUNTS, A_FXRT1,
2012 	0xff /* end */
2013 };
2014 
2015 static int alloc_pm_buffer(struct snd_emu10k1 *emu)
2016 {
2017 	int size;
2018 
2019 	size = ARRAY_SIZE(saved_regs);
2020 	if (emu->audigy)
2021 		size += ARRAY_SIZE(saved_regs_audigy);
2022 	emu->saved_ptr = vmalloc(array3_size(4, NUM_G, size));
2023 	if (!emu->saved_ptr)
2024 		return -ENOMEM;
2025 	if (snd_emu10k1_efx_alloc_pm_buffer(emu) < 0)
2026 		return -ENOMEM;
2027 	if (emu->card_capabilities->ca0151_chip &&
2028 	    snd_p16v_alloc_pm_buffer(emu) < 0)
2029 		return -ENOMEM;
2030 	return 0;
2031 }
2032 
2033 static void free_pm_buffer(struct snd_emu10k1 *emu)
2034 {
2035 	vfree(emu->saved_ptr);
2036 	snd_emu10k1_efx_free_pm_buffer(emu);
2037 	if (emu->card_capabilities->ca0151_chip)
2038 		snd_p16v_free_pm_buffer(emu);
2039 }
2040 
2041 void snd_emu10k1_suspend_regs(struct snd_emu10k1 *emu)
2042 {
2043 	int i;
2044 	const unsigned char *reg;
2045 	unsigned int *val;
2046 
2047 	val = emu->saved_ptr;
2048 	for (reg = saved_regs; *reg != 0xff; reg++)
2049 		for (i = 0; i < NUM_G; i++, val++)
2050 			*val = snd_emu10k1_ptr_read(emu, *reg, i);
2051 	if (emu->audigy) {
2052 		for (reg = saved_regs_audigy; *reg != 0xff; reg++)
2053 			for (i = 0; i < NUM_G; i++, val++)
2054 				*val = snd_emu10k1_ptr_read(emu, *reg, i);
2055 	}
2056 	if (emu->audigy)
2057 		emu->saved_a_iocfg = inl(emu->port + A_IOCFG);
2058 	emu->saved_hcfg = inl(emu->port + HCFG);
2059 }
2060 
2061 void snd_emu10k1_resume_init(struct snd_emu10k1 *emu)
2062 {
2063 	if (emu->card_capabilities->ca_cardbus_chip)
2064 		snd_emu10k1_cardbus_init(emu);
2065 	if (emu->card_capabilities->ecard)
2066 		snd_emu10k1_ecard_init(emu);
2067 	else if (emu->card_capabilities->emu_model)
2068 		snd_emu10k1_emu1010_init(emu);
2069 	else
2070 		snd_emu10k1_ptr_write(emu, AC97SLOT, 0, AC97SLOT_CNTR|AC97SLOT_LFE);
2071 	snd_emu10k1_init(emu, emu->enable_ir, 1);
2072 }
2073 
2074 void snd_emu10k1_resume_regs(struct snd_emu10k1 *emu)
2075 {
2076 	int i;
2077 	const unsigned char *reg;
2078 	unsigned int *val;
2079 
2080 	snd_emu10k1_audio_enable(emu);
2081 
2082 	/* resore for spdif */
2083 	if (emu->audigy)
2084 		outl(emu->saved_a_iocfg, emu->port + A_IOCFG);
2085 	outl(emu->saved_hcfg, emu->port + HCFG);
2086 
2087 	val = emu->saved_ptr;
2088 	for (reg = saved_regs; *reg != 0xff; reg++)
2089 		for (i = 0; i < NUM_G; i++, val++)
2090 			snd_emu10k1_ptr_write(emu, *reg, i, *val);
2091 	if (emu->audigy) {
2092 		for (reg = saved_regs_audigy; *reg != 0xff; reg++)
2093 			for (i = 0; i < NUM_G; i++, val++)
2094 				snd_emu10k1_ptr_write(emu, *reg, i, *val);
2095 	}
2096 }
2097 #endif
2098