xref: /openbmc/linux/sound/pci/bt87x.c (revision c1d3fb8a)
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, &chip->pci->dev,
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 };
549 
550 static int snd_bt87x_capture_volume_info(struct snd_kcontrol *kcontrol,
551 					 struct snd_ctl_elem_info *info)
552 {
553 	info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
554 	info->count = 1;
555 	info->value.integer.min = 0;
556 	info->value.integer.max = 15;
557 	return 0;
558 }
559 
560 static int snd_bt87x_capture_volume_get(struct snd_kcontrol *kcontrol,
561 					struct snd_ctl_elem_value *value)
562 {
563 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
564 
565 	value->value.integer.value[0] = (chip->reg_control & CTL_A_GAIN_MASK) >> CTL_A_GAIN_SHIFT;
566 	return 0;
567 }
568 
569 static int snd_bt87x_capture_volume_put(struct snd_kcontrol *kcontrol,
570 					struct snd_ctl_elem_value *value)
571 {
572 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
573 	u32 old_control;
574 	int changed;
575 
576 	spin_lock_irq(&chip->reg_lock);
577 	old_control = chip->reg_control;
578 	chip->reg_control = (chip->reg_control & ~CTL_A_GAIN_MASK)
579 		| (value->value.integer.value[0] << CTL_A_GAIN_SHIFT);
580 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
581 	changed = old_control != chip->reg_control;
582 	spin_unlock_irq(&chip->reg_lock);
583 	return changed;
584 }
585 
586 static const struct snd_kcontrol_new snd_bt87x_capture_volume = {
587 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
588 	.name = "Capture Volume",
589 	.info = snd_bt87x_capture_volume_info,
590 	.get = snd_bt87x_capture_volume_get,
591 	.put = snd_bt87x_capture_volume_put,
592 };
593 
594 #define snd_bt87x_capture_boost_info	snd_ctl_boolean_mono_info
595 
596 static int snd_bt87x_capture_boost_get(struct snd_kcontrol *kcontrol,
597 				       struct snd_ctl_elem_value *value)
598 {
599 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
600 
601 	value->value.integer.value[0] = !! (chip->reg_control & CTL_A_G2X);
602 	return 0;
603 }
604 
605 static int snd_bt87x_capture_boost_put(struct snd_kcontrol *kcontrol,
606 				       struct snd_ctl_elem_value *value)
607 {
608 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
609 	u32 old_control;
610 	int changed;
611 
612 	spin_lock_irq(&chip->reg_lock);
613 	old_control = chip->reg_control;
614 	chip->reg_control = (chip->reg_control & ~CTL_A_G2X)
615 		| (value->value.integer.value[0] ? CTL_A_G2X : 0);
616 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
617 	changed = chip->reg_control != old_control;
618 	spin_unlock_irq(&chip->reg_lock);
619 	return changed;
620 }
621 
622 static const struct snd_kcontrol_new snd_bt87x_capture_boost = {
623 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
624 	.name = "Capture Boost",
625 	.info = snd_bt87x_capture_boost_info,
626 	.get = snd_bt87x_capture_boost_get,
627 	.put = snd_bt87x_capture_boost_put,
628 };
629 
630 static int snd_bt87x_capture_source_info(struct snd_kcontrol *kcontrol,
631 					 struct snd_ctl_elem_info *info)
632 {
633 	static const char *const texts[3] = {"TV Tuner", "FM", "Mic/Line"};
634 
635 	return snd_ctl_enum_info(info, 1, 3, texts);
636 }
637 
638 static int snd_bt87x_capture_source_get(struct snd_kcontrol *kcontrol,
639 					struct snd_ctl_elem_value *value)
640 {
641 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
642 
643 	value->value.enumerated.item[0] = (chip->reg_control & CTL_A_SEL_MASK) >> CTL_A_SEL_SHIFT;
644 	return 0;
645 }
646 
647 static int snd_bt87x_capture_source_put(struct snd_kcontrol *kcontrol,
648 					struct snd_ctl_elem_value *value)
649 {
650 	struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
651 	u32 old_control;
652 	int changed;
653 
654 	spin_lock_irq(&chip->reg_lock);
655 	old_control = chip->reg_control;
656 	chip->reg_control = (chip->reg_control & ~CTL_A_SEL_MASK)
657 		| (value->value.enumerated.item[0] << CTL_A_SEL_SHIFT);
658 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
659 	changed = chip->reg_control != old_control;
660 	spin_unlock_irq(&chip->reg_lock);
661 	return changed;
662 }
663 
664 static const struct snd_kcontrol_new snd_bt87x_capture_source = {
665 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
666 	.name = "Capture Source",
667 	.info = snd_bt87x_capture_source_info,
668 	.get = snd_bt87x_capture_source_get,
669 	.put = snd_bt87x_capture_source_put,
670 };
671 
672 static int snd_bt87x_free(struct snd_bt87x *chip)
673 {
674 	if (chip->mmio)
675 		snd_bt87x_stop(chip);
676 	if (chip->irq >= 0)
677 		free_irq(chip->irq, chip);
678 	iounmap(chip->mmio);
679 	pci_release_regions(chip->pci);
680 	pci_disable_device(chip->pci);
681 	kfree(chip);
682 	return 0;
683 }
684 
685 static int snd_bt87x_dev_free(struct snd_device *device)
686 {
687 	struct snd_bt87x *chip = device->device_data;
688 	return snd_bt87x_free(chip);
689 }
690 
691 static int snd_bt87x_pcm(struct snd_bt87x *chip, int device, char *name)
692 {
693 	int err;
694 	struct snd_pcm *pcm;
695 
696 	err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
697 	if (err < 0)
698 		return err;
699 	pcm->private_data = chip;
700 	strcpy(pcm->name, name);
701 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_bt87x_pcm_ops);
702 	snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
703 					      &chip->pci->dev,
704 					      128 * 1024,
705 					      ALIGN(255 * 4092, 1024));
706 	return 0;
707 }
708 
709 static int snd_bt87x_create(struct snd_card *card,
710 			    struct pci_dev *pci,
711 			    struct snd_bt87x **rchip)
712 {
713 	struct snd_bt87x *chip;
714 	int err;
715 	static struct snd_device_ops ops = {
716 		.dev_free = snd_bt87x_dev_free
717 	};
718 
719 	*rchip = NULL;
720 
721 	err = pci_enable_device(pci);
722 	if (err < 0)
723 		return err;
724 
725 	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
726 	if (!chip) {
727 		pci_disable_device(pci);
728 		return -ENOMEM;
729 	}
730 	chip->card = card;
731 	chip->pci = pci;
732 	chip->irq = -1;
733 	spin_lock_init(&chip->reg_lock);
734 
735 	if ((err = pci_request_regions(pci, "Bt87x audio")) < 0) {
736 		kfree(chip);
737 		pci_disable_device(pci);
738 		return err;
739 	}
740 	chip->mmio = pci_ioremap_bar(pci, 0);
741 	if (!chip->mmio) {
742 		dev_err(card->dev, "cannot remap io memory\n");
743 		err = -ENOMEM;
744 		goto fail;
745 	}
746 
747 	chip->reg_control = CTL_A_PWRDN | CTL_DA_ES2 |
748 			    CTL_PKTP_16 | (15 << CTL_DA_SDR_SHIFT);
749 	chip->interrupt_mask = MY_INTERRUPTS;
750 	snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
751 	snd_bt87x_writel(chip, REG_INT_MASK, 0);
752 	snd_bt87x_writel(chip, REG_INT_STAT, MY_INTERRUPTS);
753 
754 	err = request_irq(pci->irq, snd_bt87x_interrupt, IRQF_SHARED,
755 			  KBUILD_MODNAME, chip);
756 	if (err < 0) {
757 		dev_err(card->dev, "cannot grab irq %d\n", pci->irq);
758 		goto fail;
759 	}
760 	chip->irq = pci->irq;
761 	pci_set_master(pci);
762 	synchronize_irq(chip->irq);
763 
764 	err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
765 	if (err < 0)
766 		goto fail;
767 
768 	*rchip = chip;
769 	return 0;
770 
771 fail:
772 	snd_bt87x_free(chip);
773 	return err;
774 }
775 
776 #define BT_DEVICE(chip, subvend, subdev, id) \
777 	{ .vendor = PCI_VENDOR_ID_BROOKTREE, \
778 	  .device = chip, \
779 	  .subvendor = subvend, .subdevice = subdev, \
780 	  .driver_data = SND_BT87X_BOARD_ ## id }
781 /* driver_data is the card id for that device */
782 
783 static const struct pci_device_id snd_bt87x_ids[] = {
784 	/* Hauppauge WinTV series */
785 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0x13eb, GENERIC),
786 	/* Hauppauge WinTV series */
787 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_879, 0x0070, 0x13eb, GENERIC),
788 	/* Viewcast Osprey 200 */
789 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0xff01, OSPREY2x0),
790 	/* Viewcast Osprey 440 (rate is configurable via gpio) */
791 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0xff07, OSPREY440),
792 	/* ATI TV-Wonder */
793 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1002, 0x0001, GENERIC),
794 	/* Leadtek Winfast tv 2000xp delux */
795 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x107d, 0x6606, GENERIC),
796 	/* Pinnacle PCTV */
797 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x11bd, 0x0012, GENERIC),
798 	/* Voodoo TV 200 */
799 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x121a, 0x3000, GENERIC),
800 	/* Askey Computer Corp. MagicTView'99 */
801 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x144f, 0x3000, GENERIC),
802 	/* AVerMedia Studio No. 103, 203, ...? */
803 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1461, 0x0003, AVPHONE98),
804 	/* Prolink PixelView PV-M4900 */
805 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1554, 0x4011, GENERIC),
806 	/* Pinnacle  Studio PCTV rave */
807 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0xbd11, 0x1200, GENERIC),
808 	{ }
809 };
810 MODULE_DEVICE_TABLE(pci, snd_bt87x_ids);
811 
812 /* cards known not to have audio
813  * (DVB cards use the audio function to transfer MPEG data) */
814 static struct {
815 	unsigned short subvendor, subdevice;
816 } blacklist[] = {
817 	{0x0071, 0x0101}, /* Nebula Electronics DigiTV */
818 	{0x11bd, 0x001c}, /* Pinnacle PCTV Sat */
819 	{0x11bd, 0x0026}, /* Pinnacle PCTV SAT CI */
820 	{0x1461, 0x0761}, /* AVermedia AverTV DVB-T */
821 	{0x1461, 0x0771}, /* AVermedia DVB-T 771 */
822 	{0x1822, 0x0001}, /* Twinhan VisionPlus DVB-T */
823 	{0x18ac, 0xd500}, /* DVICO FusionHDTV 5 Lite */
824 	{0x18ac, 0xdb10}, /* DVICO FusionHDTV DVB-T Lite */
825 	{0x18ac, 0xdb11}, /* Ultraview DVB-T Lite */
826 	{0x270f, 0xfc00}, /* Chaintech Digitop DST-1000 DVB-S */
827 	{0x7063, 0x2000}, /* pcHDTV HD-2000 TV */
828 };
829 
830 static struct pci_driver driver;
831 
832 /* return the id of the card, or a negative value if it's blacklisted */
833 static int snd_bt87x_detect_card(struct pci_dev *pci)
834 {
835 	int i;
836 	const struct pci_device_id *supported;
837 
838 	supported = pci_match_id(snd_bt87x_ids, pci);
839 	if (supported && supported->driver_data > 0)
840 		return supported->driver_data;
841 
842 	for (i = 0; i < ARRAY_SIZE(blacklist); ++i)
843 		if (blacklist[i].subvendor == pci->subsystem_vendor &&
844 		    blacklist[i].subdevice == pci->subsystem_device) {
845 			dev_dbg(&pci->dev,
846 				"card %#04x-%#04x:%#04x has no audio\n",
847 				    pci->device, pci->subsystem_vendor, pci->subsystem_device);
848 			return -EBUSY;
849 		}
850 
851 	dev_info(&pci->dev, "unknown card %#04x-%#04x:%#04x\n",
852 		   pci->device, pci->subsystem_vendor, pci->subsystem_device);
853 	dev_info(&pci->dev, "please mail id, board name, and, "
854 		   "if it works, the correct digital_rate option to "
855 		   "<alsa-devel@alsa-project.org>\n");
856 	return SND_BT87X_BOARD_UNKNOWN;
857 }
858 
859 static int snd_bt87x_probe(struct pci_dev *pci,
860 			   const struct pci_device_id *pci_id)
861 {
862 	static int dev;
863 	struct snd_card *card;
864 	struct snd_bt87x *chip;
865 	int err;
866 	enum snd_bt87x_boardid boardid;
867 
868 	if (!pci_id->driver_data) {
869 		err = snd_bt87x_detect_card(pci);
870 		if (err < 0)
871 			return -ENODEV;
872 		boardid = err;
873 	} else
874 		boardid = pci_id->driver_data;
875 
876 	if (dev >= SNDRV_CARDS)
877 		return -ENODEV;
878 	if (!enable[dev]) {
879 		++dev;
880 		return -ENOENT;
881 	}
882 
883 	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
884 			   0, &card);
885 	if (err < 0)
886 		return err;
887 
888 	err = snd_bt87x_create(card, pci, &chip);
889 	if (err < 0)
890 		goto _error;
891 
892 	memcpy(&chip->board, &snd_bt87x_boards[boardid], sizeof(chip->board));
893 
894 	if (!chip->board.no_digital) {
895 		if (digital_rate[dev] > 0)
896 			chip->board.dig_rate = digital_rate[dev];
897 
898 		chip->reg_control |= chip->board.digital_fmt;
899 
900 		err = snd_bt87x_pcm(chip, DEVICE_DIGITAL, "Bt87x Digital");
901 		if (err < 0)
902 			goto _error;
903 	}
904 	if (!chip->board.no_analog) {
905 		err = snd_bt87x_pcm(chip, DEVICE_ANALOG, "Bt87x Analog");
906 		if (err < 0)
907 			goto _error;
908 		err = snd_ctl_add(card, snd_ctl_new1(
909 				  &snd_bt87x_capture_volume, chip));
910 		if (err < 0)
911 			goto _error;
912 		err = snd_ctl_add(card, snd_ctl_new1(
913 				  &snd_bt87x_capture_boost, chip));
914 		if (err < 0)
915 			goto _error;
916 		err = snd_ctl_add(card, snd_ctl_new1(
917 				  &snd_bt87x_capture_source, chip));
918 		if (err < 0)
919 			goto _error;
920 	}
921 	dev_info(card->dev, "bt87x%d: Using board %d, %sanalog, %sdigital "
922 		   "(rate %d Hz)\n", dev, boardid,
923 		   chip->board.no_analog ? "no " : "",
924 		   chip->board.no_digital ? "no " : "", chip->board.dig_rate);
925 
926 	strcpy(card->driver, "Bt87x");
927 	sprintf(card->shortname, "Brooktree Bt%x", pci->device);
928 	sprintf(card->longname, "%s at %#llx, irq %i",
929 		card->shortname, (unsigned long long)pci_resource_start(pci, 0),
930 		chip->irq);
931 	strcpy(card->mixername, "Bt87x");
932 
933 	err = snd_card_register(card);
934 	if (err < 0)
935 		goto _error;
936 
937 	pci_set_drvdata(pci, card);
938 	++dev;
939 	return 0;
940 
941 _error:
942 	snd_card_free(card);
943 	return err;
944 }
945 
946 static void snd_bt87x_remove(struct pci_dev *pci)
947 {
948 	snd_card_free(pci_get_drvdata(pci));
949 }
950 
951 /* default entries for all Bt87x cards - it's not exported */
952 /* driver_data is set to 0 to call detection */
953 static const struct pci_device_id snd_bt87x_default_ids[] = {
954 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, PCI_ANY_ID, PCI_ANY_ID, UNKNOWN),
955 	BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_879, PCI_ANY_ID, PCI_ANY_ID, UNKNOWN),
956 	{ }
957 };
958 
959 static struct pci_driver driver = {
960 	.name = KBUILD_MODNAME,
961 	.id_table = snd_bt87x_ids,
962 	.probe = snd_bt87x_probe,
963 	.remove = snd_bt87x_remove,
964 };
965 
966 static int __init alsa_card_bt87x_init(void)
967 {
968 	if (load_all)
969 		driver.id_table = snd_bt87x_default_ids;
970 	return pci_register_driver(&driver);
971 }
972 
973 static void __exit alsa_card_bt87x_exit(void)
974 {
975 	pci_unregister_driver(&driver);
976 }
977 
978 module_init(alsa_card_bt87x_init)
979 module_exit(alsa_card_bt87x_exit)
980