xref: /linux/sound/usb/usx2y/usbusx2yaudio.c (revision 0d456bad36d42d16022be045c8a53ddbb59ee478)
1 /*
2  *   US-X2Y AUDIO
3  *   Copyright (c) 2002-2004 by Karsten Wiese
4  *
5  *   based on
6  *
7  *   (Tentative) USB Audio Driver for ALSA
8  *
9  *   Main and PCM part
10  *
11  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
12  *
13  *   Many codes borrowed from audio.c by
14  *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
15  *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
16  *
17  *
18  *   This program is free software; you can redistribute it and/or modify
19  *   it under the terms of the GNU General Public License as published by
20  *   the Free Software Foundation; either version 2 of the License, or
21  *   (at your option) any later version.
22  *
23  *   This program is distributed in the hope that it will be useful,
24  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
25  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  *   GNU General Public License for more details.
27  *
28  *   You should have received a copy of the GNU General Public License
29  *   along with this program; if not, write to the Free Software
30  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
31  */
32 
33 
34 #include <linux/interrupt.h>
35 #include <linux/slab.h>
36 #include <linux/usb.h>
37 #include <linux/moduleparam.h>
38 #include <sound/core.h>
39 #include <sound/info.h>
40 #include <sound/pcm.h>
41 #include <sound/pcm_params.h>
42 #include "usx2y.h"
43 #include "usbusx2y.h"
44 
45 #define USX2Y_NRPACKS 4			/* Default value used for nr of packs per urb.
46 					  1 to 4 have been tested ok on uhci.
47 					  To use 3 on ohci, you'd need a patch:
48 					  look for "0000425-linux-2.6.9-rc4-mm1_ohci-hcd.patch.gz" on
49 					  "https://bugtrack.alsa-project.org/alsa-bug/bug_view_page.php?bug_id=0000425"
50 					  .
51 					  1, 2 and 4 work out of the box on ohci, if I recall correctly.
52 					  Bigger is safer operation,
53 					  smaller gives lower latencies.
54 					*/
55 #define USX2Y_NRPACKS_VARIABLE y	/* If your system works ok with this module's parameter
56 					   nrpacks set to 1, you might as well comment
57 					   this #define out, and thereby produce smaller, faster code.
58 					   You'd also set USX2Y_NRPACKS to 1 then.
59 					*/
60 
61 #ifdef USX2Y_NRPACKS_VARIABLE
62  static int nrpacks = USX2Y_NRPACKS; /* number of packets per urb */
63  #define  nr_of_packs() nrpacks
64  module_param(nrpacks, int, 0444);
65  MODULE_PARM_DESC(nrpacks, "Number of packets per URB.");
66 #else
67  #define nr_of_packs() USX2Y_NRPACKS
68 #endif
69 
70 
71 static int usX2Y_urb_capt_retire(struct snd_usX2Y_substream *subs)
72 {
73 	struct urb	*urb = subs->completed_urb;
74 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
75 	unsigned char	*cp;
76 	int 		i, len, lens = 0, hwptr_done = subs->hwptr_done;
77 	struct usX2Ydev	*usX2Y = subs->usX2Y;
78 
79 	for (i = 0; i < nr_of_packs(); i++) {
80 		cp = (unsigned char*)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
81 		if (urb->iso_frame_desc[i].status) { /* active? hmm, skip this */
82 			snd_printk(KERN_ERR "active frame status %i. "
83 				   "Most probably some hardware problem.\n",
84 				   urb->iso_frame_desc[i].status);
85 			return urb->iso_frame_desc[i].status;
86 		}
87 		len = urb->iso_frame_desc[i].actual_length / usX2Y->stride;
88 		if (! len) {
89 			snd_printd("0 == len ERROR!\n");
90 			continue;
91 		}
92 
93 		/* copy a data chunk */
94 		if ((hwptr_done + len) > runtime->buffer_size) {
95 			int cnt = runtime->buffer_size - hwptr_done;
96 			int blen = cnt * usX2Y->stride;
97 			memcpy(runtime->dma_area + hwptr_done * usX2Y->stride, cp, blen);
98 			memcpy(runtime->dma_area, cp + blen, len * usX2Y->stride - blen);
99 		} else {
100 			memcpy(runtime->dma_area + hwptr_done * usX2Y->stride, cp,
101 			       len * usX2Y->stride);
102 		}
103 		lens += len;
104 		if ((hwptr_done += len) >= runtime->buffer_size)
105 			hwptr_done -= runtime->buffer_size;
106 	}
107 
108 	subs->hwptr_done = hwptr_done;
109 	subs->transfer_done += lens;
110 	/* update the pointer, call callback if necessary */
111 	if (subs->transfer_done >= runtime->period_size) {
112 		subs->transfer_done -= runtime->period_size;
113 		snd_pcm_period_elapsed(subs->pcm_substream);
114 	}
115 	return 0;
116 }
117 /*
118  * prepare urb for playback data pipe
119  *
120  * we copy the data directly from the pcm buffer.
121  * the current position to be copied is held in hwptr field.
122  * since a urb can handle only a single linear buffer, if the total
123  * transferred area overflows the buffer boundary, we cannot send
124  * it directly from the buffer.  thus the data is once copied to
125  * a temporary buffer and urb points to that.
126  */
127 static int usX2Y_urb_play_prepare(struct snd_usX2Y_substream *subs,
128 				  struct urb *cap_urb,
129 				  struct urb *urb)
130 {
131 	int count, counts, pack;
132 	struct usX2Ydev *usX2Y = subs->usX2Y;
133 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
134 
135 	count = 0;
136 	for (pack = 0; pack <  nr_of_packs(); pack++) {
137 		/* calculate the size of a packet */
138 		counts = cap_urb->iso_frame_desc[pack].actual_length / usX2Y->stride;
139 		count += counts;
140 		if (counts < 43 || counts > 50) {
141 			snd_printk(KERN_ERR "should not be here with counts=%i\n", counts);
142 			return -EPIPE;
143 		}
144 		/* set up descriptor */
145 		urb->iso_frame_desc[pack].offset = pack ?
146 			urb->iso_frame_desc[pack - 1].offset +
147 			urb->iso_frame_desc[pack - 1].length :
148 			0;
149 		urb->iso_frame_desc[pack].length = cap_urb->iso_frame_desc[pack].actual_length;
150 	}
151 	if (atomic_read(&subs->state) >= state_PRERUNNING)
152 		if (subs->hwptr + count > runtime->buffer_size) {
153 			/* err, the transferred area goes over buffer boundary.
154 			 * copy the data to the temp buffer.
155 			 */
156 			int len;
157 			len = runtime->buffer_size - subs->hwptr;
158 			urb->transfer_buffer = subs->tmpbuf;
159 			memcpy(subs->tmpbuf, runtime->dma_area +
160 			       subs->hwptr * usX2Y->stride, len * usX2Y->stride);
161 			memcpy(subs->tmpbuf + len * usX2Y->stride,
162 			       runtime->dma_area, (count - len) * usX2Y->stride);
163 			subs->hwptr += count;
164 			subs->hwptr -= runtime->buffer_size;
165 		} else {
166 			/* set the buffer pointer */
167 			urb->transfer_buffer = runtime->dma_area + subs->hwptr * usX2Y->stride;
168 			if ((subs->hwptr += count) >= runtime->buffer_size)
169 			subs->hwptr -= runtime->buffer_size;
170 		}
171 	else
172 		urb->transfer_buffer = subs->tmpbuf;
173 	urb->transfer_buffer_length = count * usX2Y->stride;
174 	return 0;
175 }
176 
177 /*
178  * process after playback data complete
179  *
180  * update the current position and call callback if a period is processed.
181  */
182 static void usX2Y_urb_play_retire(struct snd_usX2Y_substream *subs, struct urb *urb)
183 {
184 	struct snd_pcm_runtime *runtime = subs->pcm_substream->runtime;
185 	int		len = urb->actual_length / subs->usX2Y->stride;
186 
187 	subs->transfer_done += len;
188 	subs->hwptr_done +=  len;
189 	if (subs->hwptr_done >= runtime->buffer_size)
190 		subs->hwptr_done -= runtime->buffer_size;
191 	if (subs->transfer_done >= runtime->period_size) {
192 		subs->transfer_done -= runtime->period_size;
193 		snd_pcm_period_elapsed(subs->pcm_substream);
194 	}
195 }
196 
197 static int usX2Y_urb_submit(struct snd_usX2Y_substream *subs, struct urb *urb, int frame)
198 {
199 	int err;
200 	if (!urb)
201 		return -ENODEV;
202 	urb->start_frame = (frame + NRURBS * nr_of_packs());  // let hcd do rollover sanity checks
203 	urb->hcpriv = NULL;
204 	urb->dev = subs->usX2Y->dev; /* we need to set this at each time */
205 	if ((err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
206 		snd_printk(KERN_ERR "usb_submit_urb() returned %i\n", err);
207 		return err;
208 	}
209 	return 0;
210 }
211 
212 static inline int usX2Y_usbframe_complete(struct snd_usX2Y_substream *capsubs,
213 					  struct snd_usX2Y_substream *playbacksubs,
214 					  int frame)
215 {
216 	int err, state;
217 	struct urb *urb = playbacksubs->completed_urb;
218 
219 	state = atomic_read(&playbacksubs->state);
220 	if (NULL != urb) {
221 		if (state == state_RUNNING)
222 			usX2Y_urb_play_retire(playbacksubs, urb);
223 		else if (state >= state_PRERUNNING)
224 			atomic_inc(&playbacksubs->state);
225 	} else {
226 		switch (state) {
227 		case state_STARTING1:
228 			urb = playbacksubs->urb[0];
229 			atomic_inc(&playbacksubs->state);
230 			break;
231 		case state_STARTING2:
232 			urb = playbacksubs->urb[1];
233 			atomic_inc(&playbacksubs->state);
234 			break;
235 		}
236 	}
237 	if (urb) {
238 		if ((err = usX2Y_urb_play_prepare(playbacksubs, capsubs->completed_urb, urb)) ||
239 		    (err = usX2Y_urb_submit(playbacksubs, urb, frame))) {
240 			return err;
241 		}
242 	}
243 
244 	playbacksubs->completed_urb = NULL;
245 
246 	state = atomic_read(&capsubs->state);
247 	if (state >= state_PREPARED) {
248 		if (state == state_RUNNING) {
249 			if ((err = usX2Y_urb_capt_retire(capsubs)))
250 				return err;
251 		} else if (state >= state_PRERUNNING)
252 			atomic_inc(&capsubs->state);
253 		if ((err = usX2Y_urb_submit(capsubs, capsubs->completed_urb, frame)))
254 			return err;
255 	}
256 	capsubs->completed_urb = NULL;
257 	return 0;
258 }
259 
260 
261 static void usX2Y_clients_stop(struct usX2Ydev *usX2Y)
262 {
263 	int s, u;
264 
265 	for (s = 0; s < 4; s++) {
266 		struct snd_usX2Y_substream *subs = usX2Y->subs[s];
267 		if (subs) {
268 			snd_printdd("%i %p state=%i\n", s, subs, atomic_read(&subs->state));
269 			atomic_set(&subs->state, state_STOPPED);
270 		}
271 	}
272 	for (s = 0; s < 4; s++) {
273 		struct snd_usX2Y_substream *subs = usX2Y->subs[s];
274 		if (subs) {
275 			if (atomic_read(&subs->state) >= state_PRERUNNING) {
276 				snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
277 			}
278 			for (u = 0; u < NRURBS; u++) {
279 				struct urb *urb = subs->urb[u];
280 				if (NULL != urb)
281 					snd_printdd("%i status=%i start_frame=%i\n",
282 						    u, urb->status, urb->start_frame);
283 			}
284 		}
285 	}
286 	usX2Y->prepare_subs = NULL;
287 	wake_up(&usX2Y->prepare_wait_queue);
288 }
289 
290 static void usX2Y_error_urb_status(struct usX2Ydev *usX2Y,
291 				   struct snd_usX2Y_substream *subs, struct urb *urb)
292 {
293 	snd_printk(KERN_ERR "ep=%i stalled with status=%i\n", subs->endpoint, urb->status);
294 	urb->status = 0;
295 	usX2Y_clients_stop(usX2Y);
296 }
297 
298 static void usX2Y_error_sequence(struct usX2Ydev *usX2Y,
299 				 struct snd_usX2Y_substream *subs, struct urb *urb)
300 {
301 	snd_printk(KERN_ERR
302 "Sequence Error!(hcd_frame=%i ep=%i%s;wait=%i,frame=%i).\n"
303 "Most probably some urb of usb-frame %i is still missing.\n"
304 "Cause could be too long delays in usb-hcd interrupt handling.\n",
305 		   usb_get_current_frame_number(usX2Y->dev),
306 		   subs->endpoint, usb_pipein(urb->pipe) ? "in" : "out",
307 		   usX2Y->wait_iso_frame, urb->start_frame, usX2Y->wait_iso_frame);
308 	usX2Y_clients_stop(usX2Y);
309 }
310 
311 static void i_usX2Y_urb_complete(struct urb *urb)
312 {
313 	struct snd_usX2Y_substream *subs = urb->context;
314 	struct usX2Ydev *usX2Y = subs->usX2Y;
315 
316 	if (unlikely(atomic_read(&subs->state) < state_PREPARED)) {
317 		snd_printdd("hcd_frame=%i ep=%i%s status=%i start_frame=%i\n",
318 			    usb_get_current_frame_number(usX2Y->dev),
319 			    subs->endpoint, usb_pipein(urb->pipe) ? "in" : "out",
320 			    urb->status, urb->start_frame);
321 		return;
322 	}
323 	if (unlikely(urb->status)) {
324 		usX2Y_error_urb_status(usX2Y, subs, urb);
325 		return;
326 	}
327 	if (likely((urb->start_frame & 0xFFFF) == (usX2Y->wait_iso_frame & 0xFFFF)))
328 		subs->completed_urb = urb;
329 	else {
330 		usX2Y_error_sequence(usX2Y, subs, urb);
331 		return;
332 	}
333 	{
334 		struct snd_usX2Y_substream *capsubs = usX2Y->subs[SNDRV_PCM_STREAM_CAPTURE],
335 			*playbacksubs = usX2Y->subs[SNDRV_PCM_STREAM_PLAYBACK];
336 		if (capsubs->completed_urb &&
337 		    atomic_read(&capsubs->state) >= state_PREPARED &&
338 		    (playbacksubs->completed_urb ||
339 		     atomic_read(&playbacksubs->state) < state_PREPARED)) {
340 			if (!usX2Y_usbframe_complete(capsubs, playbacksubs, urb->start_frame))
341 				usX2Y->wait_iso_frame += nr_of_packs();
342 			else {
343 				snd_printdd("\n");
344 				usX2Y_clients_stop(usX2Y);
345 			}
346 		}
347 	}
348 }
349 
350 static void usX2Y_urbs_set_complete(struct usX2Ydev * usX2Y,
351 				    void (*complete)(struct urb *))
352 {
353 	int s, u;
354 	for (s = 0; s < 4; s++) {
355 		struct snd_usX2Y_substream *subs = usX2Y->subs[s];
356 		if (NULL != subs)
357 			for (u = 0; u < NRURBS; u++) {
358 				struct urb * urb = subs->urb[u];
359 				if (NULL != urb)
360 					urb->complete = complete;
361 			}
362 	}
363 }
364 
365 static void usX2Y_subs_startup_finish(struct usX2Ydev * usX2Y)
366 {
367 	usX2Y_urbs_set_complete(usX2Y, i_usX2Y_urb_complete);
368 	usX2Y->prepare_subs = NULL;
369 }
370 
371 static void i_usX2Y_subs_startup(struct urb *urb)
372 {
373 	struct snd_usX2Y_substream *subs = urb->context;
374 	struct usX2Ydev *usX2Y = subs->usX2Y;
375 	struct snd_usX2Y_substream *prepare_subs = usX2Y->prepare_subs;
376 	if (NULL != prepare_subs)
377 		if (urb->start_frame == prepare_subs->urb[0]->start_frame) {
378 			usX2Y_subs_startup_finish(usX2Y);
379 			atomic_inc(&prepare_subs->state);
380 			wake_up(&usX2Y->prepare_wait_queue);
381 		}
382 
383 	i_usX2Y_urb_complete(urb);
384 }
385 
386 static void usX2Y_subs_prepare(struct snd_usX2Y_substream *subs)
387 {
388 	snd_printdd("usX2Y_substream_prepare(%p) ep=%i urb0=%p urb1=%p\n",
389 		    subs, subs->endpoint, subs->urb[0], subs->urb[1]);
390 	/* reset the pointer */
391 	subs->hwptr = 0;
392 	subs->hwptr_done = 0;
393 	subs->transfer_done = 0;
394 }
395 
396 
397 static void usX2Y_urb_release(struct urb **urb, int free_tb)
398 {
399 	if (*urb) {
400 		usb_kill_urb(*urb);
401 		if (free_tb)
402 			kfree((*urb)->transfer_buffer);
403 		usb_free_urb(*urb);
404 		*urb = NULL;
405 	}
406 }
407 /*
408  * release a substreams urbs
409  */
410 static void usX2Y_urbs_release(struct snd_usX2Y_substream *subs)
411 {
412 	int i;
413 	snd_printdd("usX2Y_urbs_release() %i\n", subs->endpoint);
414 	for (i = 0; i < NRURBS; i++)
415 		usX2Y_urb_release(subs->urb + i,
416 				  subs != subs->usX2Y->subs[SNDRV_PCM_STREAM_PLAYBACK]);
417 
418 	kfree(subs->tmpbuf);
419 	subs->tmpbuf = NULL;
420 }
421 /*
422  * initialize a substream's urbs
423  */
424 static int usX2Y_urbs_allocate(struct snd_usX2Y_substream *subs)
425 {
426 	int i;
427 	unsigned int pipe;
428 	int is_playback = subs == subs->usX2Y->subs[SNDRV_PCM_STREAM_PLAYBACK];
429 	struct usb_device *dev = subs->usX2Y->dev;
430 
431 	pipe = is_playback ? usb_sndisocpipe(dev, subs->endpoint) :
432 			usb_rcvisocpipe(dev, subs->endpoint);
433 	subs->maxpacksize = usb_maxpacket(dev, pipe, is_playback);
434 	if (!subs->maxpacksize)
435 		return -EINVAL;
436 
437 	if (is_playback && NULL == subs->tmpbuf) {	/* allocate a temporary buffer for playback */
438 		subs->tmpbuf = kcalloc(nr_of_packs(), subs->maxpacksize, GFP_KERNEL);
439 		if (NULL == subs->tmpbuf) {
440 			snd_printk(KERN_ERR "cannot malloc tmpbuf\n");
441 			return -ENOMEM;
442 		}
443 	}
444 	/* allocate and initialize data urbs */
445 	for (i = 0; i < NRURBS; i++) {
446 		struct urb **purb = subs->urb + i;
447 		if (*purb) {
448 			usb_kill_urb(*purb);
449 			continue;
450 		}
451 		*purb = usb_alloc_urb(nr_of_packs(), GFP_KERNEL);
452 		if (NULL == *purb) {
453 			usX2Y_urbs_release(subs);
454 			return -ENOMEM;
455 		}
456 		if (!is_playback && !(*purb)->transfer_buffer) {
457 			/* allocate a capture buffer per urb */
458 			(*purb)->transfer_buffer = kmalloc(subs->maxpacksize * nr_of_packs(), GFP_KERNEL);
459 			if (NULL == (*purb)->transfer_buffer) {
460 				usX2Y_urbs_release(subs);
461 				return -ENOMEM;
462 			}
463 		}
464 		(*purb)->dev = dev;
465 		(*purb)->pipe = pipe;
466 		(*purb)->number_of_packets = nr_of_packs();
467 		(*purb)->context = subs;
468 		(*purb)->interval = 1;
469 		(*purb)->complete = i_usX2Y_subs_startup;
470 	}
471 	return 0;
472 }
473 
474 static void usX2Y_subs_startup(struct snd_usX2Y_substream *subs)
475 {
476 	struct usX2Ydev *usX2Y = subs->usX2Y;
477 	usX2Y->prepare_subs = subs;
478 	subs->urb[0]->start_frame = -1;
479 	wmb();
480 	usX2Y_urbs_set_complete(usX2Y, i_usX2Y_subs_startup);
481 }
482 
483 static int usX2Y_urbs_start(struct snd_usX2Y_substream *subs)
484 {
485 	int i, err;
486 	struct usX2Ydev *usX2Y = subs->usX2Y;
487 
488 	if ((err = usX2Y_urbs_allocate(subs)) < 0)
489 		return err;
490 	subs->completed_urb = NULL;
491 	for (i = 0; i < 4; i++) {
492 		struct snd_usX2Y_substream *subs = usX2Y->subs[i];
493 		if (subs != NULL && atomic_read(&subs->state) >= state_PREPARED)
494 			goto start;
495 	}
496 
497  start:
498 	usX2Y_subs_startup(subs);
499 	for (i = 0; i < NRURBS; i++) {
500 		struct urb *urb = subs->urb[i];
501 		if (usb_pipein(urb->pipe)) {
502 			unsigned long pack;
503 			if (0 == i)
504 				atomic_set(&subs->state, state_STARTING3);
505 			urb->dev = usX2Y->dev;
506 			urb->transfer_flags = URB_ISO_ASAP;
507 			for (pack = 0; pack < nr_of_packs(); pack++) {
508 				urb->iso_frame_desc[pack].offset = subs->maxpacksize * pack;
509 				urb->iso_frame_desc[pack].length = subs->maxpacksize;
510 			}
511 			urb->transfer_buffer_length = subs->maxpacksize * nr_of_packs();
512 			if ((err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
513 				snd_printk (KERN_ERR "cannot submit datapipe for urb %d, err = %d\n", i, err);
514 				err = -EPIPE;
515 				goto cleanup;
516 			} else
517 				if (i == 0)
518 					usX2Y->wait_iso_frame = urb->start_frame;
519 			urb->transfer_flags = 0;
520 		} else {
521 			atomic_set(&subs->state, state_STARTING1);
522 			break;
523 		}
524 	}
525 	err = 0;
526 	wait_event(usX2Y->prepare_wait_queue, NULL == usX2Y->prepare_subs);
527 	if (atomic_read(&subs->state) != state_PREPARED)
528 		err = -EPIPE;
529 
530  cleanup:
531 	if (err) {
532 		usX2Y_subs_startup_finish(usX2Y);
533 		usX2Y_clients_stop(usX2Y);		// something is completely wroong > stop evrything
534 	}
535 	return err;
536 }
537 
538 /*
539  * return the current pcm pointer.  just return the hwptr_done value.
540  */
541 static snd_pcm_uframes_t snd_usX2Y_pcm_pointer(struct snd_pcm_substream *substream)
542 {
543 	struct snd_usX2Y_substream *subs = substream->runtime->private_data;
544 	return subs->hwptr_done;
545 }
546 /*
547  * start/stop substream
548  */
549 static int snd_usX2Y_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
550 {
551 	struct snd_usX2Y_substream *subs = substream->runtime->private_data;
552 
553 	switch (cmd) {
554 	case SNDRV_PCM_TRIGGER_START:
555 		snd_printdd("snd_usX2Y_pcm_trigger(START)\n");
556 		if (atomic_read(&subs->state) == state_PREPARED &&
557 		    atomic_read(&subs->usX2Y->subs[SNDRV_PCM_STREAM_CAPTURE]->state) >= state_PREPARED) {
558 			atomic_set(&subs->state, state_PRERUNNING);
559 		} else {
560 			snd_printdd("\n");
561 			return -EPIPE;
562 		}
563 		break;
564 	case SNDRV_PCM_TRIGGER_STOP:
565 		snd_printdd("snd_usX2Y_pcm_trigger(STOP)\n");
566 		if (atomic_read(&subs->state) >= state_PRERUNNING)
567 			atomic_set(&subs->state, state_PREPARED);
568 		break;
569 	default:
570 		return -EINVAL;
571 	}
572 	return 0;
573 }
574 
575 
576 /*
577  * allocate a buffer, setup samplerate
578  *
579  * so far we use a physically linear buffer although packetize transfer
580  * doesn't need a continuous area.
581  * if sg buffer is supported on the later version of alsa, we'll follow
582  * that.
583  */
584 static struct s_c2
585 {
586 	char c1, c2;
587 }
588 	SetRate44100[] =
589 {
590 	{ 0x14, 0x08},	// this line sets 44100, well actually a little less
591 	{ 0x18, 0x40},	// only tascam / frontier design knows the further lines .......
592 	{ 0x18, 0x42},
593 	{ 0x18, 0x45},
594 	{ 0x18, 0x46},
595 	{ 0x18, 0x48},
596 	{ 0x18, 0x4A},
597 	{ 0x18, 0x4C},
598 	{ 0x18, 0x4E},
599 	{ 0x18, 0x50},
600 	{ 0x18, 0x52},
601 	{ 0x18, 0x54},
602 	{ 0x18, 0x56},
603 	{ 0x18, 0x58},
604 	{ 0x18, 0x5A},
605 	{ 0x18, 0x5C},
606 	{ 0x18, 0x5E},
607 	{ 0x18, 0x60},
608 	{ 0x18, 0x62},
609 	{ 0x18, 0x64},
610 	{ 0x18, 0x66},
611 	{ 0x18, 0x68},
612 	{ 0x18, 0x6A},
613 	{ 0x18, 0x6C},
614 	{ 0x18, 0x6E},
615 	{ 0x18, 0x70},
616 	{ 0x18, 0x72},
617 	{ 0x18, 0x74},
618 	{ 0x18, 0x76},
619 	{ 0x18, 0x78},
620 	{ 0x18, 0x7A},
621 	{ 0x18, 0x7C},
622 	{ 0x18, 0x7E}
623 };
624 static struct s_c2 SetRate48000[] =
625 {
626 	{ 0x14, 0x09},	// this line sets 48000, well actually a little less
627 	{ 0x18, 0x40},	// only tascam / frontier design knows the further lines .......
628 	{ 0x18, 0x42},
629 	{ 0x18, 0x45},
630 	{ 0x18, 0x46},
631 	{ 0x18, 0x48},
632 	{ 0x18, 0x4A},
633 	{ 0x18, 0x4C},
634 	{ 0x18, 0x4E},
635 	{ 0x18, 0x50},
636 	{ 0x18, 0x52},
637 	{ 0x18, 0x54},
638 	{ 0x18, 0x56},
639 	{ 0x18, 0x58},
640 	{ 0x18, 0x5A},
641 	{ 0x18, 0x5C},
642 	{ 0x18, 0x5E},
643 	{ 0x18, 0x60},
644 	{ 0x18, 0x62},
645 	{ 0x18, 0x64},
646 	{ 0x18, 0x66},
647 	{ 0x18, 0x68},
648 	{ 0x18, 0x6A},
649 	{ 0x18, 0x6C},
650 	{ 0x18, 0x6E},
651 	{ 0x18, 0x70},
652 	{ 0x18, 0x73},
653 	{ 0x18, 0x74},
654 	{ 0x18, 0x76},
655 	{ 0x18, 0x78},
656 	{ 0x18, 0x7A},
657 	{ 0x18, 0x7C},
658 	{ 0x18, 0x7E}
659 };
660 #define NOOF_SETRATE_URBS ARRAY_SIZE(SetRate48000)
661 
662 static void i_usX2Y_04Int(struct urb *urb)
663 {
664 	struct usX2Ydev *usX2Y = urb->context;
665 
666 	if (urb->status)
667 		snd_printk(KERN_ERR "snd_usX2Y_04Int() urb->status=%i\n", urb->status);
668 	if (0 == --usX2Y->US04->len)
669 		wake_up(&usX2Y->In04WaitQueue);
670 }
671 
672 static int usX2Y_rate_set(struct usX2Ydev *usX2Y, int rate)
673 {
674 	int			err = 0, i;
675 	struct snd_usX2Y_urbSeq	*us = NULL;
676 	int			*usbdata = NULL;
677 	struct s_c2		*ra = rate == 48000 ? SetRate48000 : SetRate44100;
678 
679 	if (usX2Y->rate != rate) {
680 		us = kzalloc(sizeof(*us) + sizeof(struct urb*) * NOOF_SETRATE_URBS, GFP_KERNEL);
681 		if (NULL == us) {
682 			err = -ENOMEM;
683 			goto cleanup;
684 		}
685 		usbdata = kmalloc(sizeof(int) * NOOF_SETRATE_URBS, GFP_KERNEL);
686 		if (NULL == usbdata) {
687 			err = -ENOMEM;
688 			goto cleanup;
689 		}
690 		for (i = 0; i < NOOF_SETRATE_URBS; ++i) {
691 			if (NULL == (us->urb[i] = usb_alloc_urb(0, GFP_KERNEL))) {
692 				err = -ENOMEM;
693 				goto cleanup;
694 			}
695 			((char*)(usbdata + i))[0] = ra[i].c1;
696 			((char*)(usbdata + i))[1] = ra[i].c2;
697 			usb_fill_bulk_urb(us->urb[i], usX2Y->dev, usb_sndbulkpipe(usX2Y->dev, 4),
698 					  usbdata + i, 2, i_usX2Y_04Int, usX2Y);
699 #ifdef OLD_USB
700 			us->urb[i]->transfer_flags = USB_QUEUE_BULK;
701 #endif
702 		}
703 		us->submitted =	0;
704 		us->len =	NOOF_SETRATE_URBS;
705 		usX2Y->US04 =	us;
706 		wait_event_timeout(usX2Y->In04WaitQueue, 0 == us->len, HZ);
707 		usX2Y->US04 =	NULL;
708 		if (us->len)
709 			err = -ENODEV;
710 	cleanup:
711 		if (us) {
712 			us->submitted =	2*NOOF_SETRATE_URBS;
713 			for (i = 0; i < NOOF_SETRATE_URBS; ++i) {
714 				struct urb *urb = us->urb[i];
715 				if (urb->status) {
716 					if (!err)
717 						err = -ENODEV;
718 					usb_kill_urb(urb);
719 				}
720 				usb_free_urb(urb);
721 			}
722 			usX2Y->US04 = NULL;
723 			kfree(usbdata);
724 			kfree(us);
725 			if (!err)
726 				usX2Y->rate = rate;
727 		}
728 	}
729 
730 	return err;
731 }
732 
733 
734 static int usX2Y_format_set(struct usX2Ydev *usX2Y, snd_pcm_format_t format)
735 {
736 	int alternate, err;
737 	struct list_head* p;
738 	if (format == SNDRV_PCM_FORMAT_S24_3LE) {
739 		alternate = 2;
740 		usX2Y->stride = 6;
741 	} else {
742 		alternate = 1;
743 		usX2Y->stride = 4;
744 	}
745 	list_for_each(p, &usX2Y->midi_list) {
746 		snd_usbmidi_input_stop(p);
747 	}
748 	usb_kill_urb(usX2Y->In04urb);
749 	if ((err = usb_set_interface(usX2Y->dev, 0, alternate))) {
750 		snd_printk(KERN_ERR "usb_set_interface error \n");
751 		return err;
752 	}
753 	usX2Y->In04urb->dev = usX2Y->dev;
754 	err = usb_submit_urb(usX2Y->In04urb, GFP_KERNEL);
755 	list_for_each(p, &usX2Y->midi_list) {
756 		snd_usbmidi_input_start(p);
757 	}
758 	usX2Y->format = format;
759 	usX2Y->rate = 0;
760 	return err;
761 }
762 
763 
764 static int snd_usX2Y_pcm_hw_params(struct snd_pcm_substream *substream,
765 				   struct snd_pcm_hw_params *hw_params)
766 {
767 	int			err = 0;
768 	unsigned int		rate = params_rate(hw_params);
769 	snd_pcm_format_t	format = params_format(hw_params);
770 	struct snd_card *card = substream->pstr->pcm->card;
771 	struct list_head *list;
772 
773 	snd_printdd("snd_usX2Y_hw_params(%p, %p)\n", substream, hw_params);
774 	// all pcm substreams off one usX2Y have to operate at the same rate & format
775 	list_for_each(list, &card->devices) {
776 		struct snd_device *dev;
777 		struct snd_pcm *pcm;
778 		int s;
779 		dev = snd_device(list);
780 		if (dev->type != SNDRV_DEV_PCM)
781 			continue;
782 		pcm = dev->device_data;
783 		for (s = 0; s < 2; ++s) {
784 			struct snd_pcm_substream *test_substream;
785 			test_substream = pcm->streams[s].substream;
786 			if (test_substream && test_substream != substream  &&
787 			    test_substream->runtime &&
788 			    ((test_substream->runtime->format &&
789 			      test_substream->runtime->format != format) ||
790 			     (test_substream->runtime->rate &&
791 			      test_substream->runtime->rate != rate)))
792 				return -EINVAL;
793 		}
794 	}
795 	if (0 > (err = snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params)))) {
796 		snd_printk(KERN_ERR "snd_pcm_lib_malloc_pages(%p, %i) returned %i\n",
797 			   substream, params_buffer_bytes(hw_params), err);
798 		return err;
799 	}
800 	return 0;
801 }
802 
803 /*
804  * free the buffer
805  */
806 static int snd_usX2Y_pcm_hw_free(struct snd_pcm_substream *substream)
807 {
808 	struct snd_pcm_runtime *runtime = substream->runtime;
809 	struct snd_usX2Y_substream *subs = runtime->private_data;
810 	mutex_lock(&subs->usX2Y->prepare_mutex);
811 	snd_printdd("snd_usX2Y_hw_free(%p)\n", substream);
812 
813 	if (SNDRV_PCM_STREAM_PLAYBACK == substream->stream) {
814 		struct snd_usX2Y_substream *cap_subs = subs->usX2Y->subs[SNDRV_PCM_STREAM_CAPTURE];
815 		atomic_set(&subs->state, state_STOPPED);
816 		usX2Y_urbs_release(subs);
817 		if (!cap_subs->pcm_substream ||
818 		    !cap_subs->pcm_substream->runtime ||
819 		    !cap_subs->pcm_substream->runtime->status ||
820 		    cap_subs->pcm_substream->runtime->status->state < SNDRV_PCM_STATE_PREPARED) {
821 			atomic_set(&cap_subs->state, state_STOPPED);
822 			usX2Y_urbs_release(cap_subs);
823 		}
824 	} else {
825 		struct snd_usX2Y_substream *playback_subs = subs->usX2Y->subs[SNDRV_PCM_STREAM_PLAYBACK];
826 		if (atomic_read(&playback_subs->state) < state_PREPARED) {
827 			atomic_set(&subs->state, state_STOPPED);
828 			usX2Y_urbs_release(subs);
829 		}
830 	}
831 	mutex_unlock(&subs->usX2Y->prepare_mutex);
832 	return snd_pcm_lib_free_pages(substream);
833 }
834 /*
835  * prepare callback
836  *
837  * set format and initialize urbs
838  */
839 static int snd_usX2Y_pcm_prepare(struct snd_pcm_substream *substream)
840 {
841 	struct snd_pcm_runtime *runtime = substream->runtime;
842 	struct snd_usX2Y_substream *subs = runtime->private_data;
843 	struct usX2Ydev *usX2Y = subs->usX2Y;
844 	struct snd_usX2Y_substream *capsubs = subs->usX2Y->subs[SNDRV_PCM_STREAM_CAPTURE];
845 	int err = 0;
846 	snd_printdd("snd_usX2Y_pcm_prepare(%p)\n", substream);
847 
848 	mutex_lock(&usX2Y->prepare_mutex);
849 	usX2Y_subs_prepare(subs);
850 // Start hardware streams
851 // SyncStream first....
852 	if (atomic_read(&capsubs->state) < state_PREPARED) {
853 		if (usX2Y->format != runtime->format)
854 			if ((err = usX2Y_format_set(usX2Y, runtime->format)) < 0)
855 				goto up_prepare_mutex;
856 		if (usX2Y->rate != runtime->rate)
857 			if ((err = usX2Y_rate_set(usX2Y, runtime->rate)) < 0)
858 				goto up_prepare_mutex;
859 		snd_printdd("starting capture pipe for %s\n", subs == capsubs ? "self" : "playpipe");
860 		if (0 > (err = usX2Y_urbs_start(capsubs)))
861 			goto up_prepare_mutex;
862 	}
863 
864 	if (subs != capsubs && atomic_read(&subs->state) < state_PREPARED)
865 		err = usX2Y_urbs_start(subs);
866 
867  up_prepare_mutex:
868 	mutex_unlock(&usX2Y->prepare_mutex);
869 	return err;
870 }
871 
872 static struct snd_pcm_hardware snd_usX2Y_2c =
873 {
874 	.info =			(SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
875 				 SNDRV_PCM_INFO_BLOCK_TRANSFER |
876 				 SNDRV_PCM_INFO_MMAP_VALID |
877 				 SNDRV_PCM_INFO_BATCH),
878 	.formats =                 SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_3LE,
879 	.rates =                   SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000,
880 	.rate_min =                44100,
881 	.rate_max =                48000,
882 	.channels_min =            2,
883 	.channels_max =            2,
884 	.buffer_bytes_max =	(2*128*1024),
885 	.period_bytes_min =	64,
886 	.period_bytes_max =	(128*1024),
887 	.periods_min =		2,
888 	.periods_max =		1024,
889 	.fifo_size =              0
890 };
891 
892 
893 
894 static int snd_usX2Y_pcm_open(struct snd_pcm_substream *substream)
895 {
896 	struct snd_usX2Y_substream	*subs = ((struct snd_usX2Y_substream **)
897 					 snd_pcm_substream_chip(substream))[substream->stream];
898 	struct snd_pcm_runtime	*runtime = substream->runtime;
899 
900 	if (subs->usX2Y->chip_status & USX2Y_STAT_CHIP_MMAP_PCM_URBS)
901 		return -EBUSY;
902 
903 	runtime->hw = snd_usX2Y_2c;
904 	runtime->private_data = subs;
905 	subs->pcm_substream = substream;
906 	snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME, 1000, 200000);
907 	return 0;
908 }
909 
910 
911 
912 static int snd_usX2Y_pcm_close(struct snd_pcm_substream *substream)
913 {
914 	struct snd_pcm_runtime *runtime = substream->runtime;
915 	struct snd_usX2Y_substream *subs = runtime->private_data;
916 
917 	subs->pcm_substream = NULL;
918 
919 	return 0;
920 }
921 
922 
923 static struct snd_pcm_ops snd_usX2Y_pcm_ops =
924 {
925 	.open =		snd_usX2Y_pcm_open,
926 	.close =	snd_usX2Y_pcm_close,
927 	.ioctl =	snd_pcm_lib_ioctl,
928 	.hw_params =	snd_usX2Y_pcm_hw_params,
929 	.hw_free =	snd_usX2Y_pcm_hw_free,
930 	.prepare =	snd_usX2Y_pcm_prepare,
931 	.trigger =	snd_usX2Y_pcm_trigger,
932 	.pointer =	snd_usX2Y_pcm_pointer,
933 };
934 
935 
936 /*
937  * free a usb stream instance
938  */
939 static void usX2Y_audio_stream_free(struct snd_usX2Y_substream **usX2Y_substream)
940 {
941 	kfree(usX2Y_substream[SNDRV_PCM_STREAM_PLAYBACK]);
942 	usX2Y_substream[SNDRV_PCM_STREAM_PLAYBACK] = NULL;
943 
944 	kfree(usX2Y_substream[SNDRV_PCM_STREAM_CAPTURE]);
945 	usX2Y_substream[SNDRV_PCM_STREAM_CAPTURE] = NULL;
946 }
947 
948 static void snd_usX2Y_pcm_private_free(struct snd_pcm *pcm)
949 {
950 	struct snd_usX2Y_substream **usX2Y_stream = pcm->private_data;
951 	if (usX2Y_stream)
952 		usX2Y_audio_stream_free(usX2Y_stream);
953 }
954 
955 static int usX2Y_audio_stream_new(struct snd_card *card, int playback_endpoint, int capture_endpoint)
956 {
957 	struct snd_pcm *pcm;
958 	int err, i;
959 	struct snd_usX2Y_substream **usX2Y_substream =
960 		usX2Y(card)->subs + 2 * usX2Y(card)->pcm_devs;
961 
962 	for (i = playback_endpoint ? SNDRV_PCM_STREAM_PLAYBACK : SNDRV_PCM_STREAM_CAPTURE;
963 	     i <= SNDRV_PCM_STREAM_CAPTURE; ++i) {
964 		usX2Y_substream[i] = kzalloc(sizeof(struct snd_usX2Y_substream), GFP_KERNEL);
965 		if (NULL == usX2Y_substream[i]) {
966 			snd_printk(KERN_ERR "cannot malloc\n");
967 			return -ENOMEM;
968 		}
969 		usX2Y_substream[i]->usX2Y = usX2Y(card);
970 	}
971 
972 	if (playback_endpoint)
973 		usX2Y_substream[SNDRV_PCM_STREAM_PLAYBACK]->endpoint = playback_endpoint;
974 	usX2Y_substream[SNDRV_PCM_STREAM_CAPTURE]->endpoint = capture_endpoint;
975 
976 	err = snd_pcm_new(card, NAME_ALLCAPS" Audio", usX2Y(card)->pcm_devs,
977 			  playback_endpoint ? 1 : 0, 1,
978 			  &pcm);
979 	if (err < 0) {
980 		usX2Y_audio_stream_free(usX2Y_substream);
981 		return err;
982 	}
983 
984 	if (playback_endpoint)
985 		snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_usX2Y_pcm_ops);
986 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_usX2Y_pcm_ops);
987 
988 	pcm->private_data = usX2Y_substream;
989 	pcm->private_free = snd_usX2Y_pcm_private_free;
990 	pcm->info_flags = 0;
991 
992 	sprintf(pcm->name, NAME_ALLCAPS" Audio #%d", usX2Y(card)->pcm_devs);
993 
994 	if ((playback_endpoint &&
995 	     0 > (err = snd_pcm_lib_preallocate_pages(pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream,
996 						     SNDRV_DMA_TYPE_CONTINUOUS,
997 						     snd_dma_continuous_data(GFP_KERNEL),
998 						     64*1024, 128*1024))) ||
999 	    0 > (err = snd_pcm_lib_preallocate_pages(pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream,
1000 	    					     SNDRV_DMA_TYPE_CONTINUOUS,
1001 	    					     snd_dma_continuous_data(GFP_KERNEL),
1002 						     64*1024, 128*1024))) {
1003 		snd_usX2Y_pcm_private_free(pcm);
1004 		return err;
1005 	}
1006 	usX2Y(card)->pcm_devs++;
1007 
1008 	return 0;
1009 }
1010 
1011 /*
1012  * create a chip instance and set its names.
1013  */
1014 int usX2Y_audio_create(struct snd_card *card)
1015 {
1016 	int err = 0;
1017 
1018 	INIT_LIST_HEAD(&usX2Y(card)->pcm_list);
1019 
1020 	if (0 > (err = usX2Y_audio_stream_new(card, 0xA, 0x8)))
1021 		return err;
1022 	if (le16_to_cpu(usX2Y(card)->dev->descriptor.idProduct) == USB_ID_US428)
1023 	     if (0 > (err = usX2Y_audio_stream_new(card, 0, 0xA)))
1024 		     return err;
1025 	if (le16_to_cpu(usX2Y(card)->dev->descriptor.idProduct) != USB_ID_US122)
1026 		err = usX2Y_rate_set(usX2Y(card), 44100);	// Lets us428 recognize output-volume settings, disturbs us122.
1027 	return err;
1028 }
1029