]> err.no Git - linux-2.6/blobdiff - drivers/usb/misc/emi62.c
emi62: use request_firmware()
[linux-2.6] / drivers / usb / misc / emi62.c
index fe351371f274e11e6b576dcce1a671cd2b8ef0f8..20886c21e7397b7cc5d2ea121399dd761e2bd773 100644 (file)
@@ -1,7 +1,7 @@
 /* 
  * Emagic EMI 2|6 usb audio interface firmware loader.
  * Copyright (C) 2002
- *     Tapio Laxström (tapio.laxstrom@iptime.fi)
+ *     Tapio Laxström (tapio.laxstrom@iptime.fi)
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, as published by
 #include <linux/module.h>
 #include <linux/usb.h>
 #include <linux/delay.h>
-
-#define MAX_INTEL_HEX_RECORD_LENGTH 16
-typedef struct _INTEL_HEX_RECORD
-{
-       __u32   length;
-       __u32   address;
-       __u32   type;
-       __u8    data[MAX_INTEL_HEX_RECORD_LENGTH];
-} INTEL_HEX_RECORD, *PINTEL_HEX_RECORD;
+#include <linux/firmware.h>
+#include <linux/ihex.h>
 
 /* include firmware (variables)*/
 
@@ -33,9 +26,9 @@ typedef struct _INTEL_HEX_RECORD
 //#undef SPDIF /* if you want MIDI uncomment this line */ 
 
 #ifdef SPDIF
-#  include "emi62_fw_s.h" /* spdif fw */
+#define FIRMWARE_FW "emi62/spdif.fw"
 #else
-#  include "emi62_fw_m.h" /* midi fw */
+#define FIRMWARE_FW "emi62/midi.fw"
 #endif
 
 #define EMI62_VENDOR_ID                0x086a  /* Emagic Soft-und Hardware GmBH */
@@ -48,7 +41,9 @@ typedef struct _INTEL_HEX_RECORD
 #define CPUCS_REG              0x7F92  /* EZ-USB Control and Status Register.  Bit 0 controls 8051 reset */ 
 #define INTERNAL_RAM(address)   (address <= MAX_INTERNAL_ADDRESS)
 
-static int emi62_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest);
+static int emi62_writememory(struct usb_device *dev, int address,
+                            const unsigned char *data, int length,
+                            __u8 bRequest);
 static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
 static int emi62_load_firmware (struct usb_device *dev);
 static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id);
@@ -58,16 +53,17 @@ static void __exit emi62_exit (void);
 
 
 /* thanks to drivers/usb/serial/keyspan_pda.c code */
-static int emi62_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request)
+static int emi62_writememory(struct usb_device *dev, int address,
+                            const unsigned char *data, int length,
+                            __u8 request)
 {
        int result;
-       unsigned char *buffer =  kmalloc (length, GFP_KERNEL);
+       unsigned char *buffer =  kmemdup(data, length, GFP_KERNEL);
 
        if (!buffer) {
                err("emi62: kmalloc(%d) failed.", length);
                return -ENOMEM;
        }
-       memcpy (buffer, data, length);
        /* Note: usb_control_msg returns negative value on error or length of the
         *               data that was written! */
        result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
@@ -79,7 +75,7 @@ static int emi62_writememory (struct usb_device *dev, int address, unsigned char
 static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
 {
        int response;
-       info("%s - %d", __FUNCTION__, reset_bit);
+       info("%s - %d", __func__, reset_bit);
        
        response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
        if (response < 0) {
@@ -92,56 +88,85 @@ static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
 
 static int emi62_load_firmware (struct usb_device *dev)
 {
+       const struct firmware *loader_fw = NULL;
+       const struct firmware *bitstream_fw = NULL;
+       const struct firmware *firmware_fw = NULL;
+       const struct ihex_binrec *rec;
        int err;
        int i;
-       int pos = 0;    /* Position in hex record */
        __u32 addr;     /* Address to write */
        __u8 *buf;
 
        dev_dbg(&dev->dev, "load_firmware\n");
        buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
        if (!buf) {
-               err( "%s - error loading firmware: error = %d", __FUNCTION__, -ENOMEM);
+               err( "%s - error loading firmware: error = %d", __func__, -ENOMEM);
                err = -ENOMEM;
                goto wraperr;
        }
 
+       err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev);
+       if (err)
+               goto nofw;
+
+       err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw",
+                                   &dev->dev);
+       if (err)
+               goto nofw;
+
+       err = request_ihex_firmware(&firmware_fw, FIRMWARE_FW, &dev->dev);
+       if (err) {
+       nofw:
+               err( "%s - request_firmware() failed", __func__);
+               goto wraperr;
+       }
+
        /* Assert reset (stop the CPU in the EMI) */
        err = emi62_set_reset(dev,1);
        if (err < 0) {
-               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+               err("%s - error loading firmware: error = %d", __func__, err);
                goto wraperr;
        }
 
+       rec = (const struct ihex_binrec *)loader_fw->data;
+
        /* 1. We need to put the loader for the FPGA into the EZ-USB */
-       for (i=0; g_emi62_loader[i].type == 0; i++) {
-               err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
+       while (rec) {
+               err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+                                       rec->data, be16_to_cpu(rec->len),
+                                       ANCHOR_LOAD_INTERNAL);
                if (err < 0) {
-                       err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+                       err("%s - error loading firmware: error = %d", __func__, err);
                        goto wraperr;
                }
+               rec = ihex_next_binrec(rec);
        }
 
        /* De-assert reset (let the CPU run) */
        err = emi62_set_reset(dev,0);
+       if (err < 0) {
+               err("%s - error loading firmware: error = %d", __func__, err);
+               goto wraperr;
+       }
        msleep(250);    /* let device settle */
 
        /* 2. We upload the FPGA firmware into the EMI
         * Note: collect up to 1023 (yes!) bytes and send them with
         * a single request. This is _much_ faster! */
+       rec = (const struct ihex_binrec *)bitstream_fw->data;
        do {
                i = 0;
-               addr = g_emi62bs[pos].address;
+               addr = be32_to_cpu(rec->addr);
 
                /* intel hex records are terminated with type 0 element */
-               while ((g_emi62bs[pos].type == 0) && (i + g_emi62bs[pos].length < FW_LOAD_SIZE)) {
-                       memcpy(buf + i, g_emi62bs[pos].data, g_emi62bs[pos].length);
-                       i += g_emi62bs[pos].length;
-                       pos++;
+               while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) {
+                       memcpy(buf + i, rec->data, be16_to_cpu(rec->len));
+                       i += be16_to_cpu(rec->len);
+                       rec = ihex_next_binrec(rec);
                }
                err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
                if (err < 0) {
-                       err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+                       err("%s - error loading firmware: error = %d", __func__, err);
                        goto wraperr;
                }
        } while (i > 0);
@@ -149,15 +174,18 @@ static int emi62_load_firmware (struct usb_device *dev)
        /* Assert reset (stop the CPU in the EMI) */
        err = emi62_set_reset(dev,1);
        if (err < 0) {
-               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+               err("%s - error loading firmware: error = %d", __func__, err);
                goto wraperr;
        }
 
        /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
-       for (i=0; g_emi62_loader[i].type == 0; i++) {
-               err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
+       for (rec = (const struct ihex_binrec *)loader_fw->data;
+            rec; rec = ihex_next_binrec(rec)) {
+               err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+                                       rec->data, be16_to_cpu(rec->len),
+                                       ANCHOR_LOAD_INTERNAL);
                if (err < 0) {
-                       err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+                       err("%s - error loading firmware: error = %d", __func__, err);
                        goto wraperr;
                }
        }
@@ -165,74 +193,58 @@ static int emi62_load_firmware (struct usb_device *dev)
        /* De-assert reset (let the CPU run) */
        err = emi62_set_reset(dev,0);
        if (err < 0) {
-               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+               err("%s - error loading firmware: error = %d", __func__, err);
                goto wraperr;
        }
        msleep(250);    /* let device settle */
 
        /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
 
-/* FIXME: quick and dirty ifdefs */
-#ifdef SPDIF
-       for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
-               if (!INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
-                       err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_EXTERNAL);
+       for (rec = (const struct ihex_binrec *)firmware_fw->data;
+            rec; rec = ihex_next_binrec(rec)) {
+               if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) {
+                       err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+                                               rec->data, be16_to_cpu(rec->len),
+                                               ANCHOR_LOAD_EXTERNAL);
                        if (err < 0) {
-                               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+                               err("%s - error loading firmware: error = %d", __func__, err);
                                goto wraperr;
                        }
                }
        }
-#else /* MIDI */
-       for (i=0; g_HexMidiFw62[i].type == 0; i++) {
-               if (!INTERNAL_RAM(g_HexMidiFw62[i].address)) {
-                       err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_EXTERNAL);
-                       if (err < 0) {
-                               err("%s - error loading firmware: error = %d\n", __FUNCTION__, err);
-                               goto wraperr;
-                               return err;
-                       }
-               }
-       }
-#endif 
+
        /* Assert reset (stop the CPU in the EMI) */
        err = emi62_set_reset(dev,1);
        if (err < 0) {
-               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+               err("%s - error loading firmware: error = %d", __func__, err);
                goto wraperr;
        }
 
-/* FIXME: quick and dirty ifdefs */
-#ifdef SPDIF
-       for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
-               if (INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
-                       err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_INTERNAL);
-                       if (err < 0) {
-                               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
-                               goto wraperr;
-                       }
-               }
-       }
-#else /* MIDI */
-       for (i=0; g_HexMidiFw62[i].type == 0; i++) {
-               if (INTERNAL_RAM(g_HexMidiFw62[i].address)) {
-                       err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_INTERNAL);
+       for (rec = (const struct ihex_binrec *)firmware_fw->data;
+            rec; rec = ihex_next_binrec(rec)) {
+               if (INTERNAL_RAM(be32_to_cpu(rec->addr))) {
+                       err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+                                               rec->data, be16_to_cpu(rec->len),
+                                               ANCHOR_LOAD_EXTERNAL);
                        if (err < 0) {
-                               err("%s - error loading firmware: error = %d\n", __FUNCTION__, err);
+                               err("%s - error loading firmware: error = %d", __func__, err);
                                goto wraperr;
                        }
                }
        }
-#endif
-       
+
        /* De-assert reset (let the CPU run) */
        err = emi62_set_reset(dev,0);
        if (err < 0) {
-               err("%s - error loading firmware: error = %d", __FUNCTION__, err);
+               err("%s - error loading firmware: error = %d", __func__, err);
                goto wraperr;
        }
        msleep(250);    /* let device settle */
 
+       release_firmware(loader_fw);
+       release_firmware(bitstream_fw);
+       release_firmware(firmware_fw);
+
        kfree(buf);
 
        /* return 1 to fail the driver inialization
@@ -240,6 +252,10 @@ static int emi62_load_firmware (struct usb_device *dev)
        return 1;
 
 wraperr:
+       release_firmware(loader_fw);
+       release_firmware(bitstream_fw);
+       release_firmware(firmware_fw);
+
        kfree(buf);
        dev_err(&dev->dev, "Error\n");
        return err;
@@ -257,7 +273,7 @@ static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *i
        struct usb_device *dev = interface_to_usbdev(intf);
        dev_dbg(&intf->dev, "emi62_probe\n");
 
-       info("%s start", __FUNCTION__); 
+       info("%s start", __func__);
 
        emi62_load_firmware(dev);
 
@@ -293,9 +309,12 @@ static void __exit emi62_exit (void)
 module_init(emi62_init);
 module_exit(emi62_exit);
 
-MODULE_AUTHOR("tapio laxström");
+MODULE_AUTHOR("Tapio Laxström");
 MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader.");
 MODULE_LICENSE("GPL");
 
+MODULE_FIRMWARE("emi62/loader.fw");
+MODULE_FIRMWARE("emi62/bitstream.fw");
+MODULE_FIRMWARE(FIRMWARE_FW);
 /* vi:ai:syntax=c:sw=8:ts=8:tw=80
  */