blob: d32d83d970cc9807f0fc19d31f35f5cb8d49104e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Clemens Ladisch6207e512005-08-15 08:35:25 +020048#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <linux/moduleparam.h>
Ingo Molnar12aa7572006-01-16 16:36:05 +010050#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#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 = 4; /* max. number of packets per urb */
72static int async_unlink = 1;
Thibault LE MEURe3113342006-03-14 11:44:53 +010073static int device_setup[SNDRV_CARDS]; /* device parameter for this card*/
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
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.");
Clemens Ladisch71d848c2005-08-12 15:18:00 +020085module_param(nrpacks, int, 0644);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
87module_param(async_unlink, bool, 0444);
88MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
Thibault LE MEURe3113342006-03-14 11:44:53 +010089module_param_array(device_setup, int, NULL, 0444);
90MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92
93/*
94 * debug the h/w constraints
95 */
96/* #define HW_CONST_DEBUG */
97
98
99/*
100 *
101 */
102
103#define MAX_PACKS 10
104#define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
Clemens Ladisch15a24c072005-08-12 08:25:26 +0200105#define MAX_URBS 8
Clemens Ladisch604cf492005-05-17 09:15:27 +0200106#define SYNC_URBS 4 /* always four urbs for sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107#define MIN_PACKS_URB 1 /* minimum 1 packet per urb */
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109struct 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};
127
Takashi Iwai86e07d32005-11-17 15:08:02 +0100128struct snd_usb_substream;
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130struct snd_urb_ctx {
131 struct urb *urb;
Clemens Ladisch55851f72005-08-15 08:34:16 +0200132 unsigned int buffer_size; /* size of data buffer, if data URB */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100133 struct snd_usb_substream *subs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 int index; /* index for urb array */
135 int packets; /* number of packets per urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136};
137
138struct snd_urb_ops {
Takashi Iwai86e07d32005-11-17 15:08:02 +0100139 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
140 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
142 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143};
144
145struct snd_usb_substream {
Takashi Iwai86e07d32005-11-17 15:08:02 +0100146 struct snd_usb_stream *stream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 struct usb_device *dev;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100148 struct snd_pcm_substream *pcm_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 int direction; /* playback or capture */
150 int interface; /* current interface */
151 int endpoint; /* assigned endpoint */
152 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
153 unsigned int cur_rate; /* current rate (for hw_params callback) */
154 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
155 unsigned int format; /* USB data format */
156 unsigned int datapipe; /* the data i/o pipe */
157 unsigned int syncpipe; /* 1 - async out or adaptive in */
Clemens Ladisch573567e2005-06-27 08:17:30 +0200158 unsigned int datainterval; /* log_2 of data packet interval */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
160 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
161 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
162 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
163 unsigned int phase; /* phase accumulator */
164 unsigned int maxpacksize; /* max packet size in bytes */
165 unsigned int maxframesize; /* max packet size in frames */
166 unsigned int curpacksize; /* current packet size in bytes (for capture) */
167 unsigned int curframesize; /* current packet size in frames (for capture) */
168 unsigned int fill_max: 1; /* fill max packet size always */
169 unsigned int fmt_type; /* USB audio format type (1-3) */
Clemens Ladisch9624ea82005-08-15 08:25:24 +0200170 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172 unsigned int running: 1; /* running status */
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 unsigned int hwptr_done; /* processed frame position in the buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 unsigned int transfer_done; /* processed frames since last period update */
176 unsigned long active_mask; /* bitmask of active urbs */
177 unsigned long unlink_mask; /* bitmask of unlinked urbs */
178
179 unsigned int nurbs; /* # urbs */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100180 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
181 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
Clemens Ladisch55851f72005-08-15 08:34:16 +0200182 char *syncbuf; /* sync buffer for all sync URBs */
183 dma_addr_t sync_dma; /* DMA address of syncbuf */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 u64 formats; /* format bitmasks (all or'ed) */
186 unsigned int num_formats; /* number of supported audio formats (list) */
187 struct list_head fmt_list; /* format list */
188 spinlock_t lock;
189
190 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
191};
192
193
194struct snd_usb_stream {
Takashi Iwai86e07d32005-11-17 15:08:02 +0100195 struct snd_usb_audio *chip;
196 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 int pcm_index;
198 unsigned int fmt_type; /* USB audio format type (1-3) */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100199 struct snd_usb_substream substream[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct list_head list;
201};
202
203
204/*
205 * we keep the snd_usb_audio_t instances by ourselves for merging
206 * the all interfaces on the same card as one sound device.
207 */
208
Ingo Molnar12aa7572006-01-16 16:36:05 +0100209static DEFINE_MUTEX(register_mutex);
Takashi Iwai86e07d32005-11-17 15:08:02 +0100210static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212
213/*
214 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
215 * this will overflow at approx 524 kHz
216 */
Jesper Juhl77933d72005-07-27 11:46:09 -0700217static inline unsigned get_usb_full_speed_rate(unsigned int rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218{
219 return ((rate << 13) + 62) / 125;
220}
221
222/*
223 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
224 * this will overflow at approx 4 MHz
225 */
Jesper Juhl77933d72005-07-27 11:46:09 -0700226static inline unsigned get_usb_high_speed_rate(unsigned int rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
228 return ((rate << 10) + 62) / 125;
229}
230
231/* convert our full speed USB rate into sampling rate in Hz */
Jesper Juhl77933d72005-07-27 11:46:09 -0700232static inline unsigned get_full_speed_hz(unsigned int usb_rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233{
234 return (usb_rate * 125 + (1 << 12)) >> 13;
235}
236
237/* convert our high speed USB rate into sampling rate in Hz */
Jesper Juhl77933d72005-07-27 11:46:09 -0700238static inline unsigned get_high_speed_hz(unsigned int usb_rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
240 return (usb_rate * 125 + (1 << 9)) >> 10;
241}
242
243
244/*
245 * prepare urb for full speed capture sync pipe
246 *
247 * fill the length and offset of each urb descriptor.
248 * the fixed 10.14 frequency is passed through the pipe.
249 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100250static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
251 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 struct urb *urb)
253{
254 unsigned char *cp = urb->transfer_buffer;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100255 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200258 urb->iso_frame_desc[0].length = 3;
259 urb->iso_frame_desc[0].offset = 0;
260 cp[0] = subs->freqn >> 2;
261 cp[1] = subs->freqn >> 10;
262 cp[2] = subs->freqn >> 18;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 return 0;
264}
265
266/*
267 * prepare urb for high speed capture sync pipe
268 *
269 * fill the length and offset of each urb descriptor.
270 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
271 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100272static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
273 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 struct urb *urb)
275{
276 unsigned char *cp = urb->transfer_buffer;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100277 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200280 urb->iso_frame_desc[0].length = 4;
281 urb->iso_frame_desc[0].offset = 0;
282 cp[0] = subs->freqn;
283 cp[1] = subs->freqn >> 8;
284 cp[2] = subs->freqn >> 16;
285 cp[3] = subs->freqn >> 24;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return 0;
287}
288
289/*
290 * process after capture sync complete
291 * - nothing to do
292 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100293static int retire_capture_sync_urb(struct snd_usb_substream *subs,
294 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 struct urb *urb)
296{
297 return 0;
298}
299
300/*
301 * prepare urb for capture data pipe
302 *
303 * fill the offset and length of each descriptor.
304 *
305 * we use a temporary buffer to write the captured data.
306 * since the length of written data is determined by host, we cannot
307 * write onto the pcm buffer directly... the data is thus copied
308 * later at complete callback to the global buffer.
309 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100310static int prepare_capture_urb(struct snd_usb_substream *subs,
311 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 struct urb *urb)
313{
314 int i, offs;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100315 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 offs = 0;
318 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 for (i = 0; i < ctx->packets; i++) {
320 urb->iso_frame_desc[i].offset = offs;
321 urb->iso_frame_desc[i].length = subs->curpacksize;
322 offs += subs->curpacksize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 urb->transfer_buffer_length = offs;
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200325 urb->number_of_packets = ctx->packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326#if 0 // for check
327 if (! urb->bandwidth) {
328 int bustime;
329 bustime = usb_check_bandwidth(urb->dev, urb);
330 if (bustime < 0)
331 return bustime;
332 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
333 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
334 }
335#endif // for check
336 return 0;
337}
338
339/*
340 * process after capture complete
341 *
342 * copy the data from each desctiptor to the pcm buffer, and
343 * update the current position.
344 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100345static int retire_capture_urb(struct snd_usb_substream *subs,
346 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 struct urb *urb)
348{
349 unsigned long flags;
350 unsigned char *cp;
351 int i;
352 unsigned int stride, len, oldptr;
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200353 int period_elapsed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 stride = runtime->frame_bits >> 3;
356
357 for (i = 0; i < urb->number_of_packets; i++) {
358 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
359 if (urb->iso_frame_desc[i].status) {
360 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
361 // continue;
362 }
363 len = urb->iso_frame_desc[i].actual_length / stride;
364 if (! len)
365 continue;
366 /* update the current pointer */
367 spin_lock_irqsave(&subs->lock, flags);
368 oldptr = subs->hwptr_done;
369 subs->hwptr_done += len;
370 if (subs->hwptr_done >= runtime->buffer_size)
371 subs->hwptr_done -= runtime->buffer_size;
372 subs->transfer_done += len;
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200373 if (subs->transfer_done >= runtime->period_size) {
374 subs->transfer_done -= runtime->period_size;
375 period_elapsed = 1;
376 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 spin_unlock_irqrestore(&subs->lock, flags);
378 /* copy a data chunk */
379 if (oldptr + len > runtime->buffer_size) {
380 unsigned int cnt = runtime->buffer_size - oldptr;
381 unsigned int blen = cnt * stride;
382 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
383 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
384 } else {
385 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
386 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 }
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200388 if (period_elapsed)
389 snd_pcm_period_elapsed(subs->pcm_substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 return 0;
391}
392
393
394/*
395 * prepare urb for full speed playback sync pipe
396 *
397 * set up the offset and length to receive the current frequency.
398 */
399
Takashi Iwai86e07d32005-11-17 15:08:02 +0100400static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
401 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 struct urb *urb)
403{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100404 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200407 urb->iso_frame_desc[0].length = 3;
408 urb->iso_frame_desc[0].offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 return 0;
410}
411
412/*
413 * prepare urb for high speed playback sync pipe
414 *
415 * set up the offset and length to receive the current frequency.
416 */
417
Takashi Iwai86e07d32005-11-17 15:08:02 +0100418static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
419 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 struct urb *urb)
421{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100422 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200425 urb->iso_frame_desc[0].length = 4;
426 urb->iso_frame_desc[0].offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 return 0;
428}
429
430/*
431 * process after full speed playback sync complete
432 *
433 * retrieve the current 10.14 frequency from pipe, and set it.
434 * the value is referred in prepare_playback_urb().
435 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100436static int retire_playback_sync_urb(struct snd_usb_substream *subs,
437 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 struct urb *urb)
439{
Clemens Ladischca810902005-05-02 08:55:54 +0200440 unsigned int f;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 unsigned long flags;
442
Clemens Ladischca810902005-05-02 08:55:54 +0200443 if (urb->iso_frame_desc[0].status == 0 &&
444 urb->iso_frame_desc[0].actual_length == 3) {
445 f = combine_triple((u8*)urb->transfer_buffer) << 2;
Clemens Ladisch50cdbf12005-05-13 07:44:13 +0200446 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
447 spin_lock_irqsave(&subs->lock, flags);
448 subs->freqm = f;
449 spin_unlock_irqrestore(&subs->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 }
452
453 return 0;
454}
455
456/*
457 * process after high speed playback sync complete
458 *
459 * retrieve the current 12.13 frequency from pipe, and set it.
460 * the value is referred in prepare_playback_urb().
461 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100462static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
463 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 struct urb *urb)
465{
Clemens Ladischca810902005-05-02 08:55:54 +0200466 unsigned int f;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 unsigned long flags;
468
Clemens Ladischca810902005-05-02 08:55:54 +0200469 if (urb->iso_frame_desc[0].status == 0 &&
470 urb->iso_frame_desc[0].actual_length == 4) {
471 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
Clemens Ladisch50cdbf12005-05-13 07:44:13 +0200472 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
473 spin_lock_irqsave(&subs->lock, flags);
474 subs->freqm = f;
475 spin_unlock_irqrestore(&subs->lock, flags);
476 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 }
478
479 return 0;
480}
481
Clemens Ladisch9568f462006-01-12 08:19:21 +0100482/* determine the number of frames in the next packet */
483static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
484{
485 if (subs->fill_max)
486 return subs->maxframesize;
487 else {
488 subs->phase = (subs->phase & 0xffff)
489 + (subs->freqm << subs->datainterval);
490 return min(subs->phase >> 16, subs->maxframesize);
491 }
492}
493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494/*
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100495 * Prepare urb for streaming before playback starts.
496 *
Clemens Ladisch4b284922006-01-12 08:17:49 +0100497 * We don't yet have data, so we send a frame of silence.
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100498 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100499static int prepare_startup_playback_urb(struct snd_usb_substream *subs,
500 struct snd_pcm_runtime *runtime,
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100501 struct urb *urb)
502{
Clemens Ladisch4b284922006-01-12 08:17:49 +0100503 unsigned int i, offs, counts;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100504 struct snd_urb_ctx *ctx = urb->context;
Clemens Ladisch4b284922006-01-12 08:17:49 +0100505 int stride = runtime->frame_bits >> 3;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100506
Clemens Ladisch4b284922006-01-12 08:17:49 +0100507 offs = 0;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100508 urb->dev = ctx->subs->dev;
509 urb->number_of_packets = subs->packs_per_ms;
510 for (i = 0; i < subs->packs_per_ms; ++i) {
Clemens Ladisch9568f462006-01-12 08:19:21 +0100511 counts = snd_usb_audio_next_packet_size(subs);
Clemens Ladisch4b284922006-01-12 08:17:49 +0100512 urb->iso_frame_desc[i].offset = offs * stride;
513 urb->iso_frame_desc[i].length = counts * stride;
514 offs += counts;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100515 }
Clemens Ladisch4b284922006-01-12 08:17:49 +0100516 urb->transfer_buffer_length = offs * stride;
517 memset(urb->transfer_buffer,
518 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
519 offs * stride);
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100520 return 0;
521}
522
523/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 * prepare urb for playback data pipe
525 *
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200526 * Since a URB can handle only a single linear buffer, we must use double
527 * buffering when the data to be transferred overflows the buffer boundary.
528 * To avoid inconsistencies when updating hwptr_done, we use double buffering
529 * for all URBs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100531static int prepare_playback_urb(struct snd_usb_substream *subs,
532 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 struct urb *urb)
534{
535 int i, stride, offs;
536 unsigned int counts;
537 unsigned long flags;
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200538 int period_elapsed = 0;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100539 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
541 stride = runtime->frame_bits >> 3;
542
543 offs = 0;
544 urb->dev = ctx->subs->dev; /* we need to set this at each time */
545 urb->number_of_packets = 0;
546 spin_lock_irqsave(&subs->lock, flags);
547 for (i = 0; i < ctx->packets; i++) {
Clemens Ladisch9568f462006-01-12 08:19:21 +0100548 counts = snd_usb_audio_next_packet_size(subs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 /* set up descriptor */
550 urb->iso_frame_desc[i].offset = offs * stride;
551 urb->iso_frame_desc[i].length = counts * stride;
552 offs += counts;
553 urb->number_of_packets++;
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200554 subs->transfer_done += counts;
555 if (subs->transfer_done >= runtime->period_size) {
556 subs->transfer_done -= runtime->period_size;
557 period_elapsed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200559 if (subs->transfer_done > 0) {
560 /* FIXME: fill-max mode is not
561 * supported yet */
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 }
568 i++;
569 if (i < ctx->packets) {
570 /* add a transfer delimiter */
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200571 urb->iso_frame_desc[i].offset =
572 offs * stride;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 urb->iso_frame_desc[i].length = 0;
574 urb->number_of_packets++;
575 }
Clemens Ladisch9624ea82005-08-15 08:25:24 +0200576 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 }
Clemens Ladisch9624ea82005-08-15 08:25:24 +0200579 /* 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 }
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200584 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 } else {
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200594 memcpy(urb->transfer_buffer,
595 runtime->dma_area + subs->hwptr_done * stride,
596 offs * stride);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200598 subs->hwptr_done += offs;
599 if (subs->hwptr_done >= runtime->buffer_size)
600 subs->hwptr_done -= runtime->buffer_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 spin_unlock_irqrestore(&subs->lock, flags);
602 urb->transfer_buffer_length = offs * stride;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100603 if (period_elapsed)
604 snd_pcm_period_elapsed(subs->pcm_substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 return 0;
606}
607
608/*
609 * process after playback data complete
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +0200610 * - nothing to do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100612static int retire_playback_urb(struct snd_usb_substream *subs,
613 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 struct urb *urb)
615{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 return 0;
617}
618
619
620/*
621 */
622static struct snd_urb_ops audio_urb_ops[2] = {
623 {
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100624 .prepare = prepare_startup_playback_urb,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 .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 {
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100639 .prepare = prepare_startup_playback_urb,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 .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, struct pt_regs *regs)
656{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100657 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
658 struct snd_usb_substream *subs = ctx->subs;
659 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 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, struct pt_regs *regs)
679{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100680 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
681 struct snd_usb_substream *subs = ctx->subs;
682 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 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
Clemens Ladisch6207e512005-08-15 08:35:25 +0200698/* get the physical page pointer at the given offset */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100699static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
Clemens Ladisch6207e512005-08-15 08:35:25 +0200700 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 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100707static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
Clemens Ladisch6207e512005-08-15 08:35:25 +0200708{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100709 struct snd_pcm_runtime *runtime = subs->runtime;
Clemens Ladisch6207e512005-08-15 08:35:25 +0200710 if (runtime->dma_area) {
711 if (runtime->dma_bytes >= size)
712 return 0; /* already large enough */
Takashi Iwaib1d57762005-10-10 11:56:31 +0200713 vfree(runtime->dma_area);
Clemens Ladisch6207e512005-08-15 08:35:25 +0200714 }
Takashi Iwaib1d57762005-10-10 11:56:31 +0200715 runtime->dma_area = vmalloc(size);
Clemens Ladisch6207e512005-08-15 08:35:25 +0200716 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 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100723static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
Clemens Ladisch6207e512005-08-15 08:35:25 +0200724{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100725 struct snd_pcm_runtime *runtime = subs->runtime;
Jesper Juhl9c4be3d2006-02-09 20:04:16 +0100726
727 vfree(runtime->dma_area);
728 runtime->dma_area = NULL;
Clemens Ladisch6207e512005-08-15 08:35:25 +0200729 return 0;
730}
731
732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733/*
734 * unlink active urbs.
735 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100736static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737{
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;
Alan Sternb375a042005-07-29 16:11:07 -0400755 if (async)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 usb_unlink_urb(u);
Alan Sternb375a042005-07-29 16:11:07 -0400757 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 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;
Alan Sternb375a042005-07-29 16:11:07 -0400767 if (async)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 usb_unlink_urb(u);
Alan Sternb375a042005-07-29 16:11:07 -0400769 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 usb_kill_urb(u);
771 }
772 }
773 }
774 }
775 return 0;
776}
777
778
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100779static 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";
Clemens Ladisch3e964432006-03-14 08:06:12 +0100794#ifndef CONFIG_USB_EHCI_SPLIT_ISO
795 case -ENOSYS:
796 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
797#endif
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100798 case -EINVAL:
799 case -EAGAIN:
800 case -EFBIG:
801 case -EMSGSIZE:
802 return "internal error";
803 default:
804 return "unknown error";
805 }
806}
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808/*
809 * set up and start data/sync urbs
810 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100811static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812{
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++) {
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100840 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));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 goto __error;
846 }
847 set_bit(i, &subs->active_mask);
848 }
849 if (subs->syncpipe) {
850 for (i = 0; i < SYNC_URBS; i++) {
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100851 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));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 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 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100873static int wait_clear_urbs(struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874{
Nishanth Aravamudanb27c1872005-07-09 10:54:37 +0200875 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 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;
Nishanth Aravamudan8433a502005-10-24 15:02:37 +0200893 schedule_timeout_uninterruptible(1);
Nishanth Aravamudanb27c1872005-07-09 10:54:37 +0200894 } while (time_before(jiffies, end_time));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 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 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100904static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100906 struct snd_usb_substream *subs;
Clemens Ladischdaa150e2005-08-15 08:25:50 +0200907 snd_pcm_uframes_t hwptr_done;
908
Takashi Iwai86e07d32005-11-17 15:08:02 +0100909 subs = (struct snd_usb_substream *)substream->runtime->private_data;
Clemens Ladischdaa150e2005-08-15 08:25:50 +0200910 spin_lock(&subs->lock);
911 hwptr_done = subs->hwptr_done;
912 spin_unlock(&subs->lock);
913 return hwptr_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
915
916
917/*
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100918 * start/stop playback substream
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100920static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100921 int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100923 struct snd_usb_substream *subs = substream->runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925 switch (cmd) {
926 case SNDRV_PCM_TRIGGER_START:
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100927 subs->ops.prepare = prepare_playback_urb;
928 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 case SNDRV_PCM_TRIGGER_STOP:
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100930 return deactivate_urbs(subs, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 default:
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100932 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 }
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100934}
935
936/*
937 * start/stop capture substream
938 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100939static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100940 int cmd)
941{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100942 struct snd_usb_substream *subs = substream->runtime->private_data;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100943
944 switch (cmd) {
945 case SNDRV_PCM_TRIGGER_START:
946 return start_urbs(subs, substream->runtime);
947 case SNDRV_PCM_TRIGGER_STOP:
948 return deactivate_urbs(subs, 0, 0);
949 default:
950 return -EINVAL;
951 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952}
953
954
955/*
956 * release a urb data
957 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100958static void release_urb_ctx(struct snd_urb_ctx *u)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959{
960 if (u->urb) {
Clemens Ladisch55851f72005-08-15 08:34:16 +0200961 if (u->buffer_size)
962 usb_buffer_free(u->subs->dev, u->buffer_size,
963 u->urb->transfer_buffer,
964 u->urb->transfer_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 usb_free_urb(u->urb);
966 u->urb = NULL;
967 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968}
969
970/*
971 * release a substream
972 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100973static void release_substream_urbs(struct snd_usb_substream *subs, int force)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974{
975 int i;
976
977 /* stop urbs (to be sure) */
978 deactivate_urbs(subs, force, 1);
979 wait_clear_urbs(subs);
980
981 for (i = 0; i < MAX_URBS; i++)
982 release_urb_ctx(&subs->dataurb[i]);
983 for (i = 0; i < SYNC_URBS; i++)
984 release_urb_ctx(&subs->syncurb[i]);
Clemens Ladisch55851f72005-08-15 08:34:16 +0200985 usb_buffer_free(subs->dev, SYNC_URBS * 4,
986 subs->syncbuf, subs->sync_dma);
987 subs->syncbuf = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 subs->nurbs = 0;
989}
990
991/*
992 * initialize a substream for plaback/capture
993 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100994static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 unsigned int rate, unsigned int frame_bits)
996{
997 unsigned int maxsize, n, i;
998 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
Clemens Ladischa93bf992005-08-12 15:19:39 +0200999 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000
1001 /* calculate the frequency in 16.16 format */
1002 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1003 subs->freqn = get_usb_full_speed_rate(rate);
1004 else
1005 subs->freqn = get_usb_high_speed_rate(rate);
1006 subs->freqm = subs->freqn;
Clemens Ladisch573567e2005-06-27 08:17:30 +02001007 /* calculate max. frequency */
1008 if (subs->maxpacksize) {
1009 /* whatever fits into a max. size packet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 maxsize = subs->maxpacksize;
Clemens Ladisch573567e2005-06-27 08:17:30 +02001011 subs->freqmax = (maxsize / (frame_bits >> 3))
1012 << (16 - subs->datainterval);
1013 } else {
1014 /* no max. packet size: just take 25% higher than nominal */
1015 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1016 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1017 >> (16 - subs->datainterval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 }
Clemens Ladisch573567e2005-06-27 08:17:30 +02001019 subs->phase = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 if (subs->fill_max)
1022 subs->curpacksize = subs->maxpacksize;
1023 else
1024 subs->curpacksize = maxsize;
1025
Clemens Ladischa93bf992005-08-12 15:19:39 +02001026 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1027 packs_per_ms = 8 >> subs->datainterval;
1028 else
1029 packs_per_ms = 1;
Clemens Ladisch9624ea82005-08-15 08:25:24 +02001030 subs->packs_per_ms = packs_per_ms;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001031
Clemens Ladisch71d848c2005-08-12 15:18:00 +02001032 if (is_playback) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 urb_packs = nrpacks;
Clemens Ladisch71d848c2005-08-12 15:18:00 +02001034 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1035 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1036 } else
Clemens Ladisch15a24c072005-08-12 08:25:26 +02001037 urb_packs = 1;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001038 urb_packs *= packs_per_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 /* decide how many packets to be used */
Clemens Ladisch15a24c072005-08-12 08:25:26 +02001041 if (is_playback) {
Clemens Ladischd6db3922005-08-12 08:28:27 +02001042 unsigned int minsize;
1043 /* determine how small a packet can be */
1044 minsize = (subs->freqn >> (16 - subs->datainterval))
1045 * (frame_bits >> 3);
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +02001046 /* with sync from device, assume it can be 12% lower */
Clemens Ladischd6db3922005-08-12 08:28:27 +02001047 if (subs->syncpipe)
Clemens Ladisch7efd8bc82005-08-15 08:24:44 +02001048 minsize -= minsize >> 3;
Clemens Ladischd6db3922005-08-12 08:28:27 +02001049 minsize = max(minsize, 1u);
1050 total_packs = (period_bytes + minsize - 1) / minsize;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001051 /* round up to multiple of packs_per_ms */
1052 total_packs = (total_packs + packs_per_ms - 1)
1053 & ~(packs_per_ms - 1);
1054 /* we need at least two URBs for queueing */
1055 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1056 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
Clemens Ladisch15a24c072005-08-12 08:25:26 +02001057 } else {
1058 total_packs = MAX_URBS * urb_packs;
1059 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1061 if (subs->nurbs > MAX_URBS) {
1062 /* too much... */
1063 subs->nurbs = MAX_URBS;
1064 total_packs = MAX_URBS * urb_packs;
1065 }
1066 n = total_packs;
1067 for (i = 0; i < subs->nurbs; i++) {
1068 npacks[i] = n > urb_packs ? urb_packs : n;
1069 n -= urb_packs;
1070 }
1071 if (subs->nurbs <= 1) {
1072 /* too little - we need at least two packets
1073 * to ensure contiguous playback/capture
1074 */
1075 subs->nurbs = 2;
1076 npacks[0] = (total_packs + 1) / 2;
1077 npacks[1] = total_packs - npacks[0];
Clemens Ladischa93bf992005-08-12 15:19:39 +02001078 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 /* the last packet is too small.. */
1080 if (subs->nurbs > 2) {
1081 /* merge to the first one */
1082 npacks[0] += npacks[subs->nurbs - 1];
1083 subs->nurbs--;
1084 } else {
1085 /* divide to two */
1086 subs->nurbs = 2;
1087 npacks[0] = (total_packs + 1) / 2;
1088 npacks[1] = total_packs - npacks[0];
1089 }
1090 }
1091
1092 /* allocate and initialize data urbs */
1093 for (i = 0; i < subs->nurbs; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001094 struct snd_urb_ctx *u = &subs->dataurb[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 u->index = i;
1096 u->subs = subs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 u->packets = npacks[i];
Clemens Ladisch55851f72005-08-15 08:34:16 +02001098 u->buffer_size = maxsize * u->packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1100 u->packets++; /* for transfer delimiter */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
Clemens Ladisch55851f72005-08-15 08:34:16 +02001102 if (! u->urb)
1103 goto out_of_memory;
1104 u->urb->transfer_buffer =
1105 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1106 &u->urb->transfer_dma);
1107 if (! u->urb->transfer_buffer)
1108 goto out_of_memory;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 u->urb->pipe = subs->datapipe;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001110 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
Clemens Ladisch573567e2005-06-27 08:17:30 +02001111 u->urb->interval = 1 << subs->datainterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 u->urb->context = u;
Clemens Ladisch3527a002005-09-26 10:03:09 +02001113 u->urb->complete = snd_complete_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 }
1115
1116 if (subs->syncpipe) {
1117 /* allocate and initialize sync urbs */
Clemens Ladisch55851f72005-08-15 08:34:16 +02001118 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1119 GFP_KERNEL, &subs->sync_dma);
1120 if (! subs->syncbuf)
1121 goto out_of_memory;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 for (i = 0; i < SYNC_URBS; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001123 struct snd_urb_ctx *u = &subs->syncurb[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 u->index = i;
1125 u->subs = subs;
Clemens Ladischca810902005-05-02 08:55:54 +02001126 u->packets = 1;
1127 u->urb = usb_alloc_urb(1, GFP_KERNEL);
Clemens Ladisch55851f72005-08-15 08:34:16 +02001128 if (! u->urb)
1129 goto out_of_memory;
Clemens Ladischca810902005-05-02 08:55:54 +02001130 u->urb->transfer_buffer = subs->syncbuf + i * 4;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001131 u->urb->transfer_dma = subs->sync_dma + i * 4;
Clemens Ladischca810902005-05-02 08:55:54 +02001132 u->urb->transfer_buffer_length = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 u->urb->pipe = subs->syncpipe;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001134 u->urb->transfer_flags = URB_ISO_ASAP |
1135 URB_NO_TRANSFER_DMA_MAP;
Clemens Ladischca810902005-05-02 08:55:54 +02001136 u->urb->number_of_packets = 1;
Clemens Ladisch1149a642005-05-02 08:53:46 +02001137 u->urb->interval = 1 << subs->syncinterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 u->urb->context = u;
Clemens Ladisch3527a002005-09-26 10:03:09 +02001139 u->urb->complete = snd_complete_sync_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 }
1141 }
1142 return 0;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001143
1144out_of_memory:
1145 release_substream_urbs(subs, 0);
1146 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147}
1148
1149
1150/*
1151 * find a matching audio format
1152 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001153static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 unsigned int rate, unsigned int channels)
1155{
1156 struct list_head *p;
1157 struct audioformat *found = NULL;
1158 int cur_attr = 0, attr;
1159
1160 list_for_each(p, &subs->fmt_list) {
1161 struct audioformat *fp;
1162 fp = list_entry(p, struct audioformat, list);
1163 if (fp->format != format || fp->channels != channels)
1164 continue;
1165 if (rate < fp->rate_min || rate > fp->rate_max)
1166 continue;
1167 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1168 unsigned int i;
1169 for (i = 0; i < fp->nr_rates; i++)
1170 if (fp->rate_table[i] == rate)
1171 break;
1172 if (i >= fp->nr_rates)
1173 continue;
1174 }
1175 attr = fp->ep_attr & EP_ATTR_MASK;
1176 if (! found) {
1177 found = fp;
1178 cur_attr = attr;
1179 continue;
1180 }
1181 /* avoid async out and adaptive in if the other method
1182 * supports the same format.
1183 * this is a workaround for the case like
1184 * M-audio audiophile USB.
1185 */
1186 if (attr != cur_attr) {
1187 if ((attr == EP_ATTR_ASYNC &&
1188 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1189 (attr == EP_ATTR_ADAPTIVE &&
1190 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1191 continue;
1192 if ((cur_attr == EP_ATTR_ASYNC &&
1193 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1194 (cur_attr == EP_ATTR_ADAPTIVE &&
1195 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1196 found = fp;
1197 cur_attr = attr;
1198 continue;
1199 }
1200 }
1201 /* find the format with the largest max. packet size */
1202 if (fp->maxpacksize > found->maxpacksize) {
1203 found = fp;
1204 cur_attr = attr;
1205 }
1206 }
1207 return found;
1208}
1209
1210
1211/*
1212 * initialize the picth control and sample rate
1213 */
1214static int init_usb_pitch(struct usb_device *dev, int iface,
1215 struct usb_host_interface *alts,
1216 struct audioformat *fmt)
1217{
1218 unsigned int ep;
1219 unsigned char data[1];
1220 int err;
1221
1222 ep = get_endpoint(alts, 0)->bEndpointAddress;
1223 /* if endpoint has pitch control, enable it */
1224 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1225 data[0] = 1;
1226 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1227 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1228 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1229 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1230 dev->devnum, iface, ep);
1231 return err;
1232 }
1233 }
1234 return 0;
1235}
1236
1237static int init_usb_sample_rate(struct usb_device *dev, int iface,
1238 struct usb_host_interface *alts,
1239 struct audioformat *fmt, int rate)
1240{
1241 unsigned int ep;
1242 unsigned char data[3];
1243 int err;
1244
1245 ep = get_endpoint(alts, 0)->bEndpointAddress;
1246 /* if endpoint has sampling rate control, set it */
1247 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1248 int crate;
1249 data[0] = rate;
1250 data[1] = rate >> 8;
1251 data[2] = rate >> 16;
1252 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1253 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1254 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1255 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1256 dev->devnum, iface, fmt->altsetting, rate, ep);
1257 return err;
1258 }
1259 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1260 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1261 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1262 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1263 dev->devnum, iface, fmt->altsetting, ep);
1264 return 0; /* some devices don't support reading */
1265 }
1266 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1267 if (crate != rate) {
1268 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1269 // runtime->rate = crate;
1270 }
1271 }
1272 return 0;
1273}
1274
1275/*
1276 * find a matching format and set up the interface
1277 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001278static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279{
1280 struct usb_device *dev = subs->dev;
1281 struct usb_host_interface *alts;
1282 struct usb_interface_descriptor *altsd;
1283 struct usb_interface *iface;
1284 unsigned int ep, attr;
1285 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1286 int err;
1287
1288 iface = usb_ifnum_to_if(dev, fmt->iface);
1289 snd_assert(iface, return -EINVAL);
1290 alts = &iface->altsetting[fmt->altset_idx];
1291 altsd = get_iface_desc(alts);
1292 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1293
1294 if (fmt == subs->cur_audiofmt)
1295 return 0;
1296
1297 /* close the old interface */
1298 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1299 usb_set_interface(subs->dev, subs->interface, 0);
1300 subs->interface = -1;
1301 subs->format = 0;
1302 }
1303
1304 /* set interface */
1305 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1306 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1307 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1308 dev->devnum, fmt->iface, fmt->altsetting);
1309 return -EIO;
1310 }
1311 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1312 subs->interface = fmt->iface;
1313 subs->format = fmt->altset_idx;
1314 }
1315
1316 /* create a data pipe */
1317 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1318 if (is_playback)
1319 subs->datapipe = usb_sndisocpipe(dev, ep);
1320 else
1321 subs->datapipe = usb_rcvisocpipe(dev, ep);
Clemens Ladisch573567e2005-06-27 08:17:30 +02001322 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1323 get_endpoint(alts, 0)->bInterval >= 1 &&
1324 get_endpoint(alts, 0)->bInterval <= 4)
1325 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1326 else
1327 subs->datainterval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 subs->syncpipe = subs->syncinterval = 0;
1329 subs->maxpacksize = fmt->maxpacksize;
1330 subs->fill_max = 0;
1331
1332 /* we need a sync pipe in async OUT or adaptive IN mode */
1333 /* check the number of EP, since some devices have broken
1334 * descriptors which fool us. if it has only one EP,
1335 * assume it as adaptive-out or sync-in.
1336 */
1337 attr = fmt->ep_attr & EP_ATTR_MASK;
1338 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1339 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1340 altsd->bNumEndpoints >= 2) {
1341 /* check sync-pipe endpoint */
1342 /* ... and check descriptor size before accessing bSynchAddress
1343 because there is a version of the SB Audigy 2 NX firmware lacking
1344 the audio fields in the endpoint descriptors */
1345 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1346 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1347 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1348 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1349 dev->devnum, fmt->iface, fmt->altsetting);
1350 return -EINVAL;
1351 }
1352 ep = get_endpoint(alts, 1)->bEndpointAddress;
1353 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1354 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1355 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1356 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1357 dev->devnum, fmt->iface, fmt->altsetting);
1358 return -EINVAL;
1359 }
1360 ep &= USB_ENDPOINT_NUMBER_MASK;
1361 if (is_playback)
1362 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1363 else
1364 subs->syncpipe = usb_sndisocpipe(dev, ep);
Clemens Ladisch1149a642005-05-02 08:53:46 +02001365 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1366 get_endpoint(alts, 1)->bRefresh >= 1 &&
1367 get_endpoint(alts, 1)->bRefresh <= 9)
1368 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
Clemens Ladisch604cf492005-05-17 09:15:27 +02001369 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
Clemens Ladisch1149a642005-05-02 08:53:46 +02001370 subs->syncinterval = 1;
Clemens Ladisch604cf492005-05-17 09:15:27 +02001371 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1372 get_endpoint(alts, 1)->bInterval <= 16)
1373 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1374 else
1375 subs->syncinterval = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 }
1377
1378 /* always fill max packet size */
1379 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1380 subs->fill_max = 1;
1381
1382 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1383 return err;
1384
1385 subs->cur_audiofmt = fmt;
1386
1387#if 0
1388 printk("setting done: format = %d, rate = %d, channels = %d\n",
1389 fmt->format, fmt->rate, fmt->channels);
1390 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1391 subs->datapipe, subs->syncpipe);
1392#endif
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 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001407static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1408 struct snd_pcm_hw_params *hw_params)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001410 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 struct audioformat *fmt;
1412 unsigned int channels, rate, format;
1413 int ret, changed;
1414
Clemens Ladisch6207e512005-08-15 08:35:25 +02001415 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1416 params_buffer_bytes(hw_params));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 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) {
Jaroslav Kysela21a34792006-01-13 09:12:11 +01001425 snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1426 format, rate, channels);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 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 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001464static int snd_usb_hw_free(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001466 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
1468 subs->cur_audiofmt = NULL;
1469 subs->cur_rate = 0;
1470 subs->period_bytes = 0;
1471 release_substream_urbs(subs, 0);
Clemens Ladisch6207e512005-08-15 08:35:25 +02001472 return snd_pcm_free_vmalloc_buffer(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473}
1474
1475/*
1476 * prepare callback
1477 *
1478 * only a few subtle things...
1479 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001480static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001482 struct snd_pcm_runtime *runtime = substream->runtime;
1483 struct snd_usb_substream *subs = runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
1485 if (! subs->cur_audiofmt) {
1486 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1487 return -ENXIO;
1488 }
1489
1490 /* some unit conversions in runtime */
1491 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1492 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1493
1494 /* reset the pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 subs->hwptr_done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 subs->transfer_done = 0;
1497 subs->phase = 0;
1498
1499 /* clear urbs (to be sure) */
1500 deactivate_urbs(subs, 0, 1);
1501 wait_clear_urbs(subs);
1502
Clemens Ladischb55bbf02005-11-02 11:32:52 +01001503 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1504 * updates for all URBs would happen at the same time when starting */
1505 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1506 subs->ops.prepare = prepare_startup_playback_urb;
1507 return start_urbs(subs, runtime);
1508 } else
1509 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510}
1511
Takashi Iwai86e07d32005-11-17 15:08:02 +01001512static struct snd_pcm_hardware snd_usb_playback =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513{
Clemens Ladisch49045d32005-09-05 10:31:05 +02001514 .info = SNDRV_PCM_INFO_MMAP |
1515 SNDRV_PCM_INFO_MMAP_VALID |
1516 SNDRV_PCM_INFO_BATCH |
1517 SNDRV_PCM_INFO_INTERLEAVED |
1518 SNDRV_PCM_INFO_BLOCK_TRANSFER,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001519 .buffer_bytes_max = 1024 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 .period_bytes_min = 64,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001521 .period_bytes_max = 512 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 .periods_min = 2,
1523 .periods_max = 1024,
1524};
1525
Takashi Iwai86e07d32005-11-17 15:08:02 +01001526static struct snd_pcm_hardware snd_usb_capture =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527{
Clemens Ladisch49045d32005-09-05 10:31:05 +02001528 .info = SNDRV_PCM_INFO_MMAP |
1529 SNDRV_PCM_INFO_MMAP_VALID |
1530 SNDRV_PCM_INFO_BATCH |
1531 SNDRV_PCM_INFO_INTERLEAVED |
1532 SNDRV_PCM_INFO_BLOCK_TRANSFER,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001533 .buffer_bytes_max = 1024 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 .period_bytes_min = 64,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001535 .period_bytes_max = 512 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 .periods_min = 2,
1537 .periods_max = 1024,
1538};
1539
1540/*
1541 * h/w constraints
1542 */
1543
1544#ifdef HW_CONST_DEBUG
1545#define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1546#else
1547#define hwc_debug(fmt, args...) /**/
1548#endif
1549
Takashi Iwai86e07d32005-11-17 15:08:02 +01001550static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001552 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1553 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1554 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
1556 /* check the format */
1557 if (! snd_mask_test(fmts, fp->format)) {
1558 hwc_debug(" > check: no supported format %d\n", fp->format);
1559 return 0;
1560 }
1561 /* check the channels */
1562 if (fp->channels < ct->min || fp->channels > ct->max) {
1563 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1564 return 0;
1565 }
1566 /* check the rate is within the range */
1567 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1568 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1569 return 0;
1570 }
1571 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1572 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1573 return 0;
1574 }
1575 return 1;
1576}
1577
Takashi Iwai86e07d32005-11-17 15:08:02 +01001578static int hw_rule_rate(struct snd_pcm_hw_params *params,
1579 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001581 struct snd_usb_substream *subs = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001583 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 unsigned int rmin, rmax;
1585 int changed;
1586
1587 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1588 changed = 0;
1589 rmin = rmax = 0;
1590 list_for_each(p, &subs->fmt_list) {
1591 struct audioformat *fp;
1592 fp = list_entry(p, struct audioformat, list);
1593 if (! hw_check_valid_format(params, fp))
1594 continue;
1595 if (changed++) {
1596 if (rmin > fp->rate_min)
1597 rmin = fp->rate_min;
1598 if (rmax < fp->rate_max)
1599 rmax = fp->rate_max;
1600 } else {
1601 rmin = fp->rate_min;
1602 rmax = fp->rate_max;
1603 }
1604 }
1605
1606 if (! changed) {
1607 hwc_debug(" --> get empty\n");
1608 it->empty = 1;
1609 return -EINVAL;
1610 }
1611
1612 changed = 0;
1613 if (it->min < rmin) {
1614 it->min = rmin;
1615 it->openmin = 0;
1616 changed = 1;
1617 }
1618 if (it->max > rmax) {
1619 it->max = rmax;
1620 it->openmax = 0;
1621 changed = 1;
1622 }
1623 if (snd_interval_checkempty(it)) {
1624 it->empty = 1;
1625 return -EINVAL;
1626 }
1627 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1628 return changed;
1629}
1630
1631
Takashi Iwai86e07d32005-11-17 15:08:02 +01001632static int hw_rule_channels(struct snd_pcm_hw_params *params,
1633 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001635 struct snd_usb_substream *subs = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001637 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 unsigned int rmin, rmax;
1639 int changed;
1640
1641 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1642 changed = 0;
1643 rmin = rmax = 0;
1644 list_for_each(p, &subs->fmt_list) {
1645 struct audioformat *fp;
1646 fp = list_entry(p, struct audioformat, list);
1647 if (! hw_check_valid_format(params, fp))
1648 continue;
1649 if (changed++) {
1650 if (rmin > fp->channels)
1651 rmin = fp->channels;
1652 if (rmax < fp->channels)
1653 rmax = fp->channels;
1654 } else {
1655 rmin = fp->channels;
1656 rmax = fp->channels;
1657 }
1658 }
1659
1660 if (! changed) {
1661 hwc_debug(" --> get empty\n");
1662 it->empty = 1;
1663 return -EINVAL;
1664 }
1665
1666 changed = 0;
1667 if (it->min < rmin) {
1668 it->min = rmin;
1669 it->openmin = 0;
1670 changed = 1;
1671 }
1672 if (it->max > rmax) {
1673 it->max = rmax;
1674 it->openmax = 0;
1675 changed = 1;
1676 }
1677 if (snd_interval_checkempty(it)) {
1678 it->empty = 1;
1679 return -EINVAL;
1680 }
1681 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1682 return changed;
1683}
1684
Takashi Iwai86e07d32005-11-17 15:08:02 +01001685static int hw_rule_format(struct snd_pcm_hw_params *params,
1686 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001688 struct snd_usb_substream *subs = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001690 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 u64 fbits;
1692 u32 oldbits[2];
1693 int changed;
1694
1695 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1696 fbits = 0;
1697 list_for_each(p, &subs->fmt_list) {
1698 struct audioformat *fp;
1699 fp = list_entry(p, struct audioformat, list);
1700 if (! hw_check_valid_format(params, fp))
1701 continue;
1702 fbits |= (1ULL << fp->format);
1703 }
1704
1705 oldbits[0] = fmt->bits[0];
1706 oldbits[1] = fmt->bits[1];
1707 fmt->bits[0] &= (u32)fbits;
1708 fmt->bits[1] &= (u32)(fbits >> 32);
1709 if (! fmt->bits[0] && ! fmt->bits[1]) {
1710 hwc_debug(" --> get empty\n");
1711 return -EINVAL;
1712 }
1713 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1714 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1715 return changed;
1716}
1717
1718#define MAX_MASK 64
1719
1720/*
1721 * check whether the registered audio formats need special hw-constraints
1722 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001723static int check_hw_params_convention(struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724{
1725 int i;
1726 u32 *channels;
1727 u32 *rates;
1728 u32 cmaster, rmaster;
1729 u32 rate_min = 0, rate_max = 0;
1730 struct list_head *p;
1731 int err = 1;
1732
1733 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1734 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1735
1736 list_for_each(p, &subs->fmt_list) {
1737 struct audioformat *f;
1738 f = list_entry(p, struct audioformat, list);
1739 /* unconventional channels? */
1740 if (f->channels > 32)
1741 goto __out;
1742 /* continuous rate min/max matches? */
1743 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1744 if (rate_min && f->rate_min != rate_min)
1745 goto __out;
1746 if (rate_max && f->rate_max != rate_max)
1747 goto __out;
1748 rate_min = f->rate_min;
1749 rate_max = f->rate_max;
1750 }
1751 /* combination of continuous rates and fixed rates? */
1752 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1753 if (f->rates != rates[f->format])
1754 goto __out;
1755 }
1756 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1757 if (rates[f->format] && rates[f->format] != f->rates)
1758 goto __out;
1759 }
1760 channels[f->format] |= (1 << f->channels);
1761 rates[f->format] |= f->rates;
1762 }
1763 /* check whether channels and rates match for all formats */
1764 cmaster = rmaster = 0;
1765 for (i = 0; i < MAX_MASK; i++) {
1766 if (cmaster != channels[i] && cmaster && channels[i])
1767 goto __out;
1768 if (rmaster != rates[i] && rmaster && rates[i])
1769 goto __out;
1770 if (channels[i])
1771 cmaster = channels[i];
1772 if (rates[i])
1773 rmaster = rates[i];
1774 }
1775 /* check whether channels match for all distinct rates */
1776 memset(channels, 0, MAX_MASK * sizeof(u32));
1777 list_for_each(p, &subs->fmt_list) {
1778 struct audioformat *f;
1779 f = list_entry(p, struct audioformat, list);
1780 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1781 continue;
1782 for (i = 0; i < 32; i++) {
1783 if (f->rates & (1 << i))
1784 channels[i] |= (1 << f->channels);
1785 }
1786 }
1787 cmaster = 0;
1788 for (i = 0; i < 32; i++) {
1789 if (cmaster != channels[i] && cmaster && channels[i])
1790 goto __out;
1791 if (channels[i])
1792 cmaster = channels[i];
1793 }
1794 err = 0;
1795
1796 __out:
1797 kfree(channels);
1798 kfree(rates);
1799 return err;
1800}
1801
1802
1803/*
1804 * set up the runtime hardware information.
1805 */
1806
Takashi Iwai86e07d32005-11-17 15:08:02 +01001807static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808{
1809 struct list_head *p;
1810 int err;
1811
1812 runtime->hw.formats = subs->formats;
1813
1814 runtime->hw.rate_min = 0x7fffffff;
1815 runtime->hw.rate_max = 0;
1816 runtime->hw.channels_min = 256;
1817 runtime->hw.channels_max = 0;
1818 runtime->hw.rates = 0;
1819 /* check min/max rates and channels */
1820 list_for_each(p, &subs->fmt_list) {
1821 struct audioformat *fp;
1822 fp = list_entry(p, struct audioformat, list);
1823 runtime->hw.rates |= fp->rates;
1824 if (runtime->hw.rate_min > fp->rate_min)
1825 runtime->hw.rate_min = fp->rate_min;
1826 if (runtime->hw.rate_max < fp->rate_max)
1827 runtime->hw.rate_max = fp->rate_max;
1828 if (runtime->hw.channels_min > fp->channels)
1829 runtime->hw.channels_min = fp->channels;
1830 if (runtime->hw.channels_max < fp->channels)
1831 runtime->hw.channels_max = fp->channels;
1832 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1833 /* FIXME: there might be more than one audio formats... */
1834 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1835 fp->frame_size;
1836 }
1837 }
1838
1839 /* set the period time minimum 1ms */
1840 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1841 1000 * MIN_PACKS_URB,
1842 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1843
1844 if (check_hw_params_convention(subs)) {
1845 hwc_debug("setting extra hw constraints...\n");
1846 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1847 hw_rule_rate, subs,
1848 SNDRV_PCM_HW_PARAM_FORMAT,
1849 SNDRV_PCM_HW_PARAM_CHANNELS,
1850 -1)) < 0)
1851 return err;
1852 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1853 hw_rule_channels, subs,
1854 SNDRV_PCM_HW_PARAM_FORMAT,
1855 SNDRV_PCM_HW_PARAM_RATE,
1856 -1)) < 0)
1857 return err;
1858 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1859 hw_rule_format, subs,
1860 SNDRV_PCM_HW_PARAM_RATE,
1861 SNDRV_PCM_HW_PARAM_CHANNELS,
1862 -1)) < 0)
1863 return err;
1864 }
1865 return 0;
1866}
1867
Takashi Iwai86e07d32005-11-17 15:08:02 +01001868static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction,
1869 struct snd_pcm_hardware *hw)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001871 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1872 struct snd_pcm_runtime *runtime = substream->runtime;
1873 struct snd_usb_substream *subs = &as->substream[direction];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
1875 subs->interface = -1;
1876 subs->format = 0;
1877 runtime->hw = *hw;
1878 runtime->private_data = subs;
1879 subs->pcm_substream = substream;
1880 return setup_hw_info(runtime, subs);
1881}
1882
Takashi Iwai86e07d32005-11-17 15:08:02 +01001883static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001885 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1886 struct snd_usb_substream *subs = &as->substream[direction];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887
1888 if (subs->interface >= 0) {
1889 usb_set_interface(subs->dev, subs->interface, 0);
1890 subs->interface = -1;
1891 }
1892 subs->pcm_substream = NULL;
1893 return 0;
1894}
1895
Takashi Iwai86e07d32005-11-17 15:08:02 +01001896static int snd_usb_playback_open(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897{
1898 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1899}
1900
Takashi Iwai86e07d32005-11-17 15:08:02 +01001901static int snd_usb_playback_close(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902{
1903 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1904}
1905
Takashi Iwai86e07d32005-11-17 15:08:02 +01001906static int snd_usb_capture_open(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907{
1908 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1909}
1910
Takashi Iwai86e07d32005-11-17 15:08:02 +01001911static int snd_usb_capture_close(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912{
1913 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1914}
1915
Takashi Iwai86e07d32005-11-17 15:08:02 +01001916static struct snd_pcm_ops snd_usb_playback_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 .open = snd_usb_playback_open,
1918 .close = snd_usb_playback_close,
1919 .ioctl = snd_pcm_lib_ioctl,
1920 .hw_params = snd_usb_hw_params,
1921 .hw_free = snd_usb_hw_free,
1922 .prepare = snd_usb_pcm_prepare,
Clemens Ladischb55bbf02005-11-02 11:32:52 +01001923 .trigger = snd_usb_pcm_playback_trigger,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 .pointer = snd_usb_pcm_pointer,
Clemens Ladisch6207e512005-08-15 08:35:25 +02001925 .page = snd_pcm_get_vmalloc_page,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926};
1927
Takashi Iwai86e07d32005-11-17 15:08:02 +01001928static struct snd_pcm_ops snd_usb_capture_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 .open = snd_usb_capture_open,
1930 .close = snd_usb_capture_close,
1931 .ioctl = snd_pcm_lib_ioctl,
1932 .hw_params = snd_usb_hw_params,
1933 .hw_free = snd_usb_hw_free,
1934 .prepare = snd_usb_pcm_prepare,
Clemens Ladischb55bbf02005-11-02 11:32:52 +01001935 .trigger = snd_usb_pcm_capture_trigger,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 .pointer = snd_usb_pcm_pointer,
Clemens Ladisch6207e512005-08-15 08:35:25 +02001937 .page = snd_pcm_get_vmalloc_page,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938};
1939
1940
1941
1942/*
1943 * helper functions
1944 */
1945
1946/*
1947 * combine bytes and get an integer value
1948 */
1949unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1950{
1951 switch (size) {
1952 case 1: return *bytes;
1953 case 2: return combine_word(bytes);
1954 case 3: return combine_triple(bytes);
1955 case 4: return combine_quad(bytes);
1956 default: return 0;
1957 }
1958}
1959
1960/*
1961 * parse descriptor buffer and return the pointer starting the given
1962 * descriptor type.
1963 */
1964void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
1965{
1966 u8 *p, *end, *next;
1967
1968 p = descstart;
1969 end = p + desclen;
1970 for (; p < end;) {
1971 if (p[0] < 2)
1972 return NULL;
1973 next = p + p[0];
1974 if (next > end)
1975 return NULL;
1976 if (p[1] == dtype && (!after || (void *)p > after)) {
1977 return p;
1978 }
1979 p = next;
1980 }
1981 return NULL;
1982}
1983
1984/*
1985 * find a class-specified interface descriptor with the given subtype.
1986 */
1987void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
1988{
1989 unsigned char *p = after;
1990
1991 while ((p = snd_usb_find_desc(buffer, buflen, p,
1992 USB_DT_CS_INTERFACE)) != NULL) {
1993 if (p[0] >= 3 && p[2] == dsubtype)
1994 return p;
1995 }
1996 return NULL;
1997}
1998
1999/*
2000 * Wrapper for usb_control_msg().
2001 * Allocates a temp buffer to prevent dmaing from/to the stack.
2002 */
2003int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2004 __u8 requesttype, __u16 value, __u16 index, void *data,
2005 __u16 size, int timeout)
2006{
2007 int err;
2008 void *buf = NULL;
2009
2010 if (size > 0) {
2011 buf = kmalloc(size, GFP_KERNEL);
2012 if (!buf)
2013 return -ENOMEM;
2014 memcpy(buf, data, size);
2015 }
2016 err = usb_control_msg(dev, pipe, request, requesttype,
2017 value, index, buf, size, timeout);
2018 if (size > 0) {
2019 memcpy(data, buf, size);
2020 kfree(buf);
2021 }
2022 return err;
2023}
2024
2025
2026/*
2027 * entry point for linux usb interface
2028 */
2029
2030static int usb_audio_probe(struct usb_interface *intf,
2031 const struct usb_device_id *id);
2032static void usb_audio_disconnect(struct usb_interface *intf);
2033
2034static struct usb_device_id usb_audio_ids [] = {
2035#include "usbquirks.h"
2036 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2037 .bInterfaceClass = USB_CLASS_AUDIO,
2038 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2039 { } /* Terminating entry */
2040};
2041
2042MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2043
2044static struct usb_driver usb_audio_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 .name = "snd-usb-audio",
2046 .probe = usb_audio_probe,
2047 .disconnect = usb_audio_disconnect,
2048 .id_table = usb_audio_ids,
2049};
2050
2051
Jaroslav Kysela21a34792006-01-13 09:12:11 +01002052#if defined(CONFIG_PROCFS) && defined(CONFIG_SND_VERBOSE_PROCFS)
2053
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054/*
2055 * proc interface for list the supported pcm formats
2056 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002057static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058{
2059 struct list_head *p;
2060 static char *sync_types[4] = {
2061 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2062 };
2063
2064 list_for_each(p, &subs->fmt_list) {
2065 struct audioformat *fp;
2066 fp = list_entry(p, struct audioformat, list);
2067 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2068 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
Jaroslav Kysela3f72a302006-01-18 11:50:40 +01002069 snd_iprintf(buffer, " Format: 0x%x\n", fp->format);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2071 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2072 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2073 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2074 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2075 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2076 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2077 fp->rate_min, fp->rate_max);
2078 } else {
2079 unsigned int i;
2080 snd_iprintf(buffer, " Rates: ");
2081 for (i = 0; i < fp->nr_rates; i++) {
2082 if (i > 0)
2083 snd_iprintf(buffer, ", ");
2084 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2085 }
2086 snd_iprintf(buffer, "\n");
2087 }
2088 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2089 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2090 }
2091}
2092
Takashi Iwai86e07d32005-11-17 15:08:02 +01002093static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
2095 if (subs->running) {
2096 unsigned int i;
2097 snd_iprintf(buffer, " Status: Running\n");
2098 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2099 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2100 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2101 for (i = 0; i < subs->nurbs; i++)
2102 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2103 snd_iprintf(buffer, "]\n");
2104 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
Clemens Ladisch08fe1582005-04-22 15:33:01 +02002105 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2107 ? get_full_speed_hz(subs->freqm)
Clemens Ladisch08fe1582005-04-22 15:33:01 +02002108 : get_high_speed_hz(subs->freqm),
2109 subs->freqm >> 16, subs->freqm & 0xffff);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110 } else {
2111 snd_iprintf(buffer, " Status: Stop\n");
2112 }
2113}
2114
Takashi Iwai86e07d32005-11-17 15:08:02 +01002115static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002117 struct snd_usb_stream *stream = entry->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118
2119 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2120
2121 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2122 snd_iprintf(buffer, "\nPlayback:\n");
2123 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2124 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2125 }
2126 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2127 snd_iprintf(buffer, "\nCapture:\n");
2128 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2129 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2130 }
2131}
2132
Takashi Iwai86e07d32005-11-17 15:08:02 +01002133static void proc_pcm_format_add(struct snd_usb_stream *stream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002135 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 char name[32];
Takashi Iwai86e07d32005-11-17 15:08:02 +01002137 struct snd_card *card = stream->chip->card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138
2139 sprintf(name, "stream%d", stream->pcm_index);
2140 if (! snd_card_proc_new(card, name, &entry))
Takashi Iwaibf850202006-04-28 15:13:41 +02002141 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142}
2143
Jaroslav Kysela21a34792006-01-13 09:12:11 +01002144#else
2145
2146static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2147{
2148}
2149
2150#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151
2152/*
2153 * initialize the substream instance.
2154 */
2155
Takashi Iwai86e07d32005-11-17 15:08:02 +01002156static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002158 struct snd_usb_substream *subs = &as->substream[stream];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159
2160 INIT_LIST_HEAD(&subs->fmt_list);
2161 spin_lock_init(&subs->lock);
2162
2163 subs->stream = as;
2164 subs->direction = stream;
2165 subs->dev = as->chip->dev;
2166 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2167 subs->ops = audio_urb_ops[stream];
2168 else
2169 subs->ops = audio_urb_ops_high_speed[stream];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 snd_pcm_set_ops(as->pcm, stream,
2171 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2172 &snd_usb_playback_ops : &snd_usb_capture_ops);
2173
2174 list_add_tail(&fp->list, &subs->fmt_list);
2175 subs->formats |= 1ULL << fp->format;
2176 subs->endpoint = fp->endpoint;
2177 subs->num_formats++;
2178 subs->fmt_type = fp->fmt_type;
2179}
2180
2181
2182/*
2183 * free a substream
2184 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002185static void free_substream(struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186{
2187 struct list_head *p, *n;
2188
2189 if (! subs->num_formats)
2190 return; /* not initialized */
2191 list_for_each_safe(p, n, &subs->fmt_list) {
2192 struct audioformat *fp = list_entry(p, struct audioformat, list);
2193 kfree(fp->rate_table);
2194 kfree(fp);
2195 }
2196}
2197
2198
2199/*
2200 * free a usb stream instance
2201 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002202static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203{
2204 free_substream(&stream->substream[0]);
2205 free_substream(&stream->substream[1]);
2206 list_del(&stream->list);
2207 kfree(stream);
2208}
2209
Takashi Iwai86e07d32005-11-17 15:08:02 +01002210static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002212 struct snd_usb_stream *stream = pcm->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 if (stream) {
2214 stream->pcm = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 snd_usb_audio_stream_free(stream);
2216 }
2217}
2218
2219
2220/*
2221 * add this endpoint to the chip instance.
2222 * if a stream with the same endpoint already exists, append to it.
2223 * if not, create a new pcm stream.
2224 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002225static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226{
2227 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01002228 struct snd_usb_stream *as;
2229 struct snd_usb_substream *subs;
2230 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 int err;
2232
2233 list_for_each(p, &chip->pcm_list) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002234 as = list_entry(p, struct snd_usb_stream, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 if (as->fmt_type != fp->fmt_type)
2236 continue;
2237 subs = &as->substream[stream];
2238 if (! subs->endpoint)
2239 continue;
2240 if (subs->endpoint == fp->endpoint) {
2241 list_add_tail(&fp->list, &subs->fmt_list);
2242 subs->num_formats++;
2243 subs->formats |= 1ULL << fp->format;
2244 return 0;
2245 }
2246 }
2247 /* look for an empty stream */
2248 list_for_each(p, &chip->pcm_list) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002249 as = list_entry(p, struct snd_usb_stream, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 if (as->fmt_type != fp->fmt_type)
2251 continue;
2252 subs = &as->substream[stream];
2253 if (subs->endpoint)
2254 continue;
2255 err = snd_pcm_new_stream(as->pcm, stream, 1);
2256 if (err < 0)
2257 return err;
2258 init_substream(as, stream, fp);
2259 return 0;
2260 }
2261
2262 /* create a new pcm */
2263 as = kmalloc(sizeof(*as), GFP_KERNEL);
2264 if (! as)
2265 return -ENOMEM;
2266 memset(as, 0, sizeof(*as));
2267 as->pcm_index = chip->pcm_devs;
2268 as->chip = chip;
2269 as->fmt_type = fp->fmt_type;
2270 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2271 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2272 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2273 &pcm);
2274 if (err < 0) {
2275 kfree(as);
2276 return err;
2277 }
2278 as->pcm = pcm;
2279 pcm->private_data = as;
2280 pcm->private_free = snd_usb_audio_pcm_free;
2281 pcm->info_flags = 0;
2282 if (chip->pcm_devs > 0)
2283 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2284 else
2285 strcpy(pcm->name, "USB Audio");
2286
2287 init_substream(as, stream, fp);
2288
2289 list_add(&as->list, &chip->pcm_list);
2290 chip->pcm_devs++;
2291
2292 proc_pcm_format_add(as);
2293
2294 return 0;
2295}
2296
2297
2298/*
2299 * check if the device uses big-endian samples
2300 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002301static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302{
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002303 switch (chip->usb_id) {
2304 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2305 if (fp->endpoint & USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 return 1;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002307 break;
2308 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2309 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 }
2311 return 0;
2312}
2313
2314/*
2315 * parse the audio format type I descriptor
2316 * and returns the corresponding pcm format
2317 *
2318 * @dev: usb device
2319 * @fp: audioformat record
2320 * @format: the format tag (wFormatTag)
2321 * @fmt: the format type descriptor
2322 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002323static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 int format, unsigned char *fmt)
2325{
2326 int pcm_format;
2327 int sample_width, sample_bytes;
2328
2329 /* FIXME: correct endianess and sign? */
2330 pcm_format = -1;
2331 sample_width = fmt[6];
2332 sample_bytes = fmt[5];
2333 switch (format) {
2334 case 0: /* some devices don't define this correctly... */
2335 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002336 chip->dev->devnum, fp->iface, fp->altsetting);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 /* fall-through */
2338 case USB_AUDIO_FORMAT_PCM:
2339 if (sample_width > sample_bytes * 8) {
2340 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002341 chip->dev->devnum, fp->iface, fp->altsetting,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 sample_width, sample_bytes);
2343 }
2344 /* check the format byte size */
2345 switch (fmt[5]) {
2346 case 1:
2347 pcm_format = SNDRV_PCM_FORMAT_S8;
2348 break;
2349 case 2:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002350 if (is_big_endian_format(chip, fp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2352 else
2353 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2354 break;
2355 case 3:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002356 if (is_big_endian_format(chip, fp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2358 else
2359 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2360 break;
2361 case 4:
2362 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2363 break;
2364 default:
2365 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002366 chip->dev->devnum, fp->iface,
2367 fp->altsetting, sample_width, sample_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 break;
2369 }
2370 break;
2371 case USB_AUDIO_FORMAT_PCM8:
2372 /* Dallas DS4201 workaround */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002373 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 pcm_format = SNDRV_PCM_FORMAT_S8;
2375 else
2376 pcm_format = SNDRV_PCM_FORMAT_U8;
2377 break;
2378 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2379 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2380 break;
2381 case USB_AUDIO_FORMAT_ALAW:
2382 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2383 break;
2384 case USB_AUDIO_FORMAT_MU_LAW:
2385 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2386 break;
2387 default:
2388 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002389 chip->dev->devnum, fp->iface, fp->altsetting, format);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 break;
2391 }
2392 return pcm_format;
2393}
2394
2395
2396/*
2397 * parse the format descriptor and stores the possible sample rates
2398 * on the audioformat table.
2399 *
2400 * @dev: usb device
2401 * @fp: audioformat record
2402 * @fmt: the format descriptor
2403 * @offset: the start offset of descriptor pointing the rate type
2404 * (7 for type I and II, 8 for type II)
2405 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002406static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 unsigned char *fmt, int offset)
2408{
2409 int nr_rates = fmt[offset];
2410 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2411 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002412 chip->dev->devnum, fp->iface, fp->altsetting);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 return -1;
2414 }
2415
2416 if (nr_rates) {
2417 /*
2418 * build the rate table and bitmap flags
2419 */
2420 int r, idx, c;
2421 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2422 static unsigned int conv_rates[] = {
2423 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2424 64000, 88200, 96000, 176400, 192000
2425 };
2426 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2427 if (fp->rate_table == NULL) {
2428 snd_printk(KERN_ERR "cannot malloc\n");
2429 return -1;
2430 }
2431
2432 fp->nr_rates = nr_rates;
2433 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2434 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2435 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2436 if (rate < fp->rate_min)
2437 fp->rate_min = rate;
2438 else if (rate > fp->rate_max)
2439 fp->rate_max = rate;
2440 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2441 if (rate == conv_rates[c]) {
2442 fp->rates |= (1 << c);
2443 break;
2444 }
2445 }
2446 }
2447 } else {
2448 /* continuous rates */
2449 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2450 fp->rate_min = combine_triple(&fmt[offset + 1]);
2451 fp->rate_max = combine_triple(&fmt[offset + 4]);
2452 }
2453 return 0;
2454}
2455
2456/*
2457 * parse the format type I and III descriptors
2458 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002459static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 int format, unsigned char *fmt)
2461{
2462 int pcm_format;
2463
2464 if (fmt[3] == USB_FORMAT_TYPE_III) {
2465 /* FIXME: the format type is really IECxxx
2466 * but we give normal PCM format to get the existing
2467 * apps working...
2468 */
2469 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2470 } else {
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002471 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 if (pcm_format < 0)
2473 return -1;
2474 }
2475 fp->format = pcm_format;
2476 fp->channels = fmt[4];
2477 if (fp->channels < 1) {
2478 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002479 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 return -1;
2481 }
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002482 return parse_audio_format_rates(chip, fp, fmt, 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483}
2484
2485/*
2486 * prase the format type II descriptor
2487 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002488static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 int format, unsigned char *fmt)
2490{
2491 int brate, framesize;
2492 switch (format) {
2493 case USB_AUDIO_FORMAT_AC3:
2494 /* FIXME: there is no AC3 format defined yet */
2495 // fp->format = SNDRV_PCM_FORMAT_AC3;
2496 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2497 break;
2498 case USB_AUDIO_FORMAT_MPEG:
2499 fp->format = SNDRV_PCM_FORMAT_MPEG;
2500 break;
2501 default:
2502 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag 0x%x is detected. processed as MPEG.\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002503 chip->dev->devnum, fp->iface, fp->altsetting, format);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 fp->format = SNDRV_PCM_FORMAT_MPEG;
2505 break;
2506 }
2507 fp->channels = 1;
2508 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2509 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2510 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2511 fp->frame_size = framesize;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002512 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513}
2514
Takashi Iwai86e07d32005-11-17 15:08:02 +01002515static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 int format, unsigned char *fmt, int stream)
2517{
2518 int err;
2519
2520 switch (fmt[3]) {
2521 case USB_FORMAT_TYPE_I:
2522 case USB_FORMAT_TYPE_III:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002523 err = parse_audio_format_i(chip, fp, format, fmt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 break;
2525 case USB_FORMAT_TYPE_II:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002526 err = parse_audio_format_ii(chip, fp, format, fmt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527 break;
2528 default:
2529 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002530 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 return -1;
2532 }
2533 fp->fmt_type = fmt[3];
2534 if (err < 0)
2535 return err;
2536#if 1
Clemens Ladisch33159372006-01-13 08:11:22 +01002537 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 /* extigy apparently supports sample rates other than 48k
2539 * but not in ordinary way. so we enable only 48k atm.
2540 */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002541 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
Clemens Ladisch33159372006-01-13 08:11:22 +01002542 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2543 chip->usb_id == USB_ID(0x041e, 0x3061)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 if (fmt[3] == USB_FORMAT_TYPE_I &&
Clemens Ladisch8c1872d2005-04-28 09:31:53 +02002545 fp->rates != SNDRV_PCM_RATE_48000 &&
2546 fp->rates != SNDRV_PCM_RATE_96000)
Clemens Ladischb4d3f9d2005-06-27 08:18:27 +02002547 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548 }
2549#endif
2550 return 0;
2551}
2552
Thibault LE MEURe3113342006-03-14 11:44:53 +01002553static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2554 int iface, int altno);
Takashi Iwai86e07d32005-11-17 15:08:02 +01002555static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556{
2557 struct usb_device *dev;
2558 struct usb_interface *iface;
2559 struct usb_host_interface *alts;
2560 struct usb_interface_descriptor *altsd;
2561 int i, altno, err, stream;
2562 int format;
2563 struct audioformat *fp;
2564 unsigned char *fmt, *csep;
2565
2566 dev = chip->dev;
2567
2568 /* parse the interface's altsettings */
2569 iface = usb_ifnum_to_if(dev, iface_no);
2570 for (i = 0; i < iface->num_altsetting; i++) {
2571 alts = &iface->altsetting[i];
2572 altsd = get_iface_desc(alts);
2573 /* skip invalid one */
2574 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2575 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2576 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2577 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2578 altsd->bNumEndpoints < 1 ||
2579 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2580 continue;
2581 /* must be isochronous */
2582 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2583 USB_ENDPOINT_XFER_ISOC)
2584 continue;
2585 /* check direction */
2586 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2587 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2588 altno = altsd->bAlternateSetting;
Thibault LE MEURe3113342006-03-14 11:44:53 +01002589
2590 /* audiophile usb: skip altsets incompatible with device_setup
2591 */
2592 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2593 audiophile_skip_setting_quirk(chip, iface_no, altno))
2594 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595
2596 /* get audio formats */
2597 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2598 if (!fmt) {
2599 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2600 dev->devnum, iface_no, altno);
2601 continue;
2602 }
2603
2604 if (fmt[0] < 7) {
2605 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2606 dev->devnum, iface_no, altno);
2607 continue;
2608 }
2609
2610 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2611
2612 /* get format type */
2613 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2614 if (!fmt) {
2615 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2616 dev->devnum, iface_no, altno);
2617 continue;
2618 }
2619 if (fmt[0] < 8) {
2620 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2621 dev->devnum, iface_no, altno);
2622 continue;
2623 }
2624
2625 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2626 /* Creamware Noah has this descriptor after the 2nd endpoint */
2627 if (!csep && altsd->bNumEndpoints >= 2)
2628 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2629 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
Takashi Iwaif8c75792006-05-18 14:47:03 +02002630 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
Clemens Ladischfaf8d112006-05-18 09:35:15 +02002631 " class specific endpoint descriptor\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 dev->devnum, iface_no, altno);
Clemens Ladischfaf8d112006-05-18 09:35:15 +02002633 csep = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634 }
2635
2636 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2637 if (! fp) {
2638 snd_printk(KERN_ERR "cannot malloc\n");
2639 return -ENOMEM;
2640 }
2641
2642 memset(fp, 0, sizeof(*fp));
2643 fp->iface = iface_no;
2644 fp->altsetting = altno;
2645 fp->altset_idx = i;
2646 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2647 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
Clemens Ladisch573567e2005-06-27 08:17:30 +02002649 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2650 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2651 * (fp->maxpacksize & 0x7ff);
Clemens Ladischfaf8d112006-05-18 09:35:15 +02002652 fp->attributes = csep ? csep[3] : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653
2654 /* some quirks for attributes here */
2655
Clemens Ladischc3f93292005-05-04 14:56:04 +02002656 switch (chip->usb_id) {
2657 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658 /* Optoplay sets the sample rate attribute although
2659 * it seems not supporting it in fact.
2660 */
2661 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
Clemens Ladischc3f93292005-05-04 14:56:04 +02002662 break;
2663 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2664 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 /* doesn't set the sample rate attribute, but supports it */
2666 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
Clemens Ladischc3f93292005-05-04 14:56:04 +02002667 break;
2668 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2669 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2670 an older model 77d:223) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 /*
2672 * plantronics headset and Griffin iMic have set adaptive-in
2673 * although it's really not...
2674 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675 fp->ep_attr &= ~EP_ATTR_MASK;
2676 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2677 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2678 else
2679 fp->ep_attr |= EP_ATTR_SYNC;
Clemens Ladischc3f93292005-05-04 14:56:04 +02002680 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 }
2682
2683 /* ok, let's parse further... */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002684 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 kfree(fp->rate_table);
2686 kfree(fp);
2687 continue;
2688 }
2689
Thibault LE MEURe3113342006-03-14 11:44:53 +01002690 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint 0x%x\n", dev->devnum, iface_no, altno, fp->endpoint);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691 err = add_audio_endpoint(chip, stream, fp);
2692 if (err < 0) {
2693 kfree(fp->rate_table);
2694 kfree(fp);
2695 return err;
2696 }
2697 /* try to set the interface... */
2698 usb_set_interface(chip->dev, iface_no, altno);
2699 init_usb_pitch(chip->dev, iface_no, alts, fp);
2700 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2701 }
2702 return 0;
2703}
2704
2705
2706/*
2707 * disconnect streams
2708 * called from snd_usb_audio_disconnect()
2709 */
Clemens Ladischee733392005-04-25 10:34:13 +02002710static void snd_usb_stream_disconnect(struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711{
2712 int idx;
Takashi Iwai86e07d32005-11-17 15:08:02 +01002713 struct snd_usb_stream *as;
2714 struct snd_usb_substream *subs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715
Takashi Iwai86e07d32005-11-17 15:08:02 +01002716 as = list_entry(head, struct snd_usb_stream, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 for (idx = 0; idx < 2; idx++) {
2718 subs = &as->substream[idx];
2719 if (!subs->num_formats)
2720 return;
2721 release_substream_urbs(subs, 1);
2722 subs->interface = -1;
2723 }
2724}
2725
2726/*
2727 * parse audio control descriptor and create pcm/midi streams
2728 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002729static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730{
2731 struct usb_device *dev = chip->dev;
2732 struct usb_host_interface *host_iface;
2733 struct usb_interface *iface;
2734 unsigned char *p1;
2735 int i, j;
2736
2737 /* find audiocontrol interface */
2738 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2739 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2740 snd_printk(KERN_ERR "cannot find HEADER\n");
2741 return -EINVAL;
2742 }
2743 if (! p1[7] || p1[0] < 8 + p1[7]) {
2744 snd_printk(KERN_ERR "invalid HEADER\n");
2745 return -EINVAL;
2746 }
2747
2748 /*
2749 * parse all USB audio streaming interfaces
2750 */
2751 for (i = 0; i < p1[7]; i++) {
2752 struct usb_host_interface *alts;
2753 struct usb_interface_descriptor *altsd;
2754 j = p1[8 + i];
2755 iface = usb_ifnum_to_if(dev, j);
2756 if (!iface) {
2757 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2758 dev->devnum, ctrlif, j);
2759 continue;
2760 }
2761 if (usb_interface_claimed(iface)) {
2762 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2763 continue;
2764 }
2765 alts = &iface->altsetting[0];
2766 altsd = get_iface_desc(alts);
2767 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2768 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2769 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2770 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2771 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2772 continue;
2773 }
2774 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2775 continue;
2776 }
2777 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2778 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2779 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2780 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2781 /* skip non-supported classes */
2782 continue;
2783 }
2784 if (! parse_audio_endpoints(chip, j)) {
2785 usb_set_interface(dev, j, 0); /* reset the current interface */
2786 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2787 }
2788 }
2789
2790 return 0;
2791}
2792
2793/*
2794 * create a stream for an endpoint/altsetting without proper descriptors
2795 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002796static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002798 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799{
2800 struct audioformat *fp;
2801 struct usb_host_interface *alts;
2802 int stream, err;
2803 int *rate_table = NULL;
2804
2805 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2806 if (! fp) {
2807 snd_printk(KERN_ERR "cannot malloc\n");
2808 return -ENOMEM;
2809 }
2810 memcpy(fp, quirk->data, sizeof(*fp));
2811 if (fp->nr_rates > 0) {
2812 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2813 if (!rate_table) {
2814 kfree(fp);
2815 return -ENOMEM;
2816 }
2817 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2818 fp->rate_table = rate_table;
2819 }
2820
2821 stream = (fp->endpoint & USB_DIR_IN)
2822 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2823 err = add_audio_endpoint(chip, stream, fp);
2824 if (err < 0) {
2825 kfree(fp);
2826 kfree(rate_table);
2827 return err;
2828 }
2829 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2830 fp->altset_idx >= iface->num_altsetting) {
2831 kfree(fp);
2832 kfree(rate_table);
2833 return -EINVAL;
2834 }
2835 alts = &iface->altsetting[fp->altset_idx];
2836 usb_set_interface(chip->dev, fp->iface, 0);
2837 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2838 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2839 return 0;
2840}
2841
2842/*
2843 * create a stream for an interface with proper descriptors
2844 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002845static int create_standard_audio_quirk(struct snd_usb_audio *chip,
Clemens Ladischd1bda042005-09-14 08:36:03 +02002846 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002847 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848{
2849 struct usb_host_interface *alts;
2850 struct usb_interface_descriptor *altsd;
2851 int err;
2852
2853 alts = &iface->altsetting[0];
2854 altsd = get_iface_desc(alts);
Clemens Ladischd1bda042005-09-14 08:36:03 +02002855 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 if (err < 0) {
2857 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2858 altsd->bInterfaceNumber, err);
2859 return err;
2860 }
Clemens Ladischd1bda042005-09-14 08:36:03 +02002861 /* reset the current interface */
2862 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 return 0;
2864}
2865
2866/*
2867 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2868 * to detect the sample rate is by looking at wMaxPacketSize.
2869 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002870static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
Clemens Ladisch854af952005-07-25 16:19:10 +02002871 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002872 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873{
2874 static const struct audioformat ua_format = {
2875 .format = SNDRV_PCM_FORMAT_S24_3LE,
2876 .channels = 2,
2877 .fmt_type = USB_FORMAT_TYPE_I,
2878 .altsetting = 1,
2879 .altset_idx = 1,
2880 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2881 };
2882 struct usb_host_interface *alts;
2883 struct usb_interface_descriptor *altsd;
2884 struct audioformat *fp;
2885 int stream, err;
2886
2887 /* both PCM and MIDI interfaces have 2 altsettings */
2888 if (iface->num_altsetting != 2)
2889 return -ENXIO;
2890 alts = &iface->altsetting[1];
2891 altsd = get_iface_desc(alts);
2892
2893 if (altsd->bNumEndpoints == 2) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002894 static const struct snd_usb_midi_endpoint_info ua700_ep = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 .out_cables = 0x0003,
2896 .in_cables = 0x0003
2897 };
Takashi Iwai86e07d32005-11-17 15:08:02 +01002898 static const struct snd_usb_audio_quirk ua700_quirk = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2900 .data = &ua700_ep
2901 };
Takashi Iwai86e07d32005-11-17 15:08:02 +01002902 static const struct snd_usb_midi_endpoint_info ua25_ep = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903 .out_cables = 0x0001,
2904 .in_cables = 0x0001
2905 };
Takashi Iwai86e07d32005-11-17 15:08:02 +01002906 static const struct snd_usb_audio_quirk ua25_quirk = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2908 .data = &ua25_ep
2909 };
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002910 if (chip->usb_id == USB_ID(0x0582, 0x002b))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 return snd_usb_create_midi_interface(chip, iface,
2912 &ua700_quirk);
2913 else
2914 return snd_usb_create_midi_interface(chip, iface,
2915 &ua25_quirk);
2916 }
2917
2918 if (altsd->bNumEndpoints != 1)
2919 return -ENXIO;
2920
2921 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2922 if (!fp)
2923 return -ENOMEM;
2924 memcpy(fp, &ua_format, sizeof(*fp));
2925
2926 fp->iface = altsd->bInterfaceNumber;
2927 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2928 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2929 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2930
2931 switch (fp->maxpacksize) {
2932 case 0x120:
2933 fp->rate_max = fp->rate_min = 44100;
2934 break;
2935 case 0x138:
2936 case 0x140:
2937 fp->rate_max = fp->rate_min = 48000;
2938 break;
2939 case 0x258:
2940 case 0x260:
2941 fp->rate_max = fp->rate_min = 96000;
2942 break;
2943 default:
2944 snd_printk(KERN_ERR "unknown sample rate\n");
2945 kfree(fp);
2946 return -ENXIO;
2947 }
2948
2949 stream = (fp->endpoint & USB_DIR_IN)
2950 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2951 err = add_audio_endpoint(chip, stream, fp);
2952 if (err < 0) {
2953 kfree(fp);
2954 return err;
2955 }
2956 usb_set_interface(chip->dev, fp->iface, 0);
2957 return 0;
2958}
2959
2960/*
2961 * Create a stream for an Edirol UA-1000 interface.
2962 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002963static int create_ua1000_quirk(struct snd_usb_audio *chip,
Clemens Ladisch854af952005-07-25 16:19:10 +02002964 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002965 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966{
2967 static const struct audioformat ua1000_format = {
2968 .format = SNDRV_PCM_FORMAT_S32_LE,
2969 .fmt_type = USB_FORMAT_TYPE_I,
2970 .altsetting = 1,
2971 .altset_idx = 1,
2972 .attributes = 0,
2973 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2974 };
2975 struct usb_host_interface *alts;
2976 struct usb_interface_descriptor *altsd;
2977 struct audioformat *fp;
2978 int stream, err;
2979
2980 if (iface->num_altsetting != 2)
2981 return -ENXIO;
2982 alts = &iface->altsetting[1];
2983 altsd = get_iface_desc(alts);
Ben Williamsonc4a87ef2006-06-19 17:20:09 +02002984 if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985 altsd->bNumEndpoints != 1)
2986 return -ENXIO;
2987
2988 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2989 if (!fp)
2990 return -ENOMEM;
2991 memcpy(fp, &ua1000_format, sizeof(*fp));
2992
2993 fp->channels = alts->extra[4];
2994 fp->iface = altsd->bInterfaceNumber;
2995 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2996 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2997 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2998 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
2999
3000 stream = (fp->endpoint & USB_DIR_IN)
3001 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3002 err = add_audio_endpoint(chip, stream, fp);
3003 if (err < 0) {
3004 kfree(fp);
3005 return err;
3006 }
3007 /* FIXME: playback must be synchronized to capture */
3008 usb_set_interface(chip->dev, fp->iface, 0);
3009 return 0;
3010}
3011
Takashi Iwai86e07d32005-11-17 15:08:02 +01003012static int snd_usb_create_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003014 const struct snd_usb_audio_quirk *quirk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015
3016/*
3017 * handle the quirks for the contained interfaces
3018 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003019static int create_composite_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003021 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022{
3023 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3024 int err;
3025
3026 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3027 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3028 if (!iface)
3029 continue;
3030 if (quirk->ifnum != probed_ifnum &&
3031 usb_interface_claimed(iface))
3032 continue;
3033 err = snd_usb_create_quirk(chip, iface, quirk);
3034 if (err < 0)
3035 return err;
3036 if (quirk->ifnum != probed_ifnum)
3037 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3038 }
3039 return 0;
3040}
3041
Takashi Iwai86e07d32005-11-17 15:08:02 +01003042static int ignore_interface_quirk(struct snd_usb_audio *chip,
Clemens Ladisch854af952005-07-25 16:19:10 +02003043 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003044 const struct snd_usb_audio_quirk *quirk)
Clemens Ladisch854af952005-07-25 16:19:10 +02003045{
3046 return 0;
3047}
3048
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049
3050/*
3051 * boot quirks
3052 */
3053
3054#define EXTIGY_FIRMWARE_SIZE_OLD 794
3055#define EXTIGY_FIRMWARE_SIZE_NEW 483
3056
3057static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3058{
3059 struct usb_host_config *config = dev->actconfig;
3060 int err;
3061
3062 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3063 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3064 snd_printdd("sending Extigy boot sequence...\n");
3065 /* Send message to force it to reconnect with full interface. */
3066 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3067 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3068 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3069 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3070 &dev->descriptor, sizeof(dev->descriptor));
3071 config = dev->actconfig;
3072 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3073 err = usb_reset_configuration(dev);
3074 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3075 snd_printdd("extigy_boot: new boot length = %d\n",
3076 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3077 return -ENODEV; /* quit this anyway */
3078 }
3079 return 0;
3080}
3081
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003082static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3083{
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003084 u8 buf = 1;
3085
3086 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3087 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3088 0, 0, &buf, 1, 1000);
3089 if (buf == 0) {
3090 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3091 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3092 1, 2000, NULL, 0, 1000);
3093 return -ENODEV;
3094 }
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003095 return 0;
3096}
3097
Thibault LE MEURe3113342006-03-14 11:44:53 +01003098/*
Sam Revitche217e302006-06-23 15:10:18 +02003099 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3100 * documented in the device's data sheet.
3101 */
3102static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3103{
3104 u8 buf[4];
3105 buf[0] = 0x20;
3106 buf[1] = value & 0xff;
3107 buf[2] = (value >> 8) & 0xff;
3108 buf[3] = reg;
3109 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3110 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3111 0, 0, &buf, 4, 1000);
3112}
3113
3114static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3115{
3116 /*
3117 * Enable line-out driver mode, set headphone source to front
3118 * channels, enable stereo mic.
3119 */
3120 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3121}
3122
3123
3124/*
Thibault LE MEURe3113342006-03-14 11:44:53 +01003125 * Setup quirks
3126 */
3127#define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3128#define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3129#define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3130#define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3131#define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3132#define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3133#define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3134#define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3135#define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3136#define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3137
3138static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3139 int iface, int altno)
3140{
3141 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3142 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3143 && altno != 6)
3144 return 1; /* skip this altsetting */
3145 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3146 && altno != 1)
3147 return 1; /* skip this altsetting */
3148 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3149 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3150 return 1; /* skip this altsetting */
3151 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3152 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3153 return 1; /* skip this altsetting */
3154 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3155 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3156 return 1; /* skip this altsetting */
3157 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3158 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3159 return 1; /* skip this altsetting */
3160 }
3161 return 0; /* keep this altsetting */
3162}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163
3164/*
3165 * audio-interface quirks
3166 *
3167 * returns zero if no standard audio/MIDI parsing is needed.
3168 * returns a postive value if standard audio/midi interfaces are parsed
3169 * after this.
3170 * returns a negative value at error.
3171 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003172static int snd_usb_create_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003174 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003175{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003176 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3177 const struct snd_usb_audio_quirk *);
Clemens Ladisch854af952005-07-25 16:19:10 +02003178 static const quirk_func_t quirk_funcs[] = {
3179 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3180 [QUIRK_COMPOSITE] = create_composite_quirk,
3181 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3182 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3183 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3184 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3185 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3186 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3187 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
Clemens Ladischcc7a59b2006-02-07 17:11:06 +01003188 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
Clemens Ladischd1bda042005-09-14 08:36:03 +02003189 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
Clemens Ladisch854af952005-07-25 16:19:10 +02003190 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3191 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3192 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3193 };
3194
3195 if (quirk->type < QUIRK_TYPE_COUNT) {
3196 return quirk_funcs[quirk->type](chip, iface, quirk);
3197 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3199 return -ENXIO;
3200 }
3201}
3202
3203
3204/*
3205 * common proc files to show the usb device info
3206 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003207static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003209 struct snd_usb_audio *chip = entry->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 if (! chip->shutdown)
3211 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3212}
3213
Takashi Iwai86e07d32005-11-17 15:08:02 +01003214static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003216 struct snd_usb_audio *chip = entry->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217 if (! chip->shutdown)
3218 snd_iprintf(buffer, "%04x:%04x\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003219 USB_ID_VENDOR(chip->usb_id),
3220 USB_ID_PRODUCT(chip->usb_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221}
3222
Takashi Iwai86e07d32005-11-17 15:08:02 +01003223static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003225 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003226 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
Takashi Iwaibf850202006-04-28 15:13:41 +02003227 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228 if (! snd_card_proc_new(chip->card, "usbid", &entry))
Takashi Iwaibf850202006-04-28 15:13:41 +02003229 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003230}
3231
3232/*
3233 * free the chip instance
3234 *
3235 * here we have to do not much, since pcm and controls are already freed
3236 *
3237 */
3238
Takashi Iwai86e07d32005-11-17 15:08:02 +01003239static int snd_usb_audio_free(struct snd_usb_audio *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240{
3241 kfree(chip);
3242 return 0;
3243}
3244
Takashi Iwai86e07d32005-11-17 15:08:02 +01003245static int snd_usb_audio_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003246{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003247 struct snd_usb_audio *chip = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248 return snd_usb_audio_free(chip);
3249}
3250
3251
3252/*
3253 * create a chip instance and set its names.
3254 */
3255static int snd_usb_audio_create(struct usb_device *dev, int idx,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003256 const struct snd_usb_audio_quirk *quirk,
3257 struct snd_usb_audio **rchip)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003259 struct snd_card *card;
3260 struct snd_usb_audio *chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 int err, len;
3262 char component[14];
Takashi Iwai86e07d32005-11-17 15:08:02 +01003263 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264 .dev_free = snd_usb_audio_dev_free,
3265 };
3266
3267 *rchip = NULL;
3268
3269 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3270 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3271 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3272 return -ENXIO;
3273 }
3274
3275 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3276 if (card == NULL) {
3277 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3278 return -ENOMEM;
3279 }
3280
Takashi Iwai561b2202005-09-09 14:22:34 +02003281 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282 if (! chip) {
3283 snd_card_free(card);
3284 return -ENOMEM;
3285 }
3286
3287 chip->index = idx;
3288 chip->dev = dev;
3289 chip->card = card;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003290 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3291 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292 INIT_LIST_HEAD(&chip->pcm_list);
3293 INIT_LIST_HEAD(&chip->midi_list);
Clemens Ladisch84957a82005-04-29 16:23:13 +02003294 INIT_LIST_HEAD(&chip->mixer_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003295
3296 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3297 snd_usb_audio_free(chip);
3298 snd_card_free(card);
3299 return err;
3300 }
3301
3302 strcpy(card->driver, "USB-Audio");
3303 sprintf(component, "USB%04x:%04x",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003304 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305 snd_component_add(card, component);
3306
3307 /* retrieve the device string as shortname */
3308 if (quirk && quirk->product_name) {
3309 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3310 } else {
3311 if (!dev->descriptor.iProduct ||
3312 usb_string(dev, dev->descriptor.iProduct,
3313 card->shortname, sizeof(card->shortname)) <= 0) {
3314 /* no name available from anywhere, so use ID */
3315 sprintf(card->shortname, "USB Device %#04x:%#04x",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003316 USB_ID_VENDOR(chip->usb_id),
3317 USB_ID_PRODUCT(chip->usb_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003318 }
3319 }
3320
3321 /* retrieve the vendor and device strings as longname */
3322 if (quirk && quirk->vendor_name) {
3323 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3324 } else {
3325 if (dev->descriptor.iManufacturer)
3326 len = usb_string(dev, dev->descriptor.iManufacturer,
3327 card->longname, sizeof(card->longname));
3328 else
3329 len = 0;
3330 /* we don't really care if there isn't any vendor string */
3331 }
3332 if (len > 0)
3333 strlcat(card->longname, " ", sizeof(card->longname));
3334
3335 strlcat(card->longname, card->shortname, sizeof(card->longname));
3336
3337 len = strlcat(card->longname, " at ", sizeof(card->longname));
3338
3339 if (len < sizeof(card->longname))
3340 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3341
3342 strlcat(card->longname,
3343 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3344 sizeof(card->longname));
3345
3346 snd_usb_audio_create_proc(chip);
3347
Linus Torvalds1da177e2005-04-16 15:20:36 -07003348 *rchip = chip;
3349 return 0;
3350}
3351
3352
3353/*
3354 * probe the active usb device
3355 *
3356 * note that this can be called multiple times per a device, when it
3357 * includes multiple audio control interfaces.
3358 *
3359 * thus we check the usb device pointer and creates the card instance
3360 * only at the first time. the successive calls of this function will
3361 * append the pcm interface to the corresponding card.
3362 */
3363static void *snd_usb_audio_probe(struct usb_device *dev,
3364 struct usb_interface *intf,
3365 const struct usb_device_id *usb_id)
3366{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003367 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368 int i, err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01003369 struct snd_usb_audio *chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003370 struct usb_host_interface *alts;
3371 int ifnum;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003372 u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003373
3374 alts = &intf->altsetting[0];
3375 ifnum = get_iface_desc(alts)->bInterfaceNumber;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003376 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3377 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003378
3379 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3380 goto __err_val;
3381
3382 /* SB Extigy needs special boot-up sequence */
3383 /* if more models come, this will go to the quirk list. */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003384 if (id == USB_ID(0x041e, 0x3000)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003385 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3386 goto __err_val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003387 }
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003388 /* SB Audigy 2 NX needs its own boot-up magic, too */
3389 if (id == USB_ID(0x041e, 0x3020)) {
3390 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3391 goto __err_val;
3392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393
Sam Revitche217e302006-06-23 15:10:18 +02003394 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3395 if (id == USB_ID(0x10f5, 0x0200)) {
3396 if (snd_usb_cm106_boot_quirk(dev) < 0)
3397 goto __err_val;
3398 }
3399
Linus Torvalds1da177e2005-04-16 15:20:36 -07003400 /*
3401 * found a config. now register to ALSA
3402 */
3403
3404 /* check whether it's already registered */
3405 chip = NULL;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003406 mutex_lock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407 for (i = 0; i < SNDRV_CARDS; i++) {
3408 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3409 if (usb_chip[i]->shutdown) {
3410 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3411 goto __error;
3412 }
3413 chip = usb_chip[i];
3414 break;
3415 }
3416 }
3417 if (! chip) {
3418 /* it's a fresh one.
3419 * now look for an empty slot and create a new card instance
3420 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421 for (i = 0; i < SNDRV_CARDS; i++)
3422 if (enable[i] && ! usb_chip[i] &&
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003423 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3424 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3426 goto __error;
3427 }
Clemens Ladisch1dcd3ec2005-05-10 14:51:40 +02003428 snd_card_set_dev(chip->card, &intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429 break;
3430 }
3431 if (! chip) {
3432 snd_printk(KERN_ERR "no available usb audio device\n");
3433 goto __error;
3434 }
3435 }
3436
3437 err = 1; /* continue */
3438 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3439 /* need some special handlings */
3440 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3441 goto __error;
3442 }
3443
3444 if (err > 0) {
3445 /* create normal USB audio interfaces */
3446 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3447 snd_usb_create_mixer(chip, ifnum) < 0) {
3448 goto __error;
3449 }
3450 }
3451
3452 /* we are allowed to call snd_card_register() many times */
3453 if (snd_card_register(chip->card) < 0) {
3454 goto __error;
3455 }
3456
3457 usb_chip[chip->index] = chip;
3458 chip->num_interfaces++;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003459 mutex_unlock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460 return chip;
3461
3462 __error:
3463 if (chip && !chip->num_interfaces)
3464 snd_card_free(chip->card);
Ingo Molnar12aa7572006-01-16 16:36:05 +01003465 mutex_unlock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466 __err_val:
3467 return NULL;
3468}
3469
3470/*
3471 * we need to take care of counter, since disconnection can be called also
3472 * many times as well as usb_audio_probe().
3473 */
3474static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3475{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003476 struct snd_usb_audio *chip;
3477 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003478 struct list_head *p;
3479
3480 if (ptr == (void *)-1L)
3481 return;
3482
3483 chip = ptr;
3484 card = chip->card;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003485 mutex_lock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003486 chip->shutdown = 1;
3487 chip->num_interfaces--;
3488 if (chip->num_interfaces <= 0) {
3489 snd_card_disconnect(card);
3490 /* release the pcm resources */
3491 list_for_each(p, &chip->pcm_list) {
Clemens Ladischee733392005-04-25 10:34:13 +02003492 snd_usb_stream_disconnect(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493 }
3494 /* release the midi resources */
3495 list_for_each(p, &chip->midi_list) {
Clemens Ladischee733392005-04-25 10:34:13 +02003496 snd_usbmidi_disconnect(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02003498 /* release mixer resources */
3499 list_for_each(p, &chip->mixer_list) {
3500 snd_usb_mixer_disconnect(p);
3501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502 usb_chip[chip->index] = NULL;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003503 mutex_unlock(&register_mutex);
Karsten Wiese230cd5e2005-04-20 10:12:35 +02003504 snd_card_free(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505 } else {
Ingo Molnar12aa7572006-01-16 16:36:05 +01003506 mutex_unlock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507 }
3508}
3509
3510/*
3511 * new 2.5 USB kernel API
3512 */
3513static int usb_audio_probe(struct usb_interface *intf,
3514 const struct usb_device_id *id)
3515{
3516 void *chip;
3517 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3518 if (chip) {
3519 dev_set_drvdata(&intf->dev, chip);
3520 return 0;
3521 } else
3522 return -EIO;
3523}
3524
3525static void usb_audio_disconnect(struct usb_interface *intf)
3526{
3527 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3528 dev_get_drvdata(&intf->dev));
3529}
3530
3531
3532static int __init snd_usb_audio_init(void)
3533{
3534 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3535 printk(KERN_WARNING "invalid nrpacks value.\n");
3536 return -EINVAL;
3537 }
3538 usb_register(&usb_audio_driver);
3539 return 0;
3540}
3541
3542
3543static void __exit snd_usb_audio_cleanup(void)
3544{
3545 usb_deregister(&usb_audio_driver);
3546}
3547
3548module_init(snd_usb_audio_init);
3549module_exit(snd_usb_audio_cleanup);