xref: /openbmc/linux/sound/pci/es1938.c (revision 22d55f02)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Driver for ESS Solo-1 (ES1938, ES1946, ES1969) soundcard
4  *  Copyright (c) by Jaromir Koutek <miri@punknet.cz>,
5  *                   Jaroslav Kysela <perex@perex.cz>,
6  *                   Thomas Sailer <sailer@ife.ee.ethz.ch>,
7  *                   Abramo Bagnara <abramo@alsa-project.org>,
8  *                   Markus Gruber <gruber@eikon.tum.de>
9  *
10  * Rewritten from sonicvibes.c source.
11  *
12  *  TODO:
13  *    Rewrite better spinlocks
14  */
15 
16 /*
17   NOTES:
18   - Capture data is written unaligned starting from dma_base + 1 so I need to
19     disable mmap and to add a copy callback.
20   - After several cycle of the following:
21     while : ; do arecord -d1 -f cd -t raw | aplay -f cd ; done
22     a "playback write error (DMA or IRQ trouble?)" may happen.
23     This is due to playback interrupts not generated.
24     I suspect a timing issue.
25   - Sometimes the interrupt handler is invoked wrongly during playback.
26     This generates some harmless "Unexpected hw_pointer: wrong interrupt
27     acknowledge".
28     I've seen that using small period sizes.
29     Reproducible with:
30     mpg123 test.mp3 &
31     hdparm -t -T /dev/hda
32 */
33 
34 
35 #include <linux/init.h>
36 #include <linux/interrupt.h>
37 #include <linux/pci.h>
38 #include <linux/slab.h>
39 #include <linux/gameport.h>
40 #include <linux/module.h>
41 #include <linux/delay.h>
42 #include <linux/dma-mapping.h>
43 #include <linux/io.h>
44 #include <sound/core.h>
45 #include <sound/control.h>
46 #include <sound/pcm.h>
47 #include <sound/opl3.h>
48 #include <sound/mpu401.h>
49 #include <sound/initval.h>
50 #include <sound/tlv.h>
51 
52 MODULE_AUTHOR("Jaromir Koutek <miri@punknet.cz>");
53 MODULE_DESCRIPTION("ESS Solo-1");
54 MODULE_LICENSE("GPL");
55 MODULE_SUPPORTED_DEVICE("{{ESS,ES1938},"
56                 "{ESS,ES1946},"
57                 "{ESS,ES1969},"
58 		"{TerraTec,128i PCI}}");
59 
60 #if IS_REACHABLE(CONFIG_GAMEPORT)
61 #define SUPPORT_JOYSTICK 1
62 #endif
63 
64 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
65 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
66 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;	/* Enable this card */
67 
68 module_param_array(index, int, NULL, 0444);
69 MODULE_PARM_DESC(index, "Index value for ESS Solo-1 soundcard.");
70 module_param_array(id, charp, NULL, 0444);
71 MODULE_PARM_DESC(id, "ID string for ESS Solo-1 soundcard.");
72 module_param_array(enable, bool, NULL, 0444);
73 MODULE_PARM_DESC(enable, "Enable ESS Solo-1 soundcard.");
74 
75 #define SLIO_REG(chip, x) ((chip)->io_port + ESSIO_REG_##x)
76 
77 #define SLDM_REG(chip, x) ((chip)->ddma_port + ESSDM_REG_##x)
78 
79 #define SLSB_REG(chip, x) ((chip)->sb_port + ESSSB_REG_##x)
80 
81 #define SL_PCI_LEGACYCONTROL		0x40
82 #define SL_PCI_CONFIG			0x50
83 #define SL_PCI_DDMACONTROL		0x60
84 
85 #define ESSIO_REG_AUDIO2DMAADDR		0
86 #define ESSIO_REG_AUDIO2DMACOUNT	4
87 #define ESSIO_REG_AUDIO2MODE		6
88 #define ESSIO_REG_IRQCONTROL		7
89 
90 #define ESSDM_REG_DMAADDR		0x00
91 #define ESSDM_REG_DMACOUNT		0x04
92 #define ESSDM_REG_DMACOMMAND		0x08
93 #define ESSDM_REG_DMASTATUS		0x08
94 #define ESSDM_REG_DMAMODE		0x0b
95 #define ESSDM_REG_DMACLEAR		0x0d
96 #define ESSDM_REG_DMAMASK		0x0f
97 
98 #define ESSSB_REG_FMLOWADDR		0x00
99 #define ESSSB_REG_FMHIGHADDR		0x02
100 #define ESSSB_REG_MIXERADDR		0x04
101 #define ESSSB_REG_MIXERDATA		0x05
102 
103 #define ESSSB_IREG_AUDIO1		0x14
104 #define ESSSB_IREG_MICMIX		0x1a
105 #define ESSSB_IREG_RECSRC		0x1c
106 #define ESSSB_IREG_MASTER		0x32
107 #define ESSSB_IREG_FM			0x36
108 #define ESSSB_IREG_AUXACD		0x38
109 #define ESSSB_IREG_AUXB			0x3a
110 #define ESSSB_IREG_PCSPEAKER		0x3c
111 #define ESSSB_IREG_LINE			0x3e
112 #define ESSSB_IREG_SPATCONTROL		0x50
113 #define ESSSB_IREG_SPATLEVEL		0x52
114 #define ESSSB_IREG_MASTER_LEFT		0x60
115 #define ESSSB_IREG_MASTER_RIGHT		0x62
116 #define ESSSB_IREG_MPU401CONTROL	0x64
117 #define ESSSB_IREG_MICMIXRECORD		0x68
118 #define ESSSB_IREG_AUDIO2RECORD		0x69
119 #define ESSSB_IREG_AUXACDRECORD		0x6a
120 #define ESSSB_IREG_FMRECORD		0x6b
121 #define ESSSB_IREG_AUXBRECORD		0x6c
122 #define ESSSB_IREG_MONO			0x6d
123 #define ESSSB_IREG_LINERECORD		0x6e
124 #define ESSSB_IREG_MONORECORD		0x6f
125 #define ESSSB_IREG_AUDIO2SAMPLE		0x70
126 #define ESSSB_IREG_AUDIO2MODE		0x71
127 #define ESSSB_IREG_AUDIO2FILTER		0x72
128 #define ESSSB_IREG_AUDIO2TCOUNTL	0x74
129 #define ESSSB_IREG_AUDIO2TCOUNTH	0x76
130 #define ESSSB_IREG_AUDIO2CONTROL1	0x78
131 #define ESSSB_IREG_AUDIO2CONTROL2	0x7a
132 #define ESSSB_IREG_AUDIO2		0x7c
133 
134 #define ESSSB_REG_RESET			0x06
135 
136 #define ESSSB_REG_READDATA		0x0a
137 #define ESSSB_REG_WRITEDATA		0x0c
138 #define ESSSB_REG_READSTATUS		0x0c
139 
140 #define ESSSB_REG_STATUS		0x0e
141 
142 #define ESS_CMD_EXTSAMPLERATE		0xa1
143 #define ESS_CMD_FILTERDIV		0xa2
144 #define ESS_CMD_DMACNTRELOADL		0xa4
145 #define ESS_CMD_DMACNTRELOADH		0xa5
146 #define ESS_CMD_ANALOGCONTROL		0xa8
147 #define ESS_CMD_IRQCONTROL		0xb1
148 #define ESS_CMD_DRQCONTROL		0xb2
149 #define ESS_CMD_RECLEVEL		0xb4
150 #define ESS_CMD_SETFORMAT		0xb6
151 #define ESS_CMD_SETFORMAT2		0xb7
152 #define ESS_CMD_DMACONTROL		0xb8
153 #define ESS_CMD_DMATYPE			0xb9
154 #define ESS_CMD_OFFSETLEFT		0xba
155 #define ESS_CMD_OFFSETRIGHT		0xbb
156 #define ESS_CMD_READREG			0xc0
157 #define ESS_CMD_ENABLEEXT		0xc6
158 #define ESS_CMD_PAUSEDMA		0xd0
159 #define ESS_CMD_ENABLEAUDIO1		0xd1
160 #define ESS_CMD_STOPAUDIO1		0xd3
161 #define ESS_CMD_AUDIO1STATUS		0xd8
162 #define ESS_CMD_CONTDMA			0xd4
163 #define ESS_CMD_TESTIRQ			0xf2
164 
165 #define ESS_RECSRC_MIC		0
166 #define ESS_RECSRC_AUXACD	2
167 #define ESS_RECSRC_AUXB		5
168 #define ESS_RECSRC_LINE		6
169 #define ESS_RECSRC_NONE		7
170 
171 #define DAC1 0x01
172 #define ADC1 0x02
173 #define DAC2 0x04
174 
175 /*
176 
177  */
178 
179 #define SAVED_REG_SIZE	32 /* max. number of registers to save */
180 
181 struct es1938 {
182 	int irq;
183 
184 	unsigned long io_port;
185 	unsigned long sb_port;
186 	unsigned long vc_port;
187 	unsigned long mpu_port;
188 	unsigned long game_port;
189 	unsigned long ddma_port;
190 
191 	unsigned char irqmask;
192 	unsigned char revision;
193 
194 	struct snd_kcontrol *hw_volume;
195 	struct snd_kcontrol *hw_switch;
196 	struct snd_kcontrol *master_volume;
197 	struct snd_kcontrol *master_switch;
198 
199 	struct pci_dev *pci;
200 	struct snd_card *card;
201 	struct snd_pcm *pcm;
202 	struct snd_pcm_substream *capture_substream;
203 	struct snd_pcm_substream *playback1_substream;
204 	struct snd_pcm_substream *playback2_substream;
205 	struct snd_rawmidi *rmidi;
206 
207 	unsigned int dma1_size;
208 	unsigned int dma2_size;
209 	unsigned int dma1_start;
210 	unsigned int dma2_start;
211 	unsigned int dma1_shift;
212 	unsigned int dma2_shift;
213 	unsigned int last_capture_dmaaddr;
214 	unsigned int active;
215 
216 	spinlock_t reg_lock;
217 	spinlock_t mixer_lock;
218         struct snd_info_entry *proc_entry;
219 
220 #ifdef SUPPORT_JOYSTICK
221 	struct gameport *gameport;
222 #endif
223 #ifdef CONFIG_PM_SLEEP
224 	unsigned char saved_regs[SAVED_REG_SIZE];
225 #endif
226 };
227 
228 static irqreturn_t snd_es1938_interrupt(int irq, void *dev_id);
229 
230 static const struct pci_device_id snd_es1938_ids[] = {
231 	{ PCI_VDEVICE(ESS, 0x1969), 0, },   /* Solo-1 */
232 	{ 0, }
233 };
234 
235 MODULE_DEVICE_TABLE(pci, snd_es1938_ids);
236 
237 #define RESET_LOOP_TIMEOUT	0x10000
238 #define WRITE_LOOP_TIMEOUT	0x10000
239 #define GET_LOOP_TIMEOUT	0x01000
240 
241 /* -----------------------------------------------------------------
242  * Write to a mixer register
243  * -----------------------------------------------------------------*/
244 static void snd_es1938_mixer_write(struct es1938 *chip, unsigned char reg, unsigned char val)
245 {
246 	unsigned long flags;
247 	spin_lock_irqsave(&chip->mixer_lock, flags);
248 	outb(reg, SLSB_REG(chip, MIXERADDR));
249 	outb(val, SLSB_REG(chip, MIXERDATA));
250 	spin_unlock_irqrestore(&chip->mixer_lock, flags);
251 	dev_dbg(chip->card->dev, "Mixer reg %02x set to %02x\n", reg, val);
252 }
253 
254 /* -----------------------------------------------------------------
255  * Read from a mixer register
256  * -----------------------------------------------------------------*/
257 static int snd_es1938_mixer_read(struct es1938 *chip, unsigned char reg)
258 {
259 	int data;
260 	unsigned long flags;
261 	spin_lock_irqsave(&chip->mixer_lock, flags);
262 	outb(reg, SLSB_REG(chip, MIXERADDR));
263 	data = inb(SLSB_REG(chip, MIXERDATA));
264 	spin_unlock_irqrestore(&chip->mixer_lock, flags);
265 	dev_dbg(chip->card->dev, "Mixer reg %02x now is %02x\n", reg, data);
266 	return data;
267 }
268 
269 /* -----------------------------------------------------------------
270  * Write to some bits of a mixer register (return old value)
271  * -----------------------------------------------------------------*/
272 static int snd_es1938_mixer_bits(struct es1938 *chip, unsigned char reg,
273 				 unsigned char mask, unsigned char val)
274 {
275 	unsigned long flags;
276 	unsigned char old, new, oval;
277 	spin_lock_irqsave(&chip->mixer_lock, flags);
278 	outb(reg, SLSB_REG(chip, MIXERADDR));
279 	old = inb(SLSB_REG(chip, MIXERDATA));
280 	oval = old & mask;
281 	if (val != oval) {
282 		new = (old & ~mask) | (val & mask);
283 		outb(new, SLSB_REG(chip, MIXERDATA));
284 		dev_dbg(chip->card->dev,
285 			"Mixer reg %02x was %02x, set to %02x\n",
286 			   reg, old, new);
287 	}
288 	spin_unlock_irqrestore(&chip->mixer_lock, flags);
289 	return oval;
290 }
291 
292 /* -----------------------------------------------------------------
293  * Write command to Controller Registers
294  * -----------------------------------------------------------------*/
295 static void snd_es1938_write_cmd(struct es1938 *chip, unsigned char cmd)
296 {
297 	int i;
298 	unsigned char v;
299 	for (i = 0; i < WRITE_LOOP_TIMEOUT; i++) {
300 		if (!(v = inb(SLSB_REG(chip, READSTATUS)) & 0x80)) {
301 			outb(cmd, SLSB_REG(chip, WRITEDATA));
302 			return;
303 		}
304 	}
305 	dev_err(chip->card->dev,
306 		"snd_es1938_write_cmd timeout (0x02%x/0x02%x)\n", cmd, v);
307 }
308 
309 /* -----------------------------------------------------------------
310  * Read the Read Data Buffer
311  * -----------------------------------------------------------------*/
312 static int snd_es1938_get_byte(struct es1938 *chip)
313 {
314 	int i;
315 	unsigned char v;
316 	for (i = GET_LOOP_TIMEOUT; i; i--)
317 		if ((v = inb(SLSB_REG(chip, STATUS))) & 0x80)
318 			return inb(SLSB_REG(chip, READDATA));
319 	dev_err(chip->card->dev, "get_byte timeout: status 0x02%x\n", v);
320 	return -ENODEV;
321 }
322 
323 /* -----------------------------------------------------------------
324  * Write value cmd register
325  * -----------------------------------------------------------------*/
326 static void snd_es1938_write(struct es1938 *chip, unsigned char reg, unsigned char val)
327 {
328 	unsigned long flags;
329 	spin_lock_irqsave(&chip->reg_lock, flags);
330 	snd_es1938_write_cmd(chip, reg);
331 	snd_es1938_write_cmd(chip, val);
332 	spin_unlock_irqrestore(&chip->reg_lock, flags);
333 	dev_dbg(chip->card->dev, "Reg %02x set to %02x\n", reg, val);
334 }
335 
336 /* -----------------------------------------------------------------
337  * Read data from cmd register and return it
338  * -----------------------------------------------------------------*/
339 static unsigned char snd_es1938_read(struct es1938 *chip, unsigned char reg)
340 {
341 	unsigned char val;
342 	unsigned long flags;
343 	spin_lock_irqsave(&chip->reg_lock, flags);
344 	snd_es1938_write_cmd(chip, ESS_CMD_READREG);
345 	snd_es1938_write_cmd(chip, reg);
346 	val = snd_es1938_get_byte(chip);
347 	spin_unlock_irqrestore(&chip->reg_lock, flags);
348 	dev_dbg(chip->card->dev, "Reg %02x now is %02x\n", reg, val);
349 	return val;
350 }
351 
352 /* -----------------------------------------------------------------
353  * Write data to cmd register and return old value
354  * -----------------------------------------------------------------*/
355 static int snd_es1938_bits(struct es1938 *chip, unsigned char reg, unsigned char mask,
356 			   unsigned char val)
357 {
358 	unsigned long flags;
359 	unsigned char old, new, oval;
360 	spin_lock_irqsave(&chip->reg_lock, flags);
361 	snd_es1938_write_cmd(chip, ESS_CMD_READREG);
362 	snd_es1938_write_cmd(chip, reg);
363 	old = snd_es1938_get_byte(chip);
364 	oval = old & mask;
365 	if (val != oval) {
366 		snd_es1938_write_cmd(chip, reg);
367 		new = (old & ~mask) | (val & mask);
368 		snd_es1938_write_cmd(chip, new);
369 		dev_dbg(chip->card->dev, "Reg %02x was %02x, set to %02x\n",
370 			   reg, old, new);
371 	}
372 	spin_unlock_irqrestore(&chip->reg_lock, flags);
373 	return oval;
374 }
375 
376 /* --------------------------------------------------------------------
377  * Reset the chip
378  * --------------------------------------------------------------------*/
379 static void snd_es1938_reset(struct es1938 *chip)
380 {
381 	int i;
382 
383 	outb(3, SLSB_REG(chip, RESET));
384 	inb(SLSB_REG(chip, RESET));
385 	outb(0, SLSB_REG(chip, RESET));
386 	for (i = 0; i < RESET_LOOP_TIMEOUT; i++) {
387 		if (inb(SLSB_REG(chip, STATUS)) & 0x80) {
388 			if (inb(SLSB_REG(chip, READDATA)) == 0xaa)
389 				goto __next;
390 		}
391 	}
392 	dev_err(chip->card->dev, "ESS Solo-1 reset failed\n");
393 
394      __next:
395 	snd_es1938_write_cmd(chip, ESS_CMD_ENABLEEXT);
396 
397 	/* Demand transfer DMA: 4 bytes per DMA request */
398 	snd_es1938_write(chip, ESS_CMD_DMATYPE, 2);
399 
400 	/* Change behaviour of register A1
401 	   4x oversampling
402 	   2nd channel DAC asynchronous */
403 	snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2MODE, 0x32);
404 	/* enable/select DMA channel and IRQ channel */
405 	snd_es1938_bits(chip, ESS_CMD_IRQCONTROL, 0xf0, 0x50);
406 	snd_es1938_bits(chip, ESS_CMD_DRQCONTROL, 0xf0, 0x50);
407 	snd_es1938_write_cmd(chip, ESS_CMD_ENABLEAUDIO1);
408 	/* Set spatializer parameters to recommended values */
409 	snd_es1938_mixer_write(chip, 0x54, 0x8f);
410 	snd_es1938_mixer_write(chip, 0x56, 0x95);
411 	snd_es1938_mixer_write(chip, 0x58, 0x94);
412 	snd_es1938_mixer_write(chip, 0x5a, 0x80);
413 }
414 
415 /* --------------------------------------------------------------------
416  * Reset the FIFOs
417  * --------------------------------------------------------------------*/
418 static void snd_es1938_reset_fifo(struct es1938 *chip)
419 {
420 	outb(2, SLSB_REG(chip, RESET));
421 	outb(0, SLSB_REG(chip, RESET));
422 }
423 
424 static const struct snd_ratnum clocks[2] = {
425 	{
426 		.num = 793800,
427 		.den_min = 1,
428 		.den_max = 128,
429 		.den_step = 1,
430 	},
431 	{
432 		.num = 768000,
433 		.den_min = 1,
434 		.den_max = 128,
435 		.den_step = 1,
436 	}
437 };
438 
439 static const struct snd_pcm_hw_constraint_ratnums hw_constraints_clocks = {
440 	.nrats = 2,
441 	.rats = clocks,
442 };
443 
444 
445 static void snd_es1938_rate_set(struct es1938 *chip,
446 				struct snd_pcm_substream *substream,
447 				int mode)
448 {
449 	unsigned int bits, div0;
450 	struct snd_pcm_runtime *runtime = substream->runtime;
451 	if (runtime->rate_num == clocks[0].num)
452 		bits = 128 - runtime->rate_den;
453 	else
454 		bits = 256 - runtime->rate_den;
455 
456 	/* set filter register */
457 	div0 = 256 - 7160000*20/(8*82*runtime->rate);
458 
459 	if (mode == DAC2) {
460 		snd_es1938_mixer_write(chip, 0x70, bits);
461 		snd_es1938_mixer_write(chip, 0x72, div0);
462 	} else {
463 		snd_es1938_write(chip, 0xA1, bits);
464 		snd_es1938_write(chip, 0xA2, div0);
465 	}
466 }
467 
468 /* --------------------------------------------------------------------
469  * Configure Solo1 builtin DMA Controller
470  * --------------------------------------------------------------------*/
471 
472 static void snd_es1938_playback1_setdma(struct es1938 *chip)
473 {
474 	outb(0x00, SLIO_REG(chip, AUDIO2MODE));
475 	outl(chip->dma2_start, SLIO_REG(chip, AUDIO2DMAADDR));
476 	outw(0, SLIO_REG(chip, AUDIO2DMACOUNT));
477 	outw(chip->dma2_size, SLIO_REG(chip, AUDIO2DMACOUNT));
478 }
479 
480 static void snd_es1938_playback2_setdma(struct es1938 *chip)
481 {
482 	/* Enable DMA controller */
483 	outb(0xc4, SLDM_REG(chip, DMACOMMAND));
484 	/* 1. Master reset */
485 	outb(0, SLDM_REG(chip, DMACLEAR));
486 	/* 2. Mask DMA */
487 	outb(1, SLDM_REG(chip, DMAMASK));
488 	outb(0x18, SLDM_REG(chip, DMAMODE));
489 	outl(chip->dma1_start, SLDM_REG(chip, DMAADDR));
490 	outw(chip->dma1_size - 1, SLDM_REG(chip, DMACOUNT));
491 	/* 3. Unmask DMA */
492 	outb(0, SLDM_REG(chip, DMAMASK));
493 }
494 
495 static void snd_es1938_capture_setdma(struct es1938 *chip)
496 {
497 	/* Enable DMA controller */
498 	outb(0xc4, SLDM_REG(chip, DMACOMMAND));
499 	/* 1. Master reset */
500 	outb(0, SLDM_REG(chip, DMACLEAR));
501 	/* 2. Mask DMA */
502 	outb(1, SLDM_REG(chip, DMAMASK));
503 	outb(0x14, SLDM_REG(chip, DMAMODE));
504 	outl(chip->dma1_start, SLDM_REG(chip, DMAADDR));
505 	chip->last_capture_dmaaddr = chip->dma1_start;
506 	outw(chip->dma1_size - 1, SLDM_REG(chip, DMACOUNT));
507 	/* 3. Unmask DMA */
508 	outb(0, SLDM_REG(chip, DMAMASK));
509 }
510 
511 /* ----------------------------------------------------------------------
512  *
513  *                           *** PCM part ***
514  */
515 
516 static int snd_es1938_capture_trigger(struct snd_pcm_substream *substream,
517 				      int cmd)
518 {
519 	struct es1938 *chip = snd_pcm_substream_chip(substream);
520 	int val;
521 	switch (cmd) {
522 	case SNDRV_PCM_TRIGGER_START:
523 	case SNDRV_PCM_TRIGGER_RESUME:
524 		val = 0x0f;
525 		chip->active |= ADC1;
526 		break;
527 	case SNDRV_PCM_TRIGGER_STOP:
528 	case SNDRV_PCM_TRIGGER_SUSPEND:
529 		val = 0x00;
530 		chip->active &= ~ADC1;
531 		break;
532 	default:
533 		return -EINVAL;
534 	}
535 	snd_es1938_write(chip, ESS_CMD_DMACONTROL, val);
536 	return 0;
537 }
538 
539 static int snd_es1938_playback1_trigger(struct snd_pcm_substream *substream,
540 					int cmd)
541 {
542 	struct es1938 *chip = snd_pcm_substream_chip(substream);
543 	switch (cmd) {
544 	case SNDRV_PCM_TRIGGER_START:
545 	case SNDRV_PCM_TRIGGER_RESUME:
546 		/* According to the documentation this should be:
547 		   0x13 but that value may randomly swap stereo channels */
548                 snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2CONTROL1, 0x92);
549                 udelay(10);
550 		snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2CONTROL1, 0x93);
551                 /* This two stage init gives the FIFO -> DAC connection time to
552                  * settle before first data from DMA flows in.  This should ensure
553                  * no swapping of stereo channels.  Report a bug if otherwise :-) */
554 		outb(0x0a, SLIO_REG(chip, AUDIO2MODE));
555 		chip->active |= DAC2;
556 		break;
557 	case SNDRV_PCM_TRIGGER_STOP:
558 	case SNDRV_PCM_TRIGGER_SUSPEND:
559 		outb(0, SLIO_REG(chip, AUDIO2MODE));
560 		snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2CONTROL1, 0);
561 		chip->active &= ~DAC2;
562 		break;
563 	default:
564 		return -EINVAL;
565 	}
566 	return 0;
567 }
568 
569 static int snd_es1938_playback2_trigger(struct snd_pcm_substream *substream,
570 					int cmd)
571 {
572 	struct es1938 *chip = snd_pcm_substream_chip(substream);
573 	int val;
574 	switch (cmd) {
575 	case SNDRV_PCM_TRIGGER_START:
576 	case SNDRV_PCM_TRIGGER_RESUME:
577 		val = 5;
578 		chip->active |= DAC1;
579 		break;
580 	case SNDRV_PCM_TRIGGER_STOP:
581 	case SNDRV_PCM_TRIGGER_SUSPEND:
582 		val = 0;
583 		chip->active &= ~DAC1;
584 		break;
585 	default:
586 		return -EINVAL;
587 	}
588 	snd_es1938_write(chip, ESS_CMD_DMACONTROL, val);
589 	return 0;
590 }
591 
592 static int snd_es1938_playback_trigger(struct snd_pcm_substream *substream,
593 				       int cmd)
594 {
595 	switch (substream->number) {
596 	case 0:
597 		return snd_es1938_playback1_trigger(substream, cmd);
598 	case 1:
599 		return snd_es1938_playback2_trigger(substream, cmd);
600 	}
601 	snd_BUG();
602 	return -EINVAL;
603 }
604 
605 /* --------------------------------------------------------------------
606  * First channel for Extended Mode Audio 1 ADC Operation
607  * --------------------------------------------------------------------*/
608 static int snd_es1938_capture_prepare(struct snd_pcm_substream *substream)
609 {
610 	struct es1938 *chip = snd_pcm_substream_chip(substream);
611 	struct snd_pcm_runtime *runtime = substream->runtime;
612 	int u, is8, mono;
613 	unsigned int size = snd_pcm_lib_buffer_bytes(substream);
614 	unsigned int count = snd_pcm_lib_period_bytes(substream);
615 
616 	chip->dma1_size = size;
617 	chip->dma1_start = runtime->dma_addr;
618 
619 	mono = (runtime->channels > 1) ? 0 : 1;
620 	is8 = snd_pcm_format_width(runtime->format) == 16 ? 0 : 1;
621 	u = snd_pcm_format_unsigned(runtime->format);
622 
623 	chip->dma1_shift = 2 - mono - is8;
624 
625 	snd_es1938_reset_fifo(chip);
626 
627 	/* program type */
628 	snd_es1938_bits(chip, ESS_CMD_ANALOGCONTROL, 0x03, (mono ? 2 : 1));
629 
630 	/* set clock and counters */
631         snd_es1938_rate_set(chip, substream, ADC1);
632 
633 	count = 0x10000 - count;
634 	snd_es1938_write(chip, ESS_CMD_DMACNTRELOADL, count & 0xff);
635 	snd_es1938_write(chip, ESS_CMD_DMACNTRELOADH, count >> 8);
636 
637 	/* initialize and configure ADC */
638 	snd_es1938_write(chip, ESS_CMD_SETFORMAT2, u ? 0x51 : 0x71);
639 	snd_es1938_write(chip, ESS_CMD_SETFORMAT2, 0x90 |
640 		       (u ? 0x00 : 0x20) |
641 		       (is8 ? 0x00 : 0x04) |
642 		       (mono ? 0x40 : 0x08));
643 
644 	//	snd_es1938_reset_fifo(chip);
645 
646 	/* 11. configure system interrupt controller and DMA controller */
647 	snd_es1938_capture_setdma(chip);
648 
649 	return 0;
650 }
651 
652 
653 /* ------------------------------------------------------------------------------
654  * Second Audio channel DAC Operation
655  * ------------------------------------------------------------------------------*/
656 static int snd_es1938_playback1_prepare(struct snd_pcm_substream *substream)
657 {
658 	struct es1938 *chip = snd_pcm_substream_chip(substream);
659 	struct snd_pcm_runtime *runtime = substream->runtime;
660 	int u, is8, mono;
661 	unsigned int size = snd_pcm_lib_buffer_bytes(substream);
662 	unsigned int count = snd_pcm_lib_period_bytes(substream);
663 
664 	chip->dma2_size = size;
665 	chip->dma2_start = runtime->dma_addr;
666 
667 	mono = (runtime->channels > 1) ? 0 : 1;
668 	is8 = snd_pcm_format_width(runtime->format) == 16 ? 0 : 1;
669 	u = snd_pcm_format_unsigned(runtime->format);
670 
671 	chip->dma2_shift = 2 - mono - is8;
672 
673         snd_es1938_reset_fifo(chip);
674 
675 	/* set clock and counters */
676         snd_es1938_rate_set(chip, substream, DAC2);
677 
678 	count >>= 1;
679 	count = 0x10000 - count;
680 	snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2TCOUNTL, count & 0xff);
681 	snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2TCOUNTH, count >> 8);
682 
683 	/* initialize and configure Audio 2 DAC */
684 	snd_es1938_mixer_write(chip, ESSSB_IREG_AUDIO2CONTROL2, 0x40 | (u ? 0 : 4) |
685 			       (mono ? 0 : 2) | (is8 ? 0 : 1));
686 
687 	/* program DMA */
688 	snd_es1938_playback1_setdma(chip);
689 
690 	return 0;
691 }
692 
693 static int snd_es1938_playback2_prepare(struct snd_pcm_substream *substream)
694 {
695 	struct es1938 *chip = snd_pcm_substream_chip(substream);
696 	struct snd_pcm_runtime *runtime = substream->runtime;
697 	int u, is8, mono;
698 	unsigned int size = snd_pcm_lib_buffer_bytes(substream);
699 	unsigned int count = snd_pcm_lib_period_bytes(substream);
700 
701 	chip->dma1_size = size;
702 	chip->dma1_start = runtime->dma_addr;
703 
704 	mono = (runtime->channels > 1) ? 0 : 1;
705 	is8 = snd_pcm_format_width(runtime->format) == 16 ? 0 : 1;
706 	u = snd_pcm_format_unsigned(runtime->format);
707 
708 	chip->dma1_shift = 2 - mono - is8;
709 
710 	count = 0x10000 - count;
711 
712 	/* reset */
713 	snd_es1938_reset_fifo(chip);
714 
715 	snd_es1938_bits(chip, ESS_CMD_ANALOGCONTROL, 0x03, (mono ? 2 : 1));
716 
717 	/* set clock and counters */
718         snd_es1938_rate_set(chip, substream, DAC1);
719 	snd_es1938_write(chip, ESS_CMD_DMACNTRELOADL, count & 0xff);
720 	snd_es1938_write(chip, ESS_CMD_DMACNTRELOADH, count >> 8);
721 
722 	/* initialized and configure DAC */
723         snd_es1938_write(chip, ESS_CMD_SETFORMAT, u ? 0x80 : 0x00);
724         snd_es1938_write(chip, ESS_CMD_SETFORMAT, u ? 0x51 : 0x71);
725         snd_es1938_write(chip, ESS_CMD_SETFORMAT2,
726 			 0x90 | (mono ? 0x40 : 0x08) |
727 			 (is8 ? 0x00 : 0x04) | (u ? 0x00 : 0x20));
728 
729 	/* program DMA */
730 	snd_es1938_playback2_setdma(chip);
731 
732 	return 0;
733 }
734 
735 static int snd_es1938_playback_prepare(struct snd_pcm_substream *substream)
736 {
737 	switch (substream->number) {
738 	case 0:
739 		return snd_es1938_playback1_prepare(substream);
740 	case 1:
741 		return snd_es1938_playback2_prepare(substream);
742 	}
743 	snd_BUG();
744 	return -EINVAL;
745 }
746 
747 /* during the incrementing of dma counters the DMA register reads sometimes
748    returns garbage. To ensure a valid hw pointer, the following checks which
749    should be very unlikely to fail are used:
750    - is the current DMA address in the valid DMA range ?
751    - is the sum of DMA address and DMA counter pointing to the last DMA byte ?
752    One can argue this could differ by one byte depending on which register is
753    updated first, so the implementation below allows for that.
754 */
755 static snd_pcm_uframes_t snd_es1938_capture_pointer(struct snd_pcm_substream *substream)
756 {
757 	struct es1938 *chip = snd_pcm_substream_chip(substream);
758 	size_t ptr;
759 #if 0
760 	size_t old, new;
761 	/* This stuff is *needed*, don't ask why - AB */
762 	old = inw(SLDM_REG(chip, DMACOUNT));
763 	while ((new = inw(SLDM_REG(chip, DMACOUNT))) != old)
764 		old = new;
765 	ptr = chip->dma1_size - 1 - new;
766 #else
767 	size_t count;
768 	unsigned int diff;
769 
770 	ptr = inl(SLDM_REG(chip, DMAADDR));
771 	count = inw(SLDM_REG(chip, DMACOUNT));
772 	diff = chip->dma1_start + chip->dma1_size - ptr - count;
773 
774 	if (diff > 3 || ptr < chip->dma1_start
775 	      || ptr >= chip->dma1_start+chip->dma1_size)
776 	  ptr = chip->last_capture_dmaaddr;            /* bad, use last saved */
777 	else
778 	  chip->last_capture_dmaaddr = ptr;            /* good, remember it */
779 
780 	ptr -= chip->dma1_start;
781 #endif
782 	return ptr >> chip->dma1_shift;
783 }
784 
785 static snd_pcm_uframes_t snd_es1938_playback1_pointer(struct snd_pcm_substream *substream)
786 {
787 	struct es1938 *chip = snd_pcm_substream_chip(substream);
788 	size_t ptr;
789 #if 1
790 	ptr = chip->dma2_size - inw(SLIO_REG(chip, AUDIO2DMACOUNT));
791 #else
792 	ptr = inl(SLIO_REG(chip, AUDIO2DMAADDR)) - chip->dma2_start;
793 #endif
794 	return ptr >> chip->dma2_shift;
795 }
796 
797 static snd_pcm_uframes_t snd_es1938_playback2_pointer(struct snd_pcm_substream *substream)
798 {
799 	struct es1938 *chip = snd_pcm_substream_chip(substream);
800 	size_t ptr;
801 	size_t old, new;
802 #if 1
803 	/* This stuff is *needed*, don't ask why - AB */
804 	old = inw(SLDM_REG(chip, DMACOUNT));
805 	while ((new = inw(SLDM_REG(chip, DMACOUNT))) != old)
806 		old = new;
807 	ptr = chip->dma1_size - 1 - new;
808 #else
809 	ptr = inl(SLDM_REG(chip, DMAADDR)) - chip->dma1_start;
810 #endif
811 	return ptr >> chip->dma1_shift;
812 }
813 
814 static snd_pcm_uframes_t snd_es1938_playback_pointer(struct snd_pcm_substream *substream)
815 {
816 	switch (substream->number) {
817 	case 0:
818 		return snd_es1938_playback1_pointer(substream);
819 	case 1:
820 		return snd_es1938_playback2_pointer(substream);
821 	}
822 	snd_BUG();
823 	return -EINVAL;
824 }
825 
826 static int snd_es1938_capture_copy(struct snd_pcm_substream *substream,
827 				   int channel, unsigned long pos,
828 				   void __user *dst, unsigned long count)
829 {
830 	struct snd_pcm_runtime *runtime = substream->runtime;
831 	struct es1938 *chip = snd_pcm_substream_chip(substream);
832 
833 	if (snd_BUG_ON(pos + count > chip->dma1_size))
834 		return -EINVAL;
835 	if (pos + count < chip->dma1_size) {
836 		if (copy_to_user(dst, runtime->dma_area + pos + 1, count))
837 			return -EFAULT;
838 	} else {
839 		if (copy_to_user(dst, runtime->dma_area + pos + 1, count - 1))
840 			return -EFAULT;
841 		if (put_user(runtime->dma_area[0],
842 			     ((unsigned char __user *)dst) + count - 1))
843 			return -EFAULT;
844 	}
845 	return 0;
846 }
847 
848 static int snd_es1938_capture_copy_kernel(struct snd_pcm_substream *substream,
849 					  int channel, unsigned long pos,
850 					  void *dst, unsigned long count)
851 {
852 	struct snd_pcm_runtime *runtime = substream->runtime;
853 	struct es1938 *chip = snd_pcm_substream_chip(substream);
854 
855 	if (snd_BUG_ON(pos + count > chip->dma1_size))
856 		return -EINVAL;
857 	if (pos + count < chip->dma1_size) {
858 		memcpy(dst, runtime->dma_area + pos + 1, count);
859 	} else {
860 		memcpy(dst, runtime->dma_area + pos + 1, count - 1);
861 		runtime->dma_area[0] = *((unsigned char *)dst + count - 1);
862 	}
863 	return 0;
864 }
865 
866 /*
867  * buffer management
868  */
869 static int snd_es1938_pcm_hw_params(struct snd_pcm_substream *substream,
870 				    struct snd_pcm_hw_params *hw_params)
871 
872 {
873 	int err;
874 
875 	if ((err = snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params))) < 0)
876 		return err;
877 	return 0;
878 }
879 
880 static int snd_es1938_pcm_hw_free(struct snd_pcm_substream *substream)
881 {
882 	return snd_pcm_lib_free_pages(substream);
883 }
884 
885 /* ----------------------------------------------------------------------
886  * Audio1 Capture (ADC)
887  * ----------------------------------------------------------------------*/
888 static const struct snd_pcm_hardware snd_es1938_capture =
889 {
890 	.info =			(SNDRV_PCM_INFO_INTERLEAVED |
891 				SNDRV_PCM_INFO_BLOCK_TRANSFER),
892 	.formats =		(SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE |
893 				 SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_U16_LE),
894 	.rates =		SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
895 	.rate_min =		6000,
896 	.rate_max =		48000,
897 	.channels_min =		1,
898 	.channels_max =		2,
899         .buffer_bytes_max =	0x8000,       /* DMA controller screws on higher values */
900 	.period_bytes_min =	64,
901 	.period_bytes_max =	0x8000,
902 	.periods_min =		1,
903 	.periods_max =		1024,
904 	.fifo_size =		256,
905 };
906 
907 /* -----------------------------------------------------------------------
908  * Audio2 Playback (DAC)
909  * -----------------------------------------------------------------------*/
910 static const struct snd_pcm_hardware snd_es1938_playback =
911 {
912 	.info =			(SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
913 				 SNDRV_PCM_INFO_BLOCK_TRANSFER |
914 				 SNDRV_PCM_INFO_MMAP_VALID),
915 	.formats =		(SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE |
916 				 SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_U16_LE),
917 	.rates =		SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
918 	.rate_min =		6000,
919 	.rate_max =		48000,
920 	.channels_min =		1,
921 	.channels_max =		2,
922         .buffer_bytes_max =	0x8000,       /* DMA controller screws on higher values */
923 	.period_bytes_min =	64,
924 	.period_bytes_max =	0x8000,
925 	.periods_min =		1,
926 	.periods_max =		1024,
927 	.fifo_size =		256,
928 };
929 
930 static int snd_es1938_capture_open(struct snd_pcm_substream *substream)
931 {
932 	struct es1938 *chip = snd_pcm_substream_chip(substream);
933 	struct snd_pcm_runtime *runtime = substream->runtime;
934 
935 	if (chip->playback2_substream)
936 		return -EAGAIN;
937 	chip->capture_substream = substream;
938 	runtime->hw = snd_es1938_capture;
939 	snd_pcm_hw_constraint_ratnums(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
940 				      &hw_constraints_clocks);
941 	snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, 0xff00);
942 	return 0;
943 }
944 
945 static int snd_es1938_playback_open(struct snd_pcm_substream *substream)
946 {
947 	struct es1938 *chip = snd_pcm_substream_chip(substream);
948 	struct snd_pcm_runtime *runtime = substream->runtime;
949 
950 	switch (substream->number) {
951 	case 0:
952 		chip->playback1_substream = substream;
953 		break;
954 	case 1:
955 		if (chip->capture_substream)
956 			return -EAGAIN;
957 		chip->playback2_substream = substream;
958 		break;
959 	default:
960 		snd_BUG();
961 		return -EINVAL;
962 	}
963 	runtime->hw = snd_es1938_playback;
964 	snd_pcm_hw_constraint_ratnums(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
965 				      &hw_constraints_clocks);
966 	snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, 0xff00);
967 	return 0;
968 }
969 
970 static int snd_es1938_capture_close(struct snd_pcm_substream *substream)
971 {
972 	struct es1938 *chip = snd_pcm_substream_chip(substream);
973 
974 	chip->capture_substream = NULL;
975 	return 0;
976 }
977 
978 static int snd_es1938_playback_close(struct snd_pcm_substream *substream)
979 {
980 	struct es1938 *chip = snd_pcm_substream_chip(substream);
981 
982 	switch (substream->number) {
983 	case 0:
984 		chip->playback1_substream = NULL;
985 		break;
986 	case 1:
987 		chip->playback2_substream = NULL;
988 		break;
989 	default:
990 		snd_BUG();
991 		return -EINVAL;
992 	}
993 	return 0;
994 }
995 
996 static const struct snd_pcm_ops snd_es1938_playback_ops = {
997 	.open =		snd_es1938_playback_open,
998 	.close =	snd_es1938_playback_close,
999 	.ioctl =	snd_pcm_lib_ioctl,
1000 	.hw_params =	snd_es1938_pcm_hw_params,
1001 	.hw_free =	snd_es1938_pcm_hw_free,
1002 	.prepare =	snd_es1938_playback_prepare,
1003 	.trigger =	snd_es1938_playback_trigger,
1004 	.pointer =	snd_es1938_playback_pointer,
1005 };
1006 
1007 static const struct snd_pcm_ops snd_es1938_capture_ops = {
1008 	.open =		snd_es1938_capture_open,
1009 	.close =	snd_es1938_capture_close,
1010 	.ioctl =	snd_pcm_lib_ioctl,
1011 	.hw_params =	snd_es1938_pcm_hw_params,
1012 	.hw_free =	snd_es1938_pcm_hw_free,
1013 	.prepare =	snd_es1938_capture_prepare,
1014 	.trigger =	snd_es1938_capture_trigger,
1015 	.pointer =	snd_es1938_capture_pointer,
1016 	.copy_user =	snd_es1938_capture_copy,
1017 	.copy_kernel =	snd_es1938_capture_copy_kernel,
1018 };
1019 
1020 static int snd_es1938_new_pcm(struct es1938 *chip, int device)
1021 {
1022 	struct snd_pcm *pcm;
1023 	int err;
1024 
1025 	if ((err = snd_pcm_new(chip->card, "es-1938-1946", device, 2, 1, &pcm)) < 0)
1026 		return err;
1027 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_es1938_playback_ops);
1028 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_es1938_capture_ops);
1029 
1030 	pcm->private_data = chip;
1031 	pcm->info_flags = 0;
1032 	strcpy(pcm->name, "ESS Solo-1");
1033 
1034 	snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV,
1035 					      snd_dma_pci_data(chip->pci), 64*1024, 64*1024);
1036 
1037 	chip->pcm = pcm;
1038 	return 0;
1039 }
1040 
1041 /* -------------------------------------------------------------------
1042  *
1043  *                       *** Mixer part ***
1044  */
1045 
1046 static int snd_es1938_info_mux(struct snd_kcontrol *kcontrol,
1047 			       struct snd_ctl_elem_info *uinfo)
1048 {
1049 	static const char * const texts[8] = {
1050 		"Mic", "Mic Master", "CD", "AOUT",
1051 		"Mic1", "Mix", "Line", "Master"
1052 	};
1053 
1054 	return snd_ctl_enum_info(uinfo, 1, 8, texts);
1055 }
1056 
1057 static int snd_es1938_get_mux(struct snd_kcontrol *kcontrol,
1058 			      struct snd_ctl_elem_value *ucontrol)
1059 {
1060 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1061 	ucontrol->value.enumerated.item[0] = snd_es1938_mixer_read(chip, 0x1c) & 0x07;
1062 	return 0;
1063 }
1064 
1065 static int snd_es1938_put_mux(struct snd_kcontrol *kcontrol,
1066 			      struct snd_ctl_elem_value *ucontrol)
1067 {
1068 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1069 	unsigned char val = ucontrol->value.enumerated.item[0];
1070 
1071 	if (val > 7)
1072 		return -EINVAL;
1073 	return snd_es1938_mixer_bits(chip, 0x1c, 0x07, val) != val;
1074 }
1075 
1076 #define snd_es1938_info_spatializer_enable	snd_ctl_boolean_mono_info
1077 
1078 static int snd_es1938_get_spatializer_enable(struct snd_kcontrol *kcontrol,
1079 					     struct snd_ctl_elem_value *ucontrol)
1080 {
1081 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1082 	unsigned char val = snd_es1938_mixer_read(chip, 0x50);
1083 	ucontrol->value.integer.value[0] = !!(val & 8);
1084 	return 0;
1085 }
1086 
1087 static int snd_es1938_put_spatializer_enable(struct snd_kcontrol *kcontrol,
1088 					     struct snd_ctl_elem_value *ucontrol)
1089 {
1090 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1091 	unsigned char oval, nval;
1092 	int change;
1093 	nval = ucontrol->value.integer.value[0] ? 0x0c : 0x04;
1094 	oval = snd_es1938_mixer_read(chip, 0x50) & 0x0c;
1095 	change = nval != oval;
1096 	if (change) {
1097 		snd_es1938_mixer_write(chip, 0x50, nval & ~0x04);
1098 		snd_es1938_mixer_write(chip, 0x50, nval);
1099 	}
1100 	return change;
1101 }
1102 
1103 static int snd_es1938_info_hw_volume(struct snd_kcontrol *kcontrol,
1104 				     struct snd_ctl_elem_info *uinfo)
1105 {
1106 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1107 	uinfo->count = 2;
1108 	uinfo->value.integer.min = 0;
1109 	uinfo->value.integer.max = 63;
1110 	return 0;
1111 }
1112 
1113 static int snd_es1938_get_hw_volume(struct snd_kcontrol *kcontrol,
1114 				    struct snd_ctl_elem_value *ucontrol)
1115 {
1116 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1117 	ucontrol->value.integer.value[0] = snd_es1938_mixer_read(chip, 0x61) & 0x3f;
1118 	ucontrol->value.integer.value[1] = snd_es1938_mixer_read(chip, 0x63) & 0x3f;
1119 	return 0;
1120 }
1121 
1122 #define snd_es1938_info_hw_switch		snd_ctl_boolean_stereo_info
1123 
1124 static int snd_es1938_get_hw_switch(struct snd_kcontrol *kcontrol,
1125 				    struct snd_ctl_elem_value *ucontrol)
1126 {
1127 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1128 	ucontrol->value.integer.value[0] = !(snd_es1938_mixer_read(chip, 0x61) & 0x40);
1129 	ucontrol->value.integer.value[1] = !(snd_es1938_mixer_read(chip, 0x63) & 0x40);
1130 	return 0;
1131 }
1132 
1133 static void snd_es1938_hwv_free(struct snd_kcontrol *kcontrol)
1134 {
1135 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1136 	chip->master_volume = NULL;
1137 	chip->master_switch = NULL;
1138 	chip->hw_volume = NULL;
1139 	chip->hw_switch = NULL;
1140 }
1141 
1142 static int snd_es1938_reg_bits(struct es1938 *chip, unsigned char reg,
1143 			       unsigned char mask, unsigned char val)
1144 {
1145 	if (reg < 0xa0)
1146 		return snd_es1938_mixer_bits(chip, reg, mask, val);
1147 	else
1148 		return snd_es1938_bits(chip, reg, mask, val);
1149 }
1150 
1151 static int snd_es1938_reg_read(struct es1938 *chip, unsigned char reg)
1152 {
1153 	if (reg < 0xa0)
1154 		return snd_es1938_mixer_read(chip, reg);
1155 	else
1156 		return snd_es1938_read(chip, reg);
1157 }
1158 
1159 #define ES1938_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv)    \
1160 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
1161   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ,\
1162   .name = xname, .index = xindex, \
1163   .info = snd_es1938_info_single, \
1164   .get = snd_es1938_get_single, .put = snd_es1938_put_single, \
1165   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
1166   .tlv = { .p = xtlv } }
1167 #define ES1938_SINGLE(xname, xindex, reg, shift, mask, invert) \
1168 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
1169   .info = snd_es1938_info_single, \
1170   .get = snd_es1938_get_single, .put = snd_es1938_put_single, \
1171   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
1172 
1173 static int snd_es1938_info_single(struct snd_kcontrol *kcontrol,
1174 				  struct snd_ctl_elem_info *uinfo)
1175 {
1176 	int mask = (kcontrol->private_value >> 16) & 0xff;
1177 
1178 	uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
1179 	uinfo->count = 1;
1180 	uinfo->value.integer.min = 0;
1181 	uinfo->value.integer.max = mask;
1182 	return 0;
1183 }
1184 
1185 static int snd_es1938_get_single(struct snd_kcontrol *kcontrol,
1186 				 struct snd_ctl_elem_value *ucontrol)
1187 {
1188 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1189 	int reg = kcontrol->private_value & 0xff;
1190 	int shift = (kcontrol->private_value >> 8) & 0xff;
1191 	int mask = (kcontrol->private_value >> 16) & 0xff;
1192 	int invert = (kcontrol->private_value >> 24) & 0xff;
1193 	int val;
1194 
1195 	val = snd_es1938_reg_read(chip, reg);
1196 	ucontrol->value.integer.value[0] = (val >> shift) & mask;
1197 	if (invert)
1198 		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
1199 	return 0;
1200 }
1201 
1202 static int snd_es1938_put_single(struct snd_kcontrol *kcontrol,
1203 				 struct snd_ctl_elem_value *ucontrol)
1204 {
1205 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1206 	int reg = kcontrol->private_value & 0xff;
1207 	int shift = (kcontrol->private_value >> 8) & 0xff;
1208 	int mask = (kcontrol->private_value >> 16) & 0xff;
1209 	int invert = (kcontrol->private_value >> 24) & 0xff;
1210 	unsigned char val;
1211 
1212 	val = (ucontrol->value.integer.value[0] & mask);
1213 	if (invert)
1214 		val = mask - val;
1215 	mask <<= shift;
1216 	val <<= shift;
1217 	return snd_es1938_reg_bits(chip, reg, mask, val) != val;
1218 }
1219 
1220 #define ES1938_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
1221 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
1222   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ,\
1223   .name = xname, .index = xindex, \
1224   .info = snd_es1938_info_double, \
1225   .get = snd_es1938_get_double, .put = snd_es1938_put_double, \
1226   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
1227   .tlv = { .p = xtlv } }
1228 #define ES1938_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
1229 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
1230   .info = snd_es1938_info_double, \
1231   .get = snd_es1938_get_double, .put = snd_es1938_put_double, \
1232   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
1233 
1234 static int snd_es1938_info_double(struct snd_kcontrol *kcontrol,
1235 				  struct snd_ctl_elem_info *uinfo)
1236 {
1237 	int mask = (kcontrol->private_value >> 24) & 0xff;
1238 
1239 	uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
1240 	uinfo->count = 2;
1241 	uinfo->value.integer.min = 0;
1242 	uinfo->value.integer.max = mask;
1243 	return 0;
1244 }
1245 
1246 static int snd_es1938_get_double(struct snd_kcontrol *kcontrol,
1247 				 struct snd_ctl_elem_value *ucontrol)
1248 {
1249 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1250 	int left_reg = kcontrol->private_value & 0xff;
1251 	int right_reg = (kcontrol->private_value >> 8) & 0xff;
1252 	int shift_left = (kcontrol->private_value >> 16) & 0x07;
1253 	int shift_right = (kcontrol->private_value >> 19) & 0x07;
1254 	int mask = (kcontrol->private_value >> 24) & 0xff;
1255 	int invert = (kcontrol->private_value >> 22) & 1;
1256 	unsigned char left, right;
1257 
1258 	left = snd_es1938_reg_read(chip, left_reg);
1259 	if (left_reg != right_reg)
1260 		right = snd_es1938_reg_read(chip, right_reg);
1261 	else
1262 		right = left;
1263 	ucontrol->value.integer.value[0] = (left >> shift_left) & mask;
1264 	ucontrol->value.integer.value[1] = (right >> shift_right) & mask;
1265 	if (invert) {
1266 		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
1267 		ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
1268 	}
1269 	return 0;
1270 }
1271 
1272 static int snd_es1938_put_double(struct snd_kcontrol *kcontrol,
1273 				 struct snd_ctl_elem_value *ucontrol)
1274 {
1275 	struct es1938 *chip = snd_kcontrol_chip(kcontrol);
1276 	int left_reg = kcontrol->private_value & 0xff;
1277 	int right_reg = (kcontrol->private_value >> 8) & 0xff;
1278 	int shift_left = (kcontrol->private_value >> 16) & 0x07;
1279 	int shift_right = (kcontrol->private_value >> 19) & 0x07;
1280 	int mask = (kcontrol->private_value >> 24) & 0xff;
1281 	int invert = (kcontrol->private_value >> 22) & 1;
1282 	int change;
1283 	unsigned char val1, val2, mask1, mask2;
1284 
1285 	val1 = ucontrol->value.integer.value[0] & mask;
1286 	val2 = ucontrol->value.integer.value[1] & mask;
1287 	if (invert) {
1288 		val1 = mask - val1;
1289 		val2 = mask - val2;
1290 	}
1291 	val1 <<= shift_left;
1292 	val2 <<= shift_right;
1293 	mask1 = mask << shift_left;
1294 	mask2 = mask << shift_right;
1295 	if (left_reg != right_reg) {
1296 		change = 0;
1297 		if (snd_es1938_reg_bits(chip, left_reg, mask1, val1) != val1)
1298 			change = 1;
1299 		if (snd_es1938_reg_bits(chip, right_reg, mask2, val2) != val2)
1300 			change = 1;
1301 	} else {
1302 		change = (snd_es1938_reg_bits(chip, left_reg, mask1 | mask2,
1303 					      val1 | val2) != (val1 | val2));
1304 	}
1305 	return change;
1306 }
1307 
1308 static const DECLARE_TLV_DB_RANGE(db_scale_master,
1309 	0, 54, TLV_DB_SCALE_ITEM(-3600, 50, 1),
1310 	54, 63, TLV_DB_SCALE_ITEM(-900, 100, 0),
1311 );
1312 
1313 static const DECLARE_TLV_DB_RANGE(db_scale_audio1,
1314 	0, 8, TLV_DB_SCALE_ITEM(-3300, 300, 1),
1315 	8, 15, TLV_DB_SCALE_ITEM(-900, 150, 0),
1316 );
1317 
1318 static const DECLARE_TLV_DB_RANGE(db_scale_audio2,
1319 	0, 8, TLV_DB_SCALE_ITEM(-3450, 300, 1),
1320 	8, 15, TLV_DB_SCALE_ITEM(-1050, 150, 0),
1321 );
1322 
1323 static const DECLARE_TLV_DB_RANGE(db_scale_mic,
1324 	0, 8, TLV_DB_SCALE_ITEM(-2400, 300, 1),
1325 	8, 15, TLV_DB_SCALE_ITEM(0, 150, 0),
1326 );
1327 
1328 static const DECLARE_TLV_DB_RANGE(db_scale_line,
1329 	0, 8, TLV_DB_SCALE_ITEM(-3150, 300, 1),
1330 	8, 15, TLV_DB_SCALE_ITEM(-750, 150, 0),
1331 );
1332 
1333 static const DECLARE_TLV_DB_SCALE(db_scale_capture, 0, 150, 0);
1334 
1335 static struct snd_kcontrol_new snd_es1938_controls[] = {
1336 ES1938_DOUBLE_TLV("Master Playback Volume", 0, 0x60, 0x62, 0, 0, 63, 0,
1337 		  db_scale_master),
1338 ES1938_DOUBLE("Master Playback Switch", 0, 0x60, 0x62, 6, 6, 1, 1),
1339 {
1340 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1341 	.name = "Hardware Master Playback Volume",
1342 	.access = SNDRV_CTL_ELEM_ACCESS_READ,
1343 	.info = snd_es1938_info_hw_volume,
1344 	.get = snd_es1938_get_hw_volume,
1345 },
1346 {
1347 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1348 	.access = (SNDRV_CTL_ELEM_ACCESS_READ |
1349 		   SNDRV_CTL_ELEM_ACCESS_TLV_READ),
1350 	.name = "Hardware Master Playback Switch",
1351 	.info = snd_es1938_info_hw_switch,
1352 	.get = snd_es1938_get_hw_switch,
1353 	.tlv = { .p = db_scale_master },
1354 },
1355 ES1938_SINGLE("Hardware Volume Split", 0, 0x64, 7, 1, 0),
1356 ES1938_DOUBLE_TLV("Line Playback Volume", 0, 0x3e, 0x3e, 4, 0, 15, 0,
1357 		  db_scale_line),
1358 ES1938_DOUBLE("CD Playback Volume", 0, 0x38, 0x38, 4, 0, 15, 0),
1359 ES1938_DOUBLE_TLV("FM Playback Volume", 0, 0x36, 0x36, 4, 0, 15, 0,
1360 		  db_scale_mic),
1361 ES1938_DOUBLE_TLV("Mono Playback Volume", 0, 0x6d, 0x6d, 4, 0, 15, 0,
1362 		  db_scale_line),
1363 ES1938_DOUBLE_TLV("Mic Playback Volume", 0, 0x1a, 0x1a, 4, 0, 15, 0,
1364 		  db_scale_mic),
1365 ES1938_DOUBLE_TLV("Aux Playback Volume", 0, 0x3a, 0x3a, 4, 0, 15, 0,
1366 		  db_scale_line),
1367 ES1938_DOUBLE_TLV("Capture Volume", 0, 0xb4, 0xb4, 4, 0, 15, 0,
1368 		  db_scale_capture),
1369 ES1938_SINGLE("Beep Volume", 0, 0x3c, 0, 7, 0),
1370 ES1938_SINGLE("Record Monitor", 0, 0xa8, 3, 1, 0),
1371 ES1938_SINGLE("Capture Switch", 0, 0x1c, 4, 1, 1),
1372 {
1373 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1374 	.name = "Capture Source",
1375 	.info = snd_es1938_info_mux,
1376 	.get = snd_es1938_get_mux,
1377 	.put = snd_es1938_put_mux,
1378 },
1379 ES1938_DOUBLE_TLV("Mono Input Playback Volume", 0, 0x6d, 0x6d, 4, 0, 15, 0,
1380 		  db_scale_line),
1381 ES1938_DOUBLE_TLV("PCM Capture Volume", 0, 0x69, 0x69, 4, 0, 15, 0,
1382 		  db_scale_audio2),
1383 ES1938_DOUBLE_TLV("Mic Capture Volume", 0, 0x68, 0x68, 4, 0, 15, 0,
1384 		  db_scale_mic),
1385 ES1938_DOUBLE_TLV("Line Capture Volume", 0, 0x6e, 0x6e, 4, 0, 15, 0,
1386 		  db_scale_line),
1387 ES1938_DOUBLE_TLV("FM Capture Volume", 0, 0x6b, 0x6b, 4, 0, 15, 0,
1388 		  db_scale_mic),
1389 ES1938_DOUBLE_TLV("Mono Capture Volume", 0, 0x6f, 0x6f, 4, 0, 15, 0,
1390 		  db_scale_line),
1391 ES1938_DOUBLE_TLV("CD Capture Volume", 0, 0x6a, 0x6a, 4, 0, 15, 0,
1392 		  db_scale_line),
1393 ES1938_DOUBLE_TLV("Aux Capture Volume", 0, 0x6c, 0x6c, 4, 0, 15, 0,
1394 		  db_scale_line),
1395 ES1938_DOUBLE_TLV("PCM Playback Volume", 0, 0x7c, 0x7c, 4, 0, 15, 0,
1396 		  db_scale_audio2),
1397 ES1938_DOUBLE_TLV("PCM Playback Volume", 1, 0x14, 0x14, 4, 0, 15, 0,
1398 		  db_scale_audio1),
1399 ES1938_SINGLE("3D Control - Level", 0, 0x52, 0, 63, 0),
1400 {
1401 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1402 	.name = "3D Control - Switch",
1403 	.info = snd_es1938_info_spatializer_enable,
1404 	.get = snd_es1938_get_spatializer_enable,
1405 	.put = snd_es1938_put_spatializer_enable,
1406 },
1407 ES1938_SINGLE("Mic Boost (+26dB)", 0, 0x7d, 3, 1, 0)
1408 };
1409 
1410 
1411 /* ---------------------------------------------------------------------------- */
1412 /* ---------------------------------------------------------------------------- */
1413 
1414 /*
1415  * initialize the chip - used by resume callback, too
1416  */
1417 static void snd_es1938_chip_init(struct es1938 *chip)
1418 {
1419 	/* reset chip */
1420 	snd_es1938_reset(chip);
1421 
1422 	/* configure native mode */
1423 
1424 	/* enable bus master */
1425 	pci_set_master(chip->pci);
1426 
1427 	/* disable legacy audio */
1428 	pci_write_config_word(chip->pci, SL_PCI_LEGACYCONTROL, 0x805f);
1429 
1430 	/* set DDMA base */
1431 	pci_write_config_word(chip->pci, SL_PCI_DDMACONTROL, chip->ddma_port | 1);
1432 
1433 	/* set DMA/IRQ policy */
1434 	pci_write_config_dword(chip->pci, SL_PCI_CONFIG, 0);
1435 
1436 	/* enable Audio 1, Audio 2, MPU401 IRQ and HW volume IRQ*/
1437 	outb(0xf0, SLIO_REG(chip, IRQCONTROL));
1438 
1439 	/* reset DMA */
1440 	outb(0, SLDM_REG(chip, DMACLEAR));
1441 }
1442 
1443 #ifdef CONFIG_PM_SLEEP
1444 /*
1445  * PM support
1446  */
1447 
1448 static unsigned char saved_regs[SAVED_REG_SIZE+1] = {
1449 	0x14, 0x1a, 0x1c, 0x3a, 0x3c, 0x3e, 0x36, 0x38,
1450 	0x50, 0x52, 0x60, 0x61, 0x62, 0x63, 0x64, 0x68,
1451 	0x69, 0x6a, 0x6b, 0x6d, 0x6e, 0x6f, 0x7c, 0x7d,
1452 	0xa8, 0xb4,
1453 };
1454 
1455 
1456 static int es1938_suspend(struct device *dev)
1457 {
1458 	struct snd_card *card = dev_get_drvdata(dev);
1459 	struct es1938 *chip = card->private_data;
1460 	unsigned char *s, *d;
1461 
1462 	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
1463 
1464 	/* save mixer-related registers */
1465 	for (s = saved_regs, d = chip->saved_regs; *s; s++, d++)
1466 		*d = snd_es1938_reg_read(chip, *s);
1467 
1468 	outb(0x00, SLIO_REG(chip, IRQCONTROL)); /* disable irqs */
1469 	if (chip->irq >= 0) {
1470 		free_irq(chip->irq, chip);
1471 		chip->irq = -1;
1472 	}
1473 	return 0;
1474 }
1475 
1476 static int es1938_resume(struct device *dev)
1477 {
1478 	struct pci_dev *pci = to_pci_dev(dev);
1479 	struct snd_card *card = dev_get_drvdata(dev);
1480 	struct es1938 *chip = card->private_data;
1481 	unsigned char *s, *d;
1482 
1483 	if (request_irq(pci->irq, snd_es1938_interrupt,
1484 			IRQF_SHARED, KBUILD_MODNAME, chip)) {
1485 		dev_err(dev, "unable to grab IRQ %d, disabling device\n",
1486 			pci->irq);
1487 		snd_card_disconnect(card);
1488 		return -EIO;
1489 	}
1490 	chip->irq = pci->irq;
1491 	snd_es1938_chip_init(chip);
1492 
1493 	/* restore mixer-related registers */
1494 	for (s = saved_regs, d = chip->saved_regs; *s; s++, d++) {
1495 		if (*s < 0xa0)
1496 			snd_es1938_mixer_write(chip, *s, *d);
1497 		else
1498 			snd_es1938_write(chip, *s, *d);
1499 	}
1500 
1501 	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
1502 	return 0;
1503 }
1504 
1505 static SIMPLE_DEV_PM_OPS(es1938_pm, es1938_suspend, es1938_resume);
1506 #define ES1938_PM_OPS	&es1938_pm
1507 #else
1508 #define ES1938_PM_OPS	NULL
1509 #endif /* CONFIG_PM_SLEEP */
1510 
1511 #ifdef SUPPORT_JOYSTICK
1512 static int snd_es1938_create_gameport(struct es1938 *chip)
1513 {
1514 	struct gameport *gp;
1515 
1516 	chip->gameport = gp = gameport_allocate_port();
1517 	if (!gp) {
1518 		dev_err(chip->card->dev,
1519 			"cannot allocate memory for gameport\n");
1520 		return -ENOMEM;
1521 	}
1522 
1523 	gameport_set_name(gp, "ES1938");
1524 	gameport_set_phys(gp, "pci%s/gameport0", pci_name(chip->pci));
1525 	gameport_set_dev_parent(gp, &chip->pci->dev);
1526 	gp->io = chip->game_port;
1527 
1528 	gameport_register_port(gp);
1529 
1530 	return 0;
1531 }
1532 
1533 static void snd_es1938_free_gameport(struct es1938 *chip)
1534 {
1535 	if (chip->gameport) {
1536 		gameport_unregister_port(chip->gameport);
1537 		chip->gameport = NULL;
1538 	}
1539 }
1540 #else
1541 static inline int snd_es1938_create_gameport(struct es1938 *chip) { return -ENOSYS; }
1542 static inline void snd_es1938_free_gameport(struct es1938 *chip) { }
1543 #endif /* SUPPORT_JOYSTICK */
1544 
1545 static int snd_es1938_free(struct es1938 *chip)
1546 {
1547 	/* disable irqs */
1548 	outb(0x00, SLIO_REG(chip, IRQCONTROL));
1549 	if (chip->rmidi)
1550 		snd_es1938_mixer_bits(chip, ESSSB_IREG_MPU401CONTROL, 0x40, 0);
1551 
1552 	snd_es1938_free_gameport(chip);
1553 
1554 	if (chip->irq >= 0)
1555 		free_irq(chip->irq, chip);
1556 	pci_release_regions(chip->pci);
1557 	pci_disable_device(chip->pci);
1558 	kfree(chip);
1559 	return 0;
1560 }
1561 
1562 static int snd_es1938_dev_free(struct snd_device *device)
1563 {
1564 	struct es1938 *chip = device->device_data;
1565 	return snd_es1938_free(chip);
1566 }
1567 
1568 static int snd_es1938_create(struct snd_card *card,
1569 			     struct pci_dev *pci,
1570 			     struct es1938 **rchip)
1571 {
1572 	struct es1938 *chip;
1573 	int err;
1574 	static struct snd_device_ops ops = {
1575 		.dev_free =	snd_es1938_dev_free,
1576 	};
1577 
1578 	*rchip = NULL;
1579 
1580 	/* enable PCI device */
1581 	if ((err = pci_enable_device(pci)) < 0)
1582 		return err;
1583         /* check, if we can restrict PCI DMA transfers to 24 bits */
1584 	if (dma_set_mask(&pci->dev, DMA_BIT_MASK(24)) < 0 ||
1585 	    dma_set_coherent_mask(&pci->dev, DMA_BIT_MASK(24)) < 0) {
1586 		dev_err(card->dev,
1587 			"architecture does not support 24bit PCI busmaster DMA\n");
1588 		pci_disable_device(pci);
1589                 return -ENXIO;
1590         }
1591 
1592 	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1593 	if (chip == NULL) {
1594 		pci_disable_device(pci);
1595 		return -ENOMEM;
1596 	}
1597 	spin_lock_init(&chip->reg_lock);
1598 	spin_lock_init(&chip->mixer_lock);
1599 	chip->card = card;
1600 	chip->pci = pci;
1601 	chip->irq = -1;
1602 	if ((err = pci_request_regions(pci, "ESS Solo-1")) < 0) {
1603 		kfree(chip);
1604 		pci_disable_device(pci);
1605 		return err;
1606 	}
1607 	chip->io_port = pci_resource_start(pci, 0);
1608 	chip->sb_port = pci_resource_start(pci, 1);
1609 	chip->vc_port = pci_resource_start(pci, 2);
1610 	chip->mpu_port = pci_resource_start(pci, 3);
1611 	chip->game_port = pci_resource_start(pci, 4);
1612 	if (request_irq(pci->irq, snd_es1938_interrupt, IRQF_SHARED,
1613 			KBUILD_MODNAME, chip)) {
1614 		dev_err(card->dev, "unable to grab IRQ %d\n", pci->irq);
1615 		snd_es1938_free(chip);
1616 		return -EBUSY;
1617 	}
1618 	chip->irq = pci->irq;
1619 	dev_dbg(card->dev,
1620 		"create: io: 0x%lx, sb: 0x%lx, vc: 0x%lx, mpu: 0x%lx, game: 0x%lx\n",
1621 		   chip->io_port, chip->sb_port, chip->vc_port, chip->mpu_port, chip->game_port);
1622 
1623 	chip->ddma_port = chip->vc_port + 0x00;		/* fix from Thomas Sailer */
1624 
1625 	snd_es1938_chip_init(chip);
1626 
1627 	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
1628 		snd_es1938_free(chip);
1629 		return err;
1630 	}
1631 
1632 	*rchip = chip;
1633 	return 0;
1634 }
1635 
1636 /* --------------------------------------------------------------------
1637  * Interrupt handler
1638  * -------------------------------------------------------------------- */
1639 static irqreturn_t snd_es1938_interrupt(int irq, void *dev_id)
1640 {
1641 	struct es1938 *chip = dev_id;
1642 	unsigned char status, audiostatus;
1643 	int handled = 0;
1644 
1645 	status = inb(SLIO_REG(chip, IRQCONTROL));
1646 #if 0
1647 	dev_dbg(chip->card->dev,
1648 		"Es1938debug - interrupt status: =0x%x\n", status);
1649 #endif
1650 
1651 	/* AUDIO 1 */
1652 	if (status & 0x10) {
1653 #if 0
1654 		dev_dbg(chip->card->dev,
1655 		       "Es1938debug - AUDIO channel 1 interrupt\n");
1656 		dev_dbg(chip->card->dev,
1657 		       "Es1938debug - AUDIO channel 1 DMAC DMA count: %u\n",
1658 		       inw(SLDM_REG(chip, DMACOUNT)));
1659 		dev_dbg(chip->card->dev,
1660 		       "Es1938debug - AUDIO channel 1 DMAC DMA base: %u\n",
1661 		       inl(SLDM_REG(chip, DMAADDR)));
1662 		dev_dbg(chip->card->dev,
1663 		       "Es1938debug - AUDIO channel 1 DMAC DMA status: 0x%x\n",
1664 		       inl(SLDM_REG(chip, DMASTATUS)));
1665 #endif
1666 		/* clear irq */
1667 		handled = 1;
1668 		audiostatus = inb(SLSB_REG(chip, STATUS));
1669 		if (chip->active & ADC1)
1670 			snd_pcm_period_elapsed(chip->capture_substream);
1671 		else if (chip->active & DAC1)
1672 			snd_pcm_period_elapsed(chip->playback2_substream);
1673 	}
1674 
1675 	/* AUDIO 2 */
1676 	if (status & 0x20) {
1677 #if 0
1678 		dev_dbg(chip->card->dev,
1679 		       "Es1938debug - AUDIO channel 2 interrupt\n");
1680 		dev_dbg(chip->card->dev,
1681 		       "Es1938debug - AUDIO channel 2 DMAC DMA count: %u\n",
1682 		       inw(SLIO_REG(chip, AUDIO2DMACOUNT)));
1683 		dev_dbg(chip->card->dev,
1684 		       "Es1938debug - AUDIO channel 2 DMAC DMA base: %u\n",
1685 		       inl(SLIO_REG(chip, AUDIO2DMAADDR)));
1686 
1687 #endif
1688 		/* clear irq */
1689 		handled = 1;
1690 		snd_es1938_mixer_bits(chip, ESSSB_IREG_AUDIO2CONTROL2, 0x80, 0);
1691 		if (chip->active & DAC2)
1692 			snd_pcm_period_elapsed(chip->playback1_substream);
1693 	}
1694 
1695 	/* Hardware volume */
1696 	if (status & 0x40) {
1697 		int split = snd_es1938_mixer_read(chip, 0x64) & 0x80;
1698 		handled = 1;
1699 		snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE, &chip->hw_switch->id);
1700 		snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE, &chip->hw_volume->id);
1701 		if (!split) {
1702 			snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1703 				       &chip->master_switch->id);
1704 			snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1705 				       &chip->master_volume->id);
1706 		}
1707 		/* ack interrupt */
1708 		snd_es1938_mixer_write(chip, 0x66, 0x00);
1709 	}
1710 
1711 	/* MPU401 */
1712 	if (status & 0x80) {
1713 		// the following line is evil! It switches off MIDI interrupt handling after the first interrupt received.
1714 		// replacing the last 0 by 0x40 works for ESS-Solo1, but just doing nothing works as well!
1715 		// andreas@flying-snail.de
1716 		// snd_es1938_mixer_bits(chip, ESSSB_IREG_MPU401CONTROL, 0x40, 0); /* ack? */
1717 		if (chip->rmidi) {
1718 			handled = 1;
1719 			snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
1720 		}
1721 	}
1722 	return IRQ_RETVAL(handled);
1723 }
1724 
1725 #define ES1938_DMA_SIZE 64
1726 
1727 static int snd_es1938_mixer(struct es1938 *chip)
1728 {
1729 	struct snd_card *card;
1730 	unsigned int idx;
1731 	int err;
1732 
1733 	card = chip->card;
1734 
1735 	strcpy(card->mixername, "ESS Solo-1");
1736 
1737 	for (idx = 0; idx < ARRAY_SIZE(snd_es1938_controls); idx++) {
1738 		struct snd_kcontrol *kctl;
1739 		kctl = snd_ctl_new1(&snd_es1938_controls[idx], chip);
1740 		switch (idx) {
1741 			case 0:
1742 				chip->master_volume = kctl;
1743 				kctl->private_free = snd_es1938_hwv_free;
1744 				break;
1745 			case 1:
1746 				chip->master_switch = kctl;
1747 				kctl->private_free = snd_es1938_hwv_free;
1748 				break;
1749 			case 2:
1750 				chip->hw_volume = kctl;
1751 				kctl->private_free = snd_es1938_hwv_free;
1752 				break;
1753 			case 3:
1754 				chip->hw_switch = kctl;
1755 				kctl->private_free = snd_es1938_hwv_free;
1756 				break;
1757 			}
1758 		if ((err = snd_ctl_add(card, kctl)) < 0)
1759 			return err;
1760 	}
1761 	return 0;
1762 }
1763 
1764 
1765 static int snd_es1938_probe(struct pci_dev *pci,
1766 			    const struct pci_device_id *pci_id)
1767 {
1768 	static int dev;
1769 	struct snd_card *card;
1770 	struct es1938 *chip;
1771 	struct snd_opl3 *opl3;
1772 	int idx, err;
1773 
1774 	if (dev >= SNDRV_CARDS)
1775 		return -ENODEV;
1776 	if (!enable[dev]) {
1777 		dev++;
1778 		return -ENOENT;
1779 	}
1780 
1781 	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
1782 			   0, &card);
1783 	if (err < 0)
1784 		return err;
1785 	for (idx = 0; idx < 5; idx++) {
1786 		if (pci_resource_start(pci, idx) == 0 ||
1787 		    !(pci_resource_flags(pci, idx) & IORESOURCE_IO)) {
1788 		    	snd_card_free(card);
1789 		    	return -ENODEV;
1790 		}
1791 	}
1792 	if ((err = snd_es1938_create(card, pci, &chip)) < 0) {
1793 		snd_card_free(card);
1794 		return err;
1795 	}
1796 	card->private_data = chip;
1797 
1798 	strcpy(card->driver, "ES1938");
1799 	strcpy(card->shortname, "ESS ES1938 (Solo-1)");
1800 	sprintf(card->longname, "%s rev %i, irq %i",
1801 		card->shortname,
1802 		chip->revision,
1803 		chip->irq);
1804 
1805 	if ((err = snd_es1938_new_pcm(chip, 0)) < 0) {
1806 		snd_card_free(card);
1807 		return err;
1808 	}
1809 	if ((err = snd_es1938_mixer(chip)) < 0) {
1810 		snd_card_free(card);
1811 		return err;
1812 	}
1813 	if (snd_opl3_create(card,
1814 			    SLSB_REG(chip, FMLOWADDR),
1815 			    SLSB_REG(chip, FMHIGHADDR),
1816 			    OPL3_HW_OPL3, 1, &opl3) < 0) {
1817 		dev_err(card->dev, "OPL3 not detected at 0x%lx\n",
1818 			   SLSB_REG(chip, FMLOWADDR));
1819 	} else {
1820 	        if ((err = snd_opl3_timer_new(opl3, 0, 1)) < 0) {
1821 	                snd_card_free(card);
1822 	                return err;
1823 		}
1824 	        if ((err = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0) {
1825 	                snd_card_free(card);
1826 	                return err;
1827 		}
1828 	}
1829 	if (snd_mpu401_uart_new(card, 0, MPU401_HW_MPU401,
1830 				chip->mpu_port,
1831 				MPU401_INFO_INTEGRATED | MPU401_INFO_IRQ_HOOK,
1832 				-1, &chip->rmidi) < 0) {
1833 		dev_err(card->dev, "unable to initialize MPU-401\n");
1834 	} else {
1835 		// this line is vital for MIDI interrupt handling on ess-solo1
1836 		// andreas@flying-snail.de
1837 		snd_es1938_mixer_bits(chip, ESSSB_IREG_MPU401CONTROL, 0x40, 0x40);
1838 	}
1839 
1840 	snd_es1938_create_gameport(chip);
1841 
1842 	if ((err = snd_card_register(card)) < 0) {
1843 		snd_card_free(card);
1844 		return err;
1845 	}
1846 
1847 	pci_set_drvdata(pci, card);
1848 	dev++;
1849 	return 0;
1850 }
1851 
1852 static void snd_es1938_remove(struct pci_dev *pci)
1853 {
1854 	snd_card_free(pci_get_drvdata(pci));
1855 }
1856 
1857 static struct pci_driver es1938_driver = {
1858 	.name = KBUILD_MODNAME,
1859 	.id_table = snd_es1938_ids,
1860 	.probe = snd_es1938_probe,
1861 	.remove = snd_es1938_remove,
1862 	.driver = {
1863 		.pm = ES1938_PM_OPS,
1864 	},
1865 };
1866 
1867 module_pci_driver(es1938_driver);
1868