2 * Driver for Digigram miXart soundcards
4 * DSP firmware management
6 * Copyright (c) 2003 by Digigram <alsa@digigram.com>
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 #include <sound/driver.h>
24 #include <linux/interrupt.h>
25 #include <linux/pci.h>
26 #include <linux/firmware.h>
28 #include <sound/core.h>
30 #include "mixart_mixer.h"
31 #include "mixart_core.h"
32 #include "mixart_hwdep.h"
36 * wait for a value on a peudo register, exit with a timeout
38 * @param mgr pointer to miXart manager structure
39 * @param offset unsigned pseudo_register base + offset of value
41 * @param timeout timeout in centisenconds
43 static int mixart_wait_nice_for_register_value(mixart_mgr_t *mgr, u32 offset, int is_egal, u32 value, unsigned long timeout)
45 unsigned long end_time = jiffies + (timeout * HZ / 100);
48 do { /* we may take too long time in this loop.
49 * so give controls back to kernel if needed.
53 read = readl_be( MIXART_MEM( mgr, offset ));
55 if(read == value) return 0;
57 else { /* wait for different value */
58 if(read != value) return 0;
60 } while ( time_after_eq(end_time, jiffies) );
67 structures needed to upload elf code packets
69 typedef struct snd_mixart_elf32_ehdr snd_mixart_elf32_ehdr_t;
71 struct snd_mixart_elf32_ehdr {
88 typedef struct snd_mixart_elf32_phdr snd_mixart_elf32_phdr_t;
90 struct snd_mixart_elf32_phdr {
101 static int mixart_load_elf(mixart_mgr_t *mgr, const struct firmware *dsp )
103 char elf32_magic_number[4] = {0x7f,'E','L','F'};
104 snd_mixart_elf32_ehdr_t *elf_header;
107 elf_header = (snd_mixart_elf32_ehdr_t *)dsp->data;
109 if ( elf32_magic_number[i] != elf_header->e_ident[i] )
112 if( elf_header->e_phoff != 0 ) {
113 snd_mixart_elf32_phdr_t elf_programheader;
115 for( i=0; i < be16_to_cpu(elf_header->e_phnum); i++ ) {
116 u32 pos = be32_to_cpu(elf_header->e_phoff) + (u32)(i * be16_to_cpu(elf_header->e_phentsize));
118 memcpy( &elf_programheader, dsp->data + pos, sizeof(elf_programheader) );
120 if(elf_programheader.p_type != 0) {
121 if( elf_programheader.p_filesz != 0 ) {
122 memcpy_toio( MIXART_MEM( mgr, be32_to_cpu(elf_programheader.p_vaddr)),
123 dsp->data + be32_to_cpu( elf_programheader.p_offset ),
124 be32_to_cpu( elf_programheader.p_filesz ));
133 * get basic information and init miXart
136 /* audio IDs for request to the board */
137 #define MIXART_FIRST_ANA_AUDIO_ID 0
138 #define MIXART_FIRST_DIG_AUDIO_ID 8
140 static int mixart_enum_connectors(mixart_mgr_t *mgr)
144 mixart_msg_t request;
145 mixart_enum_connector_resp_t connector;
146 mixart_audio_info_req_t audio_info_req;
147 mixart_audio_info_resp_t audio_info;
149 audio_info_req.line_max_level = MIXART_FLOAT_P_22_0_TO_HEX;
150 audio_info_req.micro_max_level = MIXART_FLOAT_M_20_0_TO_HEX;
151 audio_info_req.cd_max_level = MIXART_FLOAT____0_0_TO_HEX;
153 request.message_id = MSG_SYSTEM_ENUM_PLAY_CONNECTOR;
154 request.uid = (mixart_uid_t){0,0}; /* board num = 0 */
158 err = snd_mixart_send_msg(mgr, &request, sizeof(connector), &connector);
159 if((err < 0) || (connector.error_code) || (connector.uid_count > MIXART_MAX_PHYS_CONNECTORS)) {
160 snd_printk(KERN_ERR "error MSG_SYSTEM_ENUM_PLAY_CONNECTOR\n");
164 for(k=0; k < connector.uid_count; k++) {
167 if(k < MIXART_FIRST_DIG_AUDIO_ID) {
168 pipe = &mgr->chip[k/2]->pipe_out_ana;
170 pipe = &mgr->chip[(k-MIXART_FIRST_DIG_AUDIO_ID)/2]->pipe_out_dig;
173 pipe->uid_right_connector = connector.uid[k]; /* odd */
175 pipe->uid_left_connector = connector.uid[k]; /* even */
178 /* snd_printk(KERN_DEBUG "playback connector[%d].object_id = %x\n", k, connector.uid[k].object_id); */
180 /* TODO: really need send_msg MSG_CONNECTOR_GET_AUDIO_INFO for each connector ? perhaps for analog level caps ? */
181 request.message_id = MSG_CONNECTOR_GET_AUDIO_INFO;
182 request.uid = connector.uid[k];
183 request.data = &audio_info_req;
184 request.size = sizeof(audio_info_req);
186 err = snd_mixart_send_msg(mgr, &request, sizeof(audio_info), &audio_info);
188 snd_printk(KERN_ERR "error MSG_CONNECTOR_GET_AUDIO_INFO\n");
191 /*snd_printk(KERN_DEBUG "play analog_info.analog_level_present = %x\n", audio_info.info.analog_info.analog_level_present);*/
194 request.message_id = MSG_SYSTEM_ENUM_RECORD_CONNECTOR;
195 request.uid = (mixart_uid_t){0,0}; /* board num = 0 */
199 err = snd_mixart_send_msg(mgr, &request, sizeof(connector), &connector);
200 if((err < 0) || (connector.error_code) || (connector.uid_count > MIXART_MAX_PHYS_CONNECTORS)) {
201 snd_printk(KERN_ERR "error MSG_SYSTEM_ENUM_RECORD_CONNECTOR\n");
205 for(k=0; k < connector.uid_count; k++) {
208 if(k < MIXART_FIRST_DIG_AUDIO_ID) {
209 pipe = &mgr->chip[k/2]->pipe_in_ana;
211 pipe = &mgr->chip[(k-MIXART_FIRST_DIG_AUDIO_ID)/2]->pipe_in_dig;
214 pipe->uid_right_connector = connector.uid[k]; /* odd */
216 pipe->uid_left_connector = connector.uid[k]; /* even */
219 /* snd_printk(KERN_DEBUG "capture connector[%d].object_id = %x\n", k, connector.uid[k].object_id); */
221 /* TODO: really need send_msg MSG_CONNECTOR_GET_AUDIO_INFO for each connector ? perhaps for analog level caps ? */
222 request.message_id = MSG_CONNECTOR_GET_AUDIO_INFO;
223 request.uid = connector.uid[k];
224 request.data = &audio_info_req;
225 request.size = sizeof(audio_info_req);
227 err = snd_mixart_send_msg(mgr, &request, sizeof(audio_info), &audio_info);
229 snd_printk(KERN_ERR "error MSG_CONNECTOR_GET_AUDIO_INFO\n");
232 /*snd_printk(KERN_DEBUG "rec analog_info.analog_level_present = %x\n", audio_info.info.analog_info.analog_level_present);*/
238 static int mixart_enum_physio(mixart_mgr_t *mgr)
242 mixart_msg_t request;
243 mixart_uid_t get_console_mgr;
244 mixart_return_uid_t console_mgr;
245 mixart_uid_enumeration_t phys_io;
247 /* get the uid for the console manager */
248 get_console_mgr.object_id = 0;
249 get_console_mgr.desc = MSG_CONSOLE_MANAGER | 0; /* cardindex = 0 */
251 request.message_id = MSG_CONSOLE_GET_CLOCK_UID;
252 request.uid = get_console_mgr;
253 request.data = &get_console_mgr;
254 request.size = sizeof(get_console_mgr);
256 err = snd_mixart_send_msg(mgr, &request, sizeof(console_mgr), &console_mgr);
258 if( (err < 0) || (console_mgr.error_code != 0) ) {
259 snd_printk(KERN_DEBUG "error MSG_CONSOLE_GET_CLOCK_UID : err=%x\n", console_mgr.error_code);
263 /* used later for clock issues ! */
264 mgr->uid_console_manager = console_mgr.uid;
266 request.message_id = MSG_SYSTEM_ENUM_PHYSICAL_IO;
267 request.uid = (mixart_uid_t){0,0};
268 request.data = &console_mgr.uid;
269 request.size = sizeof(console_mgr.uid);
271 err = snd_mixart_send_msg(mgr, &request, sizeof(phys_io), &phys_io);
272 if( (err < 0) || ( phys_io.error_code != 0 ) ) {
273 snd_printk(KERN_ERR "error MSG_SYSTEM_ENUM_PHYSICAL_IO err(%x) error_code(%x)\n", err, phys_io.error_code );
277 snd_assert(phys_io.nb_uid >= (MIXART_MAX_CARDS * 2), return -EINVAL); /* min 2 phys io per card (analog in + analog out) */
279 for(k=0; k<mgr->num_cards; k++) {
280 mgr->chip[k]->uid_in_analog_physio = phys_io.uid[k];
281 mgr->chip[k]->uid_out_analog_physio = phys_io.uid[phys_io.nb_uid/2 + k];
288 static int mixart_first_init(mixart_mgr_t *mgr)
292 mixart_msg_t request;
294 if((err = mixart_enum_connectors(mgr)) < 0) return err;
296 if((err = mixart_enum_physio(mgr)) < 0) return err;
298 /* send a synchro command to card (necessary to do this before first MSG_STREAM_START_STREAM_GRP_PACKET) */
299 /* though why not here */
300 request.message_id = MSG_SYSTEM_SEND_SYNCHRO_CMD;
301 request.uid = (mixart_uid_t){0,0};
304 /* this command has no data. response is a 32 bit status */
305 err = snd_mixart_send_msg(mgr, &request, sizeof(k), &k);
306 if( (err < 0) || (k != 0) ) {
307 snd_printk(KERN_ERR "error MSG_SYSTEM_SEND_SYNCHRO_CMD\n");
308 return err == 0 ? -EINVAL : err;
315 /* firmware base addresses (when hard coded) */
316 #define MIXART_MOTHERBOARD_XLX_BASE_ADDRESS 0x00600000
318 static int mixart_dsp_load(mixart_mgr_t* mgr, int index, const struct firmware *dsp)
321 u32 status_xilinx, status_elf, status_daught;
324 /* read motherboard xilinx status */
325 status_xilinx = readl_be( MIXART_MEM( mgr,MIXART_PSEUDOREG_MXLX_STATUS_OFFSET ));
326 /* read elf status */
327 status_elf = readl_be( MIXART_MEM( mgr,MIXART_PSEUDOREG_ELF_STATUS_OFFSET ));
328 /* read daughterboard xilinx status */
329 status_daught = readl_be( MIXART_MEM( mgr,MIXART_PSEUDOREG_DXLX_STATUS_OFFSET ));
331 /* motherboard xilinx status 5 will say that the board is performing a reset */
332 if( status_xilinx == 5 ) {
333 snd_printk( KERN_ERR "miXart is resetting !\n");
334 return -EAGAIN; /* try again later */
338 case MIXART_MOTHERBOARD_XLX_INDEX:
340 /* xilinx already loaded ? */
341 if( status_xilinx == 4 ) {
342 snd_printk( KERN_DEBUG "xilinx is already loaded !\n");
345 /* the status should be 0 == "idle" */
346 if( status_xilinx != 0 ) {
347 snd_printk( KERN_ERR "xilinx load error ! status = %d\n", status_xilinx);
348 return -EIO; /* modprob -r may help ? */
351 /* check xilinx validity */
352 snd_assert(((u32*)(dsp->data))[0]==0xFFFFFFFF, return -EINVAL);
353 snd_assert(dsp->size % 4 == 0, return -EINVAL);
355 /* set xilinx status to copying */
356 writel_be( 1, MIXART_MEM( mgr, MIXART_PSEUDOREG_MXLX_STATUS_OFFSET ));
358 /* setup xilinx base address */
359 writel_be( MIXART_MOTHERBOARD_XLX_BASE_ADDRESS, MIXART_MEM( mgr,MIXART_PSEUDOREG_MXLX_BASE_ADDR_OFFSET ));
360 /* setup code size for xilinx file */
361 writel_be( dsp->size, MIXART_MEM( mgr, MIXART_PSEUDOREG_MXLX_SIZE_OFFSET ));
363 /* copy xilinx code */
364 memcpy_toio( MIXART_MEM( mgr, MIXART_MOTHERBOARD_XLX_BASE_ADDRESS), dsp->data, dsp->size);
366 /* set xilinx status to copy finished */
367 writel_be( 2, MIXART_MEM( mgr, MIXART_PSEUDOREG_MXLX_STATUS_OFFSET ));
369 /* return, because no further processing needed */
372 case MIXART_MOTHERBOARD_ELF_INDEX:
374 if( status_elf == 4 ) {
375 snd_printk( KERN_DEBUG "elf file already loaded !\n");
379 /* the status should be 0 == "idle" */
380 if( status_elf != 0 ) {
381 snd_printk( KERN_ERR "elf load error ! status = %d\n", status_elf);
382 return -EIO; /* modprob -r may help ? */
385 /* wait for xilinx status == 4 */
386 err = mixart_wait_nice_for_register_value( mgr, MIXART_PSEUDOREG_MXLX_STATUS_OFFSET, 1, 4, 500); /* 5sec */
388 snd_printk( KERN_ERR "xilinx was not loaded or could not be started\n");
392 /* init some data on the card */
393 writel_be( 0, MIXART_MEM( mgr, MIXART_PSEUDOREG_BOARDNUMBER ) ); /* set miXart boardnumber to 0 */
394 writel_be( 0, MIXART_MEM( mgr, MIXART_FLOWTABLE_PTR ) ); /* reset pointer to flow table on miXart */
396 /* set elf status to copying */
397 writel_be( 1, MIXART_MEM( mgr, MIXART_PSEUDOREG_ELF_STATUS_OFFSET ));
399 /* process the copying of the elf packets */
400 err = mixart_load_elf( mgr, dsp );
401 if (err < 0) return err;
403 /* set elf status to copy finished */
404 writel_be( 2, MIXART_MEM( mgr, MIXART_PSEUDOREG_ELF_STATUS_OFFSET ));
406 /* wait for elf status == 4 */
407 err = mixart_wait_nice_for_register_value( mgr, MIXART_PSEUDOREG_ELF_STATUS_OFFSET, 1, 4, 300); /* 3sec */
409 snd_printk( KERN_ERR "elf could not be started\n");
413 /* miXart waits at this point on the pointer to the flow table */
414 writel_be( (u32)mgr->flowinfo.addr, MIXART_MEM( mgr, MIXART_FLOWTABLE_PTR ) ); /* give pointer of flow table to miXart */
416 return 0; /* return, another xilinx file has to be loaded before */
418 case MIXART_AESEBUBOARD_XLX_INDEX:
421 /* elf and xilinx should be loaded */
422 if( (status_elf != 4) || (status_xilinx != 4) ) {
423 printk( KERN_ERR "xilinx or elf not successfully loaded\n");
424 return -EIO; /* modprob -r may help ? */
427 /* wait for daughter detection != 0 */
428 err = mixart_wait_nice_for_register_value( mgr, MIXART_PSEUDOREG_DBRD_PRESENCE_OFFSET, 0, 0, 30); /* 300msec */
430 snd_printk( KERN_ERR "error starting elf file\n");
434 /* the board type can now be retrieved */
435 mgr->board_type = (DAUGHTER_TYPE_MASK & readl_be( MIXART_MEM( mgr, MIXART_PSEUDOREG_DBRD_TYPE_OFFSET)));
437 if (mgr->board_type == MIXART_DAUGHTER_TYPE_NONE)
438 break; /* no daughter board; the file does not have to be loaded, continue after the switch */
440 /* only if aesebu daughter board presence (elf code must run) */
441 if (mgr->board_type != MIXART_DAUGHTER_TYPE_AES )
444 /* daughter should be idle */
445 if( status_daught != 0 ) {
446 printk( KERN_ERR "daughter load error ! status = %d\n", status_daught);
447 return -EIO; /* modprob -r may help ? */
450 /* check daughterboard xilinx validity */
451 snd_assert(((u32*)(dsp->data))[0]==0xFFFFFFFF, return -EINVAL);
452 snd_assert(dsp->size % 4 == 0, return -EINVAL);
454 /* inform mixart about the size of the file */
455 writel_be( dsp->size, MIXART_MEM( mgr, MIXART_PSEUDOREG_DXLX_SIZE_OFFSET ));
457 /* set daughterboard status to 1 */
458 writel_be( 1, MIXART_MEM( mgr, MIXART_PSEUDOREG_DXLX_STATUS_OFFSET ));
460 /* wait for status == 2 */
461 err = mixart_wait_nice_for_register_value( mgr, MIXART_PSEUDOREG_DXLX_STATUS_OFFSET, 1, 2, 30); /* 300msec */
463 snd_printk( KERN_ERR "daughter board load error\n");
467 /* get the address where to write the file */
468 val = readl_be( MIXART_MEM( mgr, MIXART_PSEUDOREG_DXLX_BASE_ADDR_OFFSET ));
469 snd_assert(val != 0, return -EINVAL);
471 /* copy daughterboard xilinx code */
472 memcpy_toio( MIXART_MEM( mgr, val), dsp->data, dsp->size);
474 /* set daughterboard status to 4 */
475 writel_be( 4, MIXART_MEM( mgr, MIXART_PSEUDOREG_DXLX_STATUS_OFFSET ));
477 /* continue with init */
479 } /* end of switch file index*/
481 /* wait for daughter status == 3 */
482 err = mixart_wait_nice_for_register_value( mgr, MIXART_PSEUDOREG_DXLX_STATUS_OFFSET, 1, 3, 300); /* 3sec */
484 snd_printk( KERN_ERR "daughter board could not be initialised\n");
488 /* init mailbox (communication with embedded) */
489 snd_mixart_init_mailbox(mgr);
491 /* first communication with embedded */
492 err = mixart_first_init(mgr);
494 snd_printk( KERN_ERR "miXart could not be set up\n");
498 /* create devices and mixer in accordance with HW options*/
499 for (card_index = 0; card_index < mgr->num_cards; card_index++) {
500 mixart_t *chip = mgr->chip[card_index];
502 if ((err = snd_mixart_create_pcm(chip)) < 0)
505 if (card_index == 0) {
506 if ((err = snd_mixart_create_mixer(chip->mgr)) < 0)
510 if ((err = snd_card_register(chip->card)) < 0)
514 snd_printdd("miXart firmware downloaded and successfully set up\n");
520 #if defined(CONFIG_FW_LOADER) || defined(CONFIG_FW_LOADER_MODULE)
521 #if !defined(CONFIG_USE_MIXARTLOADER) && !defined(CONFIG_SND_MIXART) /* built-in kernel */
522 #define SND_MIXART_FW_LOADER /* use the standard firmware loader */
526 #ifdef SND_MIXART_FW_LOADER
528 int snd_mixart_setup_firmware(mixart_mgr_t *mgr)
530 static char *fw_files[3] = {
531 "miXart8.xlx", "miXart8.elf", "miXart8AES.xlx"
535 const struct firmware *fw_entry;
538 for (i = 0; i < 3; i++) {
539 sprintf(path, "mixart/%s", fw_files[i]);
540 if (request_firmware(&fw_entry, path, &mgr->pci->dev)) {
541 snd_printk(KERN_ERR "miXart: can't load firmware %s\n", path);
544 /* fake hwdep dsp record */
545 err = mixart_dsp_load(mgr, i, fw_entry);
546 release_firmware(fw_entry);
554 #else /* old style firmware loading */
556 /* miXart hwdep interface id string */
557 #define SND_MIXART_HWDEP_ID "miXart Loader"
559 static int mixart_hwdep_open(snd_hwdep_t *hw, struct file *file)
564 static int mixart_hwdep_release(snd_hwdep_t *hw, struct file *file)
569 static int mixart_hwdep_dsp_status(snd_hwdep_t *hw, snd_hwdep_dsp_status_t *info)
571 mixart_mgr_t *mgr = hw->private_data;
573 strcpy(info->id, "miXart");
574 info->num_dsps = MIXART_HARDW_FILES_MAX_INDEX;
576 if (mgr->hwdep->dsp_loaded & (1 << MIXART_MOTHERBOARD_ELF_INDEX))
577 info->chip_ready = 1;
579 info->version = MIXART_DRIVER_VERSION;
583 static int mixart_hwdep_dsp_load(snd_hwdep_t *hw, snd_hwdep_dsp_image_t *dsp)
585 mixart_mgr_t* mgr = hw->private_data;
589 fw.size = dsp->length;
590 fw.data = vmalloc(dsp->length);
592 snd_printk(KERN_ERR "miXart: cannot allocate image size %d\n",
596 if (copy_from_user(fw.data, dsp->image, dsp->length)) {
600 err = mixart_dsp_load(mgr, dsp->index, &fw);
605 int snd_mixart_setup_firmware(mixart_mgr_t *mgr)
610 /* only create hwdep interface for first cardX (see "index" module parameter)*/
611 if ((err = snd_hwdep_new(mgr->chip[0]->card, SND_MIXART_HWDEP_ID, 0, &hw)) < 0)
614 hw->iface = SNDRV_HWDEP_IFACE_MIXART;
615 hw->private_data = mgr;
616 hw->ops.open = mixart_hwdep_open;
617 hw->ops.release = mixart_hwdep_release;
618 hw->ops.dsp_status = mixart_hwdep_dsp_status;
619 hw->ops.dsp_load = mixart_hwdep_dsp_load;
621 sprintf(hw->name, SND_MIXART_HWDEP_ID);
623 mgr->hwdep->dsp_loaded = 0;
625 return snd_card_register(mgr->chip[0]->card);
628 #endif /* SND_MIXART_FW_LOADER */