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