11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * Emagic EMI 2|6 usb audio interface firmware loader. 31da177e4SLinus Torvalds * Copyright (C) 2002 496de0e25SJan Engelhardt * 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 #include <linux/kernel.h> 111da177e4SLinus Torvalds #include <linux/errno.h> 121da177e4SLinus Torvalds #include <linux/slab.h> 131da177e4SLinus Torvalds #include <linux/init.h> 141da177e4SLinus Torvalds #include <linux/module.h> 151da177e4SLinus Torvalds #include <linux/usb.h> 1616c23f7dSMonty #include <linux/delay.h> 17b8e24bfaSDavid Woodhouse #include <linux/firmware.h> 18b8e24bfaSDavid Woodhouse #include <linux/ihex.h> 191da177e4SLinus Torvalds 201da177e4SLinus Torvalds /* include firmware (variables)*/ 211da177e4SLinus Torvalds 221da177e4SLinus Torvalds /* FIXME: This is quick and dirty solution! */ 231da177e4SLinus Torvalds #define SPDIF /* if you want SPDIF comment next line */ 241da177e4SLinus Torvalds //#undef SPDIF /* if you want MIDI uncomment this line */ 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds #ifdef SPDIF 27b8e24bfaSDavid Woodhouse #define FIRMWARE_FW "emi62/spdif.fw" 281da177e4SLinus Torvalds #else 29b8e24bfaSDavid Woodhouse #define FIRMWARE_FW "emi62/midi.fw" 301da177e4SLinus Torvalds #endif 311da177e4SLinus Torvalds 321da177e4SLinus Torvalds #define EMI62_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */ 331da177e4SLinus Torvalds #define EMI62_PRODUCT_ID 0x0110 /* EMI 6|2m without firmware */ 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds #define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */ 361da177e4SLinus Torvalds #define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */ 371da177e4SLinus Torvalds #define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */ 381da177e4SLinus Torvalds #define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */ 391da177e4SLinus Torvalds #define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */ 401da177e4SLinus Torvalds #define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS) 411da177e4SLinus Torvalds 42b8e24bfaSDavid Woodhouse static int emi62_writememory(struct usb_device *dev, int address, 43b8e24bfaSDavid Woodhouse const unsigned char *data, int length, 44b8e24bfaSDavid Woodhouse __u8 bRequest); 451da177e4SLinus Torvalds static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit); 461da177e4SLinus Torvalds static int emi62_load_firmware (struct usb_device *dev); 471da177e4SLinus Torvalds static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id); 481da177e4SLinus Torvalds static void emi62_disconnect(struct usb_interface *intf); 491da177e4SLinus Torvalds static int __init emi62_init (void); 501da177e4SLinus Torvalds static void __exit emi62_exit (void); 511da177e4SLinus Torvalds 521da177e4SLinus Torvalds 531da177e4SLinus Torvalds /* thanks to drivers/usb/serial/keyspan_pda.c code */ 54b8e24bfaSDavid Woodhouse static int emi62_writememory(struct usb_device *dev, int address, 55b8e24bfaSDavid Woodhouse const unsigned char *data, int length, 56b8e24bfaSDavid Woodhouse __u8 request) 571da177e4SLinus Torvalds { 581da177e4SLinus Torvalds int result; 595d7efe5bSEric Sesterhenn unsigned char *buffer = kmemdup(data, length, GFP_KERNEL); 601da177e4SLinus Torvalds 611da177e4SLinus Torvalds if (!buffer) { 621da177e4SLinus Torvalds err("emi62: kmalloc(%d) failed.", length); 631da177e4SLinus Torvalds return -ENOMEM; 641da177e4SLinus Torvalds } 651da177e4SLinus Torvalds /* Note: usb_control_msg returns negative value on error or length of the 661da177e4SLinus Torvalds * data that was written! */ 671da177e4SLinus Torvalds result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300); 681da177e4SLinus Torvalds kfree (buffer); 691da177e4SLinus Torvalds return result; 701da177e4SLinus Torvalds } 711da177e4SLinus Torvalds 721da177e4SLinus Torvalds /* thanks to drivers/usb/serial/keyspan_pda.c code */ 731da177e4SLinus Torvalds static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit) 741da177e4SLinus Torvalds { 751da177e4SLinus Torvalds int response; 761b29a375SGreg Kroah-Hartman dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit); 771da177e4SLinus Torvalds 781da177e4SLinus Torvalds response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0); 791da177e4SLinus Torvalds if (response < 0) { 801da177e4SLinus Torvalds err("emi62: set_reset (%d) failed", reset_bit); 811da177e4SLinus Torvalds } 821da177e4SLinus Torvalds return response; 831da177e4SLinus Torvalds } 841da177e4SLinus Torvalds 851da177e4SLinus Torvalds #define FW_LOAD_SIZE 1023 861da177e4SLinus Torvalds 871da177e4SLinus Torvalds static int emi62_load_firmware (struct usb_device *dev) 881da177e4SLinus Torvalds { 89b8e24bfaSDavid Woodhouse const struct firmware *loader_fw = NULL; 90b8e24bfaSDavid Woodhouse const struct firmware *bitstream_fw = NULL; 91b8e24bfaSDavid Woodhouse const struct firmware *firmware_fw = NULL; 92b8e24bfaSDavid Woodhouse const struct ihex_binrec *rec; 931da177e4SLinus Torvalds int err; 941da177e4SLinus Torvalds int i; 951da177e4SLinus Torvalds __u32 addr; /* Address to write */ 961da177e4SLinus Torvalds __u8 *buf; 971da177e4SLinus Torvalds 981da177e4SLinus Torvalds dev_dbg(&dev->dev, "load_firmware\n"); 991da177e4SLinus Torvalds buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL); 1001da177e4SLinus Torvalds if (!buf) { 101441b62c1SHarvey Harrison err( "%s - error loading firmware: error = %d", __func__, -ENOMEM); 1021da177e4SLinus Torvalds err = -ENOMEM; 1031da177e4SLinus Torvalds goto wraperr; 1041da177e4SLinus Torvalds } 1051da177e4SLinus Torvalds 106b8e24bfaSDavid Woodhouse err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev); 107b8e24bfaSDavid Woodhouse if (err) 108b8e24bfaSDavid Woodhouse goto nofw; 109b8e24bfaSDavid Woodhouse 110b8e24bfaSDavid Woodhouse err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw", 111b8e24bfaSDavid Woodhouse &dev->dev); 112b8e24bfaSDavid Woodhouse if (err) 113b8e24bfaSDavid Woodhouse goto nofw; 114b8e24bfaSDavid Woodhouse 115b8e24bfaSDavid Woodhouse err = request_ihex_firmware(&firmware_fw, FIRMWARE_FW, &dev->dev); 116b8e24bfaSDavid Woodhouse if (err) { 117b8e24bfaSDavid Woodhouse nofw: 118b8e24bfaSDavid Woodhouse err( "%s - request_firmware() failed", __func__); 119b8e24bfaSDavid Woodhouse goto wraperr; 120b8e24bfaSDavid Woodhouse } 121b8e24bfaSDavid Woodhouse 1221da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1231da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 1241da177e4SLinus Torvalds if (err < 0) { 125441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1261da177e4SLinus Torvalds goto wraperr; 1271da177e4SLinus Torvalds } 1281da177e4SLinus Torvalds 129b8e24bfaSDavid Woodhouse rec = (const struct ihex_binrec *)loader_fw->data; 130b8e24bfaSDavid Woodhouse 1311da177e4SLinus Torvalds /* 1. We need to put the loader for the FPGA into the EZ-USB */ 132b8e24bfaSDavid Woodhouse while (rec) { 133b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 134b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 135b8e24bfaSDavid Woodhouse ANCHOR_LOAD_INTERNAL); 1361da177e4SLinus Torvalds if (err < 0) { 137441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1381da177e4SLinus Torvalds goto wraperr; 1391da177e4SLinus Torvalds } 140b8e24bfaSDavid Woodhouse rec = ihex_next_binrec(rec); 1411da177e4SLinus Torvalds } 1421da177e4SLinus Torvalds 1431da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 1441da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 1455919a43bSOliver Neukum if (err < 0) { 146441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1475919a43bSOliver Neukum goto wraperr; 1485919a43bSOliver Neukum } 14916c23f7dSMonty msleep(250); /* let device settle */ 1501da177e4SLinus Torvalds 1511da177e4SLinus Torvalds /* 2. We upload the FPGA firmware into the EMI 1521da177e4SLinus Torvalds * Note: collect up to 1023 (yes!) bytes and send them with 1531da177e4SLinus Torvalds * a single request. This is _much_ faster! */ 154b8e24bfaSDavid Woodhouse rec = (const struct ihex_binrec *)bitstream_fw->data; 1551da177e4SLinus Torvalds do { 1561da177e4SLinus Torvalds i = 0; 157b8e24bfaSDavid Woodhouse addr = be32_to_cpu(rec->addr); 1581da177e4SLinus Torvalds 1591da177e4SLinus Torvalds /* intel hex records are terminated with type 0 element */ 160b8e24bfaSDavid Woodhouse while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) { 161b8e24bfaSDavid Woodhouse memcpy(buf + i, rec->data, be16_to_cpu(rec->len)); 162b8e24bfaSDavid Woodhouse i += be16_to_cpu(rec->len); 163b8e24bfaSDavid Woodhouse rec = ihex_next_binrec(rec); 1641da177e4SLinus Torvalds } 1651da177e4SLinus Torvalds err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA); 1661da177e4SLinus Torvalds if (err < 0) { 167441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1681da177e4SLinus Torvalds goto wraperr; 1691da177e4SLinus Torvalds } 170ac06c067SClemens Ladisch } while (rec); 1711da177e4SLinus Torvalds 1721da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1731da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 1741da177e4SLinus Torvalds if (err < 0) { 175441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1761da177e4SLinus Torvalds goto wraperr; 1771da177e4SLinus Torvalds } 1781da177e4SLinus Torvalds 1791da177e4SLinus Torvalds /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */ 180b8e24bfaSDavid Woodhouse for (rec = (const struct ihex_binrec *)loader_fw->data; 181b8e24bfaSDavid Woodhouse rec; rec = ihex_next_binrec(rec)) { 182b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 183b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 184b8e24bfaSDavid Woodhouse ANCHOR_LOAD_INTERNAL); 1851da177e4SLinus Torvalds if (err < 0) { 186441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1871da177e4SLinus Torvalds goto wraperr; 1881da177e4SLinus Torvalds } 1891da177e4SLinus Torvalds } 1901da177e4SLinus Torvalds 1911da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 1921da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 1931da177e4SLinus Torvalds if (err < 0) { 194441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 1951da177e4SLinus Torvalds goto wraperr; 1961da177e4SLinus Torvalds } 19716c23f7dSMonty msleep(250); /* let device settle */ 1981da177e4SLinus Torvalds 1991da177e4SLinus Torvalds /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */ 2001da177e4SLinus Torvalds 201b8e24bfaSDavid Woodhouse for (rec = (const struct ihex_binrec *)firmware_fw->data; 202b8e24bfaSDavid Woodhouse rec; rec = ihex_next_binrec(rec)) { 203b8e24bfaSDavid Woodhouse if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) { 204b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 205b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 206b8e24bfaSDavid Woodhouse ANCHOR_LOAD_EXTERNAL); 2071da177e4SLinus Torvalds if (err < 0) { 208441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 2091da177e4SLinus Torvalds goto wraperr; 2101da177e4SLinus Torvalds } 2111da177e4SLinus Torvalds } 2121da177e4SLinus Torvalds } 213b8e24bfaSDavid Woodhouse 2141da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 2151da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 2161da177e4SLinus Torvalds if (err < 0) { 217441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 2181da177e4SLinus Torvalds goto wraperr; 2191da177e4SLinus Torvalds } 2201da177e4SLinus Torvalds 221b8e24bfaSDavid Woodhouse for (rec = (const struct ihex_binrec *)firmware_fw->data; 222b8e24bfaSDavid Woodhouse rec; rec = ihex_next_binrec(rec)) { 223b8e24bfaSDavid Woodhouse if (INTERNAL_RAM(be32_to_cpu(rec->addr))) { 224b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 225b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 226b8e24bfaSDavid Woodhouse ANCHOR_LOAD_EXTERNAL); 2271da177e4SLinus Torvalds if (err < 0) { 228441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 2291da177e4SLinus Torvalds goto wraperr; 2301da177e4SLinus Torvalds } 2311da177e4SLinus Torvalds } 2321da177e4SLinus Torvalds } 2331da177e4SLinus Torvalds 2341da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 2351da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 2361da177e4SLinus Torvalds if (err < 0) { 237441b62c1SHarvey Harrison err("%s - error loading firmware: error = %d", __func__, err); 2381da177e4SLinus Torvalds goto wraperr; 2391da177e4SLinus Torvalds } 24016c23f7dSMonty msleep(250); /* let device settle */ 2411da177e4SLinus Torvalds 242b8e24bfaSDavid Woodhouse release_firmware(loader_fw); 243b8e24bfaSDavid Woodhouse release_firmware(bitstream_fw); 244b8e24bfaSDavid Woodhouse release_firmware(firmware_fw); 245b8e24bfaSDavid Woodhouse 2461da177e4SLinus Torvalds kfree(buf); 2471da177e4SLinus Torvalds 2481da177e4SLinus Torvalds /* return 1 to fail the driver inialization 2491da177e4SLinus Torvalds * and give real driver change to load */ 2501da177e4SLinus Torvalds return 1; 2511da177e4SLinus Torvalds 2521da177e4SLinus Torvalds wraperr: 253b8e24bfaSDavid Woodhouse release_firmware(loader_fw); 254b8e24bfaSDavid Woodhouse release_firmware(bitstream_fw); 255b8e24bfaSDavid Woodhouse release_firmware(firmware_fw); 256b8e24bfaSDavid Woodhouse 2571da177e4SLinus Torvalds kfree(buf); 2581da177e4SLinus Torvalds dev_err(&dev->dev, "Error\n"); 2591da177e4SLinus Torvalds return err; 2601da177e4SLinus Torvalds } 2611da177e4SLinus Torvalds 26233b9e162SNémeth Márton static const struct usb_device_id id_table[] __devinitconst = { 2631da177e4SLinus Torvalds { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) }, 2641da177e4SLinus Torvalds { } /* Terminating entry */ 2651da177e4SLinus Torvalds }; 2661da177e4SLinus Torvalds 2671da177e4SLinus Torvalds MODULE_DEVICE_TABLE (usb, id_table); 2681da177e4SLinus Torvalds 2691da177e4SLinus Torvalds static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id) 2701da177e4SLinus Torvalds { 2711da177e4SLinus Torvalds struct usb_device *dev = interface_to_usbdev(intf); 2721da177e4SLinus Torvalds dev_dbg(&intf->dev, "emi62_probe\n"); 2731da177e4SLinus Torvalds 2741b29a375SGreg Kroah-Hartman dev_info(&intf->dev, "%s start\n", __func__); 2751da177e4SLinus Torvalds 2761da177e4SLinus Torvalds emi62_load_firmware(dev); 2771da177e4SLinus Torvalds 2781da177e4SLinus Torvalds /* do not return the driver context, let real audio driver do that */ 2791da177e4SLinus Torvalds return -EIO; 2801da177e4SLinus Torvalds } 2811da177e4SLinus Torvalds 2821da177e4SLinus Torvalds static void emi62_disconnect(struct usb_interface *intf) 2831da177e4SLinus Torvalds { 2841da177e4SLinus Torvalds } 2851da177e4SLinus Torvalds 2861da177e4SLinus Torvalds static struct usb_driver emi62_driver = { 2871da177e4SLinus Torvalds .name = "emi62 - firmware loader", 2881da177e4SLinus Torvalds .probe = emi62_probe, 2891da177e4SLinus Torvalds .disconnect = emi62_disconnect, 2901da177e4SLinus Torvalds .id_table = id_table, 2911da177e4SLinus Torvalds }; 2921da177e4SLinus Torvalds 29365db4305SGreg Kroah-Hartman module_usb_driver(emi62_driver); 2941da177e4SLinus Torvalds 29596de0e25SJan Engelhardt MODULE_AUTHOR("Tapio Laxström"); 2961da177e4SLinus Torvalds MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader."); 2971da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 2981da177e4SLinus Torvalds 299b8e24bfaSDavid Woodhouse MODULE_FIRMWARE("emi62/loader.fw"); 300b8e24bfaSDavid Woodhouse MODULE_FIRMWARE("emi62/bitstream.fw"); 301b8e24bfaSDavid Woodhouse MODULE_FIRMWARE(FIRMWARE_FW); 3021da177e4SLinus Torvalds /* vi:ai:syntax=c:sw=8:ts=8:tw=80 3031da177e4SLinus Torvalds */ 304