xref: /openbmc/linux/sound/pci/bt87x.c (revision 5e012745)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * bt87x.c - Brooktree Bt878/Bt879 driver for ALSA
4  *
5  * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
6  *
7  * based on btaudio.c by Gerd Knorr <kraxel@bytesex.org>
8  */
9 
10 #include <linux/init.h>
11 #include <linux/interrupt.h>
12 #include <linux/pci.h>
13 #include <linux/slab.h>
14 #include <linux/module.h>
15 #include <linux/bitops.h>
16 #include <linux/io.h>
17 #include <sound/core.h>
18 #include <sound/pcm.h>
19 #include <sound/pcm_params.h>
20 #include <sound/control.h>
21 #include <sound/initval.h>
22 
23 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
24 MODULE_DESCRIPTION("Brooktree Bt87x audio driver");
25 MODULE_LICENSE("GPL");
26 MODULE_SUPPORTED_DEVICE("{{Brooktree,Bt878},"
27 		"{Brooktree,Bt879}}");
28 
29 static int index[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -2}; /* Exclude the first card */
30 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
31 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;	/* Enable this card */
32 static int digital_rate[SNDRV_CARDS];	/* digital input rate */
33 static bool load_all;	/* allow to load the non-whitelisted cards */
34 
35 module_param_array(index, int, NULL, 0444);
36 MODULE_PARM_DESC(index, "Index value for Bt87x soundcard");
37 module_param_array(id, charp, NULL, 0444);
38 MODULE_PARM_DESC(id, "ID string for Bt87x soundcard");
39 module_param_array(enable, bool, NULL, 0444);
40 MODULE_PARM_DESC(enable, "Enable Bt87x soundcard");
41 module_param_array(digital_rate, int, NULL, 0444);
42 MODULE_PARM_DESC(digital_rate, "Digital input rate for Bt87x soundcard");
43 module_param(load_all, bool, 0444);
44 MODULE_PARM_DESC(load_all, "Allow to load the non-whitelisted cards");
45 
46 
47 /* register offsets */
48 #define REG_INT_STAT		0x100	/* interrupt status */
49 #define REG_INT_MASK		0x104	/* interrupt mask */
50 #define REG_GPIO_DMA_CTL	0x10c	/* audio control */
51 #define REG_PACKET_LEN		0x110	/* audio packet lengths */
52 #define REG_RISC_STRT_ADD	0x114	/* RISC program start address */
53 #define REG_RISC_COUNT		0x120	/* RISC program counter */
54 
55 /* interrupt bits */
56 #define INT_OFLOW	(1 <<  3)	/* audio A/D overflow */
57 #define INT_RISCI	(1 << 11)	/* RISC instruction IRQ bit set */
58 #define INT_FBUS	(1 << 12)	/* FIFO overrun due to bus access latency */
59 #define INT_FTRGT	(1 << 13)	/* FIFO overrun due to target latency */
60 #define INT_FDSR	(1 << 14)	/* FIFO data stream resynchronization */
61 #define INT_PPERR	(1 << 15)	/* PCI parity error */
62 #define INT_RIPERR	(1 << 16)	/* RISC instruction parity error */
63 #define INT_PABORT	(1 << 17)	/* PCI master or target abort */
64 #define INT_OCERR	(1 << 18)	/* invalid opcode */
65 #define INT_SCERR	(1 << 19)	/* sync counter overflow */
66 #define INT_RISC_EN	(1 << 27)	/* DMA controller running */
67 #define INT_RISCS_SHIFT	      28	/* RISC status bits */
68 
69 /* audio control bits */
70 #define CTL_FIFO_ENABLE		(1 <<  0)	/* enable audio data FIFO */
71 #define CTL_RISC_ENABLE		(1 <<  1)	/* enable audio DMA controller */
72 #define CTL_PKTP_4		(0 <<  2)	/* packet mode FIFO trigger point - 4 DWORDs */
73 #define CTL_PKTP_8		(1 <<  2)	/* 8 DWORDs */
74 #define CTL_PKTP_16		(2 <<  2)	/* 16 DWORDs */
75 #define CTL_ACAP_EN		(1 <<  4)	/* enable audio capture */
76 #define CTL_DA_APP		(1 <<  5)	/* GPIO input */
77 #define CTL_DA_IOM_AFE		(0 <<  6)	/* audio A/D input */
78 #define CTL_DA_IOM_DA		(1 <<  6)	/* digital audio input */
79 #define CTL_DA_SDR_SHIFT	       8	/* DDF first stage decimation rate */
80 #define CTL_DA_SDR_MASK		(0xf<< 8)
81 #define CTL_DA_LMT		(1 << 12)	/* limit audio data values */
82 #define CTL_DA_ES2		(1 << 13)	/* enable DDF stage 2 */
83 #define CTL_DA_SBR		(1 << 14)	/* samples rounded to 8 bits */
84 #define CTL_DA_DPM		(1 << 15)	/* data packet mode */
85 #define CTL_DA_LRD_SHIFT	      16	/* ALRCK delay */
86 #define CTL_DA_MLB		(1 << 21)	/* MSB/LSB format */
87 #define CTL_DA_LRI		(1 << 22)	/* left/right indication */
88 #define CTL_DA_SCE		(1 << 23)	/* sample clock edge */
89 #define CTL_A_SEL_STV		(0 << 24)	/* TV tuner audio input */
90 #define CTL_A_SEL_SFM		(1 << 24)	/* FM audio input */
91 #define CTL_A_SEL_SML		(2 << 24)	/* mic/line audio input */
92 #define CTL_A_SEL_SMXC		(3 << 24)	/* MUX bypass */
93 #define CTL_A_SEL_SHIFT		      24
94 #define CTL_A_SEL_MASK		(3 << 24)
95 #define CTL_A_PWRDN		(1 << 26)	/* analog audio power-down */
96 #define CTL_A_G2X		(1 << 27)	/* audio gain boost */
97 #define CTL_A_GAIN_SHIFT	      28	/* audio input gain */
98 #define CTL_A_GAIN_MASK		(0xf<<28)
99 
100 /* RISC instruction opcodes */
101 #define RISC_WRITE	(0x1 << 28)	/* write FIFO data to memory at address */
102 #define RISC_WRITEC	(0x5 << 28)	/* write FIFO data to memory at current address */
103 #define RISC_SKIP	(0x2 << 28)	/* skip FIFO data */
104 #define RISC_JUMP	(0x7 << 28)	/* jump to address */
105 #define RISC_SYNC	(0x8 << 28)	/* synchronize with FIFO */
106 
107 /* RISC instruction bits */
108 #define RISC_BYTES_ENABLE	(0xf << 12)	/* byte enable bits */
109 #define RISC_RESYNC		(  1 << 15)	/* disable FDSR errors */
110 #define RISC_SET_STATUS_SHIFT	        16	/* set status bits */
111 #define RISC_RESET_STATUS_SHIFT	        20	/* clear status bits */
112 #define RISC_IRQ		(  1 << 24)	/* interrupt */
113 #define RISC_EOL		(  1 << 26)	/* end of line */
114 #define RISC_SOL		(  1 << 27)	/* start of line */
115 
116 /* SYNC status bits values */
117 #define RISC_SYNC_FM1	0x6
118 #define RISC_SYNC_VRO	0xc
119 
120 #define ANALOG_CLOCK 1792000
121 #ifdef CONFIG_SND_BT87X_OVERCLOCK
122 #define CLOCK_DIV_MIN 1
123 #else
124 #define CLOCK_DIV_MIN 4
125 #endif
126 #define CLOCK_DIV_MAX 15
127 
128 #define ERROR_INTERRUPTS (INT_FBUS | INT_FTRGT | INT_PPERR | \
129 			  INT_RIPERR | INT_PABORT | INT_OCERR)
130 #define MY_INTERRUPTS (INT_RISCI | ERROR_INTERRUPTS)
131 
132 /* SYNC, one WRITE per line, one extra WRITE per page boundary, SYNC, JUMP */
133 #define MAX_RISC_SIZE ((1 + 255 + (PAGE_ALIGN(255 * 4092) / PAGE_SIZE - 1) + 1 + 1) * 8)
134 
135 /* Cards with configuration information */
136 enum snd_bt87x_boardid {
137 	SND_BT87X_BOARD_UNKNOWN,
138 	SND_BT87X_BOARD_GENERIC,	/* both an & dig interfaces, 32kHz */
139 	SND_BT87X_BOARD_ANALOG,		/* board with no external A/D */
140 	SND_BT87X_BOARD_OSPREY2x0,
141 	SND_BT87X_BOARD_OSPREY440,
142 	SND_BT87X_BOARD_AVPHONE98,
143 };
144 
145 /* Card configuration */
146 struct snd_bt87x_board {
147 	int dig_rate;		/* Digital input sampling rate */
148 	u32 digital_fmt;	/* Register settings for digital input */
149 	unsigned no_analog:1;	/* No analog input */
150 	unsigned no_digital:1;	/* No digital input */
151 };
152 
153 static struct snd_bt87x_board snd_bt87x_boards[] = {
154 	[SND_BT87X_BOARD_UNKNOWN] = {
155 		.dig_rate = 32000, /* just a guess */
156 	},
157 	[SND_BT87X_BOARD_GENERIC] = {
158 		.dig_rate = 32000,
159 	},
160 	[SND_BT87X_BOARD_ANALOG] = {
161 		.no_digital = 1,
162 	},
163 	[SND_BT87X_BOARD_OSPREY2x0] = {
164 		.dig_rate = 44100,
165 		.digital_fmt = CTL_DA_LRI | (1 << CTL_DA_LRD_SHIFT),
166 	},
167 	[SND_BT87X_BOARD_OSPREY440] = {
168 		.dig_rate = 32000,
169 		.digital_fmt = CTL_DA_LRI | (1 << CTL_DA_LRD_SHIFT),
170 		.no_analog = 1,
171 	},
172 	[SND_BT87X_BOARD_AVPHONE98] = {
173 		.dig_rate = 48000,
174 	},
175 };
176 
177 struct snd_bt87x {
178 	struct snd_card *card;
179 	struct pci_dev *pci;
180 	struct snd_bt87x_board board;
181 
182 	void __iomem *mmio;
183 	int irq;
184 
185 	spinlock_t reg_lock;
186 	unsigned long opened;
187 	struct snd_pcm_substream *substream;
188 
189 	struct snd_dma_buffer dma_risc;
190 	unsigned int line_bytes;
191 	unsigned int lines;
192 
193 	u32 reg_control;
194 	u32 interrupt_mask;
195 
196 	int current_line;
197 
198 	int pci_parity_errors;
199 };
200 
201 enum { DEVICE_DIGITAL, DEVICE_ANALOG };
202 
203 static inline u32 snd_bt87x_readl(struct snd_bt87x *chip, u32 reg)
204 {
205 	return readl(chip->mmio + reg);
206 }
207 
208 static inline void snd_bt87x_writel(struct snd_bt87x *chip, u32 reg, u32 value)
209 {
210 	writel(value, chip->mmio + reg);
211 }
212 
213 static int snd_bt87x_create_risc(struct snd_bt87x *chip, struct snd_pcm_substream *substream,
214 			       	 unsigned int periods, unsigned int period_bytes)
215 {
216 	unsigned int i, offset;
217 	__le32 *risc;
218 
219 	if (chip->dma_risc.area == NULL) {
220 		if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(chip->pci),
221 					PAGE_ALIGN(MAX_RISC_SIZE), &chip->dma_risc) < 0)
222 			return -ENOMEM;
223 	}
224 	risc = (__le32 *)chip->dma_risc.area;
225 	offset = 0;
226 	*risc++ = cpu_to_le32(RISC_SYNC | RISC_SYNC_FM1);
227 	*risc++ = cpu_to_le32(0);
228 	for (i = 0; i < periods; ++i) {
229 		u32 rest;
230 
231 		rest = period_bytes;
232 		do {
233 			u32 cmd, len;
234 			unsigned int addr;
235 
236 			len = PAGE_SIZE - (offset % PAGE_SIZE);
237 			if (len > rest)
238 				len = rest;
239 			cmd = RISC_WRITE | len;
240 			if (rest == period_bytes) {
241 				u32 block = i * 16 / periods;
242 				cmd |= RISC_SOL;
243 				cmd |= block << RISC_SET_STATUS_SHIFT;
244 				cmd |= (~block & 0xf) << RISC_RESET_STATUS_SHIFT;
245 			}
246 			if (len == rest)
247 				cmd |= RISC_EOL | RISC_IRQ;
248 			*risc++ = cpu_to_le32(cmd);
249 			addr = snd_pcm_sgbuf_get_addr(substream, offset);
250 			*risc++ = cpu_to_le32(addr);
251 			offset += len;
252 			rest -= len;
253 		} while (rest > 0);
254 	}
255 	*risc++ = cpu_to_le32(RISC_SYNC | RISC_SYNC_VRO);
256 	*risc++ = cpu_to_le32(0);
257 	*risc++ = cpu_to_le32(RISC_JUMP);
258 	*risc++ = cpu_to_le32(chip->dma_risc.addr);
259 	chip->line_bytes = period_bytes;
260 	chip->lines = periods;
261 	return 0;
262 }
263 
264 static void snd_bt87x_free_risc(struct snd_bt87x *chip)
265 {
266 	if (chip->dma_risc.area) {
267 		snd_dma_free_pages(&chip->dma_risc);
268 		chip->dma_risc.area = NULL;
269 	}
270 }
271 
272 static void snd_bt87x_pci_error(struct snd_bt87x *chip, unsigned int status)
273 {
274 	u16 pci_status;
275 
276 	pci_read_config_word(chip->pci, PCI_STATUS, &pci_status);
277 	pci_status &= PCI_STATUS_PARITY | PCI_STATUS_SIG_TARGET_ABORT |
278 		PCI_STATUS_REC_TARGET_ABORT | PCI_STATUS_REC_MASTER_ABORT |
279 		PCI_STATUS_SIG_SYSTEM_ERROR | PCI_STATUS_DETECTED_PARITY;
280 	pci_write_config_word(chip->pci, PCI_STATUS, pci_status);
281 	if (pci_status != PCI_STATUS_DETECTED_PARITY)
282 		dev_err(chip->card->dev,
283 			"Aieee - PCI error! status %#08x, PCI status %#04x\n",
284 			   status & ERROR_INTERRUPTS, pci_status);
285 	else {
286 		dev_err(chip->card->dev,
287 			"Aieee - PCI parity error detected!\n");
288 		/* error 'handling' similar to aic7xxx_pci.c: */
289 		chip->pci_parity_errors++;
290 		if (chip->pci_parity_errors > 20) {
291 			dev_err(chip->card->dev,
292 				"Too many PCI parity errors observed.\n");
293 			dev_err(chip->card->dev,
294 				"Some device on this bus is generating bad parity.\n");
295 			dev_err(chip->card->dev,
296 				"This is an error *observed by*, not *generated by*, this card.\n");
297 			dev_err(chip->card->dev,
298 				"PCI parity error checking has been disabled.\n");
299 			chip->interrupt_mask &= ~(INT_PPERR | INT_RIPERR);
300 			snd_bt87x_writel(chip, REG_INT_MASK, chip->interrupt_mask);
301 		}
302 	}
303 }
304 
305 static irqreturn_t snd_bt87x_interrupt(int irq, void *dev_id)
306 {
307 	struct snd_bt87x *chip = dev_id;
308 	unsigned int status, irq_status;
309 
310 	status = snd_bt87x_readl(chip, REG_INT_STAT);
311 	irq_status = status & chip->interrupt_mask;
312 	if (!irq_status)
313 		return IRQ_NONE;
314 	snd_bt87x_writel(chip, REG_INT_STAT, irq_status);
315 
316 	if (irq_status & ERROR_INTERRUPTS) {
317 		if (irq_status & (INT_FBUS | INT_FTRGT))
318 			dev_warn(chip->card->dev,
319 				 "FIFO overrun, status %#08x\n", status);
320 		if (irq_status & INT_OCERR)
321 			dev_err(chip->card->dev,
322 				"internal RISC error, status %#08x\n", status);
323 		if (irq_status & (INT_PPERR | INT_RIPERR | INT_PABORT))
324 			snd_bt87x_pci_error(chip, irq_status);
325 	}
326 	if ((irq_status & INT_RISCI) && (chip->reg_control & CTL_ACAP_EN)) {
327 		int current_block, irq_block;
328 
329 		/* assume that exactly one line has been recorded */
330 		chip->current_line = (chip->current_line + 1) % chip->lines;
331 		/* but check if some interrupts have been skipped */
332 		current_block = chip->current_line * 16 / chip->lines;
333 		irq_block = status >> INT_RISCS_SHIFT;
334 		if (current_block != irq_block)
335 			chip->current_line = (irq_block * chip->lines + 15) / 16;
336 
337 		snd_pcm_period_elapsed(chip->substream);
338 	}
339 	return IRQ_HANDLED;
340 }
341 
342 static const struct snd_pcm_hardware snd_bt87x_digital_hw = {
343 	.info = SNDRV_PCM_INFO_MMAP |
344 		SNDRV_PCM_INFO_INTERLEAVED |
345 		SNDRV_PCM_INFO_BLOCK_TRANSFER |
346 		SNDRV_PCM_INFO_MMAP_VALID |
347 		SNDRV_PCM_INFO_BATCH,
348 	.formats = SNDRV_PCM_FMTBIT_S16_LE,
349 	.rates = 0, /* set at runtime */
350 	.channels_min = 2,
351 	.channels_max = 2,
352 	.buffer_bytes_max = 255 * 4092,
353 	.period_bytes_min = 32,
354 	.period_bytes_max = 4092,
355 	.periods_min = 2,
356 	.periods_max = 255,
357 };
358 
359 static const struct snd_pcm_hardware snd_bt87x_analog_hw = {
360 	.info = SNDRV_PCM_INFO_MMAP |
361 		SNDRV_PCM_INFO_INTERLEAVED |
362 		SNDRV_PCM_INFO_BLOCK_TRANSFER |
363 		SNDRV_PCM_INFO_MMAP_VALID |
364 		SNDRV_PCM_INFO_BATCH,
365 	.formats = SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S8,
366 	.rates = SNDRV_PCM_RATE_KNOT,
367 	.rate_min = ANALOG_CLOCK / CLOCK_DIV_MAX,
368 	.rate_max = ANALOG_CLOCK / CLOCK_DIV_MIN,
369 	.channels_min = 1,
370 	.channels_max = 1,
371 	.buffer_bytes_max = 255 * 4092,
372 	.period_bytes_min = 32,
373 	.period_bytes_max = 4092,
374 	.periods_min = 2,
375 	.periods_max = 255,
376 };
377 
378 static int snd_bt87x_set_digital_hw(struct snd_bt87x *chip, struct snd_pcm_runtime *runtime)
379 {
380 	chip->reg_control |= CTL_DA_IOM_DA | CTL_A_PWRDN;
381 	runtime->hw = snd_bt87x_digital_hw;
382 	runtime->hw.rates = snd_pcm_rate_to_rate_bit(chip->board.dig_rate);
383 	runtime->hw.rate_min = chip->board.dig_rate;
384 	runtime->hw.rate_max = chip->board.dig_rate;
385 	return 0;
386 }
387 
388 static int snd_bt87x_set_analog_hw(struct snd_bt87x *chip, struct snd_pcm_runtime *runtime)
389 {
390 	static const struct snd_ratnum analog_clock = {
391 		.num = ANALOG_CLOCK,
392 		.den_min = CLOCK_DIV_MIN,
393 		.den_max = CLOCK_DIV_MAX,
394 		.den_step = 1
395 	};
396 	static const struct snd_pcm_hw_constraint_ratnums constraint_rates = {
397 		.nrats = 1,
398 		.rats = &analog_clock
399 	};
400 
401 	chip->reg_control &= ~(CTL_DA_IOM_DA | CTL_A_PWRDN);
402 	runtime->hw = snd_bt87x_analog_hw;
403 	return snd_pcm_hw_constraint_ratnums(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
404 					     &constraint_rates);
405 }
406 
407 static int snd_bt87x_pcm_open(struct snd_pcm_substream *substream)
408 {
409 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
410 	struct snd_pcm_runtime *runtime = substream->runtime;
411 	int err;
412 
413 	if (test_and_set_bit(0, &chip->opened))
414 		return -EBUSY;
415 
416 	if (substream->pcm->device == DEVICE_DIGITAL)
417 		err = snd_bt87x_set_digital_hw(chip, runtime);
418 	else
419 		err = snd_bt87x_set_analog_hw(chip, runtime);
420 	if (err < 0)
421 		goto _error;
422 
423 	err = snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
424 	if (err < 0)
425 		goto _error;
426 
427 	chip->substream = substream;
428 	return 0;
429 
430 _error:
431 	clear_bit(0, &chip->opened);
432 	smp_mb__after_atomic();
433 	return err;
434 }
435 
436 static int snd_bt87x_close(struct snd_pcm_substream *substream)
437 {
438 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
439 
440 	spin_lock_irq(&chip->reg_lock);
441 	chip->reg_control |= CTL_A_PWRDN;
442 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
443 	spin_unlock_irq(&chip->reg_lock);
444 
445 	chip->substream = NULL;
446 	clear_bit(0, &chip->opened);
447 	smp_mb__after_atomic();
448 	return 0;
449 }
450 
451 static int snd_bt87x_hw_params(struct snd_pcm_substream *substream,
452 			       struct snd_pcm_hw_params *hw_params)
453 {
454 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
455 	int err;
456 
457 	err = snd_pcm_lib_malloc_pages(substream,
458 				       params_buffer_bytes(hw_params));
459 	if (err < 0)
460 		return err;
461 	return snd_bt87x_create_risc(chip, substream,
462 				     params_periods(hw_params),
463 				     params_period_bytes(hw_params));
464 }
465 
466 static int snd_bt87x_hw_free(struct snd_pcm_substream *substream)
467 {
468 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
469 
470 	snd_bt87x_free_risc(chip);
471 	snd_pcm_lib_free_pages(substream);
472 	return 0;
473 }
474 
475 static int snd_bt87x_prepare(struct snd_pcm_substream *substream)
476 {
477 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
478 	struct snd_pcm_runtime *runtime = substream->runtime;
479 	int decimation;
480 
481 	spin_lock_irq(&chip->reg_lock);
482 	chip->reg_control &= ~(CTL_DA_SDR_MASK | CTL_DA_SBR);
483 	decimation = (ANALOG_CLOCK + runtime->rate / 4) / runtime->rate;
484 	chip->reg_control |= decimation << CTL_DA_SDR_SHIFT;
485 	if (runtime->format == SNDRV_PCM_FORMAT_S8)
486 		chip->reg_control |= CTL_DA_SBR;
487 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
488 	spin_unlock_irq(&chip->reg_lock);
489 	return 0;
490 }
491 
492 static int snd_bt87x_start(struct snd_bt87x *chip)
493 {
494 	spin_lock(&chip->reg_lock);
495 	chip->current_line = 0;
496 	chip->reg_control |= CTL_FIFO_ENABLE | CTL_RISC_ENABLE | CTL_ACAP_EN;
497 	snd_bt87x_writel(chip, REG_RISC_STRT_ADD, chip->dma_risc.addr);
498 	snd_bt87x_writel(chip, REG_PACKET_LEN,
499 			 chip->line_bytes | (chip->lines << 16));
500 	snd_bt87x_writel(chip, REG_INT_MASK, chip->interrupt_mask);
501 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
502 	spin_unlock(&chip->reg_lock);
503 	return 0;
504 }
505 
506 static int snd_bt87x_stop(struct snd_bt87x *chip)
507 {
508 	spin_lock(&chip->reg_lock);
509 	chip->reg_control &= ~(CTL_FIFO_ENABLE | CTL_RISC_ENABLE | CTL_ACAP_EN);
510 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
511 	snd_bt87x_writel(chip, REG_INT_MASK, 0);
512 	snd_bt87x_writel(chip, REG_INT_STAT, MY_INTERRUPTS);
513 	spin_unlock(&chip->reg_lock);
514 	return 0;
515 }
516 
517 static int snd_bt87x_trigger(struct snd_pcm_substream *substream, int cmd)
518 {
519 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
520 
521 	switch (cmd) {
522 	case SNDRV_PCM_TRIGGER_START:
523 		return snd_bt87x_start(chip);
524 	case SNDRV_PCM_TRIGGER_STOP:
525 		return snd_bt87x_stop(chip);
526 	default:
527 		return -EINVAL;
528 	}
529 }
530 
531 static snd_pcm_uframes_t snd_bt87x_pointer(struct snd_pcm_substream *substream)
532 {
533 	struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
534 	struct snd_pcm_runtime *runtime = substream->runtime;
535 
536 	return (snd_pcm_uframes_t)bytes_to_frames(runtime, chip->current_line * chip->line_bytes);
537 }
538 
539 static const struct snd_pcm_ops snd_bt87x_pcm_ops = {
540 	.open = snd_bt87x_pcm_open,
541 	.close = snd_bt87x_close,
542 	.ioctl = snd_pcm_lib_ioctl,
543 	.hw_params = snd_bt87x_hw_params,
544 	.hw_free = snd_bt87x_hw_free,
545 	.prepare = snd_bt87x_prepare,
546 	.trigger = snd_bt87x_trigger,
547 	.pointer = snd_bt87x_pointer,
548 	.page = snd_pcm_sgbuf_ops_page,
549 };
550 
551 static int snd_bt87x_capture_volume_info(struct snd_kcontrol *kcontrol,
552 					 struct snd_ctl_elem_info *info)
553 {
554 	info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
555 	info->count = 1;
556 	info->value.integer.min = 0;
557 	info->value.integer.max = 15;
558 	return 0;
559 }
560 
561 static int snd_bt87x_capture_volume_get(struct snd_kcontrol *kcontrol,
562 					struct snd_ctl_elem_value *value)
563 {
564 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
565 
566 	value->value.integer.value[0] = (chip->reg_control & CTL_A_GAIN_MASK) >> CTL_A_GAIN_SHIFT;
567 	return 0;
568 }
569 
570 static int snd_bt87x_capture_volume_put(struct snd_kcontrol *kcontrol,
571 					struct snd_ctl_elem_value *value)
572 {
573 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
574 	u32 old_control;
575 	int changed;
576 
577 	spin_lock_irq(&chip->reg_lock);
578 	old_control = chip->reg_control;
579 	chip->reg_control = (chip->reg_control & ~CTL_A_GAIN_MASK)
580 		| (value->value.integer.value[0] << CTL_A_GAIN_SHIFT);
581 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
582 	changed = old_control != chip->reg_control;
583 	spin_unlock_irq(&chip->reg_lock);
584 	return changed;
585 }
586 
587 static const struct snd_kcontrol_new snd_bt87x_capture_volume = {
588 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
589 	.name = "Capture Volume",
590 	.info = snd_bt87x_capture_volume_info,
591 	.get = snd_bt87x_capture_volume_get,
592 	.put = snd_bt87x_capture_volume_put,
593 };
594 
595 #define snd_bt87x_capture_boost_info	snd_ctl_boolean_mono_info
596 
597 static int snd_bt87x_capture_boost_get(struct snd_kcontrol *kcontrol,
598 				       struct snd_ctl_elem_value *value)
599 {
600 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
601 
602 	value->value.integer.value[0] = !! (chip->reg_control & CTL_A_G2X);
603 	return 0;
604 }
605 
606 static int snd_bt87x_capture_boost_put(struct snd_kcontrol *kcontrol,
607 				       struct snd_ctl_elem_value *value)
608 {
609 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
610 	u32 old_control;
611 	int changed;
612 
613 	spin_lock_irq(&chip->reg_lock);
614 	old_control = chip->reg_control;
615 	chip->reg_control = (chip->reg_control & ~CTL_A_G2X)
616 		| (value->value.integer.value[0] ? CTL_A_G2X : 0);
617 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
618 	changed = chip->reg_control != old_control;
619 	spin_unlock_irq(&chip->reg_lock);
620 	return changed;
621 }
622 
623 static const struct snd_kcontrol_new snd_bt87x_capture_boost = {
624 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
625 	.name = "Capture Boost",
626 	.info = snd_bt87x_capture_boost_info,
627 	.get = snd_bt87x_capture_boost_get,
628 	.put = snd_bt87x_capture_boost_put,
629 };
630 
631 static int snd_bt87x_capture_source_info(struct snd_kcontrol *kcontrol,
632 					 struct snd_ctl_elem_info *info)
633 {
634 	static const char *const texts[3] = {"TV Tuner", "FM", "Mic/Line"};
635 
636 	return snd_ctl_enum_info(info, 1, 3, texts);
637 }
638 
639 static int snd_bt87x_capture_source_get(struct snd_kcontrol *kcontrol,
640 					struct snd_ctl_elem_value *value)
641 {
642 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
643 
644 	value->value.enumerated.item[0] = (chip->reg_control & CTL_A_SEL_MASK) >> CTL_A_SEL_SHIFT;
645 	return 0;
646 }
647 
648 static int snd_bt87x_capture_source_put(struct snd_kcontrol *kcontrol,
649 					struct snd_ctl_elem_value *value)
650 {
651 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
652 	u32 old_control;
653 	int changed;
654 
655 	spin_lock_irq(&chip->reg_lock);
656 	old_control = chip->reg_control;
657 	chip->reg_control = (chip->reg_control & ~CTL_A_SEL_MASK)
658 		| (value->value.enumerated.item[0] << CTL_A_SEL_SHIFT);
659 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
660 	changed = chip->reg_control != old_control;
661 	spin_unlock_irq(&chip->reg_lock);
662 	return changed;
663 }
664 
665 static const struct snd_kcontrol_new snd_bt87x_capture_source = {
666 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
667 	.name = "Capture Source",
668 	.info = snd_bt87x_capture_source_info,
669 	.get = snd_bt87x_capture_source_get,
670 	.put = snd_bt87x_capture_source_put,
671 };
672 
673 static int snd_bt87x_free(struct snd_bt87x *chip)
674 {
675 	if (chip->mmio)
676 		snd_bt87x_stop(chip);
677 	if (chip->irq >= 0)
678 		free_irq(chip->irq, chip);
679 	iounmap(chip->mmio);
680 	pci_release_regions(chip->pci);
681 	pci_disable_device(chip->pci);
682 	kfree(chip);
683 	return 0;
684 }
685 
686 static int snd_bt87x_dev_free(struct snd_device *device)
687 {
688 	struct snd_bt87x *chip = device->device_data;
689 	return snd_bt87x_free(chip);
690 }
691 
692 static int snd_bt87x_pcm(struct snd_bt87x *chip, int device, char *name)
693 {
694 	int err;
695 	struct snd_pcm *pcm;
696 
697 	err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
698 	if (err < 0)
699 		return err;
700 	pcm->private_data = chip;
701 	strcpy(pcm->name, name);
702 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_bt87x_pcm_ops);
703 	snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
704 					      snd_dma_pci_data(chip->pci),
705 					      128 * 1024,
706 					      ALIGN(255 * 4092, 1024));
707 	return 0;
708 }
709 
710 static int snd_bt87x_create(struct snd_card *card,
711 			    struct pci_dev *pci,
712 			    struct snd_bt87x **rchip)
713 {
714 	struct snd_bt87x *chip;
715 	int err;
716 	static struct snd_device_ops ops = {
717 		.dev_free = snd_bt87x_dev_free
718 	};
719 
720 	*rchip = NULL;
721 
722 	err = pci_enable_device(pci);
723 	if (err < 0)
724 		return err;
725 
726 	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
727 	if (!chip) {
728 		pci_disable_device(pci);
729 		return -ENOMEM;
730 	}
731 	chip->card = card;
732 	chip->pci = pci;
733 	chip->irq = -1;
734 	spin_lock_init(&chip->reg_lock);
735 
736 	if ((err = pci_request_regions(pci, "Bt87x audio")) < 0) {
737 		kfree(chip);
738 		pci_disable_device(pci);
739 		return err;
740 	}
741 	chip->mmio = pci_ioremap_bar(pci, 0);
742 	if (!chip->mmio) {
743 		dev_err(card->dev, "cannot remap io memory\n");
744 		err = -ENOMEM;
745 		goto fail;
746 	}
747 
748 	chip->reg_control = CTL_A_PWRDN | CTL_DA_ES2 |
749 			    CTL_PKTP_16 | (15 << CTL_DA_SDR_SHIFT);
750 	chip->interrupt_mask = MY_INTERRUPTS;
751 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
752 	snd_bt87x_writel(chip, REG_INT_MASK, 0);
753 	snd_bt87x_writel(chip, REG_INT_STAT, MY_INTERRUPTS);
754 
755 	err = request_irq(pci->irq, snd_bt87x_interrupt, IRQF_SHARED,
756 			  KBUILD_MODNAME, chip);
757 	if (err < 0) {
758 		dev_err(card->dev, "cannot grab irq %d\n", pci->irq);
759 		goto fail;
760 	}
761 	chip->irq = pci->irq;
762 	pci_set_master(pci);
763 	synchronize_irq(chip->irq);
764 
765 	err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
766 	if (err < 0)
767 		goto fail;
768 
769 	*rchip = chip;
770 	return 0;
771 
772 fail:
773 	snd_bt87x_free(chip);
774 	return err;
775 }
776 
777 #define BT_DEVICE(chip, subvend, subdev, id) \
778 	{ .vendor = PCI_VENDOR_ID_BROOKTREE, \
779 	  .device = chip, \
780 	  .subvendor = subvend, .subdevice = subdev, \
781 	  .driver_data = SND_BT87X_BOARD_ ## id }
782 /* driver_data is the card id for that device */
783 
784 static const struct pci_device_id snd_bt87x_ids[] = {
785 	/* Hauppauge WinTV series */
786 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0x13eb, GENERIC),
787 	/* Hauppauge WinTV series */
788 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_879, 0x0070, 0x13eb, GENERIC),
789 	/* Viewcast Osprey 200 */
790 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0xff01, OSPREY2x0),
791 	/* Viewcast Osprey 440 (rate is configurable via gpio) */
792 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0xff07, OSPREY440),
793 	/* ATI TV-Wonder */
794 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1002, 0x0001, GENERIC),
795 	/* Leadtek Winfast tv 2000xp delux */
796 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x107d, 0x6606, GENERIC),
797 	/* Pinnacle PCTV */
798 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x11bd, 0x0012, GENERIC),
799 	/* Voodoo TV 200 */
800 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x121a, 0x3000, GENERIC),
801 	/* Askey Computer Corp. MagicTView'99 */
802 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x144f, 0x3000, GENERIC),
803 	/* AVerMedia Studio No. 103, 203, ...? */
804 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1461, 0x0003, AVPHONE98),
805 	/* Prolink PixelView PV-M4900 */
806 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1554, 0x4011, GENERIC),
807 	/* Pinnacle  Studio PCTV rave */
808 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0xbd11, 0x1200, GENERIC),
809 	{ }
810 };
811 MODULE_DEVICE_TABLE(pci, snd_bt87x_ids);
812 
813 /* cards known not to have audio
814  * (DVB cards use the audio function to transfer MPEG data) */
815 static struct {
816 	unsigned short subvendor, subdevice;
817 } blacklist[] = {
818 	{0x0071, 0x0101}, /* Nebula Electronics DigiTV */
819 	{0x11bd, 0x001c}, /* Pinnacle PCTV Sat */
820 	{0x11bd, 0x0026}, /* Pinnacle PCTV SAT CI */
821 	{0x1461, 0x0761}, /* AVermedia AverTV DVB-T */
822 	{0x1461, 0x0771}, /* AVermedia DVB-T 771 */
823 	{0x1822, 0x0001}, /* Twinhan VisionPlus DVB-T */
824 	{0x18ac, 0xd500}, /* DVICO FusionHDTV 5 Lite */
825 	{0x18ac, 0xdb10}, /* DVICO FusionHDTV DVB-T Lite */
826 	{0x18ac, 0xdb11}, /* Ultraview DVB-T Lite */
827 	{0x270f, 0xfc00}, /* Chaintech Digitop DST-1000 DVB-S */
828 	{0x7063, 0x2000}, /* pcHDTV HD-2000 TV */
829 };
830 
831 static struct pci_driver driver;
832 
833 /* return the id of the card, or a negative value if it's blacklisted */
834 static int snd_bt87x_detect_card(struct pci_dev *pci)
835 {
836 	int i;
837 	const struct pci_device_id *supported;
838 
839 	supported = pci_match_id(snd_bt87x_ids, pci);
840 	if (supported && supported->driver_data > 0)
841 		return supported->driver_data;
842 
843 	for (i = 0; i < ARRAY_SIZE(blacklist); ++i)
844 		if (blacklist[i].subvendor == pci->subsystem_vendor &&
845 		    blacklist[i].subdevice == pci->subsystem_device) {
846 			dev_dbg(&pci->dev,
847 				"card %#04x-%#04x:%#04x has no audio\n",
848 				    pci->device, pci->subsystem_vendor, pci->subsystem_device);
849 			return -EBUSY;
850 		}
851 
852 	dev_info(&pci->dev, "unknown card %#04x-%#04x:%#04x\n",
853 		   pci->device, pci->subsystem_vendor, pci->subsystem_device);
854 	dev_info(&pci->dev, "please mail id, board name, and, "
855 		   "if it works, the correct digital_rate option to "
856 		   "<alsa-devel@alsa-project.org>\n");
857 	return SND_BT87X_BOARD_UNKNOWN;
858 }
859 
860 static int snd_bt87x_probe(struct pci_dev *pci,
861 			   const struct pci_device_id *pci_id)
862 {
863 	static int dev;
864 	struct snd_card *card;
865 	struct snd_bt87x *chip;
866 	int err;
867 	enum snd_bt87x_boardid boardid;
868 
869 	if (!pci_id->driver_data) {
870 		err = snd_bt87x_detect_card(pci);
871 		if (err < 0)
872 			return -ENODEV;
873 		boardid = err;
874 	} else
875 		boardid = pci_id->driver_data;
876 
877 	if (dev >= SNDRV_CARDS)
878 		return -ENODEV;
879 	if (!enable[dev]) {
880 		++dev;
881 		return -ENOENT;
882 	}
883 
884 	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
885 			   0, &card);
886 	if (err < 0)
887 		return err;
888 
889 	err = snd_bt87x_create(card, pci, &chip);
890 	if (err < 0)
891 		goto _error;
892 
893 	memcpy(&chip->board, &snd_bt87x_boards[boardid], sizeof(chip->board));
894 
895 	if (!chip->board.no_digital) {
896 		if (digital_rate[dev] > 0)
897 			chip->board.dig_rate = digital_rate[dev];
898 
899 		chip->reg_control |= chip->board.digital_fmt;
900 
901 		err = snd_bt87x_pcm(chip, DEVICE_DIGITAL, "Bt87x Digital");
902 		if (err < 0)
903 			goto _error;
904 	}
905 	if (!chip->board.no_analog) {
906 		err = snd_bt87x_pcm(chip, DEVICE_ANALOG, "Bt87x Analog");
907 		if (err < 0)
908 			goto _error;
909 		err = snd_ctl_add(card, snd_ctl_new1(
910 				  &snd_bt87x_capture_volume, chip));
911 		if (err < 0)
912 			goto _error;
913 		err = snd_ctl_add(card, snd_ctl_new1(
914 				  &snd_bt87x_capture_boost, chip));
915 		if (err < 0)
916 			goto _error;
917 		err = snd_ctl_add(card, snd_ctl_new1(
918 				  &snd_bt87x_capture_source, chip));
919 		if (err < 0)
920 			goto _error;
921 	}
922 	dev_info(card->dev, "bt87x%d: Using board %d, %sanalog, %sdigital "
923 		   "(rate %d Hz)\n", dev, boardid,
924 		   chip->board.no_analog ? "no " : "",
925 		   chip->board.no_digital ? "no " : "", chip->board.dig_rate);
926 
927 	strcpy(card->driver, "Bt87x");
928 	sprintf(card->shortname, "Brooktree Bt%x", pci->device);
929 	sprintf(card->longname, "%s at %#llx, irq %i",
930 		card->shortname, (unsigned long long)pci_resource_start(pci, 0),
931 		chip->irq);
932 	strcpy(card->mixername, "Bt87x");
933 
934 	err = snd_card_register(card);
935 	if (err < 0)
936 		goto _error;
937 
938 	pci_set_drvdata(pci, card);
939 	++dev;
940 	return 0;
941 
942 _error:
943 	snd_card_free(card);
944 	return err;
945 }
946 
947 static void snd_bt87x_remove(struct pci_dev *pci)
948 {
949 	snd_card_free(pci_get_drvdata(pci));
950 }
951 
952 /* default entries for all Bt87x cards - it's not exported */
953 /* driver_data is set to 0 to call detection */
954 static const struct pci_device_id snd_bt87x_default_ids[] = {
955 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, PCI_ANY_ID, PCI_ANY_ID, UNKNOWN),
956 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_879, PCI_ANY_ID, PCI_ANY_ID, UNKNOWN),
957 	{ }
958 };
959 
960 static struct pci_driver driver = {
961 	.name = KBUILD_MODNAME,
962 	.id_table = snd_bt87x_ids,
963 	.probe = snd_bt87x_probe,
964 	.remove = snd_bt87x_remove,
965 };
966 
967 static int __init alsa_card_bt87x_init(void)
968 {
969 	if (load_all)
970 		driver.id_table = snd_bt87x_default_ids;
971 	return pci_register_driver(&driver);
972 }
973 
974 static void __exit alsa_card_bt87x_exit(void)
975 {
976 	pci_unregister_driver(&driver);
977 }
978 
979 module_init(alsa_card_bt87x_init)
980 module_exit(alsa_card_bt87x_exit)
981