/**************************************************************************** Copyright Echo Digital Audio Corporation (c) 1998 - 2004 All rights reserved www.echoaudio.com This file is part of Echo Digital Audio's generic driver library. Echo Digital Audio's generic driver library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. **************************************************************************** Translation from C++ and adaptation for use in ALSA-Driver were made by Giuliano Pochini <[email protected]> **************************************************************************** Here's a block diagram of how most of the cards work: +-----------+ record | |<-------------------- Inputs <-------| | | PCI | Transport | | bus | engine | \|/ ------->| | +-------+ play | |--->|monitor|-------> Outputs +-----------+ | mixer | +-------+ The lines going to and from the PCI bus represent "pipes". A pipe performs audio transport - moving audio data to and from buffers on the host via bus mastering. The inputs and outputs on the right represent input and output "busses." A bus is a physical, real connection to the outside world. An example of a bus would be the 1/4" analog connectors on the back of Layla or an RCA S/PDIF connector. For most cards, there is a one-to-one correspondence between outputs and busses; that is, each individual pipe is hard-wired to a single bus. Cards that work this way are Darla20, Gina20, Layla20, Darla24, Gina24, Layla24, Mona, and Indigo. Mia has a feature called "virtual outputs." +-----------+ record | |<----------------------------- Inputs <-------| | | PCI | Transport | | bus | engine | \|/ ------->| | +------+ +-------+ play | |-->|vmixer|-->|monitor|-------> Outputs +-----------+ +------+ | mixer | +-------+ Obviously, the difference here is the box labeled "vmixer." Vmixer is short for "virtual output mixer." For Mia, pipes are *not* hard-wired to a single bus; the vmixer lets you mix any pipe to any bus in any combination. Note, however, that the left-hand side of the diagram is unchanged. Transport works exactly the same way - the difference is in the mixer stage. Pipes and busses are numbered starting at zero. Pipe index ========== A number of calls in CEchoGals refer to a "pipe index". A pipe index is a unique number for a pipe that unambiguously refers to a playback or record pipe. Pipe indices are numbered starting with analog outputs, followed by digital outputs, then analog inputs, then digital inputs. Take Gina24 as an example: Pipe index 0-7 Analog outputs (0 .. FirstDigitalBusOut-1) 8-15 Digital outputs (FirstDigitalBusOut .. NumBussesOut-1) 16-17 Analog inputs 18-25 Digital inputs You get the pipe index by calling CEchoGals::OpenAudio; the other transport functions take the pipe index as a parameter. If you need a pipe index for some other reason, use the handy Makepipe_index method. Some calls take a CChannelMask parameter; CChannelMask is a handy way to group pipe indices. Digital mode switch =================== Some cards (right now, Gina24, Layla24, and Mona) have a Digital Mode Switch or DMS. Cards with a DMS can be set to one of three mutually exclusive digital modes: S/PDIF RCA, S/PDIF optical, or ADAT optical. This may create some confusion since ADAT optical is 8 channels wide and S/PDIF is only two channels wide. Gina24, Layla24, and Mona handle this by acting as if they always have 8 digital outs and ins. If you are in either S/PDIF mode, the last 6 channels don't do anything - data sent out these channels is thrown away and you will always record zeros. Note that with Gina24, Layla24, and Mona, sample rates above 50 kHz are only available if you have the card configured for S/PDIF optical or S/PDIF RCA. Double speed mode ================= Some of the cards support 88.2 kHz and 96 kHz sampling (Darla24, Gina24, Layla24, Mona, Mia, and Indigo). For these cards, the driver sometimes has to worry about "double speed mode"; double speed mode applies whenever the sampling rate is above 50 kHz. For instance, Mona and Layla24 support word clock sync. However, they actually support two different word clock modes - single speed (below 50 kHz) and double speed (above 50 kHz). The hardware detects if a single or double speed word clock signal is present; the generic code uses that information to determine which mode to use. The generic code takes care of all this for you. */ #ifndef _ECHOAUDIO_H_ #define _ECHOAUDIO_H_ #include "echoaudio_dsp.h" /*********************************************************************** PCI configuration space ***********************************************************************/ /* * PCI vendor ID and device IDs for the hardware */ #define VENDOR_ID … #define DEVICE_ID_56301 … #define DEVICE_ID_56361 … #define SUBVENDOR_ID … /* * Valid Echo PCI subsystem card IDs */ #define DARLA20 … #define GINA20 … #define LAYLA20 … #define DARLA24 … #define GINA24 … #define LAYLA24 … #define MONA … #define MIA … #define INDIGO … #define INDIGO_IO … #define INDIGO_DJ … #define DC8 … #define INDIGO_IOX … #define INDIGO_DJX … #define ECHO3G … /************************************************************************ Array sizes and so forth ***********************************************************************/ /* * Sizes */ #define ECHO_MAXAUDIOINPUTS … #define ECHO_MAXAUDIOOUTPUTS … #define ECHO_MAXAUDIOPIPES … #define E3G_MAX_OUTPUTS … #define ECHO_MAXMIDIJACKS … #define ECHO_MIDI_QUEUE_SZ … #define ECHO_MTC_QUEUE_SZ … /* * MIDI activity indicator timeout */ #define MIDI_ACTIVITY_TIMEOUT_USEC … /**************************************************************************** Clocks *****************************************************************************/ /* * Clock numbers */ #define ECHO_CLOCK_INTERNAL … #define ECHO_CLOCK_WORD … #define ECHO_CLOCK_SUPER … #define ECHO_CLOCK_SPDIF … #define ECHO_CLOCK_ADAT … #define ECHO_CLOCK_ESYNC … #define ECHO_CLOCK_ESYNC96 … #define ECHO_CLOCK_MTC … #define ECHO_CLOCK_NUMBER … #define ECHO_CLOCKS … /* * Clock bit numbers - used to report capabilities and whatever clocks * are being detected dynamically. */ #define ECHO_CLOCK_BIT_INTERNAL … #define ECHO_CLOCK_BIT_WORD … #define ECHO_CLOCK_BIT_SUPER … #define ECHO_CLOCK_BIT_SPDIF … #define ECHO_CLOCK_BIT_ADAT … #define ECHO_CLOCK_BIT_ESYNC … #define ECHO_CLOCK_BIT_ESYNC96 … #define ECHO_CLOCK_BIT_MTC … /*************************************************************************** Digital modes ****************************************************************************/ /* * Digital modes for Mona, Layla24, and Gina24 */ #define DIGITAL_MODE_NONE … #define DIGITAL_MODE_SPDIF_RCA … #define DIGITAL_MODE_SPDIF_OPTICAL … #define DIGITAL_MODE_ADAT … #define DIGITAL_MODE_SPDIF_CDROM … #define DIGITAL_MODES … /* * Digital mode capability masks */ #define ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_RCA … #define ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_OPTICAL … #define ECHOCAPS_HAS_DIGITAL_MODE_ADAT … #define ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_CDROM … #define EXT_3GBOX_NC … #define EXT_3GBOX_NOT_SET … #define ECHOGAIN_MUTED … #define ECHOGAIN_MINOUT … #define ECHOGAIN_MAXOUT … #define ECHOGAIN_MININP … #define ECHOGAIN_MAXINP … #define PIPE_STATE_STOPPED … #define PIPE_STATE_PAUSED … #define PIPE_STATE_STARTED … #define PIPE_STATE_PENDING … struct audiopipe { … }; struct audioformat { … }; struct echoaudio { … }; static int init_dsp_comm_page(struct echoaudio *chip); static int init_line_levels(struct echoaudio *chip); static int free_pipes(struct echoaudio *chip, struct audiopipe *pipe); static int load_firmware(struct echoaudio *chip); static int wait_handshake(struct echoaudio *chip); static int send_vector(struct echoaudio *chip, u32 command); static int get_firmware(const struct firmware **fw_entry, struct echoaudio *chip, const short fw_index); static void free_firmware(const struct firmware *fw_entry, struct echoaudio *chip); #ifdef ECHOCARD_HAS_MIDI static int enable_midi_input(struct echoaudio *chip, char enable); static void snd_echo_midi_output_trigger( struct snd_rawmidi_substream *substream, int up); static int midi_service_irq(struct echoaudio *chip); static int snd_echo_midi_create(struct snd_card *card, struct echoaudio *chip); #endif static inline void clear_handshake(struct echoaudio *chip) { … } static inline u32 get_dsp_register(struct echoaudio *chip, u32 index) { … } static inline void set_dsp_register(struct echoaudio *chip, u32 index, u32 value) { … } /* Pipe and bus indexes. PX_* and BX_* are defined as chip->px_* and chip->bx_* for 3G cards because they depend on the external box. They are integer constants for all other cards. Never use those defines directly, use the following functions instead. */ static inline int px_digital_out(const struct echoaudio *chip) { … } static inline int px_analog_in(const struct echoaudio *chip) { … } static inline int px_digital_in(const struct echoaudio *chip) { … } static inline int px_num(const struct echoaudio *chip) { … } static inline int bx_digital_out(const struct echoaudio *chip) { … } static inline int bx_analog_in(const struct echoaudio *chip) { … } static inline int bx_digital_in(const struct echoaudio *chip) { … } static inline int bx_num(const struct echoaudio *chip) { … } static inline int num_pipes_out(const struct echoaudio *chip) { … } static inline int num_pipes_in(const struct echoaudio *chip) { … } static inline int num_busses_out(const struct echoaudio *chip) { … } static inline int num_busses_in(const struct echoaudio *chip) { … } static inline int num_analog_busses_out(const struct echoaudio *chip) { … } static inline int num_analog_busses_in(const struct echoaudio *chip) { … } static inline int num_digital_busses_out(const struct echoaudio *chip) { … } static inline int num_digital_busses_in(const struct echoaudio *chip) { … } /* The monitor array is a one-dimensional array; compute the offset * into the array */ static inline int monitor_index(const struct echoaudio *chip, int out, int in) { … } #endif /* _ECHOAUDIO_H_ */
Codebase Browser
linux