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 501da177e4SLinus Torvalds /* thanks to drivers/usb/serial/keyspan_pda.c code */ 51b8e24bfaSDavid Woodhouse static int emi62_writememory(struct usb_device *dev, int address, 52b8e24bfaSDavid Woodhouse const unsigned char *data, int length, 53b8e24bfaSDavid Woodhouse __u8 request) 541da177e4SLinus Torvalds { 551da177e4SLinus Torvalds int result; 565d7efe5bSEric Sesterhenn unsigned char *buffer = kmemdup(data, length, GFP_KERNEL); 571da177e4SLinus Torvalds 581da177e4SLinus Torvalds if (!buffer) { 59e9a527daSGreg Kroah-Hartman dev_err(&dev->dev, "kmalloc(%d) failed.\n", length); 601da177e4SLinus Torvalds return -ENOMEM; 611da177e4SLinus Torvalds } 621da177e4SLinus Torvalds /* Note: usb_control_msg returns negative value on error or length of the 631da177e4SLinus Torvalds * data that was written! */ 641da177e4SLinus Torvalds result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300); 651da177e4SLinus Torvalds kfree (buffer); 661da177e4SLinus Torvalds return result; 671da177e4SLinus Torvalds } 681da177e4SLinus Torvalds 691da177e4SLinus Torvalds /* thanks to drivers/usb/serial/keyspan_pda.c code */ 701da177e4SLinus Torvalds static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit) 711da177e4SLinus Torvalds { 721da177e4SLinus Torvalds int response; 731b29a375SGreg Kroah-Hartman dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit); 741da177e4SLinus Torvalds 751da177e4SLinus Torvalds response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0); 76e9a527daSGreg Kroah-Hartman if (response < 0) 77e9a527daSGreg Kroah-Hartman dev_err(&dev->dev, "set_reset (%d) failed\n", reset_bit); 781da177e4SLinus Torvalds return response; 791da177e4SLinus Torvalds } 801da177e4SLinus Torvalds 811da177e4SLinus Torvalds #define FW_LOAD_SIZE 1023 821da177e4SLinus Torvalds 831da177e4SLinus Torvalds static int emi62_load_firmware (struct usb_device *dev) 841da177e4SLinus Torvalds { 85b8e24bfaSDavid Woodhouse const struct firmware *loader_fw = NULL; 86b8e24bfaSDavid Woodhouse const struct firmware *bitstream_fw = NULL; 87b8e24bfaSDavid Woodhouse const struct firmware *firmware_fw = NULL; 88b8e24bfaSDavid Woodhouse const struct ihex_binrec *rec; 89e9a527daSGreg Kroah-Hartman int err = -ENOMEM; 901da177e4SLinus Torvalds int i; 911da177e4SLinus Torvalds __u32 addr; /* Address to write */ 921da177e4SLinus Torvalds __u8 *buf; 931da177e4SLinus Torvalds 941da177e4SLinus Torvalds dev_dbg(&dev->dev, "load_firmware\n"); 951da177e4SLinus Torvalds buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL); 96e9a527daSGreg Kroah-Hartman if (!buf) 971da177e4SLinus Torvalds goto wraperr; 981da177e4SLinus Torvalds 99b8e24bfaSDavid Woodhouse err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev); 100b8e24bfaSDavid Woodhouse if (err) 101b8e24bfaSDavid Woodhouse goto nofw; 102b8e24bfaSDavid Woodhouse 103b8e24bfaSDavid Woodhouse err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw", 104b8e24bfaSDavid Woodhouse &dev->dev); 105b8e24bfaSDavid Woodhouse if (err) 106b8e24bfaSDavid Woodhouse goto nofw; 107b8e24bfaSDavid Woodhouse 108b8e24bfaSDavid Woodhouse err = request_ihex_firmware(&firmware_fw, FIRMWARE_FW, &dev->dev); 109b8e24bfaSDavid Woodhouse if (err) { 110b8e24bfaSDavid Woodhouse nofw: 111b8e24bfaSDavid Woodhouse goto wraperr; 112b8e24bfaSDavid Woodhouse } 113b8e24bfaSDavid Woodhouse 1141da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1151da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 116e9a527daSGreg Kroah-Hartman if (err < 0) 1171da177e4SLinus Torvalds goto wraperr; 1181da177e4SLinus Torvalds 119b8e24bfaSDavid Woodhouse rec = (const struct ihex_binrec *)loader_fw->data; 120b8e24bfaSDavid Woodhouse 1211da177e4SLinus Torvalds /* 1. We need to put the loader for the FPGA into the EZ-USB */ 122b8e24bfaSDavid Woodhouse while (rec) { 123b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 124b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 125b8e24bfaSDavid Woodhouse ANCHOR_LOAD_INTERNAL); 126e9a527daSGreg Kroah-Hartman if (err < 0) 1271da177e4SLinus Torvalds goto wraperr; 128b8e24bfaSDavid Woodhouse rec = ihex_next_binrec(rec); 1291da177e4SLinus Torvalds } 1301da177e4SLinus Torvalds 1311da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 1321da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 133e9a527daSGreg Kroah-Hartman if (err < 0) 1345919a43bSOliver Neukum goto wraperr; 13516c23f7dSMonty msleep(250); /* let device settle */ 1361da177e4SLinus Torvalds 1371da177e4SLinus Torvalds /* 2. We upload the FPGA firmware into the EMI 1381da177e4SLinus Torvalds * Note: collect up to 1023 (yes!) bytes and send them with 1391da177e4SLinus Torvalds * a single request. This is _much_ faster! */ 140b8e24bfaSDavid Woodhouse rec = (const struct ihex_binrec *)bitstream_fw->data; 1411da177e4SLinus Torvalds do { 1421da177e4SLinus Torvalds i = 0; 143b8e24bfaSDavid Woodhouse addr = be32_to_cpu(rec->addr); 1441da177e4SLinus Torvalds 1451da177e4SLinus Torvalds /* intel hex records are terminated with type 0 element */ 146b8e24bfaSDavid Woodhouse while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) { 147b8e24bfaSDavid Woodhouse memcpy(buf + i, rec->data, be16_to_cpu(rec->len)); 148b8e24bfaSDavid Woodhouse i += be16_to_cpu(rec->len); 149b8e24bfaSDavid Woodhouse rec = ihex_next_binrec(rec); 1501da177e4SLinus Torvalds } 1511da177e4SLinus Torvalds err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA); 152e9a527daSGreg Kroah-Hartman if (err < 0) 1531da177e4SLinus Torvalds goto wraperr; 154ac06c067SClemens Ladisch } while (rec); 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1571da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 158e9a527daSGreg Kroah-Hartman if (err < 0) 1591da177e4SLinus Torvalds goto wraperr; 1601da177e4SLinus Torvalds 1611da177e4SLinus Torvalds /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */ 162b8e24bfaSDavid Woodhouse for (rec = (const struct ihex_binrec *)loader_fw->data; 163b8e24bfaSDavid Woodhouse rec; rec = ihex_next_binrec(rec)) { 164b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 165b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 166b8e24bfaSDavid Woodhouse ANCHOR_LOAD_INTERNAL); 167e9a527daSGreg Kroah-Hartman if (err < 0) 1681da177e4SLinus Torvalds goto wraperr; 1691da177e4SLinus Torvalds } 1701da177e4SLinus Torvalds 1711da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 1721da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 173e9a527daSGreg Kroah-Hartman if (err < 0) 1741da177e4SLinus Torvalds goto wraperr; 17516c23f7dSMonty msleep(250); /* let device settle */ 1761da177e4SLinus Torvalds 1771da177e4SLinus Torvalds /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */ 1781da177e4SLinus Torvalds 179b8e24bfaSDavid Woodhouse for (rec = (const struct ihex_binrec *)firmware_fw->data; 180b8e24bfaSDavid Woodhouse rec; rec = ihex_next_binrec(rec)) { 181b8e24bfaSDavid Woodhouse if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) { 182b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 183b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 184b8e24bfaSDavid Woodhouse ANCHOR_LOAD_EXTERNAL); 185e9a527daSGreg Kroah-Hartman if (err < 0) 1861da177e4SLinus Torvalds goto wraperr; 1871da177e4SLinus Torvalds } 1881da177e4SLinus Torvalds } 189b8e24bfaSDavid Woodhouse 1901da177e4SLinus Torvalds /* Assert reset (stop the CPU in the EMI) */ 1911da177e4SLinus Torvalds err = emi62_set_reset(dev,1); 192e9a527daSGreg Kroah-Hartman if (err < 0) 1931da177e4SLinus Torvalds goto wraperr; 1941da177e4SLinus Torvalds 195b8e24bfaSDavid Woodhouse for (rec = (const struct ihex_binrec *)firmware_fw->data; 196b8e24bfaSDavid Woodhouse rec; rec = ihex_next_binrec(rec)) { 197b8e24bfaSDavid Woodhouse if (INTERNAL_RAM(be32_to_cpu(rec->addr))) { 198b8e24bfaSDavid Woodhouse err = emi62_writememory(dev, be32_to_cpu(rec->addr), 199b8e24bfaSDavid Woodhouse rec->data, be16_to_cpu(rec->len), 200b8e24bfaSDavid Woodhouse ANCHOR_LOAD_EXTERNAL); 201e9a527daSGreg Kroah-Hartman if (err < 0) 2021da177e4SLinus Torvalds goto wraperr; 2031da177e4SLinus Torvalds } 2041da177e4SLinus Torvalds } 2051da177e4SLinus Torvalds 2061da177e4SLinus Torvalds /* De-assert reset (let the CPU run) */ 2071da177e4SLinus Torvalds err = emi62_set_reset(dev,0); 208e9a527daSGreg Kroah-Hartman if (err < 0) 2091da177e4SLinus Torvalds goto wraperr; 21016c23f7dSMonty msleep(250); /* let device settle */ 2111da177e4SLinus Torvalds 212b8e24bfaSDavid Woodhouse release_firmware(loader_fw); 213b8e24bfaSDavid Woodhouse release_firmware(bitstream_fw); 214b8e24bfaSDavid Woodhouse release_firmware(firmware_fw); 215b8e24bfaSDavid Woodhouse 2161da177e4SLinus Torvalds kfree(buf); 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds /* return 1 to fail the driver inialization 2191da177e4SLinus Torvalds * and give real driver change to load */ 2201da177e4SLinus Torvalds return 1; 2211da177e4SLinus Torvalds 2221da177e4SLinus Torvalds wraperr: 223e9a527daSGreg Kroah-Hartman if (err < 0) 224e9a527daSGreg Kroah-Hartman dev_err(&dev->dev,"%s - error loading firmware: error = %d\n", 225e9a527daSGreg Kroah-Hartman __func__, err); 226b8e24bfaSDavid Woodhouse release_firmware(loader_fw); 227b8e24bfaSDavid Woodhouse release_firmware(bitstream_fw); 228b8e24bfaSDavid Woodhouse release_firmware(firmware_fw); 229b8e24bfaSDavid Woodhouse 2301da177e4SLinus Torvalds kfree(buf); 2311da177e4SLinus Torvalds dev_err(&dev->dev, "Error\n"); 2321da177e4SLinus Torvalds return err; 2331da177e4SLinus Torvalds } 2341da177e4SLinus Torvalds 23583957df2SGreg Kroah-Hartman static const struct usb_device_id id_table[] = { 2361da177e4SLinus Torvalds { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) }, 2371da177e4SLinus Torvalds { } /* Terminating entry */ 2381da177e4SLinus Torvalds }; 2391da177e4SLinus Torvalds 2401da177e4SLinus Torvalds MODULE_DEVICE_TABLE (usb, id_table); 2411da177e4SLinus Torvalds 2421da177e4SLinus Torvalds static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id) 2431da177e4SLinus Torvalds { 2441da177e4SLinus Torvalds struct usb_device *dev = interface_to_usbdev(intf); 2451da177e4SLinus Torvalds dev_dbg(&intf->dev, "emi62_probe\n"); 2461da177e4SLinus Torvalds 2471b29a375SGreg Kroah-Hartman dev_info(&intf->dev, "%s start\n", __func__); 2481da177e4SLinus Torvalds 2491da177e4SLinus Torvalds emi62_load_firmware(dev); 2501da177e4SLinus Torvalds 2511da177e4SLinus Torvalds /* do not return the driver context, let real audio driver do that */ 2521da177e4SLinus Torvalds return -EIO; 2531da177e4SLinus Torvalds } 2541da177e4SLinus Torvalds 2551da177e4SLinus Torvalds static void emi62_disconnect(struct usb_interface *intf) 2561da177e4SLinus Torvalds { 2571da177e4SLinus Torvalds } 2581da177e4SLinus Torvalds 2591da177e4SLinus Torvalds static struct usb_driver emi62_driver = { 2601da177e4SLinus Torvalds .name = "emi62 - firmware loader", 2611da177e4SLinus Torvalds .probe = emi62_probe, 2621da177e4SLinus Torvalds .disconnect = emi62_disconnect, 2631da177e4SLinus Torvalds .id_table = id_table, 2641da177e4SLinus Torvalds }; 2651da177e4SLinus Torvalds 26665db4305SGreg Kroah-Hartman module_usb_driver(emi62_driver); 2671da177e4SLinus Torvalds 26896de0e25SJan Engelhardt MODULE_AUTHOR("Tapio Laxström"); 2691da177e4SLinus Torvalds MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader."); 2701da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 2711da177e4SLinus Torvalds 272b8e24bfaSDavid Woodhouse MODULE_FIRMWARE("emi62/loader.fw"); 273b8e24bfaSDavid Woodhouse MODULE_FIRMWARE("emi62/bitstream.fw"); 274b8e24bfaSDavid Woodhouse MODULE_FIRMWARE(FIRMWARE_FW); 2751da177e4SLinus Torvalds /* vi:ai:syntax=c:sw=8:ts=8:tw=80 2761da177e4SLinus Torvalds */ 277