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