drivers/usb/misc/emi62.c

   1 /*
   2  * Emagic EMI 2|6 usb audio interface firmware loader.
   3  * Copyright (C) 2002
   4  *      Tapio Laxström (tapio.laxstrom@iptime.fi)
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, as published by
   8  * the Free Software Foundation, version 2.
   9  *
  10  * $Id: emi62.c,v 1.15 2002/04/23 06:13:59 tapio Exp $
  11  */
  12 #include <linux/kernel.h>
  13 #include <linux/errno.h>
  14 #include <linux/slab.h>
  15 #include <linux/init.h>
  16 #include <linux/module.h>
  17 #include <linux/usb.h>
  18
  19 #define MAX_INTEL_HEX_RECORD_LENGTH 16
  20 typedef struct _INTEL_HEX_RECORD
  21 {
  22         __u32   length;
  23         __u32   address;
  24         __u32   type;
  25         __u8    data[MAX_INTEL_HEX_RECORD_LENGTH];
  26 } INTEL_HEX_RECORD, *PINTEL_HEX_RECORD;
  27
  28 /* include firmware (variables)*/
  29
  30 /* FIXME: This is quick and dirty solution! */
  31 #define SPDIF   /* if you want SPDIF comment next line */
  32 //#undef SPDIF  /* if you want MIDI uncomment this line */
  33
  34 #ifdef SPDIF
  35 #  include "emi62_fw_s.h" /* spdif fw */
  36 #else
  37 #  include "emi62_fw_m.h" /* midi fw */
  38 #endif
  39
  40 #define EMI62_VENDOR_ID                 0x086a  /* Emagic Soft-und Hardware GmBH */
  41 #define EMI62_PRODUCT_ID                0x0110  /* EMI 6|2m without firmware */
  42
  43 #define ANCHOR_LOAD_INTERNAL    0xA0    /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
  44 #define ANCHOR_LOAD_EXTERNAL    0xA3    /* This command is not implemented in the core. Requires firmware */
  45 #define ANCHOR_LOAD_FPGA        0xA5    /* This command is not implemented in the core. Requires firmware. Emagic extension */
  46 #define MAX_INTERNAL_ADDRESS    0x1B3F  /* This is the highest internal RAM address for the AN2131Q */
  47 #define CPUCS_REG               0x7F92  /* EZ-USB Control and Status Register.  Bit 0 controls 8051 reset */
  48 #define INTERNAL_RAM(address)   (address <= MAX_INTERNAL_ADDRESS)
  49
  50 static int emi62_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest);
  51 static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
  52 static int emi62_load_firmware (struct usb_device *dev);
  53 static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id);
  54 static void emi62_disconnect(struct usb_interface *intf);
  55 static int __init emi62_init (void);
  56 static void __exit emi62_exit (void);
  57
  58
  59 /* thanks to drivers/usb/serial/keyspan_pda.c code */
  60 static int emi62_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request)
  61 {
  62         int result;
  63         unsigned char *buffer =  kmalloc (length, GFP_KERNEL);
  64
  65         if (!buffer) {
  66                 err("emi62: kmalloc(%d) failed.", length);
  67                 return -ENOMEM;
  68         }
  69         memcpy (buffer, data, length);
  70         /* Note: usb_control_msg returns negative value on error or length of the
  71          *               data that was written! */
  72         result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
  73         kfree (buffer);
  74         return result;
  75 }
  76
  77 /* thanks to drivers/usb/serial/keyspan_pda.c code */
  78 static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
  79 {
  80         int response;
  81         info("%s - %d", __FUNCTION__, reset_bit);
  82
  83         response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
  84         if (response < 0) {
  85                 err("emi62: set_reset (%d) failed", reset_bit);
  86         }
  87         return response;
  88 }
  89
  90 #define FW_LOAD_SIZE            1023
  91
  92 static int emi62_load_firmware (struct usb_device *dev)
  93 {
  94         int err;
  95         int i;
  96         int pos = 0;    /* Position in hex record */
  97         __u32 addr;     /* Address to write */
  98         __u8 *buf;
  99
 100         dev_dbg(&dev->dev, "load_firmware\n");
 101         buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
 102         if (!buf) {
 103                 err( "%s - error loading firmware: error = %d", __FUNCTION__, -ENOMEM);
 104                 err = -ENOMEM;
 105                 goto wraperr;
 106         }
 107
 108         /* Assert reset (stop the CPU in the EMI) */
 109         err = emi62_set_reset(dev,1);
 110         if (err < 0) {
 111                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 112                 goto wraperr;
 113         }
 114
 115         /* 1. We need to put the loader for the FPGA into the EZ-USB */
 116         for (i=0; g_emi62_loader[i].type == 0; i++) {
 117                 err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
 118                 if (err < 0) {
 119                         err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 120                         goto wraperr;
 121                 }
 122         }
 123
 124         /* De-assert reset (let the CPU run) */
 125         err = emi62_set_reset(dev,0);
 126
 127         /* 2. We upload the FPGA firmware into the EMI
 128          * Note: collect up to 1023 (yes!) bytes and send them with
 129          * a single request. This is _much_ faster! */
 130         do {
 131                 i = 0;
 132                 addr = g_emi62bs[pos].address;
 133
 134                 /* intel hex records are terminated with type 0 element */
 135                 while ((g_emi62bs[pos].type == 0) && (i + g_emi62bs[pos].length < FW_LOAD_SIZE)) {
 136                         memcpy(buf + i, g_emi62bs[pos].data, g_emi62bs[pos].length);
 137                         i += g_emi62bs[pos].length;
 138                         pos++;
 139                 }
 140                 err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
 141                 if (err < 0) {
 142                         err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 143                         goto wraperr;
 144                 }
 145         } while (i > 0);
 146
 147         /* Assert reset (stop the CPU in the EMI) */
 148         err = emi62_set_reset(dev,1);
 149         if (err < 0) {
 150                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 151                 goto wraperr;
 152         }
 153
 154         /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
 155         for (i=0; g_emi62_loader[i].type == 0; i++) {
 156                 err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
 157                 if (err < 0) {
 158                         err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 159                         goto wraperr;
 160                 }
 161         }
 162
 163         /* De-assert reset (let the CPU run) */
 164         err = emi62_set_reset(dev,0);
 165         if (err < 0) {
 166                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 167                 goto wraperr;
 168         }
 169
 170         /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
 171
 172 /* FIXME: quick and dirty ifdefs */
 173 #ifdef SPDIF
 174         for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
 175                 if (!INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
 176                         err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_EXTERNAL);
 177                         if (err < 0) {
 178                                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 179                                 goto wraperr;
 180                         }
 181                 }
 182         }
 183 #else /* MIDI */
 184         for (i=0; g_HexMidiFw62[i].type == 0; i++) {
 185                 if (!INTERNAL_RAM(g_HexMidiFw62[i].address)) {
 186                         err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_EXTERNAL);
 187                         if (err < 0) {
 188                                 err("%s - error loading firmware: error = %d\n", __FUNCTION__, err);
 189                                 goto wraperr;
 190                                 return err;
 191                         }
 192                 }
 193         }
 194 #endif
 195         /* Assert reset (stop the CPU in the EMI) */
 196         err = emi62_set_reset(dev,1);
 197         if (err < 0) {
 198                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 199                 goto wraperr;
 200         }
 201
 202 /* FIXME: quick and dirty ifdefs */
 203 #ifdef SPDIF
 204         for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
 205                 if (INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
 206                         err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_INTERNAL);
 207                         if (err < 0) {
 208                                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 209                                 goto wraperr;
 210                         }
 211                 }
 212         }
 213 #else /* MIDI */
 214         for (i=0; g_HexMidiFw62[i].type == 0; i++) {
 215                 if (INTERNAL_RAM(g_HexMidiFw62[i].address)) {
 216                         err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_INTERNAL);
 217                         if (err < 0) {
 218                                 err("%s - error loading firmware: error = %d\n", __FUNCTION__, err);
 219                                 goto wraperr;
 220                         }
 221                 }
 222         }
 223 #endif
 224
 225         /* De-assert reset (let the CPU run) */
 226         err = emi62_set_reset(dev,0);
 227         if (err < 0) {
 228                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 229                 goto wraperr;
 230         }
 231
 232         kfree(buf);
 233
 234         /* return 1 to fail the driver inialization
 235          * and give real driver change to load */
 236         return 1;
 237
 238 wraperr:
 239         kfree(buf);
 240         dev_err(&dev->dev, "Error\n");
 241         return err;
 242 }
 243
 244 static __devinitdata struct usb_device_id id_table [] = {
 245         { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) },
 246         { }                                             /* Terminating entry */
 247 };
 248
 249 MODULE_DEVICE_TABLE (usb, id_table);
 250
 251 static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id)
 252 {
 253         struct usb_device *dev = interface_to_usbdev(intf);
 254         dev_dbg(&intf->dev, "emi62_probe\n");
 255
 256         info("%s start", __FUNCTION__);
 257
 258         emi62_load_firmware(dev);
 259
 260         /* do not return the driver context, let real audio driver do that */
 261         return -EIO;
 262 }
 263
 264 static void emi62_disconnect(struct usb_interface *intf)
 265 {
 266 }
 267
 268 static struct usb_driver emi62_driver = {
 269         .owner          = THIS_MODULE,
 270         .name           = "emi62 - firmware loader",
 271         .probe          = emi62_probe,
 272         .disconnect     = emi62_disconnect,
 273         .id_table       = id_table,
 274 };
 275
 276 static int __init emi62_init (void)
 277 {
 278         int retval;
 279         retval = usb_register (&emi62_driver);
 280         if (retval)
 281                 printk(KERN_ERR "adi-emi: registration failed\n");
 282         return retval;
 283 }
 284
 285 static void __exit emi62_exit (void)
 286 {
 287         usb_deregister (&emi62_driver);
 288 }
 289
 290 module_init(emi62_init);
 291 module_exit(emi62_exit);
 292
 293 MODULE_AUTHOR("tapio laxström");
 294 MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader.");
 295 MODULE_LICENSE("GPL");
 296
 297 /* vi:ai:syntax=c:sw=8:ts=8:tw=80
 298  */