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