Linux 2.6.25.20
[linux/fpc-iii.git] / include / sound / vx_core.h
blob4830651cc4cffd5dfafc1c29c5d5fd00c905ecac
1 /*
2 * Driver for Digigram VX soundcards
4 * Hardware core part
6 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
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.
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.
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
23 #ifndef __SOUND_VX_COMMON_H
24 #define __SOUND_VX_COMMON_H
26 #include <sound/pcm.h>
27 #include <sound/hwdep.h>
28 #include <linux/interrupt.h>
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
36 struct firmware;
37 struct device;
39 #define VX_DRIVER_VERSION 0x010000 /* 1.0.0 */
43 #define SIZE_MAX_CMD 0x10
44 #define SIZE_MAX_STATUS 0x10
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 */
54 typedef u64 pcx_time_t;
56 #define VX_MAX_PIPES 16
57 #define VX_MAX_PERIODS 32
58 #define VX_MAX_CODECS 2
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 */
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;
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) */
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)*/
90 struct tasklet_struct start_tq;
93 struct vx_core;
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);
122 struct snd_vx_hardware {
123 const char *name;
124 int type; /* VX_TYPE_XXX */
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 const unsigned int *output_level_db_scale;
134 /* hwdep id string */
135 #define SND_VX_HWDEP_ID "VX Loader"
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
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 */
158 /* min/max values for analog output for old codecs */
159 #define VX_ANALOG_OUT_LEVEL_MAX 0xe3
161 struct vx_core {
162 /* ALSA stuff */
163 struct snd_card *card;
164 struct snd_pcm *pcm[VX_MAX_CODECS];
165 int type; /* VX_TYPE_XXX */
167 int irq;
168 /* ports are defined externally */
170 /* low-level functions */
171 struct snd_vx_hardware *hw;
172 struct snd_vx_ops *ops;
174 spinlock_t lock;
175 spinlock_t irq_lock;
176 struct tasklet_struct tq;
178 unsigned int chip_status;
179 unsigned int pcm_running;
181 struct device *dev;
182 struct snd_hwdep *hwdep;
184 struct vx_rmh irq_rmh; /* RMH used in interrupts */
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;
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 */
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 */
210 struct mutex mixer_mutex;
212 const struct firmware *firmware[4]; /* loaded firmware data */
217 * constructor
219 struct vx_core *snd_vx_create(struct snd_card *card, struct snd_vx_hardware *hw,
220 struct snd_vx_ops *ops, int extra_size);
221 int snd_vx_setup_firmware(struct vx_core *chip);
222 int snd_vx_load_boot_image(struct vx_core *chip, const struct firmware *dsp);
223 int snd_vx_dsp_boot(struct vx_core *chip, const struct firmware *dsp);
224 int snd_vx_dsp_load(struct vx_core *chip, const struct firmware *dsp);
226 void snd_vx_free_firmware(struct vx_core *chip);
229 * interrupt handler; exported for pcmcia
231 irqreturn_t snd_vx_irq_handler(int irq, void *dev);
234 * lowlevel functions
236 static inline int vx_test_and_ack(struct vx_core *chip)
238 snd_assert(chip->ops->test_and_ack, return -ENXIO);
239 return chip->ops->test_and_ack(chip);
242 static inline void vx_validate_irq(struct vx_core *chip, int enable)
244 snd_assert(chip->ops->validate_irq, return);
245 chip->ops->validate_irq(chip, enable);
248 static inline unsigned char snd_vx_inb(struct vx_core *chip, int reg)
250 snd_assert(chip->ops->in8, return 0);
251 return chip->ops->in8(chip, reg);
254 static inline unsigned int snd_vx_inl(struct vx_core *chip, int reg)
256 snd_assert(chip->ops->in32, return 0);
257 return chip->ops->in32(chip, reg);
260 static inline void snd_vx_outb(struct vx_core *chip, int reg, unsigned char val)
262 snd_assert(chip->ops->out8, return);
263 chip->ops->out8(chip, reg, val);
266 static inline void snd_vx_outl(struct vx_core *chip, int reg, unsigned int val)
268 snd_assert(chip->ops->out32, return);
269 chip->ops->out32(chip, reg, val);
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)
277 static inline void vx_reset_dsp(struct vx_core *chip)
279 snd_assert(chip->ops->reset_dsp, return);
280 chip->ops->reset_dsp(chip);
283 int vx_send_msg(struct vx_core *chip, struct vx_rmh *rmh);
284 int vx_send_msg_nolock(struct vx_core *chip, struct vx_rmh *rmh);
285 int vx_send_rih(struct vx_core *chip, int cmd);
286 int vx_send_rih_nolock(struct vx_core *chip, int cmd);
288 void vx_reset_codec(struct vx_core *chip, int cold_reset);
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
295 int snd_vx_check_reg_bit(struct vx_core *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)
302 * pseudo-DMA transfer
304 static inline void vx_pseudo_dma_write(struct vx_core *chip, struct snd_pcm_runtime *runtime,
305 struct vx_pipe *pipe, int count)
307 snd_assert(chip->ops->dma_write, return);
308 chip->ops->dma_write(chip, runtime, pipe, count);
311 static inline void vx_pseudo_dma_read(struct vx_core *chip, struct snd_pcm_runtime *runtime,
312 struct vx_pipe *pipe, int count)
314 snd_assert(chip->ops->dma_read, return);
315 chip->ops->dma_read(chip, runtime, pipe, count);
320 /* error with hardware code,
321 * the return value is -(VX_ERR_MASK | actual-hw-error-code)
323 #define VX_ERR_MASK 0x1000000
324 #define vx_get_error(err) (-(err) & ~VX_ERR_MASK)
328 * pcm stuff
330 int snd_vx_pcm_new(struct vx_core *chip);
331 void vx_pcm_update_intr(struct vx_core *chip, unsigned int events);
334 * mixer stuff
336 int snd_vx_mixer_new(struct vx_core *chip);
337 void vx_toggle_dac_mute(struct vx_core *chip, int mute);
338 int vx_sync_audio_source(struct vx_core *chip);
339 int vx_set_monitor_level(struct vx_core *chip, int audio, int level, int active);
342 * IEC958 & clock stuff
344 void vx_set_iec958_status(struct vx_core *chip, unsigned int bits);
345 int vx_set_clock(struct vx_core *chip, unsigned int freq);
346 void vx_set_internal_clock(struct vx_core *chip, unsigned int freq);
347 int vx_change_frequency(struct vx_core *chip);
351 * PM
353 int snd_vx_suspend(struct vx_core *card, pm_message_t state);
354 int snd_vx_resume(struct vx_core *card);
357 * hardware constants
360 #define vx_has_new_dsp(chip) ((chip)->type != VX_TYPE_BOARD)
361 #define vx_is_pcmcia(chip) ((chip)->type >= VX_TYPE_VXPOCKET)
363 /* audio input source */
364 enum {
365 VX_AUDIO_SRC_DIGITAL,
366 VX_AUDIO_SRC_LINE,
367 VX_AUDIO_SRC_MIC
370 /* clock source */
371 enum {
372 INTERNAL_QUARTZ,
373 UER_SYNC
376 /* clock mode */
377 enum {
378 VX_CLOCK_MODE_AUTO, /* depending on the current audio source */
379 VX_CLOCK_MODE_INTERNAL, /* fixed to internal quartz */
380 VX_CLOCK_MODE_EXTERNAL /* fixed to UER sync */
383 /* SPDIF/UER type */
384 enum {
385 VX_UER_MODE_CONSUMER,
386 VX_UER_MODE_PROFESSIONAL,
387 VX_UER_MODE_NOT_PRESENT,
390 /* register indices */
391 enum {
392 VX_ICR,
393 VX_CVR,
394 VX_ISR,
395 VX_IVR,
396 VX_RXH,
397 VX_TXH = VX_RXH,
398 VX_RXM,
399 VX_TXM = VX_RXM,
400 VX_RXL,
401 VX_TXL = VX_RXL,
402 VX_DMA,
403 VX_CDSP,
404 VX_RFREQ,
405 VX_RUER_V2,
406 VX_GAIN,
407 VX_DATA = VX_GAIN,
408 VX_MEMIRQ,
409 VX_ACQ,
410 VX_BIT0,
411 VX_BIT1,
412 VX_MIC0,
413 VX_MIC1,
414 VX_MIC2,
415 VX_MIC3,
416 VX_PLX0,
417 VX_PLX1,
418 VX_PLX2,
420 VX_LOFREQ, // V2: ACQ, VP: RFREQ
421 VX_HIFREQ, // V2: BIT0, VP: RUER_V2
422 VX_CSUER, // V2: BIT1, VP: BIT0
423 VX_RUER, // V2: RUER_V2, VP: BIT1
425 VX_REG_MAX,
427 /* aliases for VX board */
428 VX_RESET_DMA = VX_ISR,
429 VX_CFG = VX_RFREQ,
430 VX_STATUS = VX_MEMIRQ,
431 VX_SELMIC = VX_MIC0,
432 VX_COMPOT = VX_MIC1,
433 VX_SCOMPR = VX_MIC2,
434 VX_GLIMIT = VX_MIC3,
435 VX_INTCSR = VX_PLX0,
436 VX_CNTRL = VX_PLX1,
437 VX_GPIOC = VX_PLX2,
439 /* aliases for VXPOCKET board */
440 VX_MICRO = VX_MEMIRQ,
441 VX_CODEC2 = VX_MEMIRQ,
442 VX_DIALOG = VX_ACQ,
446 /* RMH status type */
447 enum {
448 RMH_SSIZE_FIXED = 0, /* status size given by the driver (in LgStat) */
449 RMH_SSIZE_ARG = 1, /* status size given in the LSB byte */
450 RMH_SSIZE_MASK = 2, /* status size given in bitmask */
454 /* bits for ICR register */
455 #define ICR_HF1 0x10
456 #define ICR_HF0 0x08
457 #define ICR_TREQ 0x02 /* Interrupt mode + HREQ set on for transfer (->DSP) request */
458 #define ICR_RREQ 0x01 /* Interrupt mode + RREQ set on for transfer (->PC) request */
460 /* bits for CVR register */
461 #define CVR_HC 0x80
463 /* bits for ISR register */
464 #define ISR_HF3 0x10
465 #define ISR_HF2 0x08
466 #define ISR_CHK 0x10
467 #define ISR_ERR 0x08
468 #define ISR_TX_READY 0x04
469 #define ISR_TX_EMPTY 0x02
470 #define ISR_RX_FULL 0x01
472 /* Constants used to access the DATA register */
473 #define VX_DATA_CODEC_MASK 0x80
474 #define VX_DATA_XICOR_MASK 0x80
476 /* Constants used to access the CSUER register (both for VX2 and VXP) */
477 #define VX_SUER_FREQ_MASK 0x0c
478 #define VX_SUER_FREQ_32KHz_MASK 0x0c
479 #define VX_SUER_FREQ_44KHz_MASK 0x00
480 #define VX_SUER_FREQ_48KHz_MASK 0x04
481 #define VX_SUER_DATA_PRESENT_MASK 0x02
482 #define VX_SUER_CLOCK_PRESENT_MASK 0x01
484 #define VX_CUER_HH_BITC_SEL_MASK 0x08
485 #define VX_CUER_MH_BITC_SEL_MASK 0x04
486 #define VX_CUER_ML_BITC_SEL_MASK 0x02
487 #define VX_CUER_LL_BITC_SEL_MASK 0x01
489 #define XX_UER_CBITS_OFFSET_MASK 0x1f
492 /* bits for audio_info */
493 #define VX_AUDIO_INFO_REAL_TIME (1<<0) /* real-time processing available */
494 #define VX_AUDIO_INFO_OFFLINE (1<<1) /* offline processing available */
495 #define VX_AUDIO_INFO_MPEG1 (1<<5)
496 #define VX_AUDIO_INFO_MPEG2 (1<<6)
497 #define VX_AUDIO_INFO_LINEAR_8 (1<<7)
498 #define VX_AUDIO_INFO_LINEAR_16 (1<<8)
499 #define VX_AUDIO_INFO_LINEAR_24 (1<<9)
501 /* DSP Interrupt Request values */
502 #define VXP_IRQ_OFFSET 0x40 /* add 0x40 offset for vxpocket and vx222/v2 */
503 /* call with vx_send_irq_dsp() */
504 #define IRQ_MESS_WRITE_END 0x30
505 #define IRQ_MESS_WRITE_NEXT 0x32
506 #define IRQ_MESS_READ_NEXT 0x34
507 #define IRQ_MESS_READ_END 0x36
508 #define IRQ_MESSAGE 0x38
509 #define IRQ_RESET_CHK 0x3A
510 #define IRQ_CONNECT_STREAM_NEXT 0x26
511 #define IRQ_CONNECT_STREAM_END 0x28
512 #define IRQ_PAUSE_START_CONNECT 0x2A
513 #define IRQ_END_CONNECTION 0x2C
515 /* Is there async. events pending ( IT Source Test ) */
516 #define ASYNC_EVENTS_PENDING 0x008000
517 #define HBUFFER_EVENTS_PENDING 0x004000 // Not always accurate
518 #define NOTIF_EVENTS_PENDING 0x002000
519 #define TIME_CODE_EVENT_PENDING 0x001000
520 #define FREQUENCY_CHANGE_EVENT_PENDING 0x000800
521 #define END_OF_BUFFER_EVENTS_PENDING 0x000400
522 #define FATAL_DSP_ERROR 0xff0000
524 /* Stream Format Header Defines */
525 #define HEADER_FMT_BASE 0xFED00000
526 #define HEADER_FMT_MONO 0x000000C0
527 #define HEADER_FMT_INTEL 0x00008000
528 #define HEADER_FMT_16BITS 0x00002000
529 #define HEADER_FMT_24BITS 0x00004000
530 #define HEADER_FMT_UPTO11 0x00000200 /* frequency is less or equ. to 11k.*/
531 #define HEADER_FMT_UPTO32 0x00000100 /* frequency is over 11k and less then 32k.*/
533 /* Constants used to access the Codec */
534 #define XX_CODEC_SELECTOR 0x20
535 /* codec commands */
536 #define XX_CODEC_ADC_CONTROL_REGISTER 0x01
537 #define XX_CODEC_DAC_CONTROL_REGISTER 0x02
538 #define XX_CODEC_LEVEL_LEFT_REGISTER 0x03
539 #define XX_CODEC_LEVEL_RIGHT_REGISTER 0x04
540 #define XX_CODEC_PORT_MODE_REGISTER 0x05
541 #define XX_CODEC_STATUS_REPORT_REGISTER 0x06
542 #define XX_CODEC_CLOCK_CONTROL_REGISTER 0x07
545 * Audio-level control values
547 #define CVAL_M110DB 0x000 /* -110dB */
548 #define CVAL_M99DB 0x02C
549 #define CVAL_M21DB 0x163
550 #define CVAL_M18DB 0x16F
551 #define CVAL_M10DB 0x18F
552 #define CVAL_0DB 0x1B7
553 #define CVAL_18DB 0x1FF /* +18dB */
554 #define CVAL_MAX 0x1FF
556 #define AUDIO_IO_HAS_MUTE_LEVEL 0x400000
557 #define AUDIO_IO_HAS_MUTE_MONITORING_1 0x200000
558 #define AUDIO_IO_HAS_MUTE_MONITORING_2 0x100000
559 #define VALID_AUDIO_IO_DIGITAL_LEVEL 0x01
560 #define VALID_AUDIO_IO_MONITORING_LEVEL 0x02
561 #define VALID_AUDIO_IO_MUTE_LEVEL 0x04
562 #define VALID_AUDIO_IO_MUTE_MONITORING_1 0x08
563 #define VALID_AUDIO_IO_MUTE_MONITORING_2 0x10
566 #endif /* __SOUND_VX_COMMON_H */