1 /****************************************************************************
3 Copyright Echo Digital Audio Corporation (c) 1998 - 2004
7 This file is part of Echo Digital Audio's generic driver library.
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 Foundation.
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,
23 *************************************************************************
25 Translation from C++ and adaptation for use in ALSA-Driver
26 were made by Giuliano Pochini <pochini@shiny.it>
28 ****************************************************************************/
31 static int write_control_reg(struct echoaudio *chip, u32 value, char force);
32 static int set_input_clock(struct echoaudio *chip, u16 clock);
33 static int set_professional_spdif(struct echoaudio *chip, char prof);
34 static int set_digital_mode(struct echoaudio *chip, u8 mode);
35 static int load_asic_generic(struct echoaudio *chip, u32 cmd,
36 const struct firmware *asic);
37 static int check_asic_status(struct echoaudio *chip);
40 static int init_hw(struct echoaudio *chip, u16 device_id, u16 subdevice_id)
44 DE_INIT(("init_hw() - Layla24\n"));
45 if (snd_BUG_ON((subdevice_id & 0xfff0) != LAYLA24))
48 if ((err = init_dsp_comm_page(chip))) {
49 DE_INIT(("init_hw - could not initialize DSP comm page\n"));
53 chip->device_id = device_id;
54 chip->subdevice_id = subdevice_id;
55 chip->bad_board = TRUE;
56 chip->has_midi = TRUE;
57 chip->dsp_code_to_load = &card_fw[FW_LAYLA24_DSP];
58 chip->input_clock_types =
59 ECHO_CLOCK_BIT_INTERNAL | ECHO_CLOCK_BIT_SPDIF |
60 ECHO_CLOCK_BIT_WORD | ECHO_CLOCK_BIT_ADAT;
62 ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_RCA |
63 ECHOCAPS_HAS_DIGITAL_MODE_SPDIF_OPTICAL |
64 ECHOCAPS_HAS_DIGITAL_MODE_ADAT;
65 chip->digital_mode = DIGITAL_MODE_SPDIF_RCA;
66 chip->professional_spdif = FALSE;
67 chip->digital_in_automute = TRUE;
69 if ((err = load_firmware(chip)) < 0)
71 chip->bad_board = FALSE;
73 if ((err = init_line_levels(chip)) < 0)
76 err = set_digital_mode(chip, DIGITAL_MODE_SPDIF_RCA);
79 err = set_professional_spdif(chip, TRUE);
81 DE_INIT(("init_hw done\n"));
87 static u32 detect_input_clocks(const struct echoaudio *chip)
89 u32 clocks_from_dsp, clock_bits;
91 /* Map the DSP clock detect bits to the generic driver clock detect bits */
92 clocks_from_dsp = le32_to_cpu(chip->comm_page->status_clocks);
94 clock_bits = ECHO_CLOCK_BIT_INTERNAL;
96 if (clocks_from_dsp & GML_CLOCK_DETECT_BIT_SPDIF)
97 clock_bits |= ECHO_CLOCK_BIT_SPDIF;
99 if (clocks_from_dsp & GML_CLOCK_DETECT_BIT_ADAT)
100 clock_bits |= ECHO_CLOCK_BIT_ADAT;
102 if (clocks_from_dsp & GML_CLOCK_DETECT_BIT_WORD)
103 clock_bits |= ECHO_CLOCK_BIT_WORD;
110 /* Layla24 has an ASIC on the PCI card and another ASIC in the external box;
111 both need to be loaded. */
112 static int load_asic(struct echoaudio *chip)
116 if (chip->asic_loaded)
119 DE_INIT(("load_asic\n"));
121 /* Give the DSP a few milliseconds to settle down */
124 /* Load the ASIC for the PCI card */
125 err = load_asic_generic(chip, DSP_FNC_LOAD_LAYLA24_PCI_CARD_ASIC,
126 &card_fw[FW_LAYLA24_1_ASIC]);
130 chip->asic_code = &card_fw[FW_LAYLA24_2S_ASIC];
132 /* Now give the new ASIC a little time to set up */
135 /* Do the external one */
136 err = load_asic_generic(chip, DSP_FNC_LOAD_LAYLA24_EXTERNAL_ASIC,
137 &card_fw[FW_LAYLA24_2S_ASIC]);
141 /* Now give the external ASIC a little time to set up */
144 /* See if it worked */
145 err = check_asic_status(chip);
147 /* Set up the control register if the load succeeded -
148 48 kHz, internal clock, S/PDIF RCA mode */
150 err = write_control_reg(chip, GML_CONVERTER_ENABLE | GML_48KHZ,
153 DE_INIT(("load_asic() done\n"));
159 static int set_sample_rate(struct echoaudio *chip, u32 rate)
161 u32 control_reg, clock, base_rate;
163 if (snd_BUG_ON(rate >= 50000 &&
164 chip->digital_mode == DIGITAL_MODE_ADAT))
167 /* Only set the clock for internal mode. */
168 if (chip->input_clock != ECHO_CLOCK_INTERNAL) {
169 DE_ACT(("set_sample_rate: Cannot set sample rate - "
170 "clock not set to CLK_CLOCKININTERNAL\n"));
171 /* Save the rate anyhow */
172 chip->comm_page->sample_rate = cpu_to_le32(rate);
173 chip->sample_rate = rate;
177 /* Get the control register & clear the appropriate bits */
178 control_reg = le32_to_cpu(chip->comm_page->control_register);
179 control_reg &= GML_CLOCK_CLEAR_MASK & GML_SPDIF_RATE_CLEAR_MASK;
191 clock = GML_48KHZ | GML_SPDIF_SAMPLE_RATE1;
195 /* Professional mode */
196 if (control_reg & GML_SPDIF_PRO_MODE)
197 clock |= GML_SPDIF_SAMPLE_RATE0;
200 clock = GML_32KHZ | GML_SPDIF_SAMPLE_RATE0 |
201 GML_SPDIF_SAMPLE_RATE1;
216 /* If this is a non-standard rate, then the driver needs to
217 use Layla24's special "continuous frequency" mode */
218 clock = LAYLA24_CONTINUOUS_CLOCK;
220 base_rate = rate >> 1;
221 control_reg |= GML_DOUBLE_SPEED_MODE;
226 if (base_rate < 25000)
229 if (wait_handshake(chip))
232 chip->comm_page->sample_rate =
233 cpu_to_le32(LAYLA24_MAGIC_NUMBER / base_rate - 2);
235 clear_handshake(chip);
236 send_vector(chip, DSP_VC_SET_LAYLA24_FREQUENCY_REG);
239 control_reg |= clock;
241 chip->comm_page->sample_rate = cpu_to_le32(rate); /* ignored by the DSP ? */
242 chip->sample_rate = rate;
243 DE_ACT(("set_sample_rate: %d clock %d\n", rate, control_reg));
245 return write_control_reg(chip, control_reg, FALSE);
250 static int set_input_clock(struct echoaudio *chip, u16 clock)
252 u32 control_reg, clocks_from_dsp;
254 /* Mask off the clock select bits */
255 control_reg = le32_to_cpu(chip->comm_page->control_register) &
256 GML_CLOCK_CLEAR_MASK;
257 clocks_from_dsp = le32_to_cpu(chip->comm_page->status_clocks);
259 /* Pick the new clock */
261 case ECHO_CLOCK_INTERNAL:
262 DE_ACT(("Set Layla24 clock to INTERNAL\n"));
263 chip->input_clock = ECHO_CLOCK_INTERNAL;
264 return set_sample_rate(chip, chip->sample_rate);
265 case ECHO_CLOCK_SPDIF:
266 if (chip->digital_mode == DIGITAL_MODE_ADAT)
268 control_reg |= GML_SPDIF_CLOCK;
269 /* Layla24 doesn't support 96KHz S/PDIF */
270 control_reg &= ~GML_DOUBLE_SPEED_MODE;
271 DE_ACT(("Set Layla24 clock to SPDIF\n"));
273 case ECHO_CLOCK_WORD:
274 control_reg |= GML_WORD_CLOCK;
275 if (clocks_from_dsp & GML_CLOCK_DETECT_BIT_WORD96)
276 control_reg |= GML_DOUBLE_SPEED_MODE;
278 control_reg &= ~GML_DOUBLE_SPEED_MODE;
279 DE_ACT(("Set Layla24 clock to WORD\n"));
281 case ECHO_CLOCK_ADAT:
282 if (chip->digital_mode != DIGITAL_MODE_ADAT)
284 control_reg |= GML_ADAT_CLOCK;
285 control_reg &= ~GML_DOUBLE_SPEED_MODE;
286 DE_ACT(("Set Layla24 clock to ADAT\n"));
289 DE_ACT(("Input clock 0x%x not supported for Layla24\n", clock));
293 chip->input_clock = clock;
294 return write_control_reg(chip, control_reg, TRUE);
299 /* Depending on what digital mode you want, Layla24 needs different ASICs
300 loaded. This function checks the ASIC needed for the new mode and sees
301 if it matches the one already loaded. */
302 static int switch_asic(struct echoaudio *chip, const struct firmware *asic)
306 /* Check to see if this is already loaded */
307 if (asic != chip->asic_code) {
308 monitors = kmemdup(chip->comm_page->monitors,
309 MONITOR_ARRAY_SIZE, GFP_KERNEL);
313 memset(chip->comm_page->monitors, ECHOGAIN_MUTED,
316 /* Load the desired ASIC */
317 if (load_asic_generic(chip, DSP_FNC_LOAD_LAYLA24_EXTERNAL_ASIC,
319 memcpy(chip->comm_page->monitors, monitors,
324 chip->asic_code = asic;
325 memcpy(chip->comm_page->monitors, monitors, MONITOR_ARRAY_SIZE);
334 static int dsp_set_digital_mode(struct echoaudio *chip, u8 mode)
337 int err, incompatible_clock;
338 const struct firmware *asic;
340 /* Set clock to "internal" if it's not compatible with the new mode */
341 incompatible_clock = FALSE;
343 case DIGITAL_MODE_SPDIF_OPTICAL:
344 case DIGITAL_MODE_SPDIF_RCA:
345 if (chip->input_clock == ECHO_CLOCK_ADAT)
346 incompatible_clock = TRUE;
347 asic = &card_fw[FW_LAYLA24_2S_ASIC];
349 case DIGITAL_MODE_ADAT:
350 if (chip->input_clock == ECHO_CLOCK_SPDIF)
351 incompatible_clock = TRUE;
352 asic = &card_fw[FW_LAYLA24_2A_ASIC];
355 DE_ACT(("Digital mode not supported: %d\n", mode));
359 if (incompatible_clock) { /* Switch to 48KHz, internal */
360 chip->sample_rate = 48000;
361 spin_lock_irq(&chip->lock);
362 set_input_clock(chip, ECHO_CLOCK_INTERNAL);
363 spin_unlock_irq(&chip->lock);
366 /* switch_asic() can sleep */
367 if (switch_asic(chip, asic) < 0)
370 spin_lock_irq(&chip->lock);
372 /* Tweak the control register */
373 control_reg = le32_to_cpu(chip->comm_page->control_register);
374 control_reg &= GML_DIGITAL_MODE_CLEAR_MASK;
377 case DIGITAL_MODE_SPDIF_OPTICAL:
378 control_reg |= GML_SPDIF_OPTICAL_MODE;
380 case DIGITAL_MODE_SPDIF_RCA:
381 /* GML_SPDIF_OPTICAL_MODE bit cleared */
383 case DIGITAL_MODE_ADAT:
384 control_reg |= GML_ADAT_MODE;
385 control_reg &= ~GML_DOUBLE_SPEED_MODE;
389 err = write_control_reg(chip, control_reg, TRUE);
390 spin_unlock_irq(&chip->lock);
393 chip->digital_mode = mode;
395 DE_ACT(("set_digital_mode to %d\n", mode));
396 return incompatible_clock;