1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Driver for Tascam US-X2Y USB soundcards
4 *
5 * FPGA Loader + ALSA Startup
6 *
7 * Copyright (c) 2003 by Karsten Wiese <annabellesgarden@yahoo.de>
8 */
9
10 #include <linux/interrupt.h>
11 #include <linux/slab.h>
12 #include <linux/usb.h>
13 #include <sound/core.h>
14 #include <sound/memalloc.h>
15 #include <sound/pcm.h>
16 #include <sound/hwdep.h>
17 #include "usx2y.h"
18 #include "usbusx2y.h"
19 #include "usX2Yhwdep.h"
20
snd_us428ctls_vm_fault(struct vm_fault * vmf)21 static vm_fault_t snd_us428ctls_vm_fault(struct vm_fault *vmf)
22 {
23 unsigned long offset;
24 struct page *page;
25 void *vaddr;
26
27 offset = vmf->pgoff << PAGE_SHIFT;
28 if (offset >= US428_SHAREDMEM_PAGES)
29 return VM_FAULT_SIGBUS;
30 vaddr = (char *)((struct usx2ydev *)vmf->vma->vm_private_data)->us428ctls_sharedmem + offset;
31 page = virt_to_page(vaddr);
32 get_page(page);
33 vmf->page = page;
34
35 return 0;
36 }
37
38 static const struct vm_operations_struct us428ctls_vm_ops = {
39 .fault = snd_us428ctls_vm_fault,
40 };
41
snd_us428ctls_mmap(struct snd_hwdep * hw,struct file * filp,struct vm_area_struct * area)42 static int snd_us428ctls_mmap(struct snd_hwdep *hw, struct file *filp, struct vm_area_struct *area)
43 {
44 unsigned long size = (unsigned long)(area->vm_end - area->vm_start);
45 struct usx2ydev *us428 = hw->private_data;
46
47 // FIXME this hwdep interface is used twice: fpga download and mmap for controlling Lights etc. Maybe better using 2 hwdep devs?
48 // so as long as the device isn't fully initialised yet we return -EBUSY here.
49 if (!(us428->chip_status & USX2Y_STAT_CHIP_INIT))
50 return -EBUSY;
51
52 /* if userspace tries to mmap beyond end of our buffer, fail */
53 if (size > US428_SHAREDMEM_PAGES) {
54 dev_dbg(hw->card->dev, "%s: mmap size %lu > %lu\n", __func__,
55 size, (unsigned long)US428_SHAREDMEM_PAGES);
56 return -EINVAL;
57 }
58
59 area->vm_ops = &us428ctls_vm_ops;
60 vm_flags_set(area, VM_DONTEXPAND | VM_DONTDUMP);
61 area->vm_private_data = hw->private_data;
62 return 0;
63 }
64
snd_us428ctls_poll(struct snd_hwdep * hw,struct file * file,poll_table * wait)65 static __poll_t snd_us428ctls_poll(struct snd_hwdep *hw, struct file *file, poll_table *wait)
66 {
67 __poll_t mask = 0;
68 struct usx2ydev *us428 = hw->private_data;
69 struct us428ctls_sharedmem *shm = us428->us428ctls_sharedmem;
70
71 if (us428->chip_status & USX2Y_STAT_CHIP_HUP)
72 return EPOLLHUP;
73
74 poll_wait(file, &us428->us428ctls_wait_queue_head, wait);
75
76 if (shm && shm->ctl_snapshot_last != shm->ctl_snapshot_red)
77 mask |= EPOLLIN;
78
79 return mask;
80 }
81
82
snd_usx2y_hwdep_dsp_status(struct snd_hwdep * hw,struct snd_hwdep_dsp_status * info)83 static int snd_usx2y_hwdep_dsp_status(struct snd_hwdep *hw,
84 struct snd_hwdep_dsp_status *info)
85 {
86 static const char * const type_ids[USX2Y_TYPE_NUMS] = {
87 [USX2Y_TYPE_122] = "us122",
88 [USX2Y_TYPE_224] = "us224",
89 [USX2Y_TYPE_428] = "us428",
90 };
91 struct usx2ydev *us428 = hw->private_data;
92 int id = -1;
93
94 switch (le16_to_cpu(us428->dev->descriptor.idProduct)) {
95 case USB_ID_US122:
96 id = USX2Y_TYPE_122;
97 break;
98 case USB_ID_US224:
99 id = USX2Y_TYPE_224;
100 break;
101 case USB_ID_US428:
102 id = USX2Y_TYPE_428;
103 break;
104 }
105 if (id < 0)
106 return -ENODEV;
107 strscpy(info->id, type_ids[id]);
108 info->num_dsps = 2; // 0: Prepad Data, 1: FPGA Code
109 if (us428->chip_status & USX2Y_STAT_CHIP_INIT)
110 info->chip_ready = 1;
111 info->version = USX2Y_DRIVER_VERSION;
112 return 0;
113 }
114
usx2y_create_usbmidi(struct snd_card * card)115 static int usx2y_create_usbmidi(struct snd_card *card)
116 {
117 static const struct snd_usb_midi_endpoint_info quirk_data_1 = {
118 .out_ep = 0x06,
119 .in_ep = 0x06,
120 .out_cables = 0x001,
121 .in_cables = 0x001
122 };
123 static const struct snd_usb_audio_quirk quirk_1 = {
124 .vendor_name = "TASCAM",
125 .product_name = NAME_ALLCAPS,
126 .ifnum = 0,
127 .type = QUIRK_MIDI_FIXED_ENDPOINT,
128 .data = &quirk_data_1
129 };
130 static const struct snd_usb_midi_endpoint_info quirk_data_2 = {
131 .out_ep = 0x06,
132 .in_ep = 0x06,
133 .out_cables = 0x003,
134 .in_cables = 0x003
135 };
136 static const struct snd_usb_audio_quirk quirk_2 = {
137 .vendor_name = "TASCAM",
138 .product_name = "US428",
139 .ifnum = 0,
140 .type = QUIRK_MIDI_FIXED_ENDPOINT,
141 .data = &quirk_data_2
142 };
143 struct usb_device *dev = usx2y(card)->dev;
144 struct usb_interface *iface = usb_ifnum_to_if(dev, 0);
145 const struct snd_usb_audio_quirk *quirk =
146 le16_to_cpu(dev->descriptor.idProduct) == USB_ID_US428 ?
147 &quirk_2 : &quirk_1;
148
149 return snd_usbmidi_create(card, iface, &usx2y(card)->midi_list, quirk);
150 }
151
usx2y_create_alsa_devices(struct snd_card * card)152 static int usx2y_create_alsa_devices(struct snd_card *card)
153 {
154 int err;
155
156 err = usx2y_create_usbmidi(card);
157 if (err < 0) {
158 dev_err(card->dev, "%s: usx2y_create_usbmidi error %i\n",
159 __func__, err);
160 return err;
161 }
162 err = usx2y_audio_create(card);
163 if (err < 0)
164 return err;
165 err = usx2y_hwdep_pcm_new(card);
166 if (err < 0)
167 return err;
168 err = snd_card_register(card);
169 if (err < 0)
170 return err;
171 return 0;
172 }
173
snd_usx2y_hwdep_dsp_load(struct snd_hwdep * hw,struct snd_hwdep_dsp_image * dsp)174 static int snd_usx2y_hwdep_dsp_load(struct snd_hwdep *hw,
175 struct snd_hwdep_dsp_image *dsp)
176 {
177 struct usx2ydev *priv = hw->private_data;
178 struct usb_device *dev = priv->dev;
179 int lret, err;
180 char *buf;
181
182 buf = memdup_user(dsp->image, dsp->length);
183 if (IS_ERR(buf))
184 return PTR_ERR(buf);
185
186 err = usb_set_interface(dev, 0, 1);
187 if (err)
188 dev_err(&dev->dev, "usb_set_interface error\n");
189 else
190 err = usb_bulk_msg(dev, usb_sndbulkpipe(dev, 2), buf, dsp->length, &lret, 6000);
191 kfree(buf);
192 if (err)
193 return err;
194 if (dsp->index == 1) {
195 msleep(250); // give the device some time
196 err = usx2y_async_seq04_init(priv);
197 if (err) {
198 dev_err(&dev->dev, "usx2y_async_seq04_init error\n");
199 return err;
200 }
201 err = usx2y_in04_init(priv);
202 if (err) {
203 dev_err(&dev->dev, "usx2y_in04_init error\n");
204 return err;
205 }
206 err = usx2y_create_alsa_devices(hw->card);
207 if (err) {
208 dev_err(&dev->dev, "usx2y_create_alsa_devices error %i\n", err);
209 return err;
210 }
211 priv->chip_status |= USX2Y_STAT_CHIP_INIT;
212 }
213 return err;
214 }
215
usx2y_hwdep_new(struct snd_card * card,struct usb_device * device)216 int usx2y_hwdep_new(struct snd_card *card, struct usb_device *device)
217 {
218 int err;
219 struct snd_hwdep *hw;
220 struct usx2ydev *us428 = usx2y(card);
221
222 err = snd_hwdep_new(card, SND_USX2Y_LOADER_ID, 0, &hw);
223 if (err < 0)
224 return err;
225
226 hw->iface = SNDRV_HWDEP_IFACE_USX2Y;
227 hw->private_data = us428;
228 hw->ops.dsp_status = snd_usx2y_hwdep_dsp_status;
229 hw->ops.dsp_load = snd_usx2y_hwdep_dsp_load;
230 hw->ops.mmap = snd_us428ctls_mmap;
231 hw->ops.poll = snd_us428ctls_poll;
232 hw->exclusive = 1;
233 sprintf(hw->name, "/dev/bus/usb/%03d/%03d", device->bus->busnum, device->devnum);
234
235 us428->us428ctls_sharedmem = alloc_pages_exact(US428_SHAREDMEM_PAGES, GFP_KERNEL);
236 if (!us428->us428ctls_sharedmem)
237 return -ENOMEM;
238 memset(us428->us428ctls_sharedmem, -1, US428_SHAREDMEM_PAGES);
239 us428->us428ctls_sharedmem->ctl_snapshot_last = -2;
240
241 return 0;
242 }
243