drivers/usb/misc/emi26.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  * emi26.c,v 1.13 2002/03/08 13:10:26 tapio Exp
  11  */
  12 #include <linux/kernel.h>
  13 #include <linux/errno.h>
  14 #include <linux/slab.h>
  15 #include <linux/module.h>
  16 #include <linux/init.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 #include "emi26_fw.h"
  30
  31 #define EMI26_VENDOR_ID                 0x086a  /* Emagic Soft-und Hardware GmBH */
  32 #define EMI26_PRODUCT_ID                0x0100  /* EMI 2|6 without firmware */
  33
  34 #define ANCHOR_LOAD_INTERNAL    0xA0    /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
  35 #define ANCHOR_LOAD_EXTERNAL    0xA3    /* This command is not implemented in the core. Requires firmware */
  36 #define ANCHOR_LOAD_FPGA        0xA5    /* This command is not implemented in the core. Requires firmware. Emagic extension */
  37 #define MAX_INTERNAL_ADDRESS    0x1B3F  /* This is the highest internal RAM address for the AN2131Q */
  38 #define CPUCS_REG               0x7F92  /* EZ-USB Control and Status Register.  Bit 0 controls 8051 reset */
  39 #define INTERNAL_RAM(address)   (address <= MAX_INTERNAL_ADDRESS)
  40
  41 static int emi26_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest);
  42 static int emi26_set_reset(struct usb_device *dev, unsigned char reset_bit);
  43 static int emi26_load_firmware (struct usb_device *dev);
  44 static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id);
  45 static void emi26_disconnect(struct usb_interface *intf);
  46 static int __init emi26_init (void);
  47 static void __exit emi26_exit (void);
  48
  49
  50 /* thanks to drivers/usb/serial/keyspan_pda.c code */
  51 static int emi26_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request)
  52 {
  53         int result;
  54         unsigned char *buffer =  kmalloc (length, GFP_KERNEL);
  55
  56         if (!buffer) {
  57                 err("emi26: kmalloc(%d) failed.", length);
  58                 return -ENOMEM;
  59         }
  60         memcpy (buffer, data, length);
  61         /* Note: usb_control_msg returns negative value on error or length of the
  62          *               data that was written! */
  63         result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
  64         kfree (buffer);
  65         return result;
  66 }
  67
  68 /* thanks to drivers/usb/serial/keyspan_pda.c code */
  69 static int emi26_set_reset (struct usb_device *dev, unsigned char reset_bit)
  70 {
  71         int response;
  72         info("%s - %d", __FUNCTION__, reset_bit);
  73         /* printk(KERN_DEBUG "%s - %d", __FUNCTION__, reset_bit); */
  74         response = emi26_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
  75         if (response < 0) {
  76                 err("emi26: set_reset (%d) failed", reset_bit);
  77         }
  78         return response;
  79 }
  80
  81 #define FW_LOAD_SIZE            1023
  82
  83 static int emi26_load_firmware (struct usb_device *dev)
  84 {
  85         int err;
  86         int i;
  87         int pos = 0;    /* Position in hex record */
  88         __u32 addr;     /* Address to write */
  89         __u8 *buf;
  90
  91         buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
  92         if (!buf) {
  93                 err( "%s - error loading firmware: error = %d", __FUNCTION__, -ENOMEM);
  94                 err = -ENOMEM;
  95                 goto wraperr;
  96         }
  97
  98         /* Assert reset (stop the CPU in the EMI) */
  99         err = emi26_set_reset(dev,1);
 100         if (err < 0) {
 101                 err( "%s - error loading firmware: error = %d", __FUNCTION__, err);
 102                 goto wraperr;
 103         }
 104
 105         /* 1. We need to put the loader for the FPGA into the EZ-USB */
 106         for (i=0; g_Loader[i].type == 0; i++) {
 107                 err = emi26_writememory(dev, g_Loader[i].address, g_Loader[i].data, g_Loader[i].length, ANCHOR_LOAD_INTERNAL);
 108                 if (err < 0) {
 109                         err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 110                         goto wraperr;
 111                 }
 112         }
 113
 114         /* De-assert reset (let the CPU run) */
 115         err = emi26_set_reset(dev,0);
 116
 117         /* 2. We upload the FPGA firmware into the EMI
 118          * Note: collect up to 1023 (yes!) bytes and send them with
 119          * a single request. This is _much_ faster! */
 120         do {
 121                 i = 0;
 122                 addr = g_bitstream[pos].address;
 123
 124                 /* intel hex records are terminated with type 0 element */
 125                 while ((g_bitstream[pos].type == 0) && (i + g_bitstream[pos].length < FW_LOAD_SIZE)) {
 126                         memcpy(buf + i, g_bitstream[pos].data, g_bitstream[pos].length);
 127                         i += g_bitstream[pos].length;
 128                         pos++;
 129                 }
 130                 err = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
 131                 if (err < 0) {
 132                         err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 133                         goto wraperr;
 134                 }
 135         } while (i > 0);
 136
 137         /* Assert reset (stop the CPU in the EMI) */
 138         err = emi26_set_reset(dev,1);
 139         if (err < 0) {
 140                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 141                 goto wraperr;
 142         }
 143
 144         /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
 145         for (i=0; g_Loader[i].type == 0; i++) {
 146                 err = emi26_writememory(dev, g_Loader[i].address, g_Loader[i].data, g_Loader[i].length, ANCHOR_LOAD_INTERNAL);
 147                 if (err < 0) {
 148                         err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 149                         goto wraperr;
 150                 }
 151         }
 152
 153         /* De-assert reset (let the CPU run) */
 154         err = emi26_set_reset(dev,0);
 155         if (err < 0) {
 156                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 157                 goto wraperr;
 158         }
 159
 160         /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
 161         for (i=0; g_Firmware[i].type == 0; i++) {
 162                 if (!INTERNAL_RAM(g_Firmware[i].address)) {
 163                         err = emi26_writememory(dev, g_Firmware[i].address, g_Firmware[i].data, g_Firmware[i].length, ANCHOR_LOAD_EXTERNAL);
 164                         if (err < 0) {
 165                                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 166                                 goto wraperr;
 167                         }
 168                 }
 169         }
 170
 171         /* Assert reset (stop the CPU in the EMI) */
 172         err = emi26_set_reset(dev,1);
 173         if (err < 0) {
 174                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 175                 goto wraperr;
 176         }
 177
 178         for (i=0; g_Firmware[i].type == 0; i++) {
 179                 if (INTERNAL_RAM(g_Firmware[i].address)) {
 180                         err = emi26_writememory(dev, g_Firmware[i].address, g_Firmware[i].data, g_Firmware[i].length, ANCHOR_LOAD_INTERNAL);
 181                         if (err < 0) {
 182                                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 183                                 goto wraperr;
 184                         }
 185                 }
 186         }
 187
 188         /* De-assert reset (let the CPU run) */
 189         err = emi26_set_reset(dev,0);
 190         if (err < 0) {
 191                 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
 192                 goto wraperr;
 193         }
 194
 195         /* return 1 to fail the driver inialization
 196          * and give real driver change to load */
 197         err = 1;
 198
 199 wraperr:
 200         kfree(buf);
 201         return err;
 202 }
 203
 204 static struct usb_device_id id_table [] = {
 205         { USB_DEVICE(EMI26_VENDOR_ID, EMI26_PRODUCT_ID) },
 206         { }                                             /* Terminating entry */
 207 };
 208
 209 MODULE_DEVICE_TABLE (usb, id_table);
 210
 211 static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id)
 212 {
 213         struct usb_device *dev = interface_to_usbdev(intf);
 214
 215         info("%s start", __FUNCTION__);
 216
 217         if((dev->descriptor.idVendor == EMI26_VENDOR_ID) && (dev->descriptor.idProduct == EMI26_PRODUCT_ID)) {
 218                 emi26_load_firmware(dev);
 219         }
 220
 221         /* do not return the driver context, let real audio driver do that */
 222         return -EIO;
 223 }
 224
 225 static void emi26_disconnect(struct usb_interface *intf)
 226 {
 227 }
 228
 229 static struct usb_driver emi26_driver = {
 230         .owner          = THIS_MODULE,
 231         .name           = "emi26 - firmware loader",
 232         .probe          = emi26_probe,
 233         .disconnect     = emi26_disconnect,
 234         .id_table       = id_table,
 235 };
 236
 237 static int __init emi26_init (void)
 238 {
 239         return usb_register(&emi26_driver);
 240 }
 241
 242 static void __exit emi26_exit (void)
 243 {
 244         usb_deregister (&emi26_driver);
 245 }
 246
 247 module_init(emi26_init);
 248 module_exit(emi26_exit);
 249
 250 MODULE_AUTHOR("tapio laxström");
 251 MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader.");
 252 MODULE_LICENSE("GPL");
 253
 254 /* vi:ai:syntax=c:sw=8:ts=8:tw=80
 255  */