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