11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * Emagic EMI 2|6 usb audio interface firmware loader. 31da177e4SLinus Torvalds * Copyright (C) 2002 41da177e4SLinus Torvalds * Tapio Laxstr�m (tapio.laxstrom@iptime.fi) 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or modify 71da177e4SLinus Torvalds * it under the terms of the GNU General Public License, as published by 81da177e4SLinus Torvalds * the Free Software Foundation, version 2. 91da177e4SLinus Torvalds * 101da177e4SLinus Torvalds * $Id: emi62.c,v 1.15 2002/04/23 06:13:59 tapio Exp $ 111da177e4SLinus Torvalds */ 121da177e4SLinus Torvalds #include <linux/kernel.h> 131da177e4SLinus Torvalds #include <linux/errno.h> 141da177e4SLinus Torvalds #include <linux/slab.h> 151da177e4SLinus Torvalds #include <linux/init.h> 161da177e4SLinus Torvalds #include <linux/module.h> 171da177e4SLinus Torvalds #include <linux/usb.h> 1816c23f7dSMonty #include <linux/delay.h> 191da177e4SLinus Torvalds 201da177e4SLinus Torvalds #define MAX_INTEL_HEX_RECORD_LENGTH 16 211da177e4SLinus Torvalds typedef struct _INTEL_HEX_RECORD 221da177e4SLinus Torvalds { 231da177e4SLinus Torvalds __u32 length; 241da177e4SLinus Torvalds __u32 address; 251da177e4SLinus Torvalds __u32 type; 261da177e4SLinus Torvalds __u8 data[MAX_INTEL_HEX_RECORD_LENGTH]; 271da177e4SLinus Torvalds } INTEL_HEX_RECORD, *PINTEL_HEX_RECORD; 281da177e4SLinus Torvalds 291da177e4SLinus Torvalds /* include firmware (variables)*/ 301da177e4SLinus Torvalds 311da177e4SLinus Torvalds /* FIXME: This is quick and dirty solution! */ 321da177e4SLinus Torvalds #define SPDIF /* if you want SPDIF comment next line */ 331da177e4SLinus Torvalds //#undef SPDIF /* if you want MIDI uncomment this line */ 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds #ifdef SPDIF 361da177e4SLinus Torvalds # include "emi62_fw_s.h" /* spdif fw */ 371da177e4SLinus Torvalds #else 381da177e4SLinus Torvalds # include "emi62_fw_m.h" /* midi fw */ 391da177e4SLinus Torvalds #endif 401da177e4SLinus Torvalds 411da177e4SLinus Torvalds #define EMI62_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */ 421da177e4SLinus Torvalds #define EMI62_PRODUCT_ID 0x0110 /* EMI 6|2m without firmware */ 431da177e4SLinus Torvalds 441da177e4SLinus Torvalds #define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */ 451da177e4SLinus Torvalds #define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */ 461da177e4SLinus Torvalds #define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */ 471da177e4SLinus Torvalds #define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */ 481da177e4SLinus Torvalds #define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */ 491da177e4SLinus Torvalds #define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS) 501da177e4SLinus Torvalds 511da177e4SLinus Torvalds static int emi62_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest); 521da177e4SLinus Torvalds static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit); 531da177e4SLinus Torvalds static int emi62_load_firmware (struct usb_device *dev); 541da177e4SLinus Torvalds static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id); 551da177e4SLinus Torvalds static void emi62_disconnect(struct usb_interface *intf); 561da177e4SLinus Torvalds static int __init emi62_init (void); 571da177e4SLinus Torvalds static void __exit emi62_exit (void); 581da177e4SLinus Torvalds 591da177e4SLinus Torvalds 601da177e4SLinus Torvalds /* thanks to drivers/usb/serial/keyspan_pda.c code */ 611da177e4SLinus Torvalds static int emi62_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request) 621da177e4SLinus Torvalds { 631da177e4SLinus Torvalds int result; 641da177e4SLinus Torvalds unsigned char *buffer = kmalloc (length, GFP_KERNEL); 651da177e4SLinus Torvalds 661da177e4SLinus Torvalds if (!buffer) { 671da177e4SLinus Torvalds err("emi62: kmalloc(%d) failed.", length); 681da177e4SLinus Torvalds return -ENOMEM; 691da177e4SLinus Torvalds } 701da177e4SLinus Torvalds memcpy (buffer, data, length); 711da177e4SLinus Torvalds /* Note: usb_control_msg returns negative value on error or length of the 721da177e4SLinus Torvalds * data that was written! */ 731da177e4SLinus Torvalds result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300); 741da177e4SLinus Torvalds kfree (buffer); 751da177e4SLinus Torvalds return result; 761da177e4SLinus Torvalds } 771da177e4SLinus Torvalds 781da177e4SLinus Torvalds /* thanks to drivers/usb/serial/keyspan_pda.c code */ 791da177e4SLinus Torvalds static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit) 801da177e4SLinus Torvalds { 811da177e4SLinus Torvalds int response; 821da177e4SLinus Torvalds info("%s - %d", __FUNCTION__, reset_bit); 831da177e4SLinus Torvalds 841da177e4SLinus Torvalds response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0); 851da177e4SLinus Torvalds if (response < 0) { 861da177e4SLinus Torvalds err("emi62: set_reset (%d) failed", reset_bit); 871da177e4SLinus Torvalds } 881da177e4SLinus Torvalds return response; 891da177e4SLinus Torvalds } 901da177e4SLinus Torvalds 911da177e4SLinus Torvalds #define FW_LOAD_SIZE 1023 921da177e4SLinus Torvalds 931da177e4SLinus Torvalds static int emi62_load_firmware (struct usb_device *dev) 941da177e4SLinus Torvalds { 951da177e4SLinus Torvalds int err; 961da177e4SLinus Torvalds int i; 971da177e4SLinus Torvalds int pos = 0; /* Position in hex record */ 981da177e4SLinus Torvalds __u32 addr; /* Address to write */ 991da177e4SLinus Torvalds __u8 *buf; 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds dev_dbg(&dev->dev, "load_firmware\n"); 1021da177e4SLinus Torvalds buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL); 1031da177e4SLinus Torvalds if (!buf) { 1041da177e4SLinus Torvalds err( "%s - error loading firmware: error = %d", __FUNCTION__, -ENOMEM); 1051da177e4SLinus Torvalds err = -ENOMEM; 1061da177e4SLinus Torvalds goto wraperr; 1071da177e4SLinus Torvalds } 1081da177e4SLinus Torvalds 1091da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1101da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 1111da177e4SLinus Torvalds if (err < 0) { 1121da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1131da177e4SLinus Torvalds goto wraperr; 1141da177e4SLinus Torvalds } 1151da177e4SLinus Torvalds 1161da177e4SLinus Torvalds /* 1. We need to put the loader for the FPGA into the EZ-USB */ 1171da177e4SLinus Torvalds for (i=0; g_emi62_loader[i].type == 0; i++) { 1181da177e4SLinus Torvalds err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL); 1191da177e4SLinus Torvalds if (err < 0) { 1201da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1211da177e4SLinus Torvalds goto wraperr; 1221da177e4SLinus Torvalds } 1231da177e4SLinus Torvalds } 1241da177e4SLinus Torvalds 1251da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 1261da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 12716c23f7dSMonty msleep(250); /* let device settle */ 1281da177e4SLinus Torvalds 1291da177e4SLinus Torvalds /* 2. We upload the FPGA firmware into the EMI 1301da177e4SLinus Torvalds * Note: collect up to 1023 (yes!) bytes and send them with 1311da177e4SLinus Torvalds * a single request. This is _much_ faster! */ 1321da177e4SLinus Torvalds do { 1331da177e4SLinus Torvalds i = 0; 1341da177e4SLinus Torvalds addr = g_emi62bs[pos].address; 1351da177e4SLinus Torvalds 1361da177e4SLinus Torvalds /* intel hex records are terminated with type 0 element */ 1371da177e4SLinus Torvalds while ((g_emi62bs[pos].type == 0) && (i + g_emi62bs[pos].length < FW_LOAD_SIZE)) { 1381da177e4SLinus Torvalds memcpy(buf + i, g_emi62bs[pos].data, g_emi62bs[pos].length); 1391da177e4SLinus Torvalds i += g_emi62bs[pos].length; 1401da177e4SLinus Torvalds pos++; 1411da177e4SLinus Torvalds } 1421da177e4SLinus Torvalds err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA); 1431da177e4SLinus Torvalds if (err < 0) { 1441da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1451da177e4SLinus Torvalds goto wraperr; 1461da177e4SLinus Torvalds } 1471da177e4SLinus Torvalds } while (i > 0); 1481da177e4SLinus Torvalds 1491da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1501da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 1511da177e4SLinus Torvalds if (err < 0) { 1521da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1531da177e4SLinus Torvalds goto wraperr; 1541da177e4SLinus Torvalds } 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */ 1571da177e4SLinus Torvalds for (i=0; g_emi62_loader[i].type == 0; i++) { 1581da177e4SLinus Torvalds err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL); 1591da177e4SLinus Torvalds if (err < 0) { 1601da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1611da177e4SLinus Torvalds goto wraperr; 1621da177e4SLinus Torvalds } 1631da177e4SLinus Torvalds } 1641da177e4SLinus Torvalds 1651da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 1661da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 1671da177e4SLinus Torvalds if (err < 0) { 1681da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1691da177e4SLinus Torvalds goto wraperr; 1701da177e4SLinus Torvalds } 17116c23f7dSMonty msleep(250); /* let device settle */ 1721da177e4SLinus Torvalds 1731da177e4SLinus Torvalds /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */ 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds /* FIXME: quick and dirty ifdefs */ 1761da177e4SLinus Torvalds #ifdef SPDIF 1771da177e4SLinus Torvalds for (i=0; g_HexSpdifFw62[i].type == 0; i++) { 1781da177e4SLinus Torvalds if (!INTERNAL_RAM(g_HexSpdifFw62[i].address)) { 1791da177e4SLinus Torvalds err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_EXTERNAL); 1801da177e4SLinus Torvalds if (err < 0) { 1811da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 1821da177e4SLinus Torvalds goto wraperr; 1831da177e4SLinus Torvalds } 1841da177e4SLinus Torvalds } 1851da177e4SLinus Torvalds } 1861da177e4SLinus Torvalds #else /* MIDI */ 1871da177e4SLinus Torvalds for (i=0; g_HexMidiFw62[i].type == 0; i++) { 1881da177e4SLinus Torvalds if (!INTERNAL_RAM(g_HexMidiFw62[i].address)) { 1891da177e4SLinus Torvalds err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_EXTERNAL); 1901da177e4SLinus Torvalds if (err < 0) { 1911da177e4SLinus Torvalds err("%s - error loading firmware: error = %d\n", __FUNCTION__, err); 1921da177e4SLinus Torvalds goto wraperr; 1931da177e4SLinus Torvalds return err; 1941da177e4SLinus Torvalds } 1951da177e4SLinus Torvalds } 1961da177e4SLinus Torvalds } 1971da177e4SLinus Torvalds #endif 1981da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1991da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 2001da177e4SLinus Torvalds if (err < 0) { 2011da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 2021da177e4SLinus Torvalds goto wraperr; 2031da177e4SLinus Torvalds } 2041da177e4SLinus Torvalds 2051da177e4SLinus Torvalds /* FIXME: quick and dirty ifdefs */ 2061da177e4SLinus Torvalds #ifdef SPDIF 2071da177e4SLinus Torvalds for (i=0; g_HexSpdifFw62[i].type == 0; i++) { 2081da177e4SLinus Torvalds if (INTERNAL_RAM(g_HexSpdifFw62[i].address)) { 2091da177e4SLinus Torvalds err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_INTERNAL); 2101da177e4SLinus Torvalds if (err < 0) { 2111da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 2121da177e4SLinus Torvalds goto wraperr; 2131da177e4SLinus Torvalds } 2141da177e4SLinus Torvalds } 2151da177e4SLinus Torvalds } 2161da177e4SLinus Torvalds #else /* MIDI */ 2171da177e4SLinus Torvalds for (i=0; g_HexMidiFw62[i].type == 0; i++) { 2181da177e4SLinus Torvalds if (INTERNAL_RAM(g_HexMidiFw62[i].address)) { 2191da177e4SLinus Torvalds err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_INTERNAL); 2201da177e4SLinus Torvalds if (err < 0) { 2211da177e4SLinus Torvalds err("%s - error loading firmware: error = %d\n", __FUNCTION__, err); 2221da177e4SLinus Torvalds goto wraperr; 2231da177e4SLinus Torvalds } 2241da177e4SLinus Torvalds } 2251da177e4SLinus Torvalds } 2261da177e4SLinus Torvalds #endif 2271da177e4SLinus Torvalds 2281da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 2291da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 2301da177e4SLinus Torvalds if (err < 0) { 2311da177e4SLinus Torvalds err("%s - error loading firmware: error = %d", __FUNCTION__, err); 2321da177e4SLinus Torvalds goto wraperr; 2331da177e4SLinus Torvalds } 23416c23f7dSMonty msleep(250); /* let device settle */ 2351da177e4SLinus Torvalds 2361da177e4SLinus Torvalds kfree(buf); 2371da177e4SLinus Torvalds 2381da177e4SLinus Torvalds /* return 1 to fail the driver inialization 2391da177e4SLinus Torvalds * and give real driver change to load */ 2401da177e4SLinus Torvalds return 1; 2411da177e4SLinus Torvalds 2421da177e4SLinus Torvalds wraperr: 2431da177e4SLinus Torvalds kfree(buf); 2441da177e4SLinus Torvalds dev_err(&dev->dev, "Error\n"); 2451da177e4SLinus Torvalds return err; 2461da177e4SLinus Torvalds } 2471da177e4SLinus Torvalds 2481da177e4SLinus Torvalds static __devinitdata struct usb_device_id id_table [] = { 2491da177e4SLinus Torvalds { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) }, 2501da177e4SLinus Torvalds { } /* Terminating entry */ 2511da177e4SLinus Torvalds }; 2521da177e4SLinus Torvalds 2531da177e4SLinus Torvalds MODULE_DEVICE_TABLE (usb, id_table); 2541da177e4SLinus Torvalds 2551da177e4SLinus Torvalds static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id) 2561da177e4SLinus Torvalds { 2571da177e4SLinus Torvalds struct usb_device *dev = interface_to_usbdev(intf); 2581da177e4SLinus Torvalds dev_dbg(&intf->dev, "emi62_probe\n"); 2591da177e4SLinus Torvalds 2601da177e4SLinus Torvalds info("%s start", __FUNCTION__); 2611da177e4SLinus Torvalds 2621da177e4SLinus Torvalds emi62_load_firmware(dev); 2631da177e4SLinus Torvalds 2641da177e4SLinus Torvalds /* do not return the driver context, let real audio driver do that */ 2651da177e4SLinus Torvalds return -EIO; 2661da177e4SLinus Torvalds } 2671da177e4SLinus Torvalds 2681da177e4SLinus Torvalds static void emi62_disconnect(struct usb_interface *intf) 2691da177e4SLinus Torvalds { 2701da177e4SLinus Torvalds } 2711da177e4SLinus Torvalds 2721da177e4SLinus Torvalds static struct usb_driver emi62_driver = { 2731da177e4SLinus Torvalds .name = "emi62 - firmware loader", 2741da177e4SLinus Torvalds .probe = emi62_probe, 2751da177e4SLinus Torvalds .disconnect = emi62_disconnect, 2761da177e4SLinus Torvalds .id_table = id_table, 2771da177e4SLinus Torvalds }; 2781da177e4SLinus Torvalds 2791da177e4SLinus Torvalds static int __init emi62_init (void) 2801da177e4SLinus Torvalds { 2811da177e4SLinus Torvalds int retval; 2821da177e4SLinus Torvalds retval = usb_register (&emi62_driver); 2831da177e4SLinus Torvalds if (retval) 2841da177e4SLinus Torvalds printk(KERN_ERR "adi-emi: registration failed\n"); 2851da177e4SLinus Torvalds return retval; 2861da177e4SLinus Torvalds } 2871da177e4SLinus Torvalds 2881da177e4SLinus Torvalds static void __exit emi62_exit (void) 2891da177e4SLinus Torvalds { 2901da177e4SLinus Torvalds usb_deregister (&emi62_driver); 2911da177e4SLinus Torvalds } 2921da177e4SLinus Torvalds 2931da177e4SLinus Torvalds module_init(emi62_init); 2941da177e4SLinus Torvalds module_exit(emi62_exit); 2951da177e4SLinus Torvalds 2961da177e4SLinus Torvalds MODULE_AUTHOR("tapio laxstr�m"); 2971da177e4SLinus Torvalds MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader."); 2981da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 2991da177e4SLinus Torvalds 3001da177e4SLinus Torvalds /* vi:ai:syntax=c:sw=8:ts=8:tw=80 3011da177e4SLinus Torvalds */ 302