sound/usb/usx2y/usX2Yhwdep.c

   1 /*
   2  * Driver for Tascam US-X2Y USB soundcards
   3  *
   4  * FPGA Loader + ALSA Startup
   5  *
   6  * Copyright (c) 2003 by Karsten Wiese <annabellesgarden@yahoo.de>
   7  *
   8  *   This program is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  */
  22
  23 #include <sound/driver.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/usb.h>
  26 #include <sound/core.h>
  27 #include <sound/memalloc.h>
  28 #include <sound/pcm.h>
  29 #include <sound/hwdep.h>
  30 #include "usx2y.h"
  31 #include "usbusx2y.h"
  32 #include "usX2Yhwdep.h"
  33
  34
  35 static struct page * snd_us428ctls_vm_nopage(struct vm_area_struct *area, unsigned long address, int *type)
  36 {
  37         unsigned long offset;
  38         struct page * page;
  39         void *vaddr;
  40
  41         snd_printdd("ENTER, start %lXh, ofs %lXh, pgoff %ld, addr %lXh\n",
  42                    area->vm_start,
  43                    address - area->vm_start,
  44                    (address - area->vm_start) >> PAGE_SHIFT,
  45                    address);
  46
  47         offset = area->vm_pgoff << PAGE_SHIFT;
  48         offset += address - area->vm_start;
  49         snd_assert((offset % PAGE_SIZE) == 0, return NOPAGE_OOM);
  50         vaddr = (char*)((usX2Ydev_t*)area->vm_private_data)->us428ctls_sharedmem + offset;
  51         page = virt_to_page(vaddr);
  52         get_page(page);
  53         snd_printdd( "vaddr=%p made us428ctls_vm_nopage() return %p; offset=%lX\n", vaddr, page, offset);
  54
  55         if (type)
  56                 *type = VM_FAULT_MINOR;
  57
  58         return page;
  59 }
  60
  61 static struct vm_operations_struct us428ctls_vm_ops = {
  62         .nopage = snd_us428ctls_vm_nopage,
  63 };
  64
  65 static int snd_us428ctls_mmap(snd_hwdep_t * hw, struct file *filp, struct vm_area_struct *area)
  66 {
  67         unsigned long   size = (unsigned long)(area->vm_end - area->vm_start);
  68         usX2Ydev_t      *us428 = (usX2Ydev_t*)hw->private_data;
  69
  70         // FIXME this hwdep interface is used twice: fpga download and mmap for controlling Lights etc. Maybe better using 2 hwdep devs?
  71         // so as long as the device isn't fully initialised yet we return -EBUSY here.
  72         if (!(((usX2Ydev_t*)hw->private_data)->chip_status & USX2Y_STAT_CHIP_INIT))
  73                 return -EBUSY;
  74
  75         /* if userspace tries to mmap beyond end of our buffer, fail */
  76         if (size > ((PAGE_SIZE - 1 + sizeof(us428ctls_sharedmem_t)) / PAGE_SIZE) * PAGE_SIZE) {
  77                 snd_printd( "%lu > %lu\n", size, (unsigned long)sizeof(us428ctls_sharedmem_t));
  78                 return -EINVAL;
  79         }
  80
  81         if (!us428->us428ctls_sharedmem) {
  82                 init_waitqueue_head(&us428->us428ctls_wait_queue_head);
  83                 if(!(us428->us428ctls_sharedmem = snd_malloc_pages(sizeof(us428ctls_sharedmem_t), GFP_KERNEL)))
  84                         return -ENOMEM;
  85                 memset(us428->us428ctls_sharedmem, -1, sizeof(us428ctls_sharedmem_t));
  86                 us428->us428ctls_sharedmem->CtlSnapShotLast = -2;
  87         }
  88         area->vm_ops = &us428ctls_vm_ops;
  89         area->vm_flags |= VM_RESERVED;
  90         area->vm_private_data = hw->private_data;
  91         return 0;
  92 }
  93
  94 static unsigned int snd_us428ctls_poll(snd_hwdep_t *hw, struct file *file, poll_table *wait)
  95 {
  96         unsigned int    mask = 0;
  97         usX2Ydev_t      *us428 = (usX2Ydev_t*)hw->private_data;
  98         static unsigned LastN;
  99
 100         if (us428->chip_status & USX2Y_STAT_CHIP_HUP)
 101                 return POLLHUP;
 102
 103         poll_wait(file, &us428->us428ctls_wait_queue_head, wait);
 104
 105         down(&us428->open_mutex);
 106         if (us428->us428ctls_sharedmem
 107             && us428->us428ctls_sharedmem->CtlSnapShotLast != LastN) {
 108                 mask |= POLLIN;
 109                 LastN = us428->us428ctls_sharedmem->CtlSnapShotLast;
 110         }
 111         up(&us428->open_mutex);
 112
 113         return mask;
 114 }
 115
 116
 117 static int snd_usX2Y_hwdep_open(snd_hwdep_t *hw, struct file *file)
 118 {
 119         return 0;
 120 }
 121
 122 static int snd_usX2Y_hwdep_release(snd_hwdep_t *hw, struct file *file)
 123 {
 124         return 0;
 125 }
 126
 127 static int snd_usX2Y_hwdep_dsp_status(snd_hwdep_t *hw, snd_hwdep_dsp_status_t *info)
 128 {
 129         static char *type_ids[USX2Y_TYPE_NUMS] = {
 130                 [USX2Y_TYPE_122] = "us122",
 131                 [USX2Y_TYPE_224] = "us224",
 132                 [USX2Y_TYPE_428] = "us428",
 133         };
 134         int id = -1;
 135
 136         switch (((usX2Ydev_t*)hw->private_data)->chip.dev->descriptor.idProduct) {
 137         case USB_ID_US122:
 138                 id = USX2Y_TYPE_122;
 139                 break;
 140         case USB_ID_US224:
 141                 id = USX2Y_TYPE_224;
 142                 break;
 143         case USB_ID_US428:
 144                 id = USX2Y_TYPE_428;
 145                 break;
 146         }
 147         if (0 > id)
 148                 return -ENODEV;
 149         strcpy(info->id, type_ids[id]);
 150         info->num_dsps = 2;             // 0: Prepad Data, 1: FPGA Code
 151         if (((usX2Ydev_t*)hw->private_data)->chip_status & USX2Y_STAT_CHIP_INIT)
 152                 info->chip_ready = 1;
 153         info->version = USX2Y_DRIVER_VERSION;
 154         return 0;
 155 }
 156
 157
 158 static int usX2Y_create_usbmidi(snd_card_t* card )
 159 {
 160         static snd_usb_midi_endpoint_info_t quirk_data_1 = {
 161                 .out_ep =0x06,
 162                 .in_ep = 0x06,
 163                 .out_cables =   0x001,
 164                 .in_cables =    0x001
 165         };
 166         static snd_usb_audio_quirk_t quirk_1 = {
 167                 .vendor_name =  "TASCAM",
 168                 .product_name = NAME_ALLCAPS,
 169                 .ifnum =        0,
 170                 .type = QUIRK_MIDI_FIXED_ENDPOINT,
 171                 .data = &quirk_data_1
 172         };
 173         static snd_usb_midi_endpoint_info_t quirk_data_2 = {
 174                 .out_ep =0x06,
 175                 .in_ep = 0x06,
 176                 .out_cables =   0x003,
 177                 .in_cables =    0x003
 178         };
 179         static snd_usb_audio_quirk_t quirk_2 = {
 180                 .vendor_name =  "TASCAM",
 181                 .product_name = "US428",
 182                 .ifnum =        0,
 183                 .type = QUIRK_MIDI_FIXED_ENDPOINT,
 184                 .data = &quirk_data_2
 185         };
 186         struct usb_device *dev = usX2Y(card)->chip.dev;
 187         struct usb_interface *iface = usb_ifnum_to_if(dev, 0);
 188         snd_usb_audio_quirk_t *quirk = dev->descriptor.idProduct == USB_ID_US428 ? &quirk_2 : &quirk_1;
 189
 190         snd_printdd("usX2Y_create_usbmidi \n");
 191         return snd_usb_create_midi_interface(&usX2Y(card)->chip, iface, quirk);
 192 }
 193
 194 static int usX2Y_create_alsa_devices(snd_card_t* card)
 195 {
 196         int err;
 197
 198         do {
 199                 if ((err = usX2Y_create_usbmidi(card)) < 0) {
 200                         snd_printk("usX2Y_create_alsa_devices: usX2Y_create_usbmidi error %i \n", err);
 201                         break;
 202                 }
 203                 if ((err = usX2Y_audio_create(card)) < 0)
 204                         break;
 205                 if ((err = snd_card_register(card)) < 0)
 206                         break;
 207         } while (0);
 208
 209         return err;
 210 }
 211
 212 static int snd_usX2Y_hwdep_dsp_load(snd_hwdep_t *hw, snd_hwdep_dsp_image_t *dsp)
 213 {
 214         usX2Ydev_t *priv = hw->private_data;
 215         int     lret, err = -EINVAL;
 216         snd_printdd( "dsp_load %s\n", dsp->name);
 217
 218         if (access_ok(VERIFY_READ, dsp->image, dsp->length)) {
 219                 struct usb_device* dev = priv->chip.dev;
 220                 char *buf = kmalloc(dsp->length, GFP_KERNEL);
 221                 if (!buf)
 222                         return -ENOMEM;
 223                 if (copy_from_user(buf, dsp->image, dsp->length)) {
 224                         kfree(buf);
 225                         return -EFAULT;
 226                 }
 227                 err = usb_set_interface(dev, 0, 1);
 228                 if (err)
 229                         snd_printk("usb_set_interface error \n");
 230                 else
 231                         err = usb_bulk_msg(dev, usb_sndbulkpipe(dev, 2), buf, dsp->length, &lret, 6*HZ);
 232                 kfree(buf);
 233         }
 234         if (err)
 235                 return err;
 236         if (dsp->index == 1) {
 237                 set_current_state(TASK_UNINTERRUPTIBLE);
 238                 schedule_timeout(HZ/4);                 // give the device some time
 239                 err = usX2Y_AsyncSeq04_init(priv);
 240                 if (err) {
 241                         snd_printk("usX2Y_AsyncSeq04_init error \n");
 242                         return err;
 243                 }
 244                 err = usX2Y_In04_init(priv);
 245                 if (err) {
 246                         snd_printk("usX2Y_In04_init error \n");
 247                         return err;
 248                 }
 249                 err = usX2Y_create_alsa_devices(hw->card);
 250                 if (err) {
 251                         snd_printk("usX2Y_create_alsa_devices error %i \n", err);
 252                         snd_card_free(hw->card);
 253                         return err;
 254                 }
 255                 priv->chip_status |= USX2Y_STAT_CHIP_INIT;
 256                 snd_printdd("%s: alsa all started\n", hw->name);
 257         }
 258         return err;
 259 }
 260
 261
 262 int usX2Y_hwdep_new(snd_card_t* card, struct usb_device* device)
 263 {
 264         int err;
 265         snd_hwdep_t *hw;
 266
 267         if ((err = snd_hwdep_new(card, SND_USX2Y_LOADER_ID, 0, &hw)) < 0)
 268                 return err;
 269
 270         hw->iface = SNDRV_HWDEP_IFACE_USX2Y;
 271         hw->private_data = usX2Y(card);
 272         hw->ops.open = snd_usX2Y_hwdep_open;
 273         hw->ops.release = snd_usX2Y_hwdep_release;
 274         hw->ops.dsp_status = snd_usX2Y_hwdep_dsp_status;
 275         hw->ops.dsp_load = snd_usX2Y_hwdep_dsp_load;
 276         hw->ops.mmap = snd_us428ctls_mmap;
 277         hw->ops.poll = snd_us428ctls_poll;
 278         hw->exclusive = 1;
 279         sprintf(hw->name, "/proc/bus/usb/%03d/%03d", device->bus->busnum, device->devnum);
 280         return 0;
 281 }
 282