6567504665b9bc44160e0630ae265148a6b55a04
[linux-2.6-microblaze.git] / sound / pci / bt87x.c
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 const 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         int pci_status = pci_status_get_and_clear_errors(chip->pci);
275
276         if (pci_status != PCI_STATUS_DETECTED_PARITY)
277                 dev_err(chip->card->dev,
278                         "Aieee - PCI error! status %#08x, PCI status %#04x\n",
279                            status & ERROR_INTERRUPTS, pci_status);
280         else {
281                 dev_err(chip->card->dev,
282                         "Aieee - PCI parity error detected!\n");
283                 /* error 'handling' similar to aic7xxx_pci.c: */
284                 chip->pci_parity_errors++;
285                 if (chip->pci_parity_errors > 20) {
286                         dev_err(chip->card->dev,
287                                 "Too many PCI parity errors observed.\n");
288                         dev_err(chip->card->dev,
289                                 "Some device on this bus is generating bad parity.\n");
290                         dev_err(chip->card->dev,
291                                 "This is an error *observed by*, not *generated by*, this card.\n");
292                         dev_err(chip->card->dev,
293                                 "PCI parity error checking has been disabled.\n");
294                         chip->interrupt_mask &= ~(INT_PPERR | INT_RIPERR);
295                         snd_bt87x_writel(chip, REG_INT_MASK, chip->interrupt_mask);
296                 }
297         }
298 }
299
300 static irqreturn_t snd_bt87x_interrupt(int irq, void *dev_id)
301 {
302         struct snd_bt87x *chip = dev_id;
303         unsigned int status, irq_status;
304
305         status = snd_bt87x_readl(chip, REG_INT_STAT);
306         irq_status = status & chip->interrupt_mask;
307         if (!irq_status)
308                 return IRQ_NONE;
309         snd_bt87x_writel(chip, REG_INT_STAT, irq_status);
310
311         if (irq_status & ERROR_INTERRUPTS) {
312                 if (irq_status & (INT_FBUS | INT_FTRGT))
313                         dev_warn(chip->card->dev,
314                                  "FIFO overrun, status %#08x\n", status);
315                 if (irq_status & INT_OCERR)
316                         dev_err(chip->card->dev,
317                                 "internal RISC error, status %#08x\n", status);
318                 if (irq_status & (INT_PPERR | INT_RIPERR | INT_PABORT))
319                         snd_bt87x_pci_error(chip, irq_status);
320         }
321         if ((irq_status & INT_RISCI) && (chip->reg_control & CTL_ACAP_EN)) {
322                 int current_block, irq_block;
323
324                 /* assume that exactly one line has been recorded */
325                 chip->current_line = (chip->current_line + 1) % chip->lines;
326                 /* but check if some interrupts have been skipped */
327                 current_block = chip->current_line * 16 / chip->lines;
328                 irq_block = status >> INT_RISCS_SHIFT;
329                 if (current_block != irq_block)
330                         chip->current_line = (irq_block * chip->lines + 15) / 16;
331
332                 snd_pcm_period_elapsed(chip->substream);
333         }
334         return IRQ_HANDLED;
335 }
336
337 static const struct snd_pcm_hardware snd_bt87x_digital_hw = {
338         .info = SNDRV_PCM_INFO_MMAP |
339                 SNDRV_PCM_INFO_INTERLEAVED |
340                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
341                 SNDRV_PCM_INFO_MMAP_VALID |
342                 SNDRV_PCM_INFO_BATCH,
343         .formats = SNDRV_PCM_FMTBIT_S16_LE,
344         .rates = 0, /* set at runtime */
345         .channels_min = 2,
346         .channels_max = 2,
347         .buffer_bytes_max = 255 * 4092,
348         .period_bytes_min = 32,
349         .period_bytes_max = 4092,
350         .periods_min = 2,
351         .periods_max = 255,
352 };
353
354 static const struct snd_pcm_hardware snd_bt87x_analog_hw = {
355         .info = SNDRV_PCM_INFO_MMAP |
356                 SNDRV_PCM_INFO_INTERLEAVED |
357                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
358                 SNDRV_PCM_INFO_MMAP_VALID |
359                 SNDRV_PCM_INFO_BATCH,
360         .formats = SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S8,
361         .rates = SNDRV_PCM_RATE_KNOT,
362         .rate_min = ANALOG_CLOCK / CLOCK_DIV_MAX,
363         .rate_max = ANALOG_CLOCK / CLOCK_DIV_MIN,
364         .channels_min = 1,
365         .channels_max = 1,
366         .buffer_bytes_max = 255 * 4092,
367         .period_bytes_min = 32,
368         .period_bytes_max = 4092,
369         .periods_min = 2,
370         .periods_max = 255,
371 };
372
373 static int snd_bt87x_set_digital_hw(struct snd_bt87x *chip, struct snd_pcm_runtime *runtime)
374 {
375         chip->reg_control |= CTL_DA_IOM_DA | CTL_A_PWRDN;
376         runtime->hw = snd_bt87x_digital_hw;
377         runtime->hw.rates = snd_pcm_rate_to_rate_bit(chip->board.dig_rate);
378         runtime->hw.rate_min = chip->board.dig_rate;
379         runtime->hw.rate_max = chip->board.dig_rate;
380         return 0;
381 }
382
383 static int snd_bt87x_set_analog_hw(struct snd_bt87x *chip, struct snd_pcm_runtime *runtime)
384 {
385         static const struct snd_ratnum analog_clock = {
386                 .num = ANALOG_CLOCK,
387                 .den_min = CLOCK_DIV_MIN,
388                 .den_max = CLOCK_DIV_MAX,
389                 .den_step = 1
390         };
391         static const struct snd_pcm_hw_constraint_ratnums constraint_rates = {
392                 .nrats = 1,
393                 .rats = &analog_clock
394         };
395
396         chip->reg_control &= ~(CTL_DA_IOM_DA | CTL_A_PWRDN);
397         runtime->hw = snd_bt87x_analog_hw;
398         return snd_pcm_hw_constraint_ratnums(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
399                                              &constraint_rates);
400 }
401
402 static int snd_bt87x_pcm_open(struct snd_pcm_substream *substream)
403 {
404         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
405         struct snd_pcm_runtime *runtime = substream->runtime;
406         int err;
407
408         if (test_and_set_bit(0, &chip->opened))
409                 return -EBUSY;
410
411         if (substream->pcm->device == DEVICE_DIGITAL)
412                 err = snd_bt87x_set_digital_hw(chip, runtime);
413         else
414                 err = snd_bt87x_set_analog_hw(chip, runtime);
415         if (err < 0)
416                 goto _error;
417
418         err = snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
419         if (err < 0)
420                 goto _error;
421
422         chip->substream = substream;
423         return 0;
424
425 _error:
426         clear_bit(0, &chip->opened);
427         smp_mb__after_atomic();
428         return err;
429 }
430
431 static int snd_bt87x_close(struct snd_pcm_substream *substream)
432 {
433         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
434
435         spin_lock_irq(&chip->reg_lock);
436         chip->reg_control |= CTL_A_PWRDN;
437         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
438         spin_unlock_irq(&chip->reg_lock);
439
440         chip->substream = NULL;
441         clear_bit(0, &chip->opened);
442         smp_mb__after_atomic();
443         return 0;
444 }
445
446 static int snd_bt87x_hw_params(struct snd_pcm_substream *substream,
447                                struct snd_pcm_hw_params *hw_params)
448 {
449         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
450
451         return snd_bt87x_create_risc(chip, substream,
452                                      params_periods(hw_params),
453                                      params_period_bytes(hw_params));
454 }
455
456 static int snd_bt87x_hw_free(struct snd_pcm_substream *substream)
457 {
458         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
459
460         snd_bt87x_free_risc(chip);
461         return 0;
462 }
463
464 static int snd_bt87x_prepare(struct snd_pcm_substream *substream)
465 {
466         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
467         struct snd_pcm_runtime *runtime = substream->runtime;
468         int decimation;
469
470         spin_lock_irq(&chip->reg_lock);
471         chip->reg_control &= ~(CTL_DA_SDR_MASK | CTL_DA_SBR);
472         decimation = (ANALOG_CLOCK + runtime->rate / 4) / runtime->rate;
473         chip->reg_control |= decimation << CTL_DA_SDR_SHIFT;
474         if (runtime->format == SNDRV_PCM_FORMAT_S8)
475                 chip->reg_control |= CTL_DA_SBR;
476         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
477         spin_unlock_irq(&chip->reg_lock);
478         return 0;
479 }
480
481 static int snd_bt87x_start(struct snd_bt87x *chip)
482 {
483         spin_lock(&chip->reg_lock);
484         chip->current_line = 0;
485         chip->reg_control |= CTL_FIFO_ENABLE | CTL_RISC_ENABLE | CTL_ACAP_EN;
486         snd_bt87x_writel(chip, REG_RISC_STRT_ADD, chip->dma_risc.addr);
487         snd_bt87x_writel(chip, REG_PACKET_LEN,
488                          chip->line_bytes | (chip->lines << 16));
489         snd_bt87x_writel(chip, REG_INT_MASK, chip->interrupt_mask);
490         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
491         spin_unlock(&chip->reg_lock);
492         return 0;
493 }
494
495 static int snd_bt87x_stop(struct snd_bt87x *chip)
496 {
497         spin_lock(&chip->reg_lock);
498         chip->reg_control &= ~(CTL_FIFO_ENABLE | CTL_RISC_ENABLE | CTL_ACAP_EN);
499         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
500         snd_bt87x_writel(chip, REG_INT_MASK, 0);
501         snd_bt87x_writel(chip, REG_INT_STAT, MY_INTERRUPTS);
502         spin_unlock(&chip->reg_lock);
503         return 0;
504 }
505
506 static int snd_bt87x_trigger(struct snd_pcm_substream *substream, int cmd)
507 {
508         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
509
510         switch (cmd) {
511         case SNDRV_PCM_TRIGGER_START:
512                 return snd_bt87x_start(chip);
513         case SNDRV_PCM_TRIGGER_STOP:
514                 return snd_bt87x_stop(chip);
515         default:
516                 return -EINVAL;
517         }
518 }
519
520 static snd_pcm_uframes_t snd_bt87x_pointer(struct snd_pcm_substream *substream)
521 {
522         struct snd_bt87x *chip = snd_pcm_substream_chip(substream);
523         struct snd_pcm_runtime *runtime = substream->runtime;
524
525         return (snd_pcm_uframes_t)bytes_to_frames(runtime, chip->current_line * chip->line_bytes);
526 }
527
528 static const struct snd_pcm_ops snd_bt87x_pcm_ops = {
529         .open = snd_bt87x_pcm_open,
530         .close = snd_bt87x_close,
531         .hw_params = snd_bt87x_hw_params,
532         .hw_free = snd_bt87x_hw_free,
533         .prepare = snd_bt87x_prepare,
534         .trigger = snd_bt87x_trigger,
535         .pointer = snd_bt87x_pointer,
536 };
537
538 static int snd_bt87x_capture_volume_info(struct snd_kcontrol *kcontrol,
539                                          struct snd_ctl_elem_info *info)
540 {
541         info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
542         info->count = 1;
543         info->value.integer.min = 0;
544         info->value.integer.max = 15;
545         return 0;
546 }
547
548 static int snd_bt87x_capture_volume_get(struct snd_kcontrol *kcontrol,
549                                         struct snd_ctl_elem_value *value)
550 {
551         struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
552
553         value->value.integer.value[0] = (chip->reg_control & CTL_A_GAIN_MASK) >> CTL_A_GAIN_SHIFT;
554         return 0;
555 }
556
557 static int snd_bt87x_capture_volume_put(struct snd_kcontrol *kcontrol,
558                                         struct snd_ctl_elem_value *value)
559 {
560         struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
561         u32 old_control;
562         int changed;
563
564         spin_lock_irq(&chip->reg_lock);
565         old_control = chip->reg_control;
566         chip->reg_control = (chip->reg_control & ~CTL_A_GAIN_MASK)
567                 | (value->value.integer.value[0] << CTL_A_GAIN_SHIFT);
568         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
569         changed = old_control != chip->reg_control;
570         spin_unlock_irq(&chip->reg_lock);
571         return changed;
572 }
573
574 static const struct snd_kcontrol_new snd_bt87x_capture_volume = {
575         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
576         .name = "Capture Volume",
577         .info = snd_bt87x_capture_volume_info,
578         .get = snd_bt87x_capture_volume_get,
579         .put = snd_bt87x_capture_volume_put,
580 };
581
582 #define snd_bt87x_capture_boost_info    snd_ctl_boolean_mono_info
583
584 static int snd_bt87x_capture_boost_get(struct snd_kcontrol *kcontrol,
585                                        struct snd_ctl_elem_value *value)
586 {
587         struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
588
589         value->value.integer.value[0] = !! (chip->reg_control & CTL_A_G2X);
590         return 0;
591 }
592
593 static int snd_bt87x_capture_boost_put(struct snd_kcontrol *kcontrol,
594                                        struct snd_ctl_elem_value *value)
595 {
596         struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
597         u32 old_control;
598         int changed;
599
600         spin_lock_irq(&chip->reg_lock);
601         old_control = chip->reg_control;
602         chip->reg_control = (chip->reg_control & ~CTL_A_G2X)
603                 | (value->value.integer.value[0] ? CTL_A_G2X : 0);
604         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
605         changed = chip->reg_control != old_control;
606         spin_unlock_irq(&chip->reg_lock);
607         return changed;
608 }
609
610 static const struct snd_kcontrol_new snd_bt87x_capture_boost = {
611         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
612         .name = "Capture Boost",
613         .info = snd_bt87x_capture_boost_info,
614         .get = snd_bt87x_capture_boost_get,
615         .put = snd_bt87x_capture_boost_put,
616 };
617
618 static int snd_bt87x_capture_source_info(struct snd_kcontrol *kcontrol,
619                                          struct snd_ctl_elem_info *info)
620 {
621         static const char *const texts[3] = {"TV Tuner", "FM", "Mic/Line"};
622
623         return snd_ctl_enum_info(info, 1, 3, texts);
624 }
625
626 static int snd_bt87x_capture_source_get(struct snd_kcontrol *kcontrol,
627                                         struct snd_ctl_elem_value *value)
628 {
629         struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
630
631         value->value.enumerated.item[0] = (chip->reg_control & CTL_A_SEL_MASK) >> CTL_A_SEL_SHIFT;
632         return 0;
633 }
634
635 static int snd_bt87x_capture_source_put(struct snd_kcontrol *kcontrol,
636                                         struct snd_ctl_elem_value *value)
637 {
638         struct snd_bt87x *chip = snd_kcontrol_chip(kcontrol);
639         u32 old_control;
640         int changed;
641
642         spin_lock_irq(&chip->reg_lock);
643         old_control = chip->reg_control;
644         chip->reg_control = (chip->reg_control & ~CTL_A_SEL_MASK)
645                 | (value->value.enumerated.item[0] << CTL_A_SEL_SHIFT);
646         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
647         changed = chip->reg_control != old_control;
648         spin_unlock_irq(&chip->reg_lock);
649         return changed;
650 }
651
652 static const struct snd_kcontrol_new snd_bt87x_capture_source = {
653         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
654         .name = "Capture Source",
655         .info = snd_bt87x_capture_source_info,
656         .get = snd_bt87x_capture_source_get,
657         .put = snd_bt87x_capture_source_put,
658 };
659
660 static int snd_bt87x_free(struct snd_bt87x *chip)
661 {
662         if (chip->mmio)
663                 snd_bt87x_stop(chip);
664         if (chip->irq >= 0)
665                 free_irq(chip->irq, chip);
666         iounmap(chip->mmio);
667         pci_release_regions(chip->pci);
668         pci_disable_device(chip->pci);
669         kfree(chip);
670         return 0;
671 }
672
673 static int snd_bt87x_dev_free(struct snd_device *device)
674 {
675         struct snd_bt87x *chip = device->device_data;
676         return snd_bt87x_free(chip);
677 }
678
679 static int snd_bt87x_pcm(struct snd_bt87x *chip, int device, char *name)
680 {
681         int err;
682         struct snd_pcm *pcm;
683
684         err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
685         if (err < 0)
686                 return err;
687         pcm->private_data = chip;
688         strcpy(pcm->name, name);
689         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_bt87x_pcm_ops);
690         snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
691                                        &chip->pci->dev,
692                                        128 * 1024,
693                                        ALIGN(255 * 4092, 1024));
694         return 0;
695 }
696
697 static int snd_bt87x_create(struct snd_card *card,
698                             struct pci_dev *pci,
699                             struct snd_bt87x **rchip)
700 {
701         struct snd_bt87x *chip;
702         int err;
703         static const struct snd_device_ops ops = {
704                 .dev_free = snd_bt87x_dev_free
705         };
706
707         *rchip = NULL;
708
709         err = pci_enable_device(pci);
710         if (err < 0)
711                 return err;
712
713         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
714         if (!chip) {
715                 pci_disable_device(pci);
716                 return -ENOMEM;
717         }
718         chip->card = card;
719         chip->pci = pci;
720         chip->irq = -1;
721         spin_lock_init(&chip->reg_lock);
722
723         if ((err = pci_request_regions(pci, "Bt87x audio")) < 0) {
724                 kfree(chip);
725                 pci_disable_device(pci);
726                 return err;
727         }
728         chip->mmio = pci_ioremap_bar(pci, 0);
729         if (!chip->mmio) {
730                 dev_err(card->dev, "cannot remap io memory\n");
731                 err = -ENOMEM;
732                 goto fail;
733         }
734
735         chip->reg_control = CTL_A_PWRDN | CTL_DA_ES2 |
736                             CTL_PKTP_16 | (15 << CTL_DA_SDR_SHIFT);
737         chip->interrupt_mask = MY_INTERRUPTS;
738         snd_bt87x_writel(chip, REG_GPIO_DMA_CTL, chip->reg_control);
739         snd_bt87x_writel(chip, REG_INT_MASK, 0);
740         snd_bt87x_writel(chip, REG_INT_STAT, MY_INTERRUPTS);
741
742         err = request_irq(pci->irq, snd_bt87x_interrupt, IRQF_SHARED,
743                           KBUILD_MODNAME, chip);
744         if (err < 0) {
745                 dev_err(card->dev, "cannot grab irq %d\n", pci->irq);
746                 goto fail;
747         }
748         chip->irq = pci->irq;
749         card->sync_irq = chip->irq;
750         pci_set_master(pci);
751
752         err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
753         if (err < 0)
754                 goto fail;
755
756         *rchip = chip;
757         return 0;
758
759 fail:
760         snd_bt87x_free(chip);
761         return err;
762 }
763
764 #define BT_DEVICE(chip, subvend, subdev, id) \
765         { .vendor = PCI_VENDOR_ID_BROOKTREE, \
766           .device = chip, \
767           .subvendor = subvend, .subdevice = subdev, \
768           .driver_data = SND_BT87X_BOARD_ ## id }
769 /* driver_data is the card id for that device */
770
771 static const struct pci_device_id snd_bt87x_ids[] = {
772         /* Hauppauge WinTV series */
773         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0x13eb, GENERIC),
774         /* Hauppauge WinTV series */
775         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_879, 0x0070, 0x13eb, GENERIC),
776         /* Viewcast Osprey 200 */
777         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0xff01, OSPREY2x0),
778         /* Viewcast Osprey 440 (rate is configurable via gpio) */
779         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x0070, 0xff07, OSPREY440),
780         /* ATI TV-Wonder */
781         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1002, 0x0001, GENERIC),
782         /* Leadtek Winfast tv 2000xp delux */
783         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x107d, 0x6606, GENERIC),
784         /* Pinnacle PCTV */
785         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x11bd, 0x0012, GENERIC),
786         /* Voodoo TV 200 */
787         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x121a, 0x3000, GENERIC),
788         /* Askey Computer Corp. MagicTView'99 */
789         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x144f, 0x3000, GENERIC),
790         /* AVerMedia Studio No. 103, 203, ...? */
791         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1461, 0x0003, AVPHONE98),
792         /* Prolink PixelView PV-M4900 */
793         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0x1554, 0x4011, GENERIC),
794         /* Pinnacle  Studio PCTV rave */
795         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, 0xbd11, 0x1200, GENERIC),
796         { }
797 };
798 MODULE_DEVICE_TABLE(pci, snd_bt87x_ids);
799
800 /* cards known not to have audio
801  * (DVB cards use the audio function to transfer MPEG data) */
802 static struct {
803         unsigned short subvendor, subdevice;
804 } blacklist[] = {
805         {0x0071, 0x0101}, /* Nebula Electronics DigiTV */
806         {0x11bd, 0x001c}, /* Pinnacle PCTV Sat */
807         {0x11bd, 0x0026}, /* Pinnacle PCTV SAT CI */
808         {0x1461, 0x0761}, /* AVermedia AverTV DVB-T */
809         {0x1461, 0x0771}, /* AVermedia DVB-T 771 */
810         {0x1822, 0x0001}, /* Twinhan VisionPlus DVB-T */
811         {0x18ac, 0xd500}, /* DVICO FusionHDTV 5 Lite */
812         {0x18ac, 0xdb10}, /* DVICO FusionHDTV DVB-T Lite */
813         {0x18ac, 0xdb11}, /* Ultraview DVB-T Lite */
814         {0x270f, 0xfc00}, /* Chaintech Digitop DST-1000 DVB-S */
815         {0x7063, 0x2000}, /* pcHDTV HD-2000 TV */
816 };
817
818 static struct pci_driver driver;
819
820 /* return the id of the card, or a negative value if it's blacklisted */
821 static int snd_bt87x_detect_card(struct pci_dev *pci)
822 {
823         int i;
824         const struct pci_device_id *supported;
825
826         supported = pci_match_id(snd_bt87x_ids, pci);
827         if (supported && supported->driver_data > 0)
828                 return supported->driver_data;
829
830         for (i = 0; i < ARRAY_SIZE(blacklist); ++i)
831                 if (blacklist[i].subvendor == pci->subsystem_vendor &&
832                     blacklist[i].subdevice == pci->subsystem_device) {
833                         dev_dbg(&pci->dev,
834                                 "card %#04x-%#04x:%#04x has no audio\n",
835                                     pci->device, pci->subsystem_vendor, pci->subsystem_device);
836                         return -EBUSY;
837                 }
838
839         dev_info(&pci->dev, "unknown card %#04x-%#04x:%#04x\n",
840                    pci->device, pci->subsystem_vendor, pci->subsystem_device);
841         dev_info(&pci->dev, "please mail id, board name, and, "
842                    "if it works, the correct digital_rate option to "
843                    "<alsa-devel@alsa-project.org>\n");
844         return SND_BT87X_BOARD_UNKNOWN;
845 }
846
847 static int snd_bt87x_probe(struct pci_dev *pci,
848                            const struct pci_device_id *pci_id)
849 {
850         static int dev;
851         struct snd_card *card;
852         struct snd_bt87x *chip;
853         int err;
854         enum snd_bt87x_boardid boardid;
855
856         if (!pci_id->driver_data) {
857                 err = snd_bt87x_detect_card(pci);
858                 if (err < 0)
859                         return -ENODEV;
860                 boardid = err;
861         } else
862                 boardid = pci_id->driver_data;
863
864         if (dev >= SNDRV_CARDS)
865                 return -ENODEV;
866         if (!enable[dev]) {
867                 ++dev;
868                 return -ENOENT;
869         }
870
871         err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
872                            0, &card);
873         if (err < 0)
874                 return err;
875
876         err = snd_bt87x_create(card, pci, &chip);
877         if (err < 0)
878                 goto _error;
879
880         memcpy(&chip->board, &snd_bt87x_boards[boardid], sizeof(chip->board));
881
882         if (!chip->board.no_digital) {
883                 if (digital_rate[dev] > 0)
884                         chip->board.dig_rate = digital_rate[dev];
885
886                 chip->reg_control |= chip->board.digital_fmt;
887
888                 err = snd_bt87x_pcm(chip, DEVICE_DIGITAL, "Bt87x Digital");
889                 if (err < 0)
890                         goto _error;
891         }
892         if (!chip->board.no_analog) {
893                 err = snd_bt87x_pcm(chip, DEVICE_ANALOG, "Bt87x Analog");
894                 if (err < 0)
895                         goto _error;
896                 err = snd_ctl_add(card, snd_ctl_new1(
897                                   &snd_bt87x_capture_volume, chip));
898                 if (err < 0)
899                         goto _error;
900                 err = snd_ctl_add(card, snd_ctl_new1(
901                                   &snd_bt87x_capture_boost, chip));
902                 if (err < 0)
903                         goto _error;
904                 err = snd_ctl_add(card, snd_ctl_new1(
905                                   &snd_bt87x_capture_source, chip));
906                 if (err < 0)
907                         goto _error;
908         }
909         dev_info(card->dev, "bt87x%d: Using board %d, %sanalog, %sdigital "
910                    "(rate %d Hz)\n", dev, boardid,
911                    chip->board.no_analog ? "no " : "",
912                    chip->board.no_digital ? "no " : "", chip->board.dig_rate);
913
914         strcpy(card->driver, "Bt87x");
915         sprintf(card->shortname, "Brooktree Bt%x", pci->device);
916         sprintf(card->longname, "%s at %#llx, irq %i",
917                 card->shortname, (unsigned long long)pci_resource_start(pci, 0),
918                 chip->irq);
919         strcpy(card->mixername, "Bt87x");
920
921         err = snd_card_register(card);
922         if (err < 0)
923                 goto _error;
924
925         pci_set_drvdata(pci, card);
926         ++dev;
927         return 0;
928
929 _error:
930         snd_card_free(card);
931         return err;
932 }
933
934 static void snd_bt87x_remove(struct pci_dev *pci)
935 {
936         snd_card_free(pci_get_drvdata(pci));
937 }
938
939 /* default entries for all Bt87x cards - it's not exported */
940 /* driver_data is set to 0 to call detection */
941 static const struct pci_device_id snd_bt87x_default_ids[] = {
942         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_878, PCI_ANY_ID, PCI_ANY_ID, UNKNOWN),
943         BT_DEVICE(PCI_DEVICE_ID_BROOKTREE_879, PCI_ANY_ID, PCI_ANY_ID, UNKNOWN),
944         { }
945 };
946
947 static struct pci_driver driver = {
948         .name = KBUILD_MODNAME,
949         .id_table = snd_bt87x_ids,
950         .probe = snd_bt87x_probe,
951         .remove = snd_bt87x_remove,
952 };
953
954 static int __init alsa_card_bt87x_init(void)
955 {
956         if (load_all)
957                 driver.id_table = snd_bt87x_default_ids;
958         return pci_register_driver(&driver);
959 }
960
961 static void __exit alsa_card_bt87x_exit(void)
962 {
963         pci_unregister_driver(&driver);
964 }
965
966 module_init(alsa_card_bt87x_init)
967 module_exit(alsa_card_bt87x_exit)