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