43c901bf7c1f7178b71fb7fddc4637f8a92fa992
[linux-2.6.git] / include / sound / vx_core.h
1 /*
2  * Driver for Digigram VX soundcards
3  *
4  * Hardware core part
5  *
6  * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7  *
8  *   This program is free software; you can redistribute it and/or modify
9  *   it under the terms of the GNU General Public License as published by
10  *   the Free Software Foundation; either version 2 of the License, or
11  *   (at your option) any later version.
12  *
13  *   This program is distributed in the hope that it will be useful,
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *   GNU General Public License for more details.
17  *
18  *   You should have received a copy of the GNU General Public License
19  *   along with this program; if not, write to the Free Software
20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21  */
22
23 #ifndef __SOUND_VX_COMMON_H
24 #define __SOUND_VX_COMMON_H
25
26 #include <sound/pcm.h>
27 #include <sound/hwdep.h>
28 #include <linux/interrupt.h>
29
30 #if defined(CONFIG_FW_LOADER) || defined(CONFIG_FW_LOADER_MODULE)
31 #if !defined(CONFIG_USE_VXLOADER) && !defined(CONFIG_SND_VX_LIB) /* built-in kernel */
32 #define SND_VX_FW_LOADER        /* use the standard firmware loader */
33 #endif
34 #endif
35
36 struct firmware;
37 struct device;
38
39 typedef struct snd_vx_core vx_core_t;
40 typedef struct vx_pipe vx_pipe_t;
41
42 #define VX_DRIVER_VERSION       0x010000        /* 1.0.0 */
43
44 /*
45  */
46 #define SIZE_MAX_CMD    0x10
47 #define SIZE_MAX_STATUS 0x10
48
49 struct vx_rmh {
50         u16     LgCmd;          /* length of the command to send (WORDs) */
51         u16     LgStat;         /* length of the status received (WORDs) */
52         u32     Cmd[SIZE_MAX_CMD];
53         u32     Stat[SIZE_MAX_STATUS];
54         u16     DspStat;        /* status type, RMP_SSIZE_XXX */
55 };
56         
57 typedef u64 pcx_time_t;
58
59 #define VX_MAX_PIPES    16
60 #define VX_MAX_PERIODS  32
61 #define VX_MAX_CODECS   2
62
63 struct vx_ibl_info {
64         int size;       /* the current IBL size (0 = query) in bytes */
65         int max_size;   /* max. IBL size in bytes */
66         int min_size;   /* min. IBL size in bytes */
67         int granularity;        /* granularity */
68 };
69
70 struct vx_pipe {
71         int number;
72         unsigned int is_capture: 1;
73         unsigned int data_mode: 1;
74         unsigned int running: 1;
75         unsigned int prepared: 1;
76         int channels;
77         unsigned int differed_type;
78         pcx_time_t pcx_time;
79         snd_pcm_substream_t *substream;
80
81         int hbuf_size;          /* H-buffer size in bytes */
82         int buffer_bytes;       /* the ALSA pcm buffer size in bytes */
83         int period_bytes;       /* the ALSA pcm period size in bytes */
84         int hw_ptr;             /* the current hardware pointer in bytes */
85         int position;           /* the current position in frames (playback only) */
86         int transferred;        /* the transferred size (per period) in frames */
87         int align;              /* size of alignment */
88         u64 cur_count;          /* current sample position (for playback) */
89
90         unsigned int references;     /* an output pipe may be used for monitoring and/or playback */
91         vx_pipe_t *monitoring_pipe;  /* pointer to the monitoring pipe (capture pipe only)*/
92
93         struct tasklet_struct start_tq;
94 };
95
96 struct snd_vx_ops {
97         /* low-level i/o */
98         unsigned char (*in8)(vx_core_t *chip, int reg);
99         unsigned int (*in32)(vx_core_t *chip, int reg);
100         void (*out8)(vx_core_t *chip, int reg, unsigned char val);
101         void (*out32)(vx_core_t *chip, int reg, unsigned int val);
102         /* irq */
103         int (*test_and_ack)(vx_core_t *chip);
104         void (*validate_irq)(vx_core_t *chip, int enable);
105         /* codec */
106         void (*write_codec)(vx_core_t *chip, int codec, unsigned int data);
107         void (*akm_write)(vx_core_t *chip, int reg, unsigned int data);
108         void (*reset_codec)(vx_core_t *chip);
109         void (*change_audio_source)(vx_core_t *chip, int src);
110         void (*set_clock_source)(vx_core_t *chp, int src);
111         /* chip init */
112         int (*load_dsp)(vx_core_t *chip, int idx, const struct firmware *fw);
113         void (*reset_dsp)(vx_core_t *chip);
114         void (*reset_board)(vx_core_t *chip, int cold_reset);
115         int (*add_controls)(vx_core_t *chip);
116         /* pcm */
117         void (*dma_write)(vx_core_t *chip, snd_pcm_runtime_t *runtime,
118                           vx_pipe_t *pipe, int count);
119         void (*dma_read)(vx_core_t *chip, snd_pcm_runtime_t *runtime,
120                           vx_pipe_t *pipe, int count);
121 };
122
123 struct snd_vx_hardware {
124         const char *name;
125         int type;       /* VX_TYPE_XXX */
126
127         /* hardware specs */
128         unsigned int num_codecs;
129         unsigned int num_ins;
130         unsigned int num_outs;
131         unsigned int output_level_max;
132 };
133
134 /* hwdep id string */
135 #define SND_VX_HWDEP_ID         "VX Loader"
136
137 /* hardware type */
138 enum {
139         /* VX222 PCI */
140         VX_TYPE_BOARD,          /* old VX222 PCI */
141         VX_TYPE_V2,             /* VX222 V2 PCI */
142         VX_TYPE_MIC,            /* VX222 Mic PCI */
143         /* VX-pocket */
144         VX_TYPE_VXPOCKET,       /* VXpocket V2 */
145         VX_TYPE_VXP440,         /* VXpocket 440 */
146         VX_TYPE_NUMS
147 };
148
149 /* chip status */
150 enum {
151         VX_STAT_XILINX_LOADED   = (1 << 0),     /* devices are registered */
152         VX_STAT_DEVICE_INIT     = (1 << 1),     /* devices are registered */
153         VX_STAT_CHIP_INIT       = (1 << 2),     /* all operational */
154         VX_STAT_IN_SUSPEND      = (1 << 10),    /* in suspend phase */
155         VX_STAT_IS_STALE        = (1 << 15)     /* device is stale */
156 };
157
158 /* min/max values for analog output for old codecs */
159 #define VX_ANALOG_OUT_LEVEL_MAX         0xe3
160
161 struct snd_vx_core {
162         /* ALSA stuff */
163         snd_card_t *card;
164         snd_pcm_t *pcm[VX_MAX_CODECS];
165         int type;       /* VX_TYPE_XXX */
166
167         int irq;
168         /* ports are defined externally */
169
170         /* low-level functions */
171         struct snd_vx_hardware *hw;
172         struct snd_vx_ops *ops;
173
174         spinlock_t lock;
175         spinlock_t irq_lock;
176         struct tasklet_struct tq;
177
178         unsigned int chip_status;
179         unsigned int pcm_running;
180
181         struct device *dev;
182         snd_hwdep_t *hwdep;
183
184         struct vx_rmh irq_rmh;  /* RMH used in interrupts */
185
186         unsigned int audio_info; /* see VX_AUDIO_INFO */
187         unsigned int audio_ins;
188         unsigned int audio_outs;
189         struct vx_pipe **playback_pipes;
190         struct vx_pipe **capture_pipes;
191
192         /* clock and audio sources */
193         unsigned int audio_source;      /* current audio input source */
194         unsigned int audio_source_target;
195         unsigned int clock_mode;        /* clock mode (VX_CLOCK_MODE_XXX) */
196         unsigned int clock_source;      /* current clock source (INTERNAL_QUARTZ or UER_SYNC) */
197         unsigned int freq;              /* current frequency */
198         unsigned int freq_detected;     /* detected frequency from digital in */
199         unsigned int uer_detected;      /* VX_UER_MODE_XXX */
200         unsigned int uer_bits;  /* IEC958 status bits */
201         struct vx_ibl_info ibl; /* IBL information */
202
203         /* mixer setting */
204         int output_level[VX_MAX_CODECS][2];     /* analog output level */
205         int audio_gain[2][4];                   /* digital audio level (playback/capture) */
206         unsigned char audio_active[4];          /* mute/unmute on digital playback */
207         int audio_monitor[4];                   /* playback hw-monitor level */
208         unsigned char audio_monitor_active[4];  /* playback hw-monitor mute/unmute */
209
210         struct semaphore mixer_mutex;
211
212         const struct firmware *firmware[4]; /* loaded firmware data */
213 };
214
215
216 /*
217  * constructor
218  */
219 vx_core_t *snd_vx_create(snd_card_t *card, struct snd_vx_hardware *hw,
220                          struct snd_vx_ops *ops, int extra_size);
221 int snd_vx_setup_firmware(vx_core_t *chip);
222 int snd_vx_load_boot_image(vx_core_t *chip, const struct firmware *dsp);
223 int snd_vx_dsp_boot(vx_core_t *chip, const struct firmware *dsp);
224 int snd_vx_dsp_load(vx_core_t *chip, const struct firmware *dsp);
225
226 void snd_vx_free_firmware(vx_core_t *chip);
227
228 /*
229  * interrupt handler; exported for pcmcia
230  */
231 irqreturn_t snd_vx_irq_handler(int irq, void *dev, struct pt_regs *regs);
232
233 /*
234  * lowlevel functions
235  */
236 static inline int vx_test_and_ack(vx_core_t *chip)
237 {
238         snd_assert(chip->ops->test_and_ack, return -ENXIO);
239         return chip->ops->test_and_ack(chip);
240 }
241
242 static inline void vx_validate_irq(vx_core_t *chip, int enable)
243 {
244         snd_assert(chip->ops->validate_irq, return);
245         chip->ops->validate_irq(chip, enable);
246 }
247
248 static inline unsigned char snd_vx_inb(vx_core_t *chip, int reg)
249 {
250         snd_assert(chip->ops->in8, return 0);
251         return chip->ops->in8(chip, reg);
252 }
253
254 static inline unsigned int snd_vx_inl(vx_core_t *chip, int reg)
255 {
256         snd_assert(chip->ops->in32, return 0);
257         return chip->ops->in32(chip, reg);
258 }
259
260 static inline void snd_vx_outb(vx_core_t *chip, int reg, unsigned char val)
261 {
262         snd_assert(chip->ops->out8, return);
263         chip->ops->out8(chip, reg, val);
264 }
265
266 static inline void snd_vx_outl(vx_core_t *chip, int reg, unsigned int val)
267 {
268         snd_assert(chip->ops->out32, return);
269         chip->ops->out32(chip, reg, val);
270 }
271
272 #define vx_inb(chip,reg)        snd_vx_inb(chip, VX_##reg)
273 #define vx_outb(chip,reg,val)   snd_vx_outb(chip, VX_##reg,val)
274 #define vx_inl(chip,reg)        snd_vx_inl(chip, VX_##reg)
275 #define vx_outl(chip,reg,val)   snd_vx_outl(chip, VX_##reg,val)
276
277 static inline void vx_reset_dsp(vx_core_t *chip)
278 {
279         snd_assert(chip->ops->reset_dsp, return);
280         chip->ops->reset_dsp(chip);
281 }
282
283 int vx_send_msg(vx_core_t *chip, struct vx_rmh *rmh);
284 int vx_send_msg_nolock(vx_core_t *chip, struct vx_rmh *rmh);
285 int vx_send_rih(vx_core_t *chip, int cmd);
286 int vx_send_rih_nolock(vx_core_t *chip, int cmd);
287
288 void vx_reset_codec(vx_core_t *chip, int cold_reset);
289
290 /*
291  * check the bit on the specified register
292  * returns zero if a bit matches, or a negative error code.
293  * exported for vxpocket driver
294  */
295 int snd_vx_check_reg_bit(vx_core_t *chip, int reg, int mask, int bit, int time);
296 #define vx_check_isr(chip,mask,bit,time) snd_vx_check_reg_bit(chip, VX_ISR, mask, bit, time)
297 #define vx_wait_isr_bit(chip,bit) vx_check_isr(chip, bit, bit, 200)
298 #define vx_wait_for_rx_full(chip) vx_wait_isr_bit(chip, ISR_RX_FULL)
299
300
301 /*
302  * pseudo-DMA transfer
303  */
304 static inline void vx_pseudo_dma_write(vx_core_t *chip, snd_pcm_runtime_t *runtime,
305                                        vx_pipe_t *pipe, int count)
306 {
307         snd_assert(chip->ops->dma_write, return);
308         chip->ops->dma_write(chip, runtime, pipe, count);
309 }
310
311 static inline void vx_pseudo_dma_read(vx_core_t *chip, snd_pcm_runtime_t *runtime,
312                                       vx_pipe_t *pipe, int count)
313 {
314         snd_assert(chip->ops->dma_read, return);
315         chip->ops->dma_read(chip, runtime, pipe, count);
316 }
317
318
319
320 /* error with hardware code,
321  * the return value is -(VX_ERR_MASK | actual-hw-error-code)
322  */
323 #define VX_ERR_MASK     0x1000000
324 #define vx_get_error(err)       (-(err) & ~VX_ERR_MASK)
325
326
327 /*
328  * pcm stuff
329  */
330 int snd_vx_pcm_new(vx_core_t *chip);
331 void vx_pcm_update_intr(vx_core_t *chip, unsigned int events);
332
333 /*
334  * mixer stuff
335  */
336 int snd_vx_mixer_new(vx_core_t *chip);
337 void vx_toggle_dac_mute(vx_core_t *chip, int mute);
338 int vx_sync_audio_source(vx_core_t *chip);
339 int vx_set_monitor_level(vx_core_t *chip, int audio, int level, int active);
340
341 /*
342  * IEC958 & clock stuff
343  */
344 void vx_set_iec958_status(vx_core_t *chip, unsigned int bits);
345 int vx_set_clock(vx_core_t *chip, unsigned int freq);
346 void vx_set_internal_clock(vx_core_t *chip, unsigned int freq);
347 int vx_change_frequency(vx_core_t *chip);
348
349
350 /*
351  * hardware constants
352  */
353
354 #define vx_has_new_dsp(chip)    ((chip)->type != VX_TYPE_BOARD)
355 #define vx_is_pcmcia(chip)      ((chip)->type >= VX_TYPE_VXPOCKET)
356
357 /* audio input source */
358 enum {
359         VX_AUDIO_SRC_DIGITAL,
360         VX_AUDIO_SRC_LINE,
361         VX_AUDIO_SRC_MIC
362 };
363
364 /* clock source */
365 enum {
366         INTERNAL_QUARTZ,
367         UER_SYNC
368 };
369
370 /* clock mode */
371 enum {
372         VX_CLOCK_MODE_AUTO,     /* depending on the current audio source */
373         VX_CLOCK_MODE_INTERNAL, /* fixed to internal quartz */
374         VX_CLOCK_MODE_EXTERNAL  /* fixed to UER sync */
375 };
376
377 /* SPDIF/UER type */
378 enum {
379         VX_UER_MODE_CONSUMER,
380         VX_UER_MODE_PROFESSIONAL,
381         VX_UER_MODE_NOT_PRESENT,
382 };
383
384 /* register indices */
385 enum {
386         VX_ICR,
387         VX_CVR,
388         VX_ISR,
389         VX_IVR,
390         VX_RXH,
391         VX_TXH = VX_RXH,
392         VX_RXM,
393         VX_TXM = VX_RXM,
394         VX_RXL,
395         VX_TXL = VX_RXL,
396         VX_DMA,
397         VX_CDSP,
398         VX_RFREQ,
399         VX_RUER_V2,
400         VX_GAIN,
401         VX_DATA = VX_GAIN,
402         VX_MEMIRQ,
403         VX_ACQ,
404         VX_BIT0,
405         VX_BIT1,
406         VX_MIC0,
407         VX_MIC1,
408         VX_MIC2,
409         VX_MIC3,
410         VX_PLX0,
411         VX_PLX1,
412         VX_PLX2,
413
414         VX_LOFREQ,  // V2: ACQ, VP: RFREQ
415         VX_HIFREQ,  // V2: BIT0, VP: RUER_V2
416         VX_CSUER,   // V2: BIT1, VP: BIT0
417         VX_RUER,    // V2: RUER_V2, VP: BIT1
418
419         VX_REG_MAX,
420
421         /* aliases for VX board */
422         VX_RESET_DMA = VX_ISR,
423         VX_CFG = VX_RFREQ,
424         VX_STATUS = VX_MEMIRQ,
425         VX_SELMIC = VX_MIC0,
426         VX_COMPOT = VX_MIC1,
427         VX_SCOMPR = VX_MIC2,
428         VX_GLIMIT = VX_MIC3,
429         VX_INTCSR = VX_PLX0,
430         VX_CNTRL = VX_PLX1,
431         VX_GPIOC = VX_PLX2,
432
433         /* aliases for VXPOCKET board */
434         VX_MICRO = VX_MEMIRQ,
435         VX_CODEC2 = VX_MEMIRQ,
436         VX_DIALOG = VX_ACQ,
437
438 };
439
440 /* RMH status type */
441 enum {
442         RMH_SSIZE_FIXED = 0,    /* status size given by the driver (in LgStat) */
443         RMH_SSIZE_ARG = 1,      /* status size given in the LSB byte */
444         RMH_SSIZE_MASK = 2,     /* status size given in bitmask */
445 };
446
447
448 /* bits for ICR register */
449 #define ICR_HF1         0x10
450 #define ICR_HF0         0x08
451 #define ICR_TREQ        0x02    /* Interrupt mode + HREQ set on for transfer (->DSP) request */
452 #define ICR_RREQ        0x01    /* Interrupt mode + RREQ set on for transfer (->PC) request */
453
454 /* bits for CVR register */
455 #define CVR_HC          0x80
456
457 /* bits for ISR register */
458 #define ISR_HF3         0x10
459 #define ISR_HF2         0x08
460 #define ISR_CHK         0x10
461 #define ISR_ERR         0x08
462 #define ISR_TX_READY    0x04
463 #define ISR_TX_EMPTY    0x02
464 #define ISR_RX_FULL     0x01
465
466 /* Constants used to access the DATA register */
467 #define VX_DATA_CODEC_MASK      0x80
468 #define VX_DATA_XICOR_MASK      0x80
469
470 /* Constants used to access the CSUER register (both for VX2 and VXP) */
471 #define VX_SUER_FREQ_MASK               0x0c
472 #define VX_SUER_FREQ_32KHz_MASK         0x0c
473 #define VX_SUER_FREQ_44KHz_MASK         0x00
474 #define VX_SUER_FREQ_48KHz_MASK         0x04
475 #define VX_SUER_DATA_PRESENT_MASK       0x02
476 #define VX_SUER_CLOCK_PRESENT_MASK      0x01
477
478 #define VX_CUER_HH_BITC_SEL_MASK        0x08
479 #define VX_CUER_MH_BITC_SEL_MASK        0x04
480 #define VX_CUER_ML_BITC_SEL_MASK        0x02
481 #define VX_CUER_LL_BITC_SEL_MASK        0x01
482
483 #define XX_UER_CBITS_OFFSET_MASK        0x1f
484
485
486 /* bits for audio_info */
487 #define VX_AUDIO_INFO_REAL_TIME (1<<0)  /* real-time processing available */
488 #define VX_AUDIO_INFO_OFFLINE   (1<<1)  /* offline processing available */
489 #define VX_AUDIO_INFO_MPEG1     (1<<5)
490 #define VX_AUDIO_INFO_MPEG2     (1<<6)
491 #define VX_AUDIO_INFO_LINEAR_8  (1<<7)
492 #define VX_AUDIO_INFO_LINEAR_16 (1<<8)
493 #define VX_AUDIO_INFO_LINEAR_24 (1<<9)
494
495 /* DSP Interrupt Request values */
496 #define VXP_IRQ_OFFSET          0x40 /* add 0x40 offset for vxpocket and vx222/v2 */
497 /* call with vx_send_irq_dsp() */
498 #define IRQ_MESS_WRITE_END          0x30
499 #define IRQ_MESS_WRITE_NEXT         0x32
500 #define IRQ_MESS_READ_NEXT          0x34
501 #define IRQ_MESS_READ_END           0x36
502 #define IRQ_MESSAGE                 0x38
503 #define IRQ_RESET_CHK               0x3A
504 #define IRQ_CONNECT_STREAM_NEXT     0x26
505 #define IRQ_CONNECT_STREAM_END      0x28
506 #define IRQ_PAUSE_START_CONNECT     0x2A
507 #define IRQ_END_CONNECTION          0x2C
508
509 /* Is there async. events pending ( IT Source Test ) */
510 #define ASYNC_EVENTS_PENDING            0x008000
511 #define HBUFFER_EVENTS_PENDING          0x004000   // Not always accurate
512 #define NOTIF_EVENTS_PENDING            0x002000
513 #define TIME_CODE_EVENT_PENDING         0x001000
514 #define FREQUENCY_CHANGE_EVENT_PENDING  0x000800
515 #define END_OF_BUFFER_EVENTS_PENDING    0x000400
516 #define FATAL_DSP_ERROR                 0xff0000
517
518 /* Stream Format Header Defines */ 
519 #define HEADER_FMT_BASE                 0xFED00000
520 #define HEADER_FMT_MONO                 0x000000C0
521 #define HEADER_FMT_INTEL                0x00008000
522 #define HEADER_FMT_16BITS               0x00002000
523 #define HEADER_FMT_24BITS               0x00004000
524 #define HEADER_FMT_UPTO11               0x00000200      /* frequency is less or equ. to 11k.*/
525 #define HEADER_FMT_UPTO32               0x00000100      /* frequency is over 11k and less then 32k.*/
526
527 /* Constants used to access the Codec */
528 #define XX_CODEC_SELECTOR               0x20
529 /* codec commands */
530 #define XX_CODEC_ADC_CONTROL_REGISTER   0x01
531 #define XX_CODEC_DAC_CONTROL_REGISTER   0x02
532 #define XX_CODEC_LEVEL_LEFT_REGISTER    0x03
533 #define XX_CODEC_LEVEL_RIGHT_REGISTER   0x04
534 #define XX_CODEC_PORT_MODE_REGISTER     0x05
535 #define XX_CODEC_STATUS_REPORT_REGISTER 0x06
536 #define XX_CODEC_CLOCK_CONTROL_REGISTER 0x07
537
538 /*
539  * Audio-level control values
540  */
541 #define CVAL_M110DB             0x000   /* -110dB */
542 #define CVAL_M99DB              0x02C
543 #define CVAL_M21DB              0x163
544 #define CVAL_M18DB              0x16F
545 #define CVAL_M10DB              0x18F
546 #define CVAL_0DB                0x1B7
547 #define CVAL_18DB               0x1FF   /* +18dB */
548 #define CVAL_MAX                0x1FF
549
550 #define AUDIO_IO_HAS_MUTE_LEVEL                 0x400000
551 #define AUDIO_IO_HAS_MUTE_MONITORING_1          0x200000
552 #define AUDIO_IO_HAS_MUTE_MONITORING_2          0x100000
553 #define VALID_AUDIO_IO_DIGITAL_LEVEL            0x01
554 #define VALID_AUDIO_IO_MONITORING_LEVEL         0x02
555 #define VALID_AUDIO_IO_MUTE_LEVEL               0x04
556 #define VALID_AUDIO_IO_MUTE_MONITORING_1        0x08
557 #define VALID_AUDIO_IO_MUTE_MONITORING_2        0x10
558
559
560 #endif /* __SOUND_VX_COMMON_H */