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