1/*
2 *   (Tentative) USB Audio Driver for ALSA
3 *
4 *   Main and PCM part
5 *
6 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7 *
8 *   Many codes borrowed from audio.c by
9 *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
10 *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
11 *
12 *
13 *   This program is free software; you can redistribute it and/or modify
14 *   it under the terms of the GNU General Public License as published by
15 *   the Free Software Foundation; either version 2 of the License, or
16 *   (at your option) any later version.
17 *
18 *   This program is distributed in the hope that it will be useful,
19 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
20 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 *   GNU General Public License for more details.
22 *
23 *   You should have received a copy of the GNU General Public License
24 *   along with this program; if not, write to the Free Software
25 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
26 *
27 *
28 *  NOTES:
29 *
30 *   - async unlink should be used for avoiding the sleep inside lock.
31 *     2.4.22 usb-uhci seems buggy for async unlinking and results in
32 *     oops.  in such a cse, pass async_unlink=0 option.
33 *   - the linked URBs would be preferred but not used so far because of
34 *     the instability of unlinking.
35 *   - type II is not supported properly.  there is no device which supports
36 *     this type *correctly*.  SB extigy looks as if it supports, but it's
37 *     indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
38 */
39
40
41#include <sound/driver.h>
42#include <linux/bitops.h>
43#include <linux/init.h>
44#include <linux/list.h>
45#include <linux/slab.h>
46#include <linux/string.h>
47#include <linux/usb.h>
48#include <linux/vmalloc.h>
49#include <linux/moduleparam.h>
50#include <linux/mutex.h>
51#include <sound/core.h>
52#include <sound/info.h>
53#include <sound/pcm.h>
54#include <sound/pcm_params.h>
55#include <sound/initval.h>
56
57#include "usbaudio.h"
58
59
60MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
61MODULE_DESCRIPTION("USB Audio");
62MODULE_LICENSE("GPL");
63MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
64
65
66static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
67static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
68static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;	/* Enable this card */
69static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Vendor ID for this card */
70static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; /* Product ID for this card */
71static int nrpacks = 8;		/* max. number of packets per urb */
72static int async_unlink = 1;
73static int device_setup[SNDRV_CARDS]; /* device parameter for this card*/
74
75module_param_array(index, int, NULL, 0444);
76MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
77module_param_array(id, charp, NULL, 0444);
78MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
79module_param_array(enable, bool, NULL, 0444);
80MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
81module_param_array(vid, int, NULL, 0444);
82MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
83module_param_array(pid, int, NULL, 0444);
84MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
85module_param(nrpacks, int, 0644);
86MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
87module_param(async_unlink, bool, 0444);
88MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
89module_param_array(device_setup, int, NULL, 0444);
90MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
91
92
93/*
94 * debug the h/w constraints
95 */
96/* #define HW_CONST_DEBUG */
97
98
99/*
100 *
101 */
102
103#define MAX_PACKS	20
104#define MAX_PACKS_HS	(MAX_PACKS * 8)	/* in high speed mode */
105#define MAX_URBS	8
106#define SYNC_URBS	4	/* always four urbs for sync */
107#define MIN_PACKS_URB	1	/* minimum 1 packet per urb */
108
109struct audioformat {
110	struct list_head list;
111	snd_pcm_format_t format;	/* format type */
112	unsigned int channels;		/* # channels */
113	unsigned int fmt_type;		/* USB audio format type (1-3) */
114	unsigned int frame_size;	/* samples per frame for non-audio */
115	int iface;			/* interface number */
116	unsigned char altsetting;	/* corresponding alternate setting */
117	unsigned char altset_idx;	/* array index of altenate setting */
118	unsigned char attributes;	/* corresponding attributes of cs endpoint */
119	unsigned char endpoint;		/* endpoint */
120	unsigned char ep_attr;		/* endpoint attributes */
121	unsigned int maxpacksize;	/* max. packet size */
122	unsigned int rates;		/* rate bitmasks */
123	unsigned int rate_min, rate_max;	/* min/max rates */
124	unsigned int nr_rates;		/* number of rate table entries */
125	unsigned int *rate_table;	/* rate table */
126	unsigned int needs_knot;	/* any unusual rates? */
127};
128
129struct snd_usb_substream;
130
131struct snd_urb_ctx {
132	struct urb *urb;
133	unsigned int buffer_size;	/* size of data buffer, if data URB */
134	struct snd_usb_substream *subs;
135	int index;	/* index for urb array */
136	int packets;	/* number of packets per urb */
137};
138
139struct snd_urb_ops {
140	int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141	int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
142	int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
143	int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
144};
145
146struct snd_usb_substream {
147	struct snd_usb_stream *stream;
148	struct usb_device *dev;
149	struct snd_pcm_substream *pcm_substream;
150	int direction;	/* playback or capture */
151	int interface;	/* current interface */
152	int endpoint;	/* assigned endpoint */
153	struct audioformat *cur_audiofmt;	/* current audioformat pointer (for hw_params callback) */
154	unsigned int cur_rate;		/* current rate (for hw_params callback) */
155	unsigned int period_bytes;	/* current period bytes (for hw_params callback) */
156	unsigned int format;     /* USB data format */
157	unsigned int datapipe;   /* the data i/o pipe */
158	unsigned int syncpipe;   /* 1 - async out or adaptive in */
159	unsigned int datainterval;	/* log_2 of data packet interval */
160	unsigned int syncinterval;  /* P for adaptive mode, 0 otherwise */
161	unsigned int freqn;      /* nominal sampling rate in fs/fps in Q16.16 format */
162	unsigned int freqm;      /* momentary sampling rate in fs/fps in Q16.16 format */
163	unsigned int freqmax;    /* maximum sampling rate, used for buffer management */
164	unsigned int phase;      /* phase accumulator */
165	unsigned int maxpacksize;	/* max packet size in bytes */
166	unsigned int maxframesize;	/* max packet size in frames */
167	unsigned int curpacksize;	/* current packet size in bytes (for capture) */
168	unsigned int curframesize;	/* current packet size in frames (for capture) */
169	unsigned int fill_max: 1;	/* fill max packet size always */
170	unsigned int fmt_type;		/* USB audio format type (1-3) */
171	unsigned int packs_per_ms;	/* packets per millisecond (for playback) */
172
173	unsigned int running: 1;	/* running status */
174
175	unsigned int hwptr_done;			/* processed frame position in the buffer */
176	unsigned int transfer_done;		/* processed frames since last period update */
177	unsigned long active_mask;	/* bitmask of active urbs */
178	unsigned long unlink_mask;	/* bitmask of unlinked urbs */
179
180	unsigned int nurbs;			/* # urbs */
181	struct snd_urb_ctx dataurb[MAX_URBS];	/* data urb table */
182	struct snd_urb_ctx syncurb[SYNC_URBS];	/* sync urb table */
183	char *syncbuf;				/* sync buffer for all sync URBs */
184	dma_addr_t sync_dma;			/* DMA address of syncbuf */
185
186	u64 formats;			/* format bitmasks (all or'ed) */
187	unsigned int num_formats;		/* number of supported audio formats (list) */
188	struct list_head fmt_list;	/* format list */
189	struct snd_pcm_hw_constraint_list rate_list;	/* limited rates */
190	spinlock_t lock;
191
192	struct snd_urb_ops ops;		/* callbacks (must be filled at init) */
193};
194
195
196struct snd_usb_stream {
197	struct snd_usb_audio *chip;
198	struct snd_pcm *pcm;
199	int pcm_index;
200	unsigned int fmt_type;		/* USB audio format type (1-3) */
201	struct snd_usb_substream substream[2];
202	struct list_head list;
203};
204
205
206/*
207 * we keep the snd_usb_audio_t instances by ourselves for merging
208 * the all interfaces on the same card as one sound device.
209 */
210
211static DEFINE_MUTEX(register_mutex);
212static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
213
214
215/*
216 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
217 * this will overflow at approx 524 kHz
218 */
219static inline unsigned get_usb_full_speed_rate(unsigned int rate)
220{
221	return ((rate << 13) + 62) / 125;
222}
223
224/*
225 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
226 * this will overflow at approx 4 MHz
227 */
228static inline unsigned get_usb_high_speed_rate(unsigned int rate)
229{
230	return ((rate << 10) + 62) / 125;
231}
232
233/* convert our full speed USB rate into sampling rate in Hz */
234static inline unsigned get_full_speed_hz(unsigned int usb_rate)
235{
236	return (usb_rate * 125 + (1 << 12)) >> 13;
237}
238
239/* convert our high speed USB rate into sampling rate in Hz */
240static inline unsigned get_high_speed_hz(unsigned int usb_rate)
241{
242	return (usb_rate * 125 + (1 << 9)) >> 10;
243}
244
245
246/*
247 * prepare urb for full speed capture sync pipe
248 *
249 * fill the length and offset of each urb descriptor.
250 * the fixed 10.14 frequency is passed through the pipe.
251 */
252static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
253				    struct snd_pcm_runtime *runtime,
254				    struct urb *urb)
255{
256	unsigned char *cp = urb->transfer_buffer;
257	struct snd_urb_ctx *ctx = urb->context;
258
259	urb->dev = ctx->subs->dev; /* we need to set this at each time */
260	urb->iso_frame_desc[0].length = 3;
261	urb->iso_frame_desc[0].offset = 0;
262	cp[0] = subs->freqn >> 2;
263	cp[1] = subs->freqn >> 10;
264	cp[2] = subs->freqn >> 18;
265	return 0;
266}
267
268/*
269 * prepare urb for high speed capture sync pipe
270 *
271 * fill the length and offset of each urb descriptor.
272 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
273 */
274static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
275				       struct snd_pcm_runtime *runtime,
276				       struct urb *urb)
277{
278	unsigned char *cp = urb->transfer_buffer;
279	struct snd_urb_ctx *ctx = urb->context;
280
281	urb->dev = ctx->subs->dev; /* we need to set this at each time */
282	urb->iso_frame_desc[0].length = 4;
283	urb->iso_frame_desc[0].offset = 0;
284	cp[0] = subs->freqn;
285	cp[1] = subs->freqn >> 8;
286	cp[2] = subs->freqn >> 16;
287	cp[3] = subs->freqn >> 24;
288	return 0;
289}
290
291/*
292 * process after capture sync complete
293 * - nothing to do
294 */
295static int retire_capture_sync_urb(struct snd_usb_substream *subs,
296				   struct snd_pcm_runtime *runtime,
297				   struct urb *urb)
298{
299	return 0;
300}
301
302/*
303 * prepare urb for capture data pipe
304 *
305 * fill the offset and length of each descriptor.
306 *
307 * we use a temporary buffer to write the captured data.
308 * since the length of written data is determined by host, we cannot
309 * write onto the pcm buffer directly...  the data is thus copied
310 * later at complete callback to the global buffer.
311 */
312static int prepare_capture_urb(struct snd_usb_substream *subs,
313			       struct snd_pcm_runtime *runtime,
314			       struct urb *urb)
315{
316	int i, offs;
317	struct snd_urb_ctx *ctx = urb->context;
318
319	offs = 0;
320	urb->dev = ctx->subs->dev; /* we need to set this at each time */
321	for (i = 0; i < ctx->packets; i++) {
322		urb->iso_frame_desc[i].offset = offs;
323		urb->iso_frame_desc[i].length = subs->curpacksize;
324		offs += subs->curpacksize;
325	}
326	urb->transfer_buffer_length = offs;
327	urb->number_of_packets = ctx->packets;
328	return 0;
329}
330
331/*
332 * process after capture complete
333 *
334 * copy the data from each desctiptor to the pcm buffer, and
335 * update the current position.
336 */
337static int retire_capture_urb(struct snd_usb_substream *subs,
338			      struct snd_pcm_runtime *runtime,
339			      struct urb *urb)
340{
341	unsigned long flags;
342	unsigned char *cp;
343	int i;
344	unsigned int stride, len, oldptr;
345	int period_elapsed = 0;
346
347	stride = runtime->frame_bits >> 3;
348
349	for (i = 0; i < urb->number_of_packets; i++) {
350		cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
351		if (urb->iso_frame_desc[i].status) {
352			snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
353			// continue;
354		}
355		len = urb->iso_frame_desc[i].actual_length / stride;
356		if (! len)
357			continue;
358		/* update the current pointer */
359		spin_lock_irqsave(&subs->lock, flags);
360		oldptr = subs->hwptr_done;
361		subs->hwptr_done += len;
362		if (subs->hwptr_done >= runtime->buffer_size)
363			subs->hwptr_done -= runtime->buffer_size;
364		subs->transfer_done += len;
365		if (subs->transfer_done >= runtime->period_size) {
366			subs->transfer_done -= runtime->period_size;
367			period_elapsed = 1;
368		}
369		spin_unlock_irqrestore(&subs->lock, flags);
370		/* copy a data chunk */
371		if (oldptr + len > runtime->buffer_size) {
372			unsigned int cnt = runtime->buffer_size - oldptr;
373			unsigned int blen = cnt * stride;
374			memcpy(runtime->dma_area + oldptr * stride, cp, blen);
375			memcpy(runtime->dma_area, cp + blen, len * stride - blen);
376		} else {
377			memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
378		}
379	}
380	if (period_elapsed)
381		snd_pcm_period_elapsed(subs->pcm_substream);
382	return 0;
383}
384
385/*
386 * Process after capture complete when paused.  Nothing to do.
387 */
388static int retire_paused_capture_urb(struct snd_usb_substream *subs,
389				     struct snd_pcm_runtime *runtime,
390				     struct urb *urb)
391{
392	return 0;
393}
394
395
396/*
397 * prepare urb for full speed playback sync pipe
398 *
399 * set up the offset and length to receive the current frequency.
400 */
401
402static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
403				     struct snd_pcm_runtime *runtime,
404				     struct urb *urb)
405{
406	struct snd_urb_ctx *ctx = urb->context;
407
408	urb->dev = ctx->subs->dev; /* we need to set this at each time */
409	urb->iso_frame_desc[0].length = 3;
410	urb->iso_frame_desc[0].offset = 0;
411	return 0;
412}
413
414/*
415 * prepare urb for high speed playback sync pipe
416 *
417 * set up the offset and length to receive the current frequency.
418 */
419
420static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
421					struct snd_pcm_runtime *runtime,
422					struct urb *urb)
423{
424	struct snd_urb_ctx *ctx = urb->context;
425
426	urb->dev = ctx->subs->dev; /* we need to set this at each time */
427	urb->iso_frame_desc[0].length = 4;
428	urb->iso_frame_desc[0].offset = 0;
429	return 0;
430}
431
432/*
433 * process after full speed playback sync complete
434 *
435 * retrieve the current 10.14 frequency from pipe, and set it.
436 * the value is referred in prepare_playback_urb().
437 */
438static int retire_playback_sync_urb(struct snd_usb_substream *subs,
439				    struct snd_pcm_runtime *runtime,
440				    struct urb *urb)
441{
442	unsigned int f;
443	unsigned long flags;
444
445	if (urb->iso_frame_desc[0].status == 0 &&
446	    urb->iso_frame_desc[0].actual_length == 3) {
447		f = combine_triple((u8*)urb->transfer_buffer) << 2;
448		if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
449			spin_lock_irqsave(&subs->lock, flags);
450			subs->freqm = f;
451			spin_unlock_irqrestore(&subs->lock, flags);
452		}
453	}
454
455	return 0;
456}
457
458/*
459 * process after high speed playback sync complete
460 *
461 * retrieve the current 12.13 frequency from pipe, and set it.
462 * the value is referred in prepare_playback_urb().
463 */
464static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
465				       struct snd_pcm_runtime *runtime,
466				       struct urb *urb)
467{
468	unsigned int f;
469	unsigned long flags;
470
471	if (urb->iso_frame_desc[0].status == 0 &&
472	    urb->iso_frame_desc[0].actual_length == 4) {
473		f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
474		if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
475			spin_lock_irqsave(&subs->lock, flags);
476			subs->freqm = f;
477			spin_unlock_irqrestore(&subs->lock, flags);
478		}
479	}
480
481	return 0;
482}
483
484/* determine the number of frames in the next packet */
485static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
486{
487	if (subs->fill_max)
488		return subs->maxframesize;
489	else {
490		subs->phase = (subs->phase & 0xffff)
491			+ (subs->freqm << subs->datainterval);
492		return min(subs->phase >> 16, subs->maxframesize);
493	}
494}
495
496/*
497 * Prepare urb for streaming before playback starts or when paused.
498 *
499 * We don't have any data, so we send a frame of silence.
500 */
501static int prepare_nodata_playback_urb(struct snd_usb_substream *subs,
502				       struct snd_pcm_runtime *runtime,
503				       struct urb *urb)
504{
505	unsigned int i, offs, counts;
506	struct snd_urb_ctx *ctx = urb->context;
507	int stride = runtime->frame_bits >> 3;
508
509	offs = 0;
510	urb->dev = ctx->subs->dev;
511	urb->number_of_packets = subs->packs_per_ms;
512	for (i = 0; i < subs->packs_per_ms; ++i) {
513		counts = snd_usb_audio_next_packet_size(subs);
514		urb->iso_frame_desc[i].offset = offs * stride;
515		urb->iso_frame_desc[i].length = counts * stride;
516		offs += counts;
517	}
518	urb->transfer_buffer_length = offs * stride;
519	memset(urb->transfer_buffer,
520	       subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
521	       offs * stride);
522	return 0;
523}
524
525/*
526 * prepare urb for playback data pipe
527 *
528 * Since a URB can handle only a single linear buffer, we must use double
529 * buffering when the data to be transferred overflows the buffer boundary.
530 * To avoid inconsistencies when updating hwptr_done, we use double buffering
531 * for all URBs.
532 */
533static int prepare_playback_urb(struct snd_usb_substream *subs,
534				struct snd_pcm_runtime *runtime,
535				struct urb *urb)
536{
537	int i, stride, offs;
538	unsigned int counts;
539	unsigned long flags;
540	int period_elapsed = 0;
541	struct snd_urb_ctx *ctx = urb->context;
542
543	stride = runtime->frame_bits >> 3;
544
545	offs = 0;
546	urb->dev = ctx->subs->dev; /* we need to set this at each time */
547	urb->number_of_packets = 0;
548	spin_lock_irqsave(&subs->lock, flags);
549	for (i = 0; i < ctx->packets; i++) {
550		counts = snd_usb_audio_next_packet_size(subs);
551		/* set up descriptor */
552		urb->iso_frame_desc[i].offset = offs * stride;
553		urb->iso_frame_desc[i].length = counts * stride;
554		offs += counts;
555		urb->number_of_packets++;
556		subs->transfer_done += counts;
557		if (subs->transfer_done >= runtime->period_size) {
558			subs->transfer_done -= runtime->period_size;
559			period_elapsed = 1;
560			if (subs->fmt_type == USB_FORMAT_TYPE_II) {
561				if (subs->transfer_done > 0) {
562					offs -= subs->transfer_done;
563					counts -= subs->transfer_done;
564					urb->iso_frame_desc[i].length =
565						counts * stride;
566					subs->transfer_done = 0;
567				}
568				i++;
569				if (i < ctx->packets) {
570					/* add a transfer delimiter */
571					urb->iso_frame_desc[i].offset =
572						offs * stride;
573					urb->iso_frame_desc[i].length = 0;
574					urb->number_of_packets++;
575				}
576				break;
577			}
578 		}
579		/* finish at the frame boundary at/after the period boundary */
580		if (period_elapsed &&
581		    (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
582			break;
583	}
584	if (subs->hwptr_done + offs > runtime->buffer_size) {
585		/* err, the transferred area goes over buffer boundary. */
586		unsigned int len = runtime->buffer_size - subs->hwptr_done;
587		memcpy(urb->transfer_buffer,
588		       runtime->dma_area + subs->hwptr_done * stride,
589		       len * stride);
590		memcpy(urb->transfer_buffer + len * stride,
591		       runtime->dma_area,
592		       (offs - len) * stride);
593	} else {
594		memcpy(urb->transfer_buffer,
595		       runtime->dma_area + subs->hwptr_done * stride,
596		       offs * stride);
597	}
598	subs->hwptr_done += offs;
599	if (subs->hwptr_done >= runtime->buffer_size)
600		subs->hwptr_done -= runtime->buffer_size;
601	spin_unlock_irqrestore(&subs->lock, flags);
602	urb->transfer_buffer_length = offs * stride;
603	if (period_elapsed)
604		snd_pcm_period_elapsed(subs->pcm_substream);
605	return 0;
606}
607
608/*
609 * process after playback data complete
610 * - nothing to do
611 */
612static int retire_playback_urb(struct snd_usb_substream *subs,
613			       struct snd_pcm_runtime *runtime,
614			       struct urb *urb)
615{
616	return 0;
617}
618
619
620/*
621 */
622static struct snd_urb_ops audio_urb_ops[2] = {
623	{
624		.prepare =	prepare_nodata_playback_urb,
625		.retire =	retire_playback_urb,
626		.prepare_sync =	prepare_playback_sync_urb,
627		.retire_sync =	retire_playback_sync_urb,
628	},
629	{
630		.prepare =	prepare_capture_urb,
631		.retire =	retire_capture_urb,
632		.prepare_sync =	prepare_capture_sync_urb,
633		.retire_sync =	retire_capture_sync_urb,
634	},
635};
636
637static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
638	{
639		.prepare =	prepare_nodata_playback_urb,
640		.retire =	retire_playback_urb,
641		.prepare_sync =	prepare_playback_sync_urb_hs,
642		.retire_sync =	retire_playback_sync_urb_hs,
643	},
644	{
645		.prepare =	prepare_capture_urb,
646		.retire =	retire_capture_urb,
647		.prepare_sync =	prepare_capture_sync_urb_hs,
648		.retire_sync =	retire_capture_sync_urb,
649	},
650};
651
652/*
653 * complete callback from data urb
654 */
655static void snd_complete_urb(struct urb *urb)
656{
657	struct snd_urb_ctx *ctx = urb->context;
658	struct snd_usb_substream *subs = ctx->subs;
659	struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
660	int err = 0;
661
662	if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
663	    ! subs->running || /* can be stopped during retire callback */
664	    (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
665	    (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
666		clear_bit(ctx->index, &subs->active_mask);
667		if (err < 0) {
668			snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
669			snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
670		}
671	}
672}
673
674
675/*
676 * complete callback from sync urb
677 */
678static void snd_complete_sync_urb(struct urb *urb)
679{
680	struct snd_urb_ctx *ctx = urb->context;
681	struct snd_usb_substream *subs = ctx->subs;
682	struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
683	int err = 0;
684
685	if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
686	    ! subs->running || /* can be stopped during retire callback */
687	    (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
688	    (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
689		clear_bit(ctx->index + 16, &subs->active_mask);
690		if (err < 0) {
691			snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
692			snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
693		}
694	}
695}
696
697
698/* get the physical page pointer at the given offset */
699static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
700					     unsigned long offset)
701{
702	void *pageptr = subs->runtime->dma_area + offset;
703	return vmalloc_to_page(pageptr);
704}
705
706/* allocate virtual buffer; may be called more than once */
707static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
708{
709	struct snd_pcm_runtime *runtime = subs->runtime;
710	if (runtime->dma_area) {
711		if (runtime->dma_bytes >= size)
712			return 0; /* already large enough */
713		vfree(runtime->dma_area);
714	}
715	runtime->dma_area = vmalloc(size);
716	if (! runtime->dma_area)
717		return -ENOMEM;
718	runtime->dma_bytes = size;
719	return 0;
720}
721
722/* free virtual buffer; may be called more than once */
723static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
724{
725	struct snd_pcm_runtime *runtime = subs->runtime;
726
727	vfree(runtime->dma_area);
728	runtime->dma_area = NULL;
729	return 0;
730}
731
732
733/*
734 * unlink active urbs.
735 */
736static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
737{
738	unsigned int i;
739	int async;
740
741	subs->running = 0;
742
743	if (!force && subs->stream->chip->shutdown) /* to be sure... */
744		return -EBADFD;
745
746	async = !can_sleep && async_unlink;
747
748	if (! async && in_interrupt())
749		return 0;
750
751	for (i = 0; i < subs->nurbs; i++) {
752		if (test_bit(i, &subs->active_mask)) {
753			if (! test_and_set_bit(i, &subs->unlink_mask)) {
754				struct urb *u = subs->dataurb[i].urb;
755				if (async)
756					usb_unlink_urb(u);
757				else
758					usb_kill_urb(u);
759			}
760		}
761	}
762	if (subs->syncpipe) {
763		for (i = 0; i < SYNC_URBS; i++) {
764			if (test_bit(i+16, &subs->active_mask)) {
765 				if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
766					struct urb *u = subs->syncurb[i].urb;
767					if (async)
768						usb_unlink_urb(u);
769					else
770						usb_kill_urb(u);
771				}
772			}
773		}
774	}
775	return 0;
776}
777
778
779static const char *usb_error_string(int err)
780{
781	switch (err) {
782	case -ENODEV:
783		return "no device";
784	case -ENOENT:
785		return "endpoint not enabled";
786	case -EPIPE:
787		return "endpoint stalled";
788	case -ENOSPC:
789		return "not enough bandwidth";
790	case -ESHUTDOWN:
791		return "device disabled";
792	case -EHOSTUNREACH:
793		return "device suspended";
794#ifndef CONFIG_USB_EHCI_SPLIT_ISO
795	case -ENOSYS:
796		return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
797#endif
798	case -EINVAL:
799	case -EAGAIN:
800	case -EFBIG:
801	case -EMSGSIZE:
802		return "internal error";
803	default:
804		return "unknown error";
805	}
806}
807
808/*
809 * set up and start data/sync urbs
810 */
811static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
812{
813	unsigned int i;
814	int err;
815
816	if (subs->stream->chip->shutdown)
817		return -EBADFD;
818
819	for (i = 0; i < subs->nurbs; i++) {
820		snd_assert(subs->dataurb[i].urb, return -EINVAL);
821		if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
822			snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
823			goto __error;
824		}
825	}
826	if (subs->syncpipe) {
827		for (i = 0; i < SYNC_URBS; i++) {
828			snd_assert(subs->syncurb[i].urb, return -EINVAL);
829			if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
830				snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
831				goto __error;
832			}
833		}
834	}
835
836	subs->active_mask = 0;
837	subs->unlink_mask = 0;
838	subs->running = 1;
839	for (i = 0; i < subs->nurbs; i++) {
840		err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
841		if (err < 0) {
842			snd_printk(KERN_ERR "cannot submit datapipe "
843				   "for urb %d, error %d: %s\n",
844				   i, err, usb_error_string(err));
845			goto __error;
846		}
847		set_bit(i, &subs->active_mask);
848	}
849	if (subs->syncpipe) {
850		for (i = 0; i < SYNC_URBS; i++) {
851			err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
852			if (err < 0) {
853				snd_printk(KERN_ERR "cannot submit syncpipe "
854					   "for urb %d, error %d: %s\n",
855					   i, err, usb_error_string(err));
856				goto __error;
857			}
858			set_bit(i + 16, &subs->active_mask);
859		}
860	}
861	return 0;
862
863 __error:
864	// snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
865	deactivate_urbs(subs, 0, 0);
866	return -EPIPE;
867}
868
869
870/*
871 *  wait until all urbs are processed.
872 */
873static int wait_clear_urbs(struct snd_usb_substream *subs)
874{
875	unsigned long end_time = jiffies + msecs_to_jiffies(1000);
876	unsigned int i;
877	int alive;
878
879	do {
880		alive = 0;
881		for (i = 0; i < subs->nurbs; i++) {
882			if (test_bit(i, &subs->active_mask))
883				alive++;
884		}
885		if (subs->syncpipe) {
886			for (i = 0; i < SYNC_URBS; i++) {
887				if (test_bit(i + 16, &subs->active_mask))
888					alive++;
889			}
890		}
891		if (! alive)
892			break;
893		schedule_timeout_uninterruptible(1);
894	} while (time_before(jiffies, end_time));
895	if (alive)
896		snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
897	return 0;
898}
899
900
901/*
902 * return the current pcm pointer.  just return the hwptr_done value.
903 */
904static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
905{
906	struct snd_usb_substream *subs;
907	snd_pcm_uframes_t hwptr_done;
908
909	subs = (struct snd_usb_substream *)substream->runtime->private_data;
910	spin_lock(&subs->lock);
911	hwptr_done = subs->hwptr_done;
912	spin_unlock(&subs->lock);
913	return hwptr_done;
914}
915
916
917/*
918 * start/stop playback substream
919 */
920static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
921					int cmd)
922{
923	struct snd_usb_substream *subs = substream->runtime->private_data;
924
925	switch (cmd) {
926	case SNDRV_PCM_TRIGGER_START:
927	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
928		subs->ops.prepare = prepare_playback_urb;
929		return 0;
930	case SNDRV_PCM_TRIGGER_STOP:
931		return deactivate_urbs(subs, 0, 0);
932	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
933		subs->ops.prepare = prepare_nodata_playback_urb;
934		return 0;
935	default:
936		return -EINVAL;
937	}
938}
939
940/*
941 * start/stop capture substream
942 */
943static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
944				       int cmd)
945{
946	struct snd_usb_substream *subs = substream->runtime->private_data;
947
948	switch (cmd) {
949	case SNDRV_PCM_TRIGGER_START:
950		subs->ops.retire = retire_capture_urb;
951		return start_urbs(subs, substream->runtime);
952	case SNDRV_PCM_TRIGGER_STOP:
953		return deactivate_urbs(subs, 0, 0);
954	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
955		subs->ops.retire = retire_paused_capture_urb;
956		return 0;
957	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
958		subs->ops.retire = retire_capture_urb;
959		return 0;
960	default:
961		return -EINVAL;
962	}
963}
964
965
966/*
967 * release a urb data
968 */
969static void release_urb_ctx(struct snd_urb_ctx *u)
970{
971	if (u->urb) {
972		if (u->buffer_size)
973			usb_buffer_free(u->subs->dev, u->buffer_size,
974					u->urb->transfer_buffer,
975					u->urb->transfer_dma);
976		usb_free_urb(u->urb);
977		u->urb = NULL;
978	}
979}
980
981/*
982 * release a substream
983 */
984static void release_substream_urbs(struct snd_usb_substream *subs, int force)
985{
986	int i;
987
988	/* stop urbs (to be sure) */
989	deactivate_urbs(subs, force, 1);
990	wait_clear_urbs(subs);
991
992	for (i = 0; i < MAX_URBS; i++)
993		release_urb_ctx(&subs->dataurb[i]);
994	for (i = 0; i < SYNC_URBS; i++)
995		release_urb_ctx(&subs->syncurb[i]);
996	usb_buffer_free(subs->dev, SYNC_URBS * 4,
997			subs->syncbuf, subs->sync_dma);
998	subs->syncbuf = NULL;
999	subs->nurbs = 0;
1000}
1001
1002/*
1003 * initialize a substream for plaback/capture
1004 */
1005static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
1006			       unsigned int rate, unsigned int frame_bits)
1007{
1008	unsigned int maxsize, n, i;
1009	int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1010	unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
1011
1012	/* calculate the frequency in 16.16 format */
1013	if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1014		subs->freqn = get_usb_full_speed_rate(rate);
1015	else
1016		subs->freqn = get_usb_high_speed_rate(rate);
1017	subs->freqm = subs->freqn;
1018	/* calculate max. frequency */
1019	if (subs->maxpacksize) {
1020		/* whatever fits into a max. size packet */
1021		maxsize = subs->maxpacksize;
1022		subs->freqmax = (maxsize / (frame_bits >> 3))
1023				<< (16 - subs->datainterval);
1024	} else {
1025		/* no max. packet size: just take 25% higher than nominal */
1026		subs->freqmax = subs->freqn + (subs->freqn >> 2);
1027		maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1028				>> (16 - subs->datainterval);
1029	}
1030	subs->phase = 0;
1031
1032	if (subs->fill_max)
1033		subs->curpacksize = subs->maxpacksize;
1034	else
1035		subs->curpacksize = maxsize;
1036
1037	if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1038		packs_per_ms = 8 >> subs->datainterval;
1039	else
1040		packs_per_ms = 1;
1041	subs->packs_per_ms = packs_per_ms;
1042
1043	if (is_playback) {
1044		urb_packs = nrpacks;
1045		urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1046		urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1047	} else
1048		urb_packs = 1;
1049	urb_packs *= packs_per_ms;
1050
1051	/* decide how many packets to be used */
1052	if (is_playback) {
1053		unsigned int minsize;
1054		/* determine how small a packet can be */
1055		minsize = (subs->freqn >> (16 - subs->datainterval))
1056			  * (frame_bits >> 3);
1057		/* with sync from device, assume it can be 12% lower */
1058		if (subs->syncpipe)
1059			minsize -= minsize >> 3;
1060		minsize = max(minsize, 1u);
1061		total_packs = (period_bytes + minsize - 1) / minsize;
1062		/* round up to multiple of packs_per_ms */
1063		total_packs = (total_packs + packs_per_ms - 1)
1064				& ~(packs_per_ms - 1);
1065		/* we need at least two URBs for queueing */
1066		if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1067			total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
1068	} else {
1069		total_packs = MAX_URBS * urb_packs;
1070	}
1071	subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1072	if (subs->nurbs > MAX_URBS) {
1073		/* too much... */
1074		subs->nurbs = MAX_URBS;
1075		total_packs = MAX_URBS * urb_packs;
1076	}
1077	n = total_packs;
1078	for (i = 0; i < subs->nurbs; i++) {
1079		npacks[i] = n > urb_packs ? urb_packs : n;
1080		n -= urb_packs;
1081	}
1082	if (subs->nurbs <= 1) {
1083		/* too little - we need at least two packets
1084		 * to ensure contiguous playback/capture
1085		 */
1086		subs->nurbs = 2;
1087		npacks[0] = (total_packs + 1) / 2;
1088		npacks[1] = total_packs - npacks[0];
1089	} else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
1090		/* the last packet is too small.. */
1091		if (subs->nurbs > 2) {
1092			/* merge to the first one */
1093			npacks[0] += npacks[subs->nurbs - 1];
1094			subs->nurbs--;
1095		} else {
1096			/* divide to two */
1097			subs->nurbs = 2;
1098			npacks[0] = (total_packs + 1) / 2;
1099			npacks[1] = total_packs - npacks[0];
1100		}
1101	}
1102
1103	/* allocate and initialize data urbs */
1104	for (i = 0; i < subs->nurbs; i++) {
1105		struct snd_urb_ctx *u = &subs->dataurb[i];
1106		u->index = i;
1107		u->subs = subs;
1108		u->packets = npacks[i];
1109		u->buffer_size = maxsize * u->packets;
1110		if (subs->fmt_type == USB_FORMAT_TYPE_II)
1111			u->packets++; /* for transfer delimiter */
1112		u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
1113		if (! u->urb)
1114			goto out_of_memory;
1115		u->urb->transfer_buffer =
1116			usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1117					 &u->urb->transfer_dma);
1118		if (! u->urb->transfer_buffer)
1119			goto out_of_memory;
1120		u->urb->pipe = subs->datapipe;
1121		u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1122		u->urb->interval = 1 << subs->datainterval;
1123		u->urb->context = u;
1124		u->urb->complete = snd_complete_urb;
1125	}
1126
1127	if (subs->syncpipe) {
1128		/* allocate and initialize sync urbs */
1129		subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1130						 GFP_KERNEL, &subs->sync_dma);
1131		if (! subs->syncbuf)
1132			goto out_of_memory;
1133		for (i = 0; i < SYNC_URBS; i++) {
1134			struct snd_urb_ctx *u = &subs->syncurb[i];
1135			u->index = i;
1136			u->subs = subs;
1137			u->packets = 1;
1138			u->urb = usb_alloc_urb(1, GFP_KERNEL);
1139			if (! u->urb)
1140				goto out_of_memory;
1141			u->urb->transfer_buffer = subs->syncbuf + i * 4;
1142			u->urb->transfer_dma = subs->sync_dma + i * 4;
1143			u->urb->transfer_buffer_length = 4;
1144			u->urb->pipe = subs->syncpipe;
1145			u->urb->transfer_flags = URB_ISO_ASAP |
1146						 URB_NO_TRANSFER_DMA_MAP;
1147			u->urb->number_of_packets = 1;
1148			u->urb->interval = 1 << subs->syncinterval;
1149			u->urb->context = u;
1150			u->urb->complete = snd_complete_sync_urb;
1151		}
1152	}
1153	return 0;
1154
1155out_of_memory:
1156	release_substream_urbs(subs, 0);
1157	return -ENOMEM;
1158}
1159
1160
1161/*
1162 * find a matching audio format
1163 */
1164static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
1165				       unsigned int rate, unsigned int channels)
1166{
1167	struct list_head *p;
1168	struct audioformat *found = NULL;
1169	int cur_attr = 0, attr;
1170
1171	list_for_each(p, &subs->fmt_list) {
1172		struct audioformat *fp;
1173		fp = list_entry(p, struct audioformat, list);
1174		if (fp->format != format || fp->channels != channels)
1175			continue;
1176		if (rate < fp->rate_min || rate > fp->rate_max)
1177			continue;
1178		if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1179			unsigned int i;
1180			for (i = 0; i < fp->nr_rates; i++)
1181				if (fp->rate_table[i] == rate)
1182					break;
1183			if (i >= fp->nr_rates)
1184				continue;
1185		}
1186		attr = fp->ep_attr & EP_ATTR_MASK;
1187		if (! found) {
1188			found = fp;
1189			cur_attr = attr;
1190			continue;
1191		}
1192		if (attr != cur_attr) {
1193			if ((attr == EP_ATTR_ASYNC &&
1194			     subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1195			    (attr == EP_ATTR_ADAPTIVE &&
1196			     subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1197				continue;
1198			if ((cur_attr == EP_ATTR_ASYNC &&
1199			     subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1200			    (cur_attr == EP_ATTR_ADAPTIVE &&
1201			     subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1202				found = fp;
1203				cur_attr = attr;
1204				continue;
1205			}
1206		}
1207		/* find the format with the largest max. packet size */
1208		if (fp->maxpacksize > found->maxpacksize) {
1209			found = fp;
1210			cur_attr = attr;
1211		}
1212	}
1213	return found;
1214}
1215
1216
1217/*
1218 * initialize the picth control and sample rate
1219 */
1220static int init_usb_pitch(struct usb_device *dev, int iface,
1221			  struct usb_host_interface *alts,
1222			  struct audioformat *fmt)
1223{
1224	unsigned int ep;
1225	unsigned char data[1];
1226	int err;
1227
1228	ep = get_endpoint(alts, 0)->bEndpointAddress;
1229	/* if endpoint has pitch control, enable it */
1230	if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1231		data[0] = 1;
1232		if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1233					   USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1234					   PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1235			snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1236				   dev->devnum, iface, ep);
1237			return err;
1238		}
1239	}
1240	return 0;
1241}
1242
1243static int init_usb_sample_rate(struct usb_device *dev, int iface,
1244				struct usb_host_interface *alts,
1245				struct audioformat *fmt, int rate)
1246{
1247	unsigned int ep;
1248	unsigned char data[3];
1249	int err;
1250
1251	ep = get_endpoint(alts, 0)->bEndpointAddress;
1252	/* if endpoint has sampling rate control, set it */
1253	if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1254		int crate;
1255		data[0] = rate;
1256		data[1] = rate >> 8;
1257		data[2] = rate >> 16;
1258		if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1259					   USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1260					   SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1261			snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1262				   dev->devnum, iface, fmt->altsetting, rate, ep);
1263			return err;
1264		}
1265		if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1266					   USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1267					   SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1268			snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1269				   dev->devnum, iface, fmt->altsetting, ep);
1270			return 0; /* some devices don't support reading */
1271		}
1272		crate = data[0] | (data[1] << 8) | (data[2] << 16);
1273		if (crate != rate) {
1274			snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1275			// runtime->rate = crate;
1276		}
1277	}
1278	return 0;
1279}
1280
1281/*
1282 * find a matching format and set up the interface
1283 */
1284static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
1285{
1286	struct usb_device *dev = subs->dev;
1287	struct usb_host_interface *alts;
1288	struct usb_interface_descriptor *altsd;
1289	struct usb_interface *iface;
1290	unsigned int ep, attr;
1291	int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1292	int err;
1293
1294	iface = usb_ifnum_to_if(dev, fmt->iface);
1295	snd_assert(iface, return -EINVAL);
1296	alts = &iface->altsetting[fmt->altset_idx];
1297	altsd = get_iface_desc(alts);
1298	snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1299
1300	if (fmt == subs->cur_audiofmt)
1301		return 0;
1302
1303	/* close the old interface */
1304	if (subs->interface >= 0 && subs->interface != fmt->iface) {
1305		usb_set_interface(subs->dev, subs->interface, 0);
1306		subs->interface = -1;
1307		subs->format = 0;
1308	}
1309
1310	/* set interface */
1311	if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1312		if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1313			snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1314				   dev->devnum, fmt->iface, fmt->altsetting);
1315			return -EIO;
1316		}
1317		snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1318		subs->interface = fmt->iface;
1319		subs->format = fmt->altset_idx;
1320	}
1321
1322	/* create a data pipe */
1323	ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1324	if (is_playback)
1325		subs->datapipe = usb_sndisocpipe(dev, ep);
1326	else
1327		subs->datapipe = usb_rcvisocpipe(dev, ep);
1328	if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1329	    get_endpoint(alts, 0)->bInterval >= 1 &&
1330	    get_endpoint(alts, 0)->bInterval <= 4)
1331		subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1332	else
1333		subs->datainterval = 0;
1334	subs->syncpipe = subs->syncinterval = 0;
1335	subs->maxpacksize = fmt->maxpacksize;
1336	subs->fill_max = 0;
1337
1338	/* we need a sync pipe in async OUT or adaptive IN mode */
1339	/* check the number of EP, since some devices have broken
1340	 * descriptors which fool us.  if it has only one EP,
1341	 * assume it as adaptive-out or sync-in.
1342	 */
1343	attr = fmt->ep_attr & EP_ATTR_MASK;
1344	if (((is_playback && attr == EP_ATTR_ASYNC) ||
1345	     (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1346	    altsd->bNumEndpoints >= 2) {
1347		/* check sync-pipe endpoint */
1348		/* ... and check descriptor size before accessing bSynchAddress
1349		   because there is a version of the SB Audigy 2 NX firmware lacking
1350		   the audio fields in the endpoint descriptors */
1351		if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1352		    (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1353		     get_endpoint(alts, 1)->bSynchAddress != 0)) {
1354			snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1355				   dev->devnum, fmt->iface, fmt->altsetting);
1356			return -EINVAL;
1357		}
1358		ep = get_endpoint(alts, 1)->bEndpointAddress;
1359		if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1360		    (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1361		     (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1362			snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1363				   dev->devnum, fmt->iface, fmt->altsetting);
1364			return -EINVAL;
1365		}
1366		ep &= USB_ENDPOINT_NUMBER_MASK;
1367		if (is_playback)
1368			subs->syncpipe = usb_rcvisocpipe(dev, ep);
1369		else
1370			subs->syncpipe = usb_sndisocpipe(dev, ep);
1371		if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1372		    get_endpoint(alts, 1)->bRefresh >= 1 &&
1373		    get_endpoint(alts, 1)->bRefresh <= 9)
1374			subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
1375		else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1376			subs->syncinterval = 1;
1377		else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1378			 get_endpoint(alts, 1)->bInterval <= 16)
1379			subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1380		else
1381			subs->syncinterval = 3;
1382	}
1383
1384	/* always fill max packet size */
1385	if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1386		subs->fill_max = 1;
1387
1388	if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1389		return err;
1390
1391	subs->cur_audiofmt = fmt;
1392
1393
1394	return 0;
1395}
1396
1397/*
1398 * hw_params callback
1399 *
1400 * allocate a buffer and set the given audio format.
1401 *
1402 * so far we use a physically linear buffer although packetize transfer
1403 * doesn't need a continuous area.
1404 * if sg buffer is supported on the later version of alsa, we'll follow
1405 * that.
1406 */
1407static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1408			     struct snd_pcm_hw_params *hw_params)
1409{
1410	struct snd_usb_substream *subs = substream->runtime->private_data;
1411	struct audioformat *fmt;
1412	unsigned int channels, rate, format;
1413	int ret, changed;
1414
1415	ret = snd_pcm_alloc_vmalloc_buffer(substream,
1416					   params_buffer_bytes(hw_params));
1417	if (ret < 0)
1418		return ret;
1419
1420	format = params_format(hw_params);
1421	rate = params_rate(hw_params);
1422	channels = params_channels(hw_params);
1423	fmt = find_format(subs, format, rate, channels);
1424	if (! fmt) {
1425		snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1426			   format, rate, channels);
1427		return -EINVAL;
1428	}
1429
1430	changed = subs->cur_audiofmt != fmt ||
1431		subs->period_bytes != params_period_bytes(hw_params) ||
1432		subs->cur_rate != rate;
1433	if ((ret = set_format(subs, fmt)) < 0)
1434		return ret;
1435
1436	if (subs->cur_rate != rate) {
1437		struct usb_host_interface *alts;
1438		struct usb_interface *iface;
1439		iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1440		alts = &iface->altsetting[fmt->altset_idx];
1441		ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1442		if (ret < 0)
1443			return ret;
1444		subs->cur_rate = rate;
1445	}
1446
1447	if (changed) {
1448		/* format changed */
1449		release_substream_urbs(subs, 0);
1450		/* influenced: period_bytes, channels, rate, format, */
1451		ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1452					  params_rate(hw_params),
1453					  snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1454	}
1455
1456	return ret;
1457}
1458
1459/*
1460 * hw_free callback
1461 *
1462 * reset the audio format and release the buffer
1463 */
1464static int snd_usb_hw_free(struct snd_pcm_substream *substream)
1465{
1466	struct snd_usb_substream *subs = substream->runtime->private_data;
1467
1468	subs->cur_audiofmt = NULL;
1469	subs->cur_rate = 0;
1470	subs->period_bytes = 0;
1471	if (!subs->stream->chip->shutdown)
1472		release_substream_urbs(subs, 0);
1473	return snd_pcm_free_vmalloc_buffer(substream);
1474}
1475
1476/*
1477 * prepare callback
1478 *
1479 * only a few subtle things...
1480 */
1481static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
1482{
1483	struct snd_pcm_runtime *runtime = substream->runtime;
1484	struct snd_usb_substream *subs = runtime->private_data;
1485
1486	if (! subs->cur_audiofmt) {
1487		snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1488		return -ENXIO;
1489	}
1490
1491	/* some unit conversions in runtime */
1492	subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1493	subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1494
1495	/* reset the pointer */
1496	subs->hwptr_done = 0;
1497	subs->transfer_done = 0;
1498	subs->phase = 0;
1499
1500	/* clear urbs (to be sure) */
1501	deactivate_urbs(subs, 0, 1);
1502	wait_clear_urbs(subs);
1503
1504	/* for playback, submit the URBs now; otherwise, the first hwptr_done
1505	 * updates for all URBs would happen at the same time when starting */
1506	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1507		subs->ops.prepare = prepare_nodata_playback_urb;
1508		return start_urbs(subs, runtime);
1509	} else
1510		return 0;
1511}
1512
1513static struct snd_pcm_hardware snd_usb_hardware =
1514{
1515	.info =			SNDRV_PCM_INFO_MMAP |
1516				SNDRV_PCM_INFO_MMAP_VALID |
1517				SNDRV_PCM_INFO_BATCH |
1518				SNDRV_PCM_INFO_INTERLEAVED |
1519				SNDRV_PCM_INFO_BLOCK_TRANSFER |
1520				SNDRV_PCM_INFO_PAUSE,
1521	.buffer_bytes_max =	1024 * 1024,
1522	.period_bytes_min =	64,
1523	.period_bytes_max =	512 * 1024,
1524	.periods_min =		2,
1525	.periods_max =		1024,
1526};
1527
1528/*
1529 * h/w constraints
1530 */
1531
1532#ifdef HW_CONST_DEBUG
1533#define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1534#else
1535#define hwc_debug(fmt, args...) /**/
1536#endif
1537
1538static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
1539{
1540	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1541	struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1542	struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1543
1544	/* check the format */
1545	if (! snd_mask_test(fmts, fp->format)) {
1546		hwc_debug("   > check: no supported format %d\n", fp->format);
1547		return 0;
1548	}
1549	/* check the channels */
1550	if (fp->channels < ct->min || fp->channels > ct->max) {
1551		hwc_debug("   > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1552		return 0;
1553	}
1554	/* check the rate is within the range */
1555	if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1556		hwc_debug("   > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1557		return 0;
1558	}
1559	if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1560		hwc_debug("   > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1561		return 0;
1562	}
1563	return 1;
1564}
1565
1566static int hw_rule_rate(struct snd_pcm_hw_params *params,
1567			struct snd_pcm_hw_rule *rule)
1568{
1569	struct snd_usb_substream *subs = rule->private;
1570	struct list_head *p;
1571	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1572	unsigned int rmin, rmax;
1573	int changed;
1574
1575	hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1576	changed = 0;
1577	rmin = rmax = 0;
1578	list_for_each(p, &subs->fmt_list) {
1579		struct audioformat *fp;
1580		fp = list_entry(p, struct audioformat, list);
1581		if (! hw_check_valid_format(params, fp))
1582			continue;
1583		if (changed++) {
1584			if (rmin > fp->rate_min)
1585				rmin = fp->rate_min;
1586			if (rmax < fp->rate_max)
1587				rmax = fp->rate_max;
1588		} else {
1589			rmin = fp->rate_min;
1590			rmax = fp->rate_max;
1591		}
1592	}
1593
1594	if (! changed) {
1595		hwc_debug("  --> get empty\n");
1596		it->empty = 1;
1597		return -EINVAL;
1598	}
1599
1600	changed = 0;
1601	if (it->min < rmin) {
1602		it->min = rmin;
1603		it->openmin = 0;
1604		changed = 1;
1605	}
1606	if (it->max > rmax) {
1607		it->max = rmax;
1608		it->openmax = 0;
1609		changed = 1;
1610	}
1611	if (snd_interval_checkempty(it)) {
1612		it->empty = 1;
1613		return -EINVAL;
1614	}
1615	hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1616	return changed;
1617}
1618
1619
1620static int hw_rule_channels(struct snd_pcm_hw_params *params,
1621			    struct snd_pcm_hw_rule *rule)
1622{
1623	struct snd_usb_substream *subs = rule->private;
1624	struct list_head *p;
1625	struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1626	unsigned int rmin, rmax;
1627	int changed;
1628
1629	hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1630	changed = 0;
1631	rmin = rmax = 0;
1632	list_for_each(p, &subs->fmt_list) {
1633		struct audioformat *fp;
1634		fp = list_entry(p, struct audioformat, list);
1635		if (! hw_check_valid_format(params, fp))
1636			continue;
1637		if (changed++) {
1638			if (rmin > fp->channels)
1639				rmin = fp->channels;
1640			if (rmax < fp->channels)
1641				rmax = fp->channels;
1642		} else {
1643			rmin = fp->channels;
1644			rmax = fp->channels;
1645		}
1646	}
1647
1648	if (! changed) {
1649		hwc_debug("  --> get empty\n");
1650		it->empty = 1;
1651		return -EINVAL;
1652	}
1653
1654	changed = 0;
1655	if (it->min < rmin) {
1656		it->min = rmin;
1657		it->openmin = 0;
1658		changed = 1;
1659	}
1660	if (it->max > rmax) {
1661		it->max = rmax;
1662		it->openmax = 0;
1663		changed = 1;
1664	}
1665	if (snd_interval_checkempty(it)) {
1666		it->empty = 1;
1667		return -EINVAL;
1668	}
1669	hwc_debug("  --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1670	return changed;
1671}
1672
1673static int hw_rule_format(struct snd_pcm_hw_params *params,
1674			  struct snd_pcm_hw_rule *rule)
1675{
1676	struct snd_usb_substream *subs = rule->private;
1677	struct list_head *p;
1678	struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1679	u64 fbits;
1680	u32 oldbits[2];
1681	int changed;
1682
1683	hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1684	fbits = 0;
1685	list_for_each(p, &subs->fmt_list) {
1686		struct audioformat *fp;
1687		fp = list_entry(p, struct audioformat, list);
1688		if (! hw_check_valid_format(params, fp))
1689			continue;
1690		fbits |= (1ULL << fp->format);
1691	}
1692
1693	oldbits[0] = fmt->bits[0];
1694	oldbits[1] = fmt->bits[1];
1695	fmt->bits[0] &= (u32)fbits;
1696	fmt->bits[1] &= (u32)(fbits >> 32);
1697	if (! fmt->bits[0] && ! fmt->bits[1]) {
1698		hwc_debug("  --> get empty\n");
1699		return -EINVAL;
1700	}
1701	changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1702	hwc_debug("  --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1703	return changed;
1704}
1705
1706#define MAX_MASK	64
1707
1708/*
1709 * check whether the registered audio formats need special hw-constraints
1710 */
1711static int check_hw_params_convention(struct snd_usb_substream *subs)
1712{
1713	int i;
1714	u32 *channels;
1715	u32 *rates;
1716	u32 cmaster, rmaster;
1717	u32 rate_min = 0, rate_max = 0;
1718	struct list_head *p;
1719	int err = 1;
1720
1721	channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1722	rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1723
1724	list_for_each(p, &subs->fmt_list) {
1725		struct audioformat *f;
1726		f = list_entry(p, struct audioformat, list);
1727		/* unconventional channels? */
1728		if (f->channels > 32)
1729			goto __out;
1730		/* continuous rate min/max matches? */
1731		if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1732			if (rate_min && f->rate_min != rate_min)
1733				goto __out;
1734			if (rate_max && f->rate_max != rate_max)
1735				goto __out;
1736			rate_min = f->rate_min;
1737			rate_max = f->rate_max;
1738		}
1739		/* combination of continuous rates and fixed rates? */
1740		if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1741			if (f->rates != rates[f->format])
1742				goto __out;
1743		}
1744		if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1745			if (rates[f->format] && rates[f->format] != f->rates)
1746				goto __out;
1747		}
1748		channels[f->format] |= (1 << f->channels);
1749		rates[f->format] |= f->rates;
1750		/* needs knot? */
1751		if (f->needs_knot)
1752			goto __out;
1753	}
1754	/* check whether channels and rates match for all formats */
1755	cmaster = rmaster = 0;
1756	for (i = 0; i < MAX_MASK; i++) {
1757		if (cmaster != channels[i] && cmaster && channels[i])
1758			goto __out;
1759		if (rmaster != rates[i] && rmaster && rates[i])
1760			goto __out;
1761		if (channels[i])
1762			cmaster = channels[i];
1763		if (rates[i])
1764			rmaster = rates[i];
1765	}
1766	/* check whether channels match for all distinct rates */
1767	memset(channels, 0, MAX_MASK * sizeof(u32));
1768	list_for_each(p, &subs->fmt_list) {
1769		struct audioformat *f;
1770		f = list_entry(p, struct audioformat, list);
1771		if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1772			continue;
1773		for (i = 0; i < 32; i++) {
1774			if (f->rates & (1 << i))
1775				channels[i] |= (1 << f->channels);
1776		}
1777	}
1778	cmaster = 0;
1779	for (i = 0; i < 32; i++) {
1780		if (cmaster != channels[i] && cmaster && channels[i])
1781			goto __out;
1782		if (channels[i])
1783			cmaster = channels[i];
1784	}
1785	err = 0;
1786
1787 __out:
1788	kfree(channels);
1789	kfree(rates);
1790	return err;
1791}
1792
1793/*
1794 *  If the device supports unusual bit rates, does the request meet these?
1795 */
1796static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1797				  struct snd_usb_substream *subs)
1798{
1799	struct audioformat *fp;
1800	int count = 0, needs_knot = 0;
1801	int err;
1802
1803	list_for_each_entry(fp, &subs->fmt_list, list) {
1804		if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)
1805			return 0;
1806		count += fp->nr_rates;
1807		if (fp->needs_knot)
1808			needs_knot = 1;
1809	}
1810	if (!needs_knot)
1811		return 0;
1812
1813	subs->rate_list.count = count;
1814	subs->rate_list.list = kmalloc(sizeof(int) * count, GFP_KERNEL);
1815	subs->rate_list.mask = 0;
1816	count = 0;
1817	list_for_each_entry(fp, &subs->fmt_list, list) {
1818		int i;
1819		for (i = 0; i < fp->nr_rates; i++)
1820			subs->rate_list.list[count++] = fp->rate_table[i];
1821	}
1822	err = snd_pcm_hw_constraint_list(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1823					 &subs->rate_list);
1824	if (err < 0)
1825		return err;
1826
1827	return 0;
1828}
1829
1830
1831/*
1832 * set up the runtime hardware information.
1833 */
1834
1835static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
1836{
1837	struct list_head *p;
1838	int err;
1839
1840	runtime->hw.formats = subs->formats;
1841
1842	runtime->hw.rate_min = 0x7fffffff;
1843	runtime->hw.rate_max = 0;
1844	runtime->hw.channels_min = 256;
1845	runtime->hw.channels_max = 0;
1846	runtime->hw.rates = 0;
1847	/* check min/max rates and channels */
1848	list_for_each(p, &subs->fmt_list) {
1849		struct audioformat *fp;
1850		fp = list_entry(p, struct audioformat, list);
1851		runtime->hw.rates |= fp->rates;
1852		if (runtime->hw.rate_min > fp->rate_min)
1853			runtime->hw.rate_min = fp->rate_min;
1854		if (runtime->hw.rate_max < fp->rate_max)
1855			runtime->hw.rate_max = fp->rate_max;
1856		if (runtime->hw.channels_min > fp->channels)
1857			runtime->hw.channels_min = fp->channels;
1858		if (runtime->hw.channels_max < fp->channels)
1859			runtime->hw.channels_max = fp->channels;
1860		if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1861			runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1862				fp->frame_size;
1863		}
1864	}
1865
1866	/* set the period time minimum 1ms */
1867	snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1868				     1000 * MIN_PACKS_URB,
1869				     /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1870
1871	if (check_hw_params_convention(subs)) {
1872		hwc_debug("setting extra hw constraints...\n");
1873		if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1874					       hw_rule_rate, subs,
1875					       SNDRV_PCM_HW_PARAM_FORMAT,
1876					       SNDRV_PCM_HW_PARAM_CHANNELS,
1877					       -1)) < 0)
1878			return err;
1879		if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1880					       hw_rule_channels, subs,
1881					       SNDRV_PCM_HW_PARAM_FORMAT,
1882					       SNDRV_PCM_HW_PARAM_RATE,
1883					       -1)) < 0)
1884			return err;
1885		if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1886					       hw_rule_format, subs,
1887					       SNDRV_PCM_HW_PARAM_RATE,
1888					       SNDRV_PCM_HW_PARAM_CHANNELS,
1889					       -1)) < 0)
1890			return err;
1891		if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1892			return err;
1893	}
1894	return 0;
1895}
1896
1897static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction)
1898{
1899	struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1900	struct snd_pcm_runtime *runtime = substream->runtime;
1901	struct snd_usb_substream *subs = &as->substream[direction];
1902
1903	subs->interface = -1;
1904	subs->format = 0;
1905	runtime->hw = snd_usb_hardware;
1906	runtime->private_data = subs;
1907	subs->pcm_substream = substream;
1908	return setup_hw_info(runtime, subs);
1909}
1910
1911static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
1912{
1913	struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1914	struct snd_usb_substream *subs = &as->substream[direction];
1915
1916	if (subs->interface >= 0) {
1917		usb_set_interface(subs->dev, subs->interface, 0);
1918		subs->interface = -1;
1919	}
1920	subs->pcm_substream = NULL;
1921	return 0;
1922}
1923
1924static int snd_usb_playback_open(struct snd_pcm_substream *substream)
1925{
1926	return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK);
1927}
1928
1929static int snd_usb_playback_close(struct snd_pcm_substream *substream)
1930{
1931	return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1932}
1933
1934static int snd_usb_capture_open(struct snd_pcm_substream *substream)
1935{
1936	return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE);
1937}
1938
1939static int snd_usb_capture_close(struct snd_pcm_substream *substream)
1940{
1941	return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1942}
1943
1944static struct snd_pcm_ops snd_usb_playback_ops = {
1945	.open =		snd_usb_playback_open,
1946	.close =	snd_usb_playback_close,
1947	.ioctl =	snd_pcm_lib_ioctl,
1948	.hw_params =	snd_usb_hw_params,
1949	.hw_free =	snd_usb_hw_free,
1950	.prepare =	snd_usb_pcm_prepare,
1951	.trigger =	snd_usb_pcm_playback_trigger,
1952	.pointer =	snd_usb_pcm_pointer,
1953	.page =		snd_pcm_get_vmalloc_page,
1954};
1955
1956static struct snd_pcm_ops snd_usb_capture_ops = {
1957	.open =		snd_usb_capture_open,
1958	.close =	snd_usb_capture_close,
1959	.ioctl =	snd_pcm_lib_ioctl,
1960	.hw_params =	snd_usb_hw_params,
1961	.hw_free =	snd_usb_hw_free,
1962	.prepare =	snd_usb_pcm_prepare,
1963	.trigger =	snd_usb_pcm_capture_trigger,
1964	.pointer =	snd_usb_pcm_pointer,
1965	.page =		snd_pcm_get_vmalloc_page,
1966};
1967
1968
1969
1970/*
1971 * helper functions
1972 */
1973
1974/*
1975 * combine bytes and get an integer value
1976 */
1977unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1978{
1979	switch (size) {
1980	case 1:  return *bytes;
1981	case 2:  return combine_word(bytes);
1982	case 3:  return combine_triple(bytes);
1983	case 4:  return combine_quad(bytes);
1984	default: return 0;
1985	}
1986}
1987
1988/*
1989 * parse descriptor buffer and return the pointer starting the given
1990 * descriptor type.
1991 */
1992void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1993{
1994	u8 *p, *end, *next;
1995
1996	p = descstart;
1997	end = p + desclen;
1998	for (; p < end;) {
1999		if (p[0] < 2)
2000			return NULL;
2001		next = p + p[0];
2002		if (next > end)
2003			return NULL;
2004		if (p[1] == dtype && (!after || (void *)p > after)) {
2005			return p;
2006		}
2007		p = next;
2008	}
2009	return NULL;
2010}
2011
2012/*
2013 * find a class-specified interface descriptor with the given subtype.
2014 */
2015void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
2016{
2017	unsigned char *p = after;
2018
2019	while ((p = snd_usb_find_desc(buffer, buflen, p,
2020				      USB_DT_CS_INTERFACE)) != NULL) {
2021		if (p[0] >= 3 && p[2] == dsubtype)
2022			return p;
2023	}
2024	return NULL;
2025}
2026
2027/*
2028 * Wrapper for usb_control_msg().
2029 * Allocates a temp buffer to prevent dmaing from/to the stack.
2030 */
2031int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2032		    __u8 requesttype, __u16 value, __u16 index, void *data,
2033		    __u16 size, int timeout)
2034{
2035	int err;
2036	void *buf = NULL;
2037
2038	if (size > 0) {
2039		buf = kmemdup(data, size, GFP_KERNEL);
2040		if (!buf)
2041			return -ENOMEM;
2042	}
2043	err = usb_control_msg(dev, pipe, request, requesttype,
2044			      value, index, buf, size, timeout);
2045	if (size > 0) {
2046		memcpy(data, buf, size);
2047		kfree(buf);
2048	}
2049	return err;
2050}
2051
2052
2053/*
2054 * entry point for linux usb interface
2055 */
2056
2057static int usb_audio_probe(struct usb_interface *intf,
2058			   const struct usb_device_id *id);
2059static void usb_audio_disconnect(struct usb_interface *intf);
2060
2061static struct usb_device_id usb_audio_ids [] = {
2062#include "usbquirks.h"
2063    { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2064      .bInterfaceClass = USB_CLASS_AUDIO,
2065      .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2066    { }						/* Terminating entry */
2067};
2068
2069MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2070
2071static struct usb_driver usb_audio_driver = {
2072	.name =		"snd-usb-audio",
2073	.probe =	usb_audio_probe,
2074	.disconnect =	usb_audio_disconnect,
2075	.id_table =	usb_audio_ids,
2076};
2077
2078
2079#if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2080
2081/*
2082 * proc interface for list the supported pcm formats
2083 */
2084static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2085{
2086	struct list_head *p;
2087	static char *sync_types[4] = {
2088		"NONE", "ASYNC", "ADAPTIVE", "SYNC"
2089	};
2090
2091	list_for_each(p, &subs->fmt_list) {
2092		struct audioformat *fp;
2093		fp = list_entry(p, struct audioformat, list);
2094		snd_iprintf(buffer, "  Interface %d\n", fp->iface);
2095		snd_iprintf(buffer, "    Altset %d\n", fp->altsetting);
2096		snd_iprintf(buffer, "    Format: 0x%x\n", fp->format);
2097		snd_iprintf(buffer, "    Channels: %d\n", fp->channels);
2098		snd_iprintf(buffer, "    Endpoint: %d %s (%s)\n",
2099			    fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2100			    fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2101			    sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2102		if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2103			snd_iprintf(buffer, "    Rates: %d - %d (continuous)\n",
2104				    fp->rate_min, fp->rate_max);
2105		} else {
2106			unsigned int i;
2107			snd_iprintf(buffer, "    Rates: ");
2108			for (i = 0; i < fp->nr_rates; i++) {
2109				if (i > 0)
2110					snd_iprintf(buffer, ", ");
2111				snd_iprintf(buffer, "%d", fp->rate_table[i]);
2112			}
2113			snd_iprintf(buffer, "\n");
2114		}
2115		// snd_iprintf(buffer, "    Max Packet Size = %d\n", fp->maxpacksize);
2116		// snd_iprintf(buffer, "    EP Attribute = 0x%x\n", fp->attributes);
2117	}
2118}
2119
2120static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
2121{
2122	if (subs->running) {
2123		unsigned int i;
2124		snd_iprintf(buffer, "  Status: Running\n");
2125		snd_iprintf(buffer, "    Interface = %d\n", subs->interface);
2126		snd_iprintf(buffer, "    Altset = %d\n", subs->format);
2127		snd_iprintf(buffer, "    URBs = %d [ ", subs->nurbs);
2128		for (i = 0; i < subs->nurbs; i++)
2129			snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2130		snd_iprintf(buffer, "]\n");
2131		snd_iprintf(buffer, "    Packet Size = %d\n", subs->curpacksize);
2132		snd_iprintf(buffer, "    Momentary freq = %u Hz (%#x.%04x)\n",
2133			    snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2134			    ? get_full_speed_hz(subs->freqm)
2135			    : get_high_speed_hz(subs->freqm),
2136			    subs->freqm >> 16, subs->freqm & 0xffff);
2137	} else {
2138		snd_iprintf(buffer, "  Status: Stop\n");
2139	}
2140}
2141
2142static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
2143{
2144	struct snd_usb_stream *stream = entry->private_data;
2145
2146	snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2147
2148	if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2149		snd_iprintf(buffer, "\nPlayback:\n");
2150		proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2151		proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2152	}
2153	if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2154		snd_iprintf(buffer, "\nCapture:\n");
2155		proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2156		proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2157	}
2158}
2159
2160static void proc_pcm_format_add(struct snd_usb_stream *stream)
2161{
2162	struct snd_info_entry *entry;
2163	char name[32];
2164	struct snd_card *card = stream->chip->card;
2165
2166	sprintf(name, "stream%d", stream->pcm_index);
2167	if (! snd_card_proc_new(card, name, &entry))
2168		snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
2169}
2170
2171#else
2172
2173static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2174{
2175}
2176
2177#endif
2178
2179/*
2180 * initialize the substream instance.
2181 */
2182
2183static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
2184{
2185	struct snd_usb_substream *subs = &as->substream[stream];
2186
2187	INIT_LIST_HEAD(&subs->fmt_list);
2188	spin_lock_init(&subs->lock);
2189
2190	subs->stream = as;
2191	subs->direction = stream;
2192	subs->dev = as->chip->dev;
2193	if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2194		subs->ops = audio_urb_ops[stream];
2195	else
2196		subs->ops = audio_urb_ops_high_speed[stream];
2197	snd_pcm_set_ops(as->pcm, stream,
2198			stream == SNDRV_PCM_STREAM_PLAYBACK ?
2199			&snd_usb_playback_ops : &snd_usb_capture_ops);
2200
2201	list_add_tail(&fp->list, &subs->fmt_list);
2202	subs->formats |= 1ULL << fp->format;
2203	subs->endpoint = fp->endpoint;
2204	subs->num_formats++;
2205	subs->fmt_type = fp->fmt_type;
2206}
2207
2208
2209/*
2210 * free a substream
2211 */
2212static void free_substream(struct snd_usb_substream *subs)
2213{
2214	struct list_head *p, *n;
2215
2216	if (! subs->num_formats)
2217		return; /* not initialized */
2218	list_for_each_safe(p, n, &subs->fmt_list) {
2219		struct audioformat *fp = list_entry(p, struct audioformat, list);
2220		kfree(fp->rate_table);
2221		kfree(fp);
2222	}
2223	kfree(subs->rate_list.list);
2224}
2225
2226
2227/*
2228 * free a usb stream instance
2229 */
2230static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
2231{
2232	free_substream(&stream->substream[0]);
2233	free_substream(&stream->substream[1]);
2234	list_del(&stream->list);
2235	kfree(stream);
2236}
2237
2238static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
2239{
2240	struct snd_usb_stream *stream = pcm->private_data;
2241	if (stream) {
2242		stream->pcm = NULL;
2243		snd_usb_audio_stream_free(stream);
2244	}
2245}
2246
2247
2248/*
2249 * add this endpoint to the chip instance.
2250 * if a stream with the same endpoint already exists, append to it.
2251 * if not, create a new pcm stream.
2252 */
2253static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
2254{
2255	struct list_head *p;
2256	struct snd_usb_stream *as;
2257	struct snd_usb_substream *subs;
2258	struct snd_pcm *pcm;
2259	int err;
2260
2261	list_for_each(p, &chip->pcm_list) {
2262		as = list_entry(p, struct snd_usb_stream, list);
2263		if (as->fmt_type != fp->fmt_type)
2264			continue;
2265		subs = &as->substream[stream];
2266		if (! subs->endpoint)
2267			continue;
2268		if (subs->endpoint == fp->endpoint) {
2269			list_add_tail(&fp->list, &subs->fmt_list);
2270			subs->num_formats++;
2271			subs->formats |= 1ULL << fp->format;
2272			return 0;
2273		}
2274	}
2275	/* look for an empty stream */
2276	list_for_each(p, &chip->pcm_list) {
2277		as = list_entry(p, struct snd_usb_stream, list);
2278		if (as->fmt_type != fp->fmt_type)
2279			continue;
2280		subs = &as->substream[stream];
2281		if (subs->endpoint)
2282			continue;
2283		err = snd_pcm_new_stream(as->pcm, stream, 1);
2284		if (err < 0)
2285			return err;
2286		init_substream(as, stream, fp);
2287		return 0;
2288	}
2289
2290	/* create a new pcm */
2291	as = kzalloc(sizeof(*as), GFP_KERNEL);
2292	if (! as)
2293		return -ENOMEM;
2294	as->pcm_index = chip->pcm_devs;
2295	as->chip = chip;
2296	as->fmt_type = fp->fmt_type;
2297	err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2298			  stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2299			  stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2300			  &pcm);
2301	if (err < 0) {
2302		kfree(as);
2303		return err;
2304	}
2305	as->pcm = pcm;
2306	pcm->private_data = as;
2307	pcm->private_free = snd_usb_audio_pcm_free;
2308	pcm->info_flags = 0;
2309	if (chip->pcm_devs > 0)
2310		sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2311	else
2312		strcpy(pcm->name, "USB Audio");
2313
2314	init_substream(as, stream, fp);
2315
2316	list_add(&as->list, &chip->pcm_list);
2317	chip->pcm_devs++;
2318
2319	proc_pcm_format_add(as);
2320
2321	return 0;
2322}
2323
2324
2325/*
2326 * check if the device uses big-endian samples
2327 */
2328static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
2329{
2330	switch (chip->usb_id) {
2331	case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2332		if (fp->endpoint & USB_DIR_IN)
2333			return 1;
2334		break;
2335	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2336		return 1;
2337	}
2338	return 0;
2339}
2340
2341/*
2342 * parse the audio format type I descriptor
2343 * and returns the corresponding pcm format
2344 *
2345 * @dev: usb device
2346 * @fp: audioformat record
2347 * @format: the format tag (wFormatTag)
2348 * @fmt: the format type descriptor
2349 */
2350static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
2351				     int format, unsigned char *fmt)
2352{
2353	int pcm_format;
2354	int sample_width, sample_bytes;
2355
2356	pcm_format = -1;
2357	sample_width = fmt[6];
2358	sample_bytes = fmt[5];
2359	switch (format) {
2360	case 0: /* some devices don't define this correctly... */
2361		snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
2362			    chip->dev->devnum, fp->iface, fp->altsetting);
2363		/* fall-through */
2364	case USB_AUDIO_FORMAT_PCM:
2365		if (sample_width > sample_bytes * 8) {
2366			snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
2367				   chip->dev->devnum, fp->iface, fp->altsetting,
2368				   sample_width, sample_bytes);
2369		}
2370		/* check the format byte size */
2371		switch (fmt[5]) {
2372		case 1:
2373			pcm_format = SNDRV_PCM_FORMAT_S8;
2374			break;
2375		case 2:
2376			if (is_big_endian_format(chip, fp))
2377				pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2378			else
2379				pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2380			break;
2381		case 3:
2382			if (is_big_endian_format(chip, fp))
2383				pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2384			else
2385				pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2386			break;
2387		case 4:
2388			pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2389			break;
2390		default:
2391			snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
2392				   chip->dev->devnum, fp->iface,
2393				   fp->altsetting, sample_width, sample_bytes);
2394			break;
2395		}
2396		break;
2397	case USB_AUDIO_FORMAT_PCM8:
2398		if (chip->usb_id == USB_ID(0x04fa, 0x4201))
2399			pcm_format = SNDRV_PCM_FORMAT_S8;
2400		else
2401			pcm_format = SNDRV_PCM_FORMAT_U8;
2402		break;
2403	case USB_AUDIO_FORMAT_IEEE_FLOAT:
2404		pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2405		break;
2406	case USB_AUDIO_FORMAT_ALAW:
2407		pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2408		break;
2409	case USB_AUDIO_FORMAT_MU_LAW:
2410		pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2411		break;
2412	default:
2413		snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
2414			   chip->dev->devnum, fp->iface, fp->altsetting, format);
2415		break;
2416	}
2417	return pcm_format;
2418}
2419
2420
2421/*
2422 * parse the format descriptor and stores the possible sample rates
2423 * on the audioformat table.
2424 *
2425 * @dev: usb device
2426 * @fp: audioformat record
2427 * @fmt: the format descriptor
2428 * @offset: the start offset of descriptor pointing the rate type
2429 *          (7 for type I and II, 8 for type II)
2430 */
2431static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
2432				    unsigned char *fmt, int offset)
2433{
2434	int nr_rates = fmt[offset];
2435	int found;
2436	if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2437		snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2438				   chip->dev->devnum, fp->iface, fp->altsetting);
2439		return -1;
2440	}
2441
2442	if (nr_rates) {
2443		/*
2444		 * build the rate table and bitmap flags
2445		 */
2446		int r, idx, c;
2447		unsigned int nonzero_rates = 0;
2448		/* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2449		static unsigned int conv_rates[] = {
2450			5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2451			64000, 88200, 96000, 176400, 192000
2452		};
2453		fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2454		if (fp->rate_table == NULL) {
2455			snd_printk(KERN_ERR "cannot malloc\n");
2456			return -1;
2457		}
2458
2459		fp->needs_knot = 0;
2460		fp->nr_rates = nr_rates;
2461		fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2462		for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2463			unsigned int rate = combine_triple(&fmt[idx]);
2464			/* C-Media CM6501 mislabels its 96 kHz altsetting */
2465			if (rate == 48000 && nr_rates == 1 &&
2466			    chip->usb_id == USB_ID(0x0d8c, 0x0201) &&
2467			    fp->altsetting == 5 && fp->maxpacksize == 392)
2468				rate = 96000;
2469			fp->rate_table[r] = rate;
2470			nonzero_rates |= rate;
2471			if (rate < fp->rate_min)
2472				fp->rate_min = rate;
2473			else if (rate > fp->rate_max)
2474				fp->rate_max = rate;
2475			found = 0;
2476			for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2477				if (rate == conv_rates[c]) {
2478					found = 1;
2479					fp->rates |= (1 << c);
2480					break;
2481				}
2482			}
2483			if (!found)
2484				fp->needs_knot = 1;
2485		}
2486		if (!nonzero_rates) {
2487			hwc_debug("All rates were zero. Skipping format!\n");
2488			return -1;
2489		}
2490		if (fp->needs_knot)
2491			fp->rates |= SNDRV_PCM_RATE_KNOT;
2492	} else {
2493		/* continuous rates */
2494		fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2495		fp->rate_min = combine_triple(&fmt[offset + 1]);
2496		fp->rate_max = combine_triple(&fmt[offset + 4]);
2497	}
2498	return 0;
2499}
2500
2501/*
2502 * parse the format type I and III descriptors
2503 */
2504static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
2505				int format, unsigned char *fmt)
2506{
2507	int pcm_format;
2508
2509	if (fmt[3] == USB_FORMAT_TYPE_III) {
2510		pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2511	} else {
2512		pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
2513		if (pcm_format < 0)
2514			return -1;
2515	}
2516	fp->format = pcm_format;
2517	fp->channels = fmt[4];
2518	if (fp->channels < 1) {
2519		snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
2520			   chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
2521		return -1;
2522	}
2523	return parse_audio_format_rates(chip, fp, fmt, 7);
2524}
2525
2526/*
2527 * prase the format type II descriptor
2528 */
2529static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
2530				 int format, unsigned char *fmt)
2531{
2532	int brate, framesize;
2533	switch (format) {
2534	case USB_AUDIO_FORMAT_AC3:
2535		// fp->format = SNDRV_PCM_FORMAT_AC3;
2536		fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2537		break;
2538	case USB_AUDIO_FORMAT_MPEG:
2539		fp->format = SNDRV_PCM_FORMAT_MPEG;
2540		break;
2541	default:
2542		snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected.  processed as MPEG.\n",
2543			   chip->dev->devnum, fp->iface, fp->altsetting, format);
2544		fp->format = SNDRV_PCM_FORMAT_MPEG;
2545		break;
2546	}
2547	fp->channels = 1;
2548	brate = combine_word(&fmt[4]); 	/* fmt[4,5] : wMaxBitRate (in kbps) */
2549	framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2550	snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2551	fp->frame_size = framesize;
2552	return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
2553}
2554
2555static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
2556			      int format, unsigned char *fmt, int stream)
2557{
2558	int err;
2559
2560	switch (fmt[3]) {
2561	case USB_FORMAT_TYPE_I:
2562	case USB_FORMAT_TYPE_III:
2563		err = parse_audio_format_i(chip, fp, format, fmt);
2564		break;
2565	case USB_FORMAT_TYPE_II:
2566		err = parse_audio_format_ii(chip, fp, format, fmt);
2567		break;
2568	default:
2569		snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
2570			   chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
2571		return -1;
2572	}
2573	fp->fmt_type = fmt[3];
2574	if (err < 0)
2575		return err;
2576	/* extigy apparently supports sample rates other than 48k
2577	 * but not in ordinary way.  so we enable only 48k atm.
2578	 */
2579	if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
2580	    chip->usb_id == USB_ID(0x041e, 0x3020) ||
2581	    chip->usb_id == USB_ID(0x041e, 0x3061)) {
2582		if (fmt[3] == USB_FORMAT_TYPE_I &&
2583		    fp->rates != SNDRV_PCM_RATE_48000 &&
2584		    fp->rates != SNDRV_PCM_RATE_96000)
2585			return -1;
2586	}
2587	return 0;
2588}
2589
2590static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2591					 int iface, int altno);
2592static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
2593{
2594	struct usb_device *dev;
2595	struct usb_interface *iface;
2596	struct usb_host_interface *alts;
2597	struct usb_interface_descriptor *altsd;
2598	int i, altno, err, stream;
2599	int format;
2600	struct audioformat *fp;
2601	unsigned char *fmt, *csep;
2602
2603	dev = chip->dev;
2604
2605	/* parse the interface's altsettings */
2606	iface = usb_ifnum_to_if(dev, iface_no);
2607	for (i = 0; i < iface->num_altsetting; i++) {
2608		alts = &iface->altsetting[i];
2609		altsd = get_iface_desc(alts);
2610		/* skip invalid one */
2611		if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2612		     altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2613		    (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2614		     altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2615		    altsd->bNumEndpoints < 1 ||
2616		    le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2617			continue;
2618		/* must be isochronous */
2619		if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2620		    USB_ENDPOINT_XFER_ISOC)
2621			continue;
2622		/* check direction */
2623		stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2624			SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2625		altno = altsd->bAlternateSetting;
2626
2627		/* audiophile usb: skip altsets incompatible with device_setup
2628		 */
2629		if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2630		    audiophile_skip_setting_quirk(chip, iface_no, altno))
2631			continue;
2632
2633		/* get audio formats */
2634		fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2635		if (!fmt) {
2636			snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2637				   dev->devnum, iface_no, altno);
2638			continue;
2639		}
2640
2641		if (fmt[0] < 7) {
2642			snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2643				   dev->devnum, iface_no, altno);
2644			continue;
2645		}
2646
2647		format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2648
2649		/* get format type */
2650		fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2651		if (!fmt) {
2652			snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2653				   dev->devnum, iface_no, altno);
2654			continue;
2655		}
2656		if (fmt[0] < 8) {
2657			snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2658				   dev->devnum, iface_no, altno);
2659			continue;
2660		}
2661
2662		csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2663		/* Creamware Noah has this descriptor after the 2nd endpoint */
2664		if (!csep && altsd->bNumEndpoints >= 2)
2665			csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2666		if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
2667			snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
2668				   " class specific endpoint descriptor\n",
2669				   dev->devnum, iface_no, altno);
2670			csep = NULL;
2671		}
2672
2673		fp = kzalloc(sizeof(*fp), GFP_KERNEL);
2674		if (! fp) {
2675			snd_printk(KERN_ERR "cannot malloc\n");
2676			return -ENOMEM;
2677		}
2678
2679		fp->iface = iface_no;
2680		fp->altsetting = altno;
2681		fp->altset_idx = i;
2682		fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2683		fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2684		fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2685		if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2686			fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2687					* (fp->maxpacksize & 0x7ff);
2688		fp->attributes = csep ? csep[3] : 0;
2689
2690		/* some quirks for attributes here */
2691
2692		switch (chip->usb_id) {
2693		case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2694			/* Optoplay sets the sample rate attribute although
2695			 * it seems not supporting it in fact.
2696			 */
2697			fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
2698			break;
2699		case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2700		case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2701			/* doesn't set the sample rate attribute, but supports it */
2702			fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
2703			break;
2704		case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2705		case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2706						an older model 77d:223) */
2707		/*
2708		 * plantronics headset and Griffin iMic have set adaptive-in
2709		 * although it's really not...
2710		 */
2711			fp->ep_attr &= ~EP_ATTR_MASK;
2712			if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2713				fp->ep_attr |= EP_ATTR_ADAPTIVE;
2714			else
2715				fp->ep_attr |= EP_ATTR_SYNC;
2716			break;
2717		}
2718
2719		/* ok, let's parse further... */
2720		if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
2721			kfree(fp->rate_table);
2722			kfree(fp);
2723			continue;
2724		}
2725
2726		snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, altno, fp->endpoint);
2727		err = add_audio_endpoint(chip, stream, fp);
2728		if (err < 0) {
2729			kfree(fp->rate_table);
2730			kfree(fp);
2731			return err;
2732		}
2733		/* try to set the interface... */
2734		usb_set_interface(chip->dev, iface_no, altno);
2735		init_usb_pitch(chip->dev, iface_no, alts, fp);
2736		init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2737	}
2738	return 0;
2739}
2740
2741
2742/*
2743 * disconnect streams
2744 * called from snd_usb_audio_disconnect()
2745 */
2746static void snd_usb_stream_disconnect(struct list_head *head)
2747{
2748	int idx;
2749	struct snd_usb_stream *as;
2750	struct snd_usb_substream *subs;
2751
2752	as = list_entry(head, struct snd_usb_stream, list);
2753	for (idx = 0; idx < 2; idx++) {
2754		subs = &as->substream[idx];
2755		if (!subs->num_formats)
2756			return;
2757		release_substream_urbs(subs, 1);
2758		subs->interface = -1;
2759	}
2760}
2761
2762/*
2763 * parse audio control descriptor and create pcm/midi streams
2764 */
2765static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
2766{
2767	struct usb_device *dev = chip->dev;
2768	struct usb_host_interface *host_iface;
2769	struct usb_interface *iface;
2770	unsigned char *p1;
2771	int i, j;
2772
2773	/* find audiocontrol interface */
2774	host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2775	if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2776		snd_printk(KERN_ERR "cannot find HEADER\n");
2777		return -EINVAL;
2778	}
2779	if (! p1[7] || p1[0] < 8 + p1[7]) {
2780		snd_printk(KERN_ERR "invalid HEADER\n");
2781		return -EINVAL;
2782	}
2783
2784	/*
2785	 * parse all USB audio streaming interfaces
2786	 */
2787	for (i = 0; i < p1[7]; i++) {
2788		struct usb_host_interface *alts;
2789		struct usb_interface_descriptor *altsd;
2790		j = p1[8 + i];
2791		iface = usb_ifnum_to_if(dev, j);
2792		if (!iface) {
2793			snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2794				   dev->devnum, ctrlif, j);
2795			continue;
2796		}
2797		if (usb_interface_claimed(iface)) {
2798			snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2799			continue;
2800		}
2801		alts = &iface->altsetting[0];
2802		altsd = get_iface_desc(alts);
2803		if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2804		     altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2805		    altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2806			if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2807				snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2808				continue;
2809			}
2810			usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2811			continue;
2812		}
2813		if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2814		     altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2815		    altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2816			snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2817			/* skip non-supported classes */
2818			continue;
2819		}
2820		if (! parse_audio_endpoints(chip, j)) {
2821			usb_set_interface(dev, j, 0); /* reset the current interface */
2822			usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2823		}
2824	}
2825
2826	return 0;
2827}
2828
2829/*
2830 * create a stream for an endpoint/altsetting without proper descriptors
2831 */
2832static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
2833				     struct usb_interface *iface,
2834				     const struct snd_usb_audio_quirk *quirk)
2835{
2836	struct audioformat *fp;
2837	struct usb_host_interface *alts;
2838	int stream, err;
2839	int *rate_table = NULL;
2840
2841	fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
2842	if (! fp) {
2843		snd_printk(KERN_ERR "cannot memdup\n");
2844		return -ENOMEM;
2845	}
2846	if (fp->nr_rates > 0) {
2847		rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2848		if (!rate_table) {
2849			kfree(fp);
2850			return -ENOMEM;
2851		}
2852		memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2853		fp->rate_table = rate_table;
2854	}
2855
2856	stream = (fp->endpoint & USB_DIR_IN)
2857		? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2858	err = add_audio_endpoint(chip, stream, fp);
2859	if (err < 0) {
2860		kfree(fp);
2861		kfree(rate_table);
2862		return err;
2863	}
2864	if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2865	    fp->altset_idx >= iface->num_altsetting) {
2866		kfree(fp);
2867		kfree(rate_table);
2868		return -EINVAL;
2869	}
2870	alts = &iface->altsetting[fp->altset_idx];
2871	usb_set_interface(chip->dev, fp->iface, 0);
2872	init_usb_pitch(chip->dev, fp->iface, alts, fp);
2873	init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2874	return 0;
2875}
2876
2877/*
2878 * create a stream for an interface with proper descriptors
2879 */
2880static int create_standard_audio_quirk(struct snd_usb_audio *chip,
2881				       struct usb_interface *iface,
2882				       const struct snd_usb_audio_quirk *quirk)
2883{
2884	struct usb_host_interface *alts;
2885	struct usb_interface_descriptor *altsd;
2886	int err;
2887
2888	alts = &iface->altsetting[0];
2889	altsd = get_iface_desc(alts);
2890	err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
2891	if (err < 0) {
2892		snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2893			   altsd->bInterfaceNumber, err);
2894		return err;
2895	}
2896	/* reset the current interface */
2897	usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
2898	return 0;
2899}
2900
2901/*
2902 * Create a stream for an Edirol UA-700/UA-25 interface.  The only way
2903 * to detect the sample rate is by looking at wMaxPacketSize.
2904 */
2905static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
2906				   struct usb_interface *iface,
2907				   const struct snd_usb_audio_quirk *quirk)
2908{
2909	static const struct audioformat ua_format = {
2910		.format = SNDRV_PCM_FORMAT_S24_3LE,
2911		.channels = 2,
2912		.fmt_type = USB_FORMAT_TYPE_I,
2913		.altsetting = 1,
2914		.altset_idx = 1,
2915		.rates = SNDRV_PCM_RATE_CONTINUOUS,
2916	};
2917	struct usb_host_interface *alts;
2918	struct usb_interface_descriptor *altsd;
2919	struct audioformat *fp;
2920	int stream, err;
2921
2922	/* both PCM and MIDI interfaces have 2 altsettings */
2923	if (iface->num_altsetting != 2)
2924		return -ENXIO;
2925	alts = &iface->altsetting[1];
2926	altsd = get_iface_desc(alts);
2927
2928	if (altsd->bNumEndpoints == 2) {
2929		static const struct snd_usb_midi_endpoint_info ua700_ep = {
2930			.out_cables = 0x0003,
2931			.in_cables  = 0x0003
2932		};
2933		static const struct snd_usb_audio_quirk ua700_quirk = {
2934			.type = QUIRK_MIDI_FIXED_ENDPOINT,
2935			.data = &ua700_ep
2936		};
2937		static const struct snd_usb_midi_endpoint_info ua25_ep = {
2938			.out_cables = 0x0001,
2939			.in_cables  = 0x0001
2940		};
2941		static const struct snd_usb_audio_quirk ua25_quirk = {
2942			.type = QUIRK_MIDI_FIXED_ENDPOINT,
2943			.data = &ua25_ep
2944		};
2945		if (chip->usb_id == USB_ID(0x0582, 0x002b))
2946			return snd_usb_create_midi_interface(chip, iface,
2947							     &ua700_quirk);
2948		else
2949			return snd_usb_create_midi_interface(chip, iface,
2950							     &ua25_quirk);
2951	}
2952
2953	if (altsd->bNumEndpoints != 1)
2954		return -ENXIO;
2955
2956	fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2957	if (!fp)
2958		return -ENOMEM;
2959	memcpy(fp, &ua_format, sizeof(*fp));
2960
2961	fp->iface = altsd->bInterfaceNumber;
2962	fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2963	fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2964	fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2965
2966	switch (fp->maxpacksize) {
2967	case 0x120:
2968		fp->rate_max = fp->rate_min = 44100;
2969		break;
2970	case 0x138:
2971	case 0x140:
2972		fp->rate_max = fp->rate_min = 48000;
2973		break;
2974	case 0x258:
2975	case 0x260:
2976		fp->rate_max = fp->rate_min = 96000;
2977		break;
2978	default:
2979		snd_printk(KERN_ERR "unknown sample rate\n");
2980		kfree(fp);
2981		return -ENXIO;
2982	}
2983
2984	stream = (fp->endpoint & USB_DIR_IN)
2985		? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2986	err = add_audio_endpoint(chip, stream, fp);
2987	if (err < 0) {
2988		kfree(fp);
2989		return err;
2990	}
2991	usb_set_interface(chip->dev, fp->iface, 0);
2992	return 0;
2993}
2994
2995/*
2996 * Create a stream for an Edirol UA-1000 interface.
2997 */
2998static int create_ua1000_quirk(struct snd_usb_audio *chip,
2999			       struct usb_interface *iface,
3000			       const struct snd_usb_audio_quirk *quirk)
3001{
3002	static const struct audioformat ua1000_format = {
3003		.format = SNDRV_PCM_FORMAT_S32_LE,
3004		.fmt_type = USB_FORMAT_TYPE_I,
3005		.altsetting = 1,
3006		.altset_idx = 1,
3007		.attributes = 0,
3008		.rates = SNDRV_PCM_RATE_CONTINUOUS,
3009	};
3010	struct usb_host_interface *alts;
3011	struct usb_interface_descriptor *altsd;
3012	struct audioformat *fp;
3013	int stream, err;
3014
3015	if (iface->num_altsetting != 2)
3016		return -ENXIO;
3017	alts = &iface->altsetting[1];
3018	altsd = get_iface_desc(alts);
3019	if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3020	    altsd->bNumEndpoints != 1)
3021		return -ENXIO;
3022
3023	fp = kmemdup(&ua1000_format, sizeof(*fp), GFP_KERNEL);
3024	if (!fp)
3025		return -ENOMEM;
3026
3027	fp->channels = alts->extra[4];
3028	fp->iface = altsd->bInterfaceNumber;
3029	fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3030	fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3031	fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3032	fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
3033
3034	stream = (fp->endpoint & USB_DIR_IN)
3035		? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3036	err = add_audio_endpoint(chip, stream, fp);
3037	if (err < 0) {
3038		kfree(fp);
3039		return err;
3040	}
3041	usb_set_interface(chip->dev, fp->iface, 0);
3042	return 0;
3043}
3044
3045/*
3046 * Create a stream for an Edirol UA-101 interface.
3047 * Copy, paste and modify from Edirol UA-1000
3048 */
3049static int create_ua101_quirk(struct snd_usb_audio *chip,
3050			       struct usb_interface *iface,
3051			       const struct snd_usb_audio_quirk *quirk)
3052{
3053	static const struct audioformat ua101_format = {
3054		.format = SNDRV_PCM_FORMAT_S32_LE,
3055		.fmt_type = USB_FORMAT_TYPE_I,
3056		.altsetting = 1,
3057		.altset_idx = 1,
3058		.attributes = 0,
3059		.rates = SNDRV_PCM_RATE_CONTINUOUS,
3060	};
3061	struct usb_host_interface *alts;
3062	struct usb_interface_descriptor *altsd;
3063	struct audioformat *fp;
3064	int stream, err;
3065
3066	if (iface->num_altsetting != 2)
3067		return -ENXIO;
3068	alts = &iface->altsetting[1];
3069	altsd = get_iface_desc(alts);
3070	if (alts->extralen != 18 || alts->extra[1] != USB_DT_CS_INTERFACE ||
3071	    altsd->bNumEndpoints != 1)
3072		return -ENXIO;
3073
3074	fp = kmemdup(&ua101_format, sizeof(*fp), GFP_KERNEL);
3075	if (!fp)
3076		return -ENOMEM;
3077
3078	fp->channels = alts->extra[11];
3079	fp->iface = altsd->bInterfaceNumber;
3080	fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3081	fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3082	fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3083	fp->rate_max = fp->rate_min = combine_triple(&alts->extra[15]);
3084
3085	stream = (fp->endpoint & USB_DIR_IN)
3086		? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3087	err = add_audio_endpoint(chip, stream, fp);
3088	if (err < 0) {
3089		kfree(fp);
3090		return err;
3091	}
3092	usb_set_interface(chip->dev, fp->iface, 0);
3093	return 0;
3094}
3095
3096static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3097				struct usb_interface *iface,
3098				const struct snd_usb_audio_quirk *quirk);
3099
3100/*
3101 * handle the quirks for the contained interfaces
3102 */
3103static int create_composite_quirk(struct snd_usb_audio *chip,
3104				  struct usb_interface *iface,
3105				  const struct snd_usb_audio_quirk *quirk)
3106{
3107	int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3108	int err;
3109
3110	for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3111		iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3112		if (!iface)
3113			continue;
3114		if (quirk->ifnum != probed_ifnum &&
3115		    usb_interface_claimed(iface))
3116			continue;
3117		err = snd_usb_create_quirk(chip, iface, quirk);
3118		if (err < 0)
3119			return err;
3120		if (quirk->ifnum != probed_ifnum)
3121			usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3122	}
3123	return 0;
3124}
3125
3126static int ignore_interface_quirk(struct snd_usb_audio *chip,
3127				  struct usb_interface *iface,
3128				  const struct snd_usb_audio_quirk *quirk)
3129{
3130	return 0;
3131}
3132
3133
3134/*
3135 * boot quirks
3136 */
3137
3138#define EXTIGY_FIRMWARE_SIZE_OLD 794
3139#define EXTIGY_FIRMWARE_SIZE_NEW 483
3140
3141static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3142{
3143	struct usb_host_config *config = dev->actconfig;
3144	int err;
3145
3146	if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3147	    le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3148		snd_printdd("sending Extigy boot sequence...\n");
3149		/* Send message to force it to reconnect with full interface. */
3150		err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3151				      0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3152		if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3153		err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3154				&dev->descriptor, sizeof(dev->descriptor));
3155		config = dev->actconfig;
3156		if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3157		err = usb_reset_configuration(dev);
3158		if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3159		snd_printdd("extigy_boot: new boot length = %d\n",
3160			    le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3161		return -ENODEV; /* quit this anyway */
3162	}
3163	return 0;
3164}
3165
3166static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3167{
3168	u8 buf = 1;
3169
3170	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3171			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3172			0, 0, &buf, 1, 1000);
3173	if (buf == 0) {
3174		snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3175				USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3176				1, 2000, NULL, 0, 1000);
3177		return -ENODEV;
3178	}
3179	return 0;
3180}
3181
3182/*
3183 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3184 * documented in the device's data sheet.
3185 */
3186static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3187{
3188	u8 buf[4];
3189	buf[0] = 0x20;
3190	buf[1] = value & 0xff;
3191	buf[2] = (value >> 8) & 0xff;
3192	buf[3] = reg;
3193	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3194			       USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3195			       0, 0, &buf, 4, 1000);
3196}
3197
3198static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3199{
3200	/*
3201	 * Enable line-out driver mode, set headphone source to front
3202	 * channels, enable stereo mic.
3203	 */
3204	return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3205}
3206
3207
3208/*
3209 * Setup quirks
3210 */
3211#define AUDIOPHILE_SET			0x01 /* if set, parse device_setup */
3212#define AUDIOPHILE_SET_DTS              0x02 /* if set, enable DTS Digital Output */
3213#define AUDIOPHILE_SET_96K              0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3214#define AUDIOPHILE_SET_24B		0x08 /* 24bits sample if set, 16bits otherwise */
3215#define AUDIOPHILE_SET_DI		0x10 /* if set, enable Digital Input */
3216#define AUDIOPHILE_SET_MASK		0x1F /* bit mask for setup value */
3217#define AUDIOPHILE_SET_24B_48K_DI	0x19 /* value for 24bits+48KHz+Digital Input */
3218#define AUDIOPHILE_SET_24B_48K_NOTDI	0x09 /* value for 24bits+48KHz+No Digital Input */
3219#define AUDIOPHILE_SET_16B_48K_DI	0x11 /* value for 16bits+48KHz+Digital Input */
3220#define AUDIOPHILE_SET_16B_48K_NOTDI	0x01 /* value for 16bits+48KHz+No Digital Input */
3221
3222static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3223					 int iface, int altno)
3224{
3225	if (device_setup[chip->index] & AUDIOPHILE_SET) {
3226		if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3227		    && altno != 6)
3228			return 1; /* skip this altsetting */
3229		if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3230		    && altno != 1)
3231			return 1; /* skip this altsetting */
3232		if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3233		    AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3234			return 1; /* skip this altsetting */
3235		if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3236		    AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3237			return 1; /* skip this altsetting */
3238		if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3239		    AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3240			return 1; /* skip this altsetting */
3241		if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3242		    AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3243			return 1; /* skip this altsetting */
3244	}
3245	return 0; /* keep this altsetting */
3246}
3247
3248/*
3249 * audio-interface quirks
3250 *
3251 * returns zero if no standard audio/MIDI parsing is needed.
3252 * returns a postive value if standard audio/midi interfaces are parsed
3253 * after this.
3254 * returns a negative value at error.
3255 */
3256static int snd_usb_create_quirk(struct snd_usb_audio *chip,
3257				struct usb_interface *iface,
3258				const struct snd_usb_audio_quirk *quirk)
3259{
3260	typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3261				    const struct snd_usb_audio_quirk *);
3262	static const quirk_func_t quirk_funcs[] = {
3263		[QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3264		[QUIRK_COMPOSITE] = create_composite_quirk,
3265		[QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3266		[QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3267		[QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3268		[QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3269		[QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3270		[QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3271		[QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
3272		[QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
3273		[QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
3274		[QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3275		[QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3276		[QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3277		[QUIRK_AUDIO_EDIROL_UA101] = create_ua101_quirk,
3278	};
3279
3280	if (quirk->type < QUIRK_TYPE_COUNT) {
3281		return quirk_funcs[quirk->type](chip, iface, quirk);
3282	} else {
3283		snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3284		return -ENXIO;
3285	}
3286}
3287
3288
3289/*
3290 * common proc files to show the usb device info
3291 */
3292static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3293{
3294	struct snd_usb_audio *chip = entry->private_data;
3295	if (! chip->shutdown)
3296		snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3297}
3298
3299static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
3300{
3301	struct snd_usb_audio *chip = entry->private_data;
3302	if (! chip->shutdown)
3303		snd_iprintf(buffer, "%04x:%04x\n",
3304			    USB_ID_VENDOR(chip->usb_id),
3305			    USB_ID_PRODUCT(chip->usb_id));
3306}
3307
3308static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
3309{
3310	struct snd_info_entry *entry;
3311	if (! snd_card_proc_new(chip->card, "usbbus", &entry))
3312		snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
3313	if (! snd_card_proc_new(chip->card, "usbid", &entry))
3314		snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
3315}
3316
3317/*
3318 * free the chip instance
3319 *
3320 * here we have to do not much, since pcm and controls are already freed
3321 *
3322 */
3323
3324static int snd_usb_audio_free(struct snd_usb_audio *chip)
3325{
3326	usb_chip[chip->index] = NULL;
3327	kfree(chip);
3328	return 0;
3329}
3330
3331static int snd_usb_audio_dev_free(struct snd_device *device)
3332{
3333	struct snd_usb_audio *chip = device->device_data;
3334	return snd_usb_audio_free(chip);
3335}
3336
3337
3338/*
3339 * create a chip instance and set its names.
3340 */
3341static int snd_usb_audio_create(struct usb_device *dev, int idx,
3342				const struct snd_usb_audio_quirk *quirk,
3343				struct snd_usb_audio **rchip)
3344{
3345	struct snd_card *card;
3346	struct snd_usb_audio *chip;
3347	int err, len;
3348	char component[14];
3349	static struct snd_device_ops ops = {
3350		.dev_free =	snd_usb_audio_dev_free,
3351	};
3352
3353	*rchip = NULL;
3354
3355	if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3356	    snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3357		snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3358		return -ENXIO;
3359	}
3360
3361	card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3362	if (card == NULL) {
3363		snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3364		return -ENOMEM;
3365	}
3366
3367	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
3368	if (! chip) {
3369		snd_card_free(card);
3370		return -ENOMEM;
3371	}
3372
3373	chip->index = idx;
3374	chip->dev = dev;
3375	chip->card = card;
3376	chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3377			      le16_to_cpu(dev->descriptor.idProduct));
3378	INIT_LIST_HEAD(&chip->pcm_list);
3379	INIT_LIST_HEAD(&chip->midi_list);
3380	INIT_LIST_HEAD(&chip->mixer_list);
3381
3382	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3383		snd_usb_audio_free(chip);
3384		snd_card_free(card);
3385		return err;
3386	}
3387
3388	strcpy(card->driver, "USB-Audio");
3389	sprintf(component, "USB%04x:%04x",
3390		USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
3391	snd_component_add(card, component);
3392
3393	/* retrieve the device string as shortname */
3394 	if (quirk && quirk->product_name) {
3395		strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3396	} else {
3397		if (!dev->descriptor.iProduct ||
3398		    usb_string(dev, dev->descriptor.iProduct,
3399      			       card->shortname, sizeof(card->shortname)) <= 0) {
3400			/* no name available from anywhere, so use ID */
3401			sprintf(card->shortname, "USB Device %#04x:%#04x",
3402				USB_ID_VENDOR(chip->usb_id),
3403				USB_ID_PRODUCT(chip->usb_id));
3404		}
3405	}
3406
3407	/* retrieve the vendor and device strings as longname */
3408	if (quirk && quirk->vendor_name) {
3409		len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3410	} else {
3411		if (dev->descriptor.iManufacturer)
3412			len = usb_string(dev, dev->descriptor.iManufacturer,
3413					 card->longname, sizeof(card->longname));
3414		else
3415			len = 0;
3416		/* we don't really care if there isn't any vendor string */
3417	}
3418	if (len > 0)
3419		strlcat(card->longname, " ", sizeof(card->longname));
3420
3421	strlcat(card->longname, card->shortname, sizeof(card->longname));
3422
3423	len = strlcat(card->longname, " at ", sizeof(card->longname));
3424
3425	if (len < sizeof(card->longname))
3426		usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3427
3428	strlcat(card->longname,
3429		snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3430		sizeof(card->longname));
3431
3432	snd_usb_audio_create_proc(chip);
3433
3434	*rchip = chip;
3435	return 0;
3436}
3437
3438
3439/*
3440 * probe the active usb device
3441 *
3442 * note that this can be called multiple times per a device, when it
3443 * includes multiple audio control interfaces.
3444 *
3445 * thus we check the usb device pointer and creates the card instance
3446 * only at the first time.  the successive calls of this function will
3447 * append the pcm interface to the corresponding card.
3448 */
3449static void *snd_usb_audio_probe(struct usb_device *dev,
3450				 struct usb_interface *intf,
3451				 const struct usb_device_id *usb_id)
3452{
3453	const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
3454	int i, err;
3455	struct snd_usb_audio *chip;
3456	struct usb_host_interface *alts;
3457	int ifnum;
3458	u32 id;
3459
3460	alts = &intf->altsetting[0];
3461	ifnum = get_iface_desc(alts)->bInterfaceNumber;
3462	id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3463		    le16_to_cpu(dev->descriptor.idProduct));
3464
3465	if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3466		goto __err_val;
3467
3468	/* SB Extigy needs special boot-up sequence */
3469	/* if more models come, this will go to the quirk list. */
3470	if (id == USB_ID(0x041e, 0x3000)) {
3471		if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3472			goto __err_val;
3473	}
3474	/* SB Audigy 2 NX needs its own boot-up magic, too */
3475	if (id == USB_ID(0x041e, 0x3020)) {
3476		if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3477			goto __err_val;
3478	}
3479
3480	/* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3481	if (id == USB_ID(0x10f5, 0x0200)) {
3482		if (snd_usb_cm106_boot_quirk(dev) < 0)
3483			goto __err_val;
3484	}
3485
3486	/*
3487	 * found a config.  now register to ALSA
3488	 */
3489
3490	/* check whether it's already registered */
3491	chip = NULL;
3492	mutex_lock(&register_mutex);
3493	for (i = 0; i < SNDRV_CARDS; i++) {
3494		if (usb_chip[i] && usb_chip[i]->dev == dev) {
3495			if (usb_chip[i]->shutdown) {
3496				snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3497				goto __error;
3498			}
3499			chip = usb_chip[i];
3500			break;
3501		}
3502	}
3503	if (! chip) {
3504		/* it's a fresh one.
3505		 * now look for an empty slot and create a new card instance
3506		 */
3507		for (i = 0; i < SNDRV_CARDS; i++)
3508			if (enable[i] && ! usb_chip[i] &&
3509			    (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3510			    (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
3511				if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3512					goto __error;
3513				}
3514				snd_card_set_dev(chip->card, &intf->dev);
3515				break;
3516			}
3517		if (! chip) {
3518			snd_printk(KERN_ERR "no available usb audio device\n");
3519			goto __error;
3520		}
3521	}
3522
3523	err = 1; /* continue */
3524	if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3525		/* need some special handlings */
3526		if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3527			goto __error;
3528	}
3529
3530	if (err > 0) {
3531		/* create normal USB audio interfaces */
3532		if (snd_usb_create_streams(chip, ifnum) < 0 ||
3533		    snd_usb_create_mixer(chip, ifnum) < 0) {
3534			goto __error;
3535		}
3536	}
3537
3538	/* we are allowed to call snd_card_register() many times */
3539	if (snd_card_register(chip->card) < 0) {
3540		goto __error;
3541	}
3542
3543	usb_chip[chip->index] = chip;
3544	chip->num_interfaces++;
3545	mutex_unlock(&register_mutex);
3546	return chip;
3547
3548 __error:
3549	if (chip && !chip->num_interfaces)
3550		snd_card_free(chip->card);
3551	mutex_unlock(&register_mutex);
3552 __err_val:
3553	return NULL;
3554}
3555
3556/*
3557 * we need to take care of counter, since disconnection can be called also
3558 * many times as well as usb_audio_probe().
3559 */
3560static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3561{
3562	struct snd_usb_audio *chip;
3563	struct snd_card *card;
3564	struct list_head *p;
3565
3566	if (ptr == (void *)-1L)
3567		return;
3568
3569	chip = ptr;
3570	card = chip->card;
3571	mutex_lock(&register_mutex);
3572	chip->shutdown = 1;
3573	chip->num_interfaces--;
3574	if (chip->num_interfaces <= 0) {
3575		snd_card_disconnect(card);
3576		/* release the pcm resources */
3577		list_for_each(p, &chip->pcm_list) {
3578			snd_usb_stream_disconnect(p);
3579		}
3580		/* release the midi resources */
3581		list_for_each(p, &chip->midi_list) {
3582			snd_usbmidi_disconnect(p);
3583		}
3584		/* release mixer resources */
3585		list_for_each(p, &chip->mixer_list) {
3586			snd_usb_mixer_disconnect(p);
3587		}
3588		mutex_unlock(&register_mutex);
3589		snd_card_free_when_closed(card);
3590	} else {
3591		mutex_unlock(&register_mutex);
3592	}
3593}
3594
3595/*
3596 * new 2.5 USB kernel API
3597 */
3598static int usb_audio_probe(struct usb_interface *intf,
3599			   const struct usb_device_id *id)
3600{
3601	void *chip;
3602	chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3603	if (chip) {
3604		dev_set_drvdata(&intf->dev, chip);
3605		return 0;
3606	} else
3607		return -EIO;
3608}
3609
3610static void usb_audio_disconnect(struct usb_interface *intf)
3611{
3612	snd_usb_audio_disconnect(interface_to_usbdev(intf),
3613				 dev_get_drvdata(&intf->dev));
3614}
3615
3616
3617static int __init snd_usb_audio_init(void)
3618{
3619	if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3620		printk(KERN_WARNING "invalid nrpacks value.\n");
3621		return -EINVAL;
3622	}
3623	return usb_register(&usb_audio_driver);
3624}
3625
3626
3627static void __exit snd_usb_audio_cleanup(void)
3628{
3629	usb_deregister(&usb_audio_driver);
3630}
3631
3632module_init(snd_usb_audio_init);
3633module_exit(snd_usb_audio_cleanup);
3634