1/**************************************************************************** 2 3 Copyright Echo Digital Audio Corporation (c) 1998 - 2004 4 All rights reserved 5 www.echoaudio.com 6 7 This file is part of Echo Digital Audio's generic driver library. 8 9 Echo Digital Audio's generic driver library is free software; 10 you can redistribute it and/or modify it under the terms of 11 the GNU General Public License as published by the Free Software 12 Foundation. 13 14 This program is distributed in the hope that it will be useful, 15 but WITHOUT ANY WARRANTY; without even the implied warranty of 16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 GNU General Public License for more details. 18 19 You should have received a copy of the GNU General Public License 20 along with this program; if not, write to the Free Software 21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, 22 MA 02111-1307, USA. 23 24 **************************************************************************** 25 26 Translation from C++ and adaptation for use in ALSA-Driver 27 were made by Giuliano Pochini <pochini@shiny.it> 28 29 **************************************************************************** 30 31 32 Here's a block diagram of how most of the cards work: 33 34 +-----------+ 35 record | |<-------------------- Inputs 36 <-------| | | 37 PCI | Transport | | 38 bus | engine | \|/ 39 ------->| | +-------+ 40 play | |--->|monitor|-------> Outputs 41 +-----------+ | mixer | 42 +-------+ 43 44 The lines going to and from the PCI bus represent "pipes". A pipe performs 45 audio transport - moving audio data to and from buffers on the host via 46 bus mastering. 47 48 The inputs and outputs on the right represent input and output "busses." 49 A bus is a physical, real connection to the outside world. An example 50 of a bus would be the 1/4" analog connectors on the back of Layla or 51 an RCA S/PDIF connector. 52 53 For most cards, there is a one-to-one correspondence between outputs 54 and busses; that is, each individual pipe is hard-wired to a single bus. 55 56 Cards that work this way are Darla20, Gina20, Layla20, Darla24, Gina24, 57 Layla24, Mona, and Indigo. 58 59 60 Mia has a feature called "virtual outputs." 61 62 63 +-----------+ 64 record | |<----------------------------- Inputs 65 <-------| | | 66 PCI | Transport | | 67 bus | engine | \|/ 68 ------->| | +------+ +-------+ 69 play | |-->|vmixer|-->|monitor|-------> Outputs 70 +-----------+ +------+ | mixer | 71 +-------+ 72 73 74 Obviously, the difference here is the box labeled "vmixer." Vmixer is 75 short for "virtual output mixer." For Mia, pipes are *not* hard-wired 76 to a single bus; the vmixer lets you mix any pipe to any bus in any 77 combination. 78 79 Note, however, that the left-hand side of the diagram is unchanged. 80 Transport works exactly the same way - the difference is in the mixer stage. 81 82 83 Pipes and busses are numbered starting at zero. 84 85 86 87 Pipe index 88 ========== 89 90 A number of calls in CEchoGals refer to a "pipe index". A pipe index is 91 a unique number for a pipe that unambiguously refers to a playback or record 92 pipe. Pipe indices are numbered starting with analog outputs, followed by 93 digital outputs, then analog inputs, then digital inputs. 94 95 Take Gina24 as an example: 96 97 Pipe index 98 99 0-7 Analog outputs (0 .. FirstDigitalBusOut-1) 100 8-15 Digital outputs (FirstDigitalBusOut .. NumBussesOut-1) 101 16-17 Analog inputs 102 18-25 Digital inputs 103 104 105 You get the pipe index by calling CEchoGals::OpenAudio; the other transport 106 functions take the pipe index as a parameter. If you need a pipe index for 107 some other reason, use the handy Makepipe_index method. 108 109 110 Some calls take a CChannelMask parameter; CChannelMask is a handy way to 111 group pipe indices. 112 113 114 115 Digital mode switch 116 =================== 117 118 Some cards (right now, Gina24, Layla24, and Mona) have a Digital Mode Switch 119 or DMS. Cards with a DMS can be set to one of three mutually exclusive 120 digital modes: S/PDIF RCA, S/PDIF optical, or ADAT optical. 121 122 This may create some confusion since ADAT optical is 8 channels wide and 123 S/PDIF is only two channels wide. Gina24, Layla24, and Mona handle this 124 by acting as if they always have 8 digital outs and ins. If you are in 125 either S/PDIF mode, the last 6 channels don't do anything - data sent 126 out these channels is thrown away and you will always record zeros. 127 128 Note that with Gina24, Layla24, and Mona, sample rates above 50 kHz are 129 only available if you have the card configured for S/PDIF optical or S/PDIF 130 RCA. 131 132 133 134 Double speed mode 135 ================= 136 137 Some of the cards support 88.2 kHz and 96 kHz sampling (Darla24, Gina24, 138 Layla24, Mona, Mia, and Indigo). For these cards, the driver sometimes has 139 to worry about "double speed mode"; double speed mode applies whenever the 140 sampling rate is above 50 kHz. 141 142 For instance, Mona and Layla24 support word clock sync. However, they 143 actually support two different word clock modes - single speed (below 144 50 kHz) and double speed (above 50 kHz). The hardware detects if a single 145 or double speed word clock signal is present; the generic code uses that 146 information to determine which mode to use. 147 148 The generic code takes care of all this for you. 149*/ 150 151 152#ifndef _ECHOAUDIO_H_ 153#define _ECHOAUDIO_H_ 154 155 156#define TRUE 1 157#define FALSE 0 158 159#include "echoaudio_dsp.h" 160 161 162 163/*********************************************************************** 164 165 PCI configuration space 166 167***********************************************************************/ 168 169/* 170 * PCI vendor ID and device IDs for the hardware 171 */ 172#define VENDOR_ID 0x1057 173#define DEVICE_ID_56301 0x1801 174#define DEVICE_ID_56361 0x3410 175#define SUBVENDOR_ID 0xECC0 176 177 178/* 179 * Valid Echo PCI subsystem card IDs 180 */ 181#define DARLA20 0x0010 182#define GINA20 0x0020 183#define LAYLA20 0x0030 184#define DARLA24 0x0040 185#define GINA24 0x0050 186#define LAYLA24 0x0060 187#define MONA 0x0070 188#define MIA 0x0080 189#define INDIGO 0x0090 190#define INDIGO_IO 0x00a0 191#define INDIGO_DJ 0x00b0 192#define DC8 0x00c0 193#define INDIGO_IOX 0x00d0 194#define INDIGO_DJX 0x00e0 195#define ECHO3G 0x0100 196 197 198/************************************************************************ 199 200 Array sizes and so forth 201 202***********************************************************************/ 203 204/* 205 * Sizes 206 */ 207#define ECHO_MAXAUDIOINPUTS 32 /* Max audio input channels */ 208#define ECHO_MAXAUDIOOUTPUTS 32 /* Max audio output channels */ 209#define ECHO_MAXAUDIOPIPES 32 /* Max number of input and output 210 * pipes */ 211#define E3G_MAX_OUTPUTS 16 212#define ECHO_MAXMIDIJACKS 1 /* Max MIDI ports */ 213#define ECHO_MIDI_QUEUE_SZ 512 /* Max MIDI input queue entries */ 214#define ECHO_MTC_QUEUE_SZ 32 /* Max MIDI time code input queue 215 * entries */ 216 217/* 218 * MIDI activity indicator timeout 219 */ 220#define MIDI_ACTIVITY_TIMEOUT_USEC 200000 221 222 223/**************************************************************************** 224 225 Clocks 226 227*****************************************************************************/ 228 229/* 230 * Clock numbers 231 */ 232#define ECHO_CLOCK_INTERNAL 0 233#define ECHO_CLOCK_WORD 1 234#define ECHO_CLOCK_SUPER 2 235#define ECHO_CLOCK_SPDIF 3 236#define ECHO_CLOCK_ADAT 4 237#define ECHO_CLOCK_ESYNC 5 238#define ECHO_CLOCK_ESYNC96 6 239#define ECHO_CLOCK_MTC 7 240#define ECHO_CLOCK_NUMBER 8 241#define ECHO_CLOCKS 0xffff 242 243/* 244 * Clock bit numbers - used to report capabilities and whatever clocks 245 * are being detected dynamically. 246 */ 247#define ECHO_CLOCK_BIT_INTERNAL (1 << ECHO_CLOCK_INTERNAL) 248#define ECHO_CLOCK_BIT_WORD (1 << ECHO_CLOCK_WORD) 249#define ECHO_CLOCK_BIT_SUPER (1 << ECHO_CLOCK_SUPER) 250#define ECHO_CLOCK_BIT_SPDIF (1 << ECHO_CLOCK_SPDIF) 251#define ECHO_CLOCK_BIT_ADAT (1 << ECHO_CLOCK_ADAT) 252#define ECHO_CLOCK_BIT_ESYNC (1 << ECHO_CLOCK_ESYNC) 253#define ECHO_CLOCK_BIT_ESYNC96 (1 << ECHO_CLOCK_ESYNC96) 254#define ECHO_CLOCK_BIT_MTC (1<<ECHO_CLOCK_MTC) 255 256 257/*************************************************************************** 258 259 Digital modes 260 261****************************************************************************/ 262 263/* 264 * Digital modes for Mona, Layla24, and Gina24 265 */ 266#define DIGITAL_MODE_NONE 0xFF 267#define DIGITAL_MODE_SPDIF_RCA 0 268#define DIGITAL_MODE_SPDIF_OPTICAL 1 269#define DIGITAL_MODE_ADAT 2 270#define DIGITAL_MODE_SPDIF_CDROM 3 271#define DIGITAL_MODES 4 272 273/* 274 * Digital mode capability masks 275 */ 276#define ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_RCA (1 << DIGITAL_MODE_SPDIF_RCA) 277#define ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_OPTICAL (1 << DIGITAL_MODE_SPDIF_OPTICAL) 278#define ECHOCAPS_HAS_DIGITAL_MODE_ADAT (1 << DIGITAL_MODE_ADAT) 279#define ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_CDROM (1 << DIGITAL_MODE_SPDIF_CDROM) 280 281 282#define EXT_3GBOX_NC 0x01 /* 3G box not connected */ 283#define EXT_3GBOX_NOT_SET 0x02 /* 3G box not detected yet */ 284 285 286#define ECHOGAIN_MUTED (-128) /* Minimum possible gain */ 287#define ECHOGAIN_MINOUT (-128) /* Min output gain (dB) */ 288#define ECHOGAIN_MAXOUT (6) /* Max output gain (dB) */ 289#define ECHOGAIN_MININP (-50) /* Min input gain (0.5 dB) */ 290#define ECHOGAIN_MAXINP (50) /* Max input gain (0.5 dB) */ 291 292#define PIPE_STATE_STOPPED 0 /* Pipe has been reset */ 293#define PIPE_STATE_PAUSED 1 /* Pipe has been stopped */ 294#define PIPE_STATE_STARTED 2 /* Pipe has been started */ 295#define PIPE_STATE_PENDING 3 /* Pipe has pending start */ 296 297 298/* Debug initialization */ 299#ifdef CONFIG_SND_DEBUG 300#define DE_INIT(x) snd_printk x 301#else 302#define DE_INIT(x) 303#endif 304 305/* Debug hw_params callbacks */ 306#ifdef CONFIG_SND_DEBUG 307#define DE_HWP(x) snd_printk x 308#else 309#define DE_HWP(x) 310#endif 311 312/* Debug normal activity (open, start, stop...) */ 313#ifdef CONFIG_SND_DEBUG 314#define DE_ACT(x) snd_printk x 315#else 316#define DE_ACT(x) 317#endif 318 319/* Debug midi activity */ 320#ifdef CONFIG_SND_DEBUG 321#define DE_MID(x) snd_printk x 322#else 323#define DE_MID(x) 324#endif 325 326 327struct audiopipe { 328 volatile u32 *dma_counter; /* Commpage register that contains 329 * the current dma position 330 * (lower 32 bits only) 331 */ 332 u32 last_counter; /* The last position, which is used 333 * to compute... 334 */ 335 u32 position; /* ...the number of bytes tranferred 336 * by the DMA engine, modulo the 337 * buffer size 338 */ 339 short index; /* Index of the first channel or <0 340 * if hw is not configured yet 341 */ 342 short interleave; 343 struct snd_dma_buffer sgpage; /* Room for the scatter-gather list */ 344 struct snd_pcm_hardware hw; 345 struct snd_pcm_hw_constraint_list constr; 346 short sglist_head; 347 char state; /* pipe state */ 348}; 349 350 351struct audioformat { 352 u8 interleave; /* How the data is arranged in memory: 353 * mono = 1, stereo = 2, ... 354 */ 355 u8 bits_per_sample; /* 8, 16, 24, 32 (24 bits left aligned) */ 356 char mono_to_stereo; /* Only used if interleave is 1 and 357 * if this is an output pipe. 358 */ 359 char data_are_bigendian; /* 1 = big endian, 0 = little endian */ 360}; 361 362 363struct echoaudio { 364 spinlock_t lock; 365 struct snd_pcm_substream *substream[DSP_MAXPIPES]; 366 int last_period[DSP_MAXPIPES]; 367 struct mutex mode_mutex; 368 u16 num_digital_modes, digital_mode_list[6]; 369 u16 num_clock_sources, clock_source_list[10]; 370 atomic_t opencount; 371 struct snd_kcontrol *clock_src_ctl; 372 struct snd_pcm *analog_pcm, *digital_pcm; 373 struct snd_card *card; 374 const char *card_name; 375 struct pci_dev *pci; 376 unsigned long dsp_registers_phys; 377 struct resource *iores; 378 struct snd_dma_buffer commpage_dma_buf; 379 int irq; 380#ifdef ECHOCARD_HAS_MIDI 381 struct snd_rawmidi *rmidi; 382 struct snd_rawmidi_substream *midi_in, *midi_out; 383#endif 384 struct timer_list timer; 385 char tinuse; /* Timer in use */ 386 char midi_full; /* MIDI output buffer is full */ 387 char can_set_rate; 388 char rate_set; 389 390 /* This stuff is used mainly by the lowlevel code */ 391 struct comm_page *comm_page; /* Virtual address of the memory 392 * seen by DSP 393 */ 394 u32 pipe_alloc_mask; /* Bitmask of allocated pipes */ 395 u32 pipe_cyclic_mask; /* Bitmask of pipes with cyclic 396 * buffers 397 */ 398 u32 sample_rate; /* Card sample rate in Hz */ 399 u8 digital_mode; /* Current digital mode 400 * (see DIGITAL_MODE_*) 401 */ 402 u8 spdif_status; /* Gina20, Darla20, Darla24 - only */ 403 u8 clock_state; /* Gina20, Darla20, Darla24 - only */ 404 u8 input_clock; /* Currently selected sample clock 405 * source 406 */ 407 u8 output_clock; /* Layla20 only */ 408 char meters_enabled; /* VU-meters status */ 409 char asic_loaded; /* Set TRUE when ASIC loaded */ 410 char bad_board; /* Set TRUE if DSP won't load */ 411 char professional_spdif; /* 0 = consumer; 1 = professional */ 412 char non_audio_spdif; /* 3G - only */ 413 char digital_in_automute; /* Gina24, Layla24, Mona - only */ 414 char has_phantom_power; 415 char hasnt_input_nominal_level; /* Gina3G */ 416 char phantom_power; /* Gina3G - only */ 417 char has_midi; 418 char midi_input_enabled; 419 420#ifdef ECHOCARD_ECHO3G 421 /* External module -dependent pipe and bus indexes */ 422 char px_digital_out, px_analog_in, px_digital_in, px_num; 423 char bx_digital_out, bx_analog_in, bx_digital_in, bx_num; 424#endif 425 426 char nominal_level[ECHO_MAXAUDIOPIPES]; /* True == -10dBV 427 * False == +4dBu */ 428 s8 input_gain[ECHO_MAXAUDIOINPUTS]; /* Input level -50..+50 429 * unit is 0.5dB */ 430 s8 output_gain[ECHO_MAXAUDIOOUTPUTS]; /* Output level -128..+6 dB 431 * (-128=muted) */ 432 s8 monitor_gain[ECHO_MAXAUDIOOUTPUTS][ECHO_MAXAUDIOINPUTS]; 433 /* -128..+6 dB */ 434 s8 vmixer_gain[ECHO_MAXAUDIOOUTPUTS][ECHO_MAXAUDIOOUTPUTS]; 435 /* -128..+6 dB */ 436 437 u16 digital_modes; /* Bitmask of supported modes 438 * (see ECHOCAPS_HAS_DIGITAL_MODE_*) */ 439 u16 input_clock_types; /* Suppoted input clock types */ 440 u16 output_clock_types; /* Suppoted output clock types - 441 * Layla20 only */ 442 u16 device_id, subdevice_id; 443 u16 *dsp_code; /* Current DSP code loaded, 444 * NULL if nothing loaded */ 445 short dsp_code_to_load; /* DSP code to load */ 446 short asic_code; /* Current ASIC code */ 447 u32 comm_page_phys; /* Physical address of the 448 * memory seen by DSP */ 449 volatile u32 __iomem *dsp_registers; /* DSP's register base */ 450 u32 active_mask; /* Chs. active mask or 451 * punks out */ 452#ifdef CONFIG_PM 453 const struct firmware *fw_cache[8]; /* Cached firmwares */ 454#endif 455 456#ifdef ECHOCARD_HAS_MIDI 457 u16 mtc_state; /* State for MIDI input parsing state machine */ 458 u8 midi_buffer[MIDI_IN_BUFFER_SIZE]; 459#endif 460}; 461 462 463static int init_dsp_comm_page(struct echoaudio *chip); 464static int init_line_levels(struct echoaudio *chip); 465static int free_pipes(struct echoaudio *chip, struct audiopipe *pipe); 466static int load_firmware(struct echoaudio *chip); 467static int wait_handshake(struct echoaudio *chip); 468static int send_vector(struct echoaudio *chip, u32 command); 469static int get_firmware(const struct firmware **fw_entry, 470 struct echoaudio *chip, const short fw_index); 471static void free_firmware(const struct firmware *fw_entry); 472 473#ifdef ECHOCARD_HAS_MIDI 474static int enable_midi_input(struct echoaudio *chip, char enable); 475static void snd_echo_midi_output_trigger( 476 struct snd_rawmidi_substream *substream, int up); 477static int midi_service_irq(struct echoaudio *chip); 478static int __devinit snd_echo_midi_create(struct snd_card *card, 479 struct echoaudio *chip); 480#endif 481 482 483static inline void clear_handshake(struct echoaudio *chip) 484{ 485 chip->comm_page->handshake = 0; 486} 487 488static inline u32 get_dsp_register(struct echoaudio *chip, u32 index) 489{ 490 return readl(&chip->dsp_registers[index]); 491} 492 493static inline void set_dsp_register(struct echoaudio *chip, u32 index, 494 u32 value) 495{ 496 writel(value, &chip->dsp_registers[index]); 497} 498 499 500/* Pipe and bus indexes. PX_* and BX_* are defined as chip->px_* and chip->bx_* 501for 3G cards because they depend on the external box. They are integer 502constants for all other cards. 503Never use those defines directly, use the following functions instead. */ 504 505static inline int px_digital_out(const struct echoaudio *chip) 506{ 507 return PX_DIGITAL_OUT; 508} 509 510static inline int px_analog_in(const struct echoaudio *chip) 511{ 512 return PX_ANALOG_IN; 513} 514 515static inline int px_digital_in(const struct echoaudio *chip) 516{ 517 return PX_DIGITAL_IN; 518} 519 520static inline int px_num(const struct echoaudio *chip) 521{ 522 return PX_NUM; 523} 524 525static inline int bx_digital_out(const struct echoaudio *chip) 526{ 527 return BX_DIGITAL_OUT; 528} 529 530static inline int bx_analog_in(const struct echoaudio *chip) 531{ 532 return BX_ANALOG_IN; 533} 534 535static inline int bx_digital_in(const struct echoaudio *chip) 536{ 537 return BX_DIGITAL_IN; 538} 539 540static inline int bx_num(const struct echoaudio *chip) 541{ 542 return BX_NUM; 543} 544 545static inline int num_pipes_out(const struct echoaudio *chip) 546{ 547 return px_analog_in(chip); 548} 549 550static inline int num_pipes_in(const struct echoaudio *chip) 551{ 552 return px_num(chip) - px_analog_in(chip); 553} 554 555static inline int num_busses_out(const struct echoaudio *chip) 556{ 557 return bx_analog_in(chip); 558} 559 560static inline int num_busses_in(const struct echoaudio *chip) 561{ 562 return bx_num(chip) - bx_analog_in(chip); 563} 564 565static inline int num_analog_busses_out(const struct echoaudio *chip) 566{ 567 return bx_digital_out(chip); 568} 569 570static inline int num_analog_busses_in(const struct echoaudio *chip) 571{ 572 return bx_digital_in(chip) - bx_analog_in(chip); 573} 574 575static inline int num_digital_busses_out(const struct echoaudio *chip) 576{ 577 return num_busses_out(chip) - num_analog_busses_out(chip); 578} 579 580static inline int num_digital_busses_in(const struct echoaudio *chip) 581{ 582 return num_busses_in(chip) - num_analog_busses_in(chip); 583} 584 585/* The monitor array is a one-dimensional array; compute the offset 586 * into the array */ 587static inline int monitor_index(const struct echoaudio *chip, int out, int in) 588{ 589 return out * num_busses_in(chip) + in; 590} 591 592 593#ifndef pci_device 594#define pci_device(chip) (&chip->pci->dev) 595#endif 596 597 598#endif /* _ECHOAUDIO_H_ */ 599