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