blob: 49248fa7aef47adaa9884aada5ebf593f8838d72 [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 */
Clemens Ladisch92b9ac72006-09-22 10:57:36 +020071static int nrpacks = 8; /* max. number of packets per urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static 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
Clemens Ladisch92b9ac72006-09-22 10:57:36 +0200103#define MAX_PACKS 20
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104#define MAX_PACKS_HS (MAX_PACKS * 8) /* in high speed mode */
Clemens Ladisch15a24c02005-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 */
Luke Rossa79eee82006-08-29 10:46:32 +0200126 unsigned int needs_knot; /* any unusual rates? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128
Takashi Iwai86e07d32005-11-17 15:08:02 +0100129struct snd_usb_substream;
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131struct snd_urb_ctx {
132 struct urb *urb;
Clemens Ladisch55851f72005-08-15 08:34:16 +0200133 unsigned int buffer_size; /* size of data buffer, if data URB */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100134 struct snd_usb_substream *subs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 int index; /* index for urb array */
136 int packets; /* number of packets per urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137};
138
139struct snd_urb_ops {
Takashi Iwai86e07d32005-11-17 15:08:02 +0100140 int (*prepare)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
141 int (*retire)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
142 int (*prepare_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
143 int (*retire_sync)(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime, struct urb *u);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144};
145
146struct snd_usb_substream {
Takashi Iwai86e07d32005-11-17 15:08:02 +0100147 struct snd_usb_stream *stream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 struct usb_device *dev;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100149 struct snd_pcm_substream *pcm_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 int direction; /* playback or capture */
151 int interface; /* current interface */
152 int endpoint; /* assigned endpoint */
153 struct audioformat *cur_audiofmt; /* current audioformat pointer (for hw_params callback) */
154 unsigned int cur_rate; /* current rate (for hw_params callback) */
155 unsigned int period_bytes; /* current period bytes (for hw_params callback) */
156 unsigned int format; /* USB data format */
157 unsigned int datapipe; /* the data i/o pipe */
158 unsigned int syncpipe; /* 1 - async out or adaptive in */
Clemens Ladisch573567e2005-06-27 08:17:30 +0200159 unsigned int datainterval; /* log_2 of data packet interval */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 unsigned int syncinterval; /* P for adaptive mode, 0 otherwise */
161 unsigned int freqn; /* nominal sampling rate in fs/fps in Q16.16 format */
162 unsigned int freqm; /* momentary sampling rate in fs/fps in Q16.16 format */
163 unsigned int freqmax; /* maximum sampling rate, used for buffer management */
164 unsigned int phase; /* phase accumulator */
165 unsigned int maxpacksize; /* max packet size in bytes */
166 unsigned int maxframesize; /* max packet size in frames */
167 unsigned int curpacksize; /* current packet size in bytes (for capture) */
168 unsigned int curframesize; /* current packet size in frames (for capture) */
169 unsigned int fill_max: 1; /* fill max packet size always */
170 unsigned int fmt_type; /* USB audio format type (1-3) */
Clemens Ladisch9624ea82005-08-15 08:25:24 +0200171 unsigned int packs_per_ms; /* packets per millisecond (for playback) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173 unsigned int running: 1; /* running status */
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 unsigned int hwptr_done; /* processed frame position in the buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 unsigned int transfer_done; /* processed frames since last period update */
177 unsigned long active_mask; /* bitmask of active urbs */
178 unsigned long unlink_mask; /* bitmask of unlinked urbs */
179
180 unsigned int nurbs; /* # urbs */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100181 struct snd_urb_ctx dataurb[MAX_URBS]; /* data urb table */
182 struct snd_urb_ctx syncurb[SYNC_URBS]; /* sync urb table */
Clemens Ladisch55851f72005-08-15 08:34:16 +0200183 char *syncbuf; /* sync buffer for all sync URBs */
184 dma_addr_t sync_dma; /* DMA address of syncbuf */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 u64 formats; /* format bitmasks (all or'ed) */
187 unsigned int num_formats; /* number of supported audio formats (list) */
188 struct list_head fmt_list; /* format list */
189 spinlock_t lock;
190
191 struct snd_urb_ops ops; /* callbacks (must be filled at init) */
192};
193
194
195struct snd_usb_stream {
Takashi Iwai86e07d32005-11-17 15:08:02 +0100196 struct snd_usb_audio *chip;
197 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 int pcm_index;
199 unsigned int fmt_type; /* USB audio format type (1-3) */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100200 struct snd_usb_substream substream[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 struct list_head list;
202};
203
204
205/*
206 * we keep the snd_usb_audio_t instances by ourselves for merging
207 * the all interfaces on the same card as one sound device.
208 */
209
Ingo Molnar12aa7572006-01-16 16:36:05 +0100210static DEFINE_MUTEX(register_mutex);
Takashi Iwai86e07d32005-11-17 15:08:02 +0100211static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213
214/*
215 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
216 * this will overflow at approx 524 kHz
217 */
Jesper Juhl77933d72005-07-27 11:46:09 -0700218static inline unsigned get_usb_full_speed_rate(unsigned int rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219{
220 return ((rate << 13) + 62) / 125;
221}
222
223/*
224 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
225 * this will overflow at approx 4 MHz
226 */
Jesper Juhl77933d72005-07-27 11:46:09 -0700227static inline unsigned get_usb_high_speed_rate(unsigned int rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
229 return ((rate << 10) + 62) / 125;
230}
231
232/* convert our full speed USB rate into sampling rate in Hz */
Jesper Juhl77933d72005-07-27 11:46:09 -0700233static inline unsigned get_full_speed_hz(unsigned int usb_rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
235 return (usb_rate * 125 + (1 << 12)) >> 13;
236}
237
238/* convert our high speed USB rate into sampling rate in Hz */
Jesper Juhl77933d72005-07-27 11:46:09 -0700239static inline unsigned get_high_speed_hz(unsigned int usb_rate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
241 return (usb_rate * 125 + (1 << 9)) >> 10;
242}
243
244
245/*
246 * prepare urb for full speed capture sync pipe
247 *
248 * fill the length and offset of each urb descriptor.
249 * the fixed 10.14 frequency is passed through the pipe.
250 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100251static int prepare_capture_sync_urb(struct snd_usb_substream *subs,
252 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 struct urb *urb)
254{
255 unsigned char *cp = urb->transfer_buffer;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100256 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200259 urb->iso_frame_desc[0].length = 3;
260 urb->iso_frame_desc[0].offset = 0;
261 cp[0] = subs->freqn >> 2;
262 cp[1] = subs->freqn >> 10;
263 cp[2] = subs->freqn >> 18;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 return 0;
265}
266
267/*
268 * prepare urb for high speed capture sync pipe
269 *
270 * fill the length and offset of each urb descriptor.
271 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
272 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100273static int prepare_capture_sync_urb_hs(struct snd_usb_substream *subs,
274 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 struct urb *urb)
276{
277 unsigned char *cp = urb->transfer_buffer;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100278 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200281 urb->iso_frame_desc[0].length = 4;
282 urb->iso_frame_desc[0].offset = 0;
283 cp[0] = subs->freqn;
284 cp[1] = subs->freqn >> 8;
285 cp[2] = subs->freqn >> 16;
286 cp[3] = subs->freqn >> 24;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 return 0;
288}
289
290/*
291 * process after capture sync complete
292 * - nothing to do
293 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100294static int retire_capture_sync_urb(struct snd_usb_substream *subs,
295 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 struct urb *urb)
297{
298 return 0;
299}
300
301/*
302 * prepare urb for capture data pipe
303 *
304 * fill the offset and length of each descriptor.
305 *
306 * we use a temporary buffer to write the captured data.
307 * since the length of written data is determined by host, we cannot
308 * write onto the pcm buffer directly... the data is thus copied
309 * later at complete callback to the global buffer.
310 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100311static int prepare_capture_urb(struct snd_usb_substream *subs,
312 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 struct urb *urb)
314{
315 int i, offs;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100316 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318 offs = 0;
319 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 for (i = 0; i < ctx->packets; i++) {
321 urb->iso_frame_desc[i].offset = offs;
322 urb->iso_frame_desc[i].length = subs->curpacksize;
323 offs += subs->curpacksize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 urb->transfer_buffer_length = offs;
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200326 urb->number_of_packets = ctx->packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327#if 0 // for check
328 if (! urb->bandwidth) {
329 int bustime;
330 bustime = usb_check_bandwidth(urb->dev, urb);
331 if (bustime < 0)
332 return bustime;
333 printk("urb %d: bandwidth = %d (packets = %d)\n", ctx->index, bustime, urb->number_of_packets);
334 usb_claim_bandwidth(urb->dev, urb, bustime, 1);
335 }
336#endif // for check
337 return 0;
338}
339
340/*
341 * process after capture complete
342 *
343 * copy the data from each desctiptor to the pcm buffer, and
344 * update the current position.
345 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100346static int retire_capture_urb(struct snd_usb_substream *subs,
347 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 struct urb *urb)
349{
350 unsigned long flags;
351 unsigned char *cp;
352 int i;
353 unsigned int stride, len, oldptr;
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200354 int period_elapsed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
356 stride = runtime->frame_bits >> 3;
357
358 for (i = 0; i < urb->number_of_packets; i++) {
359 cp = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
360 if (urb->iso_frame_desc[i].status) {
361 snd_printd(KERN_ERR "frame %d active: %d\n", i, urb->iso_frame_desc[i].status);
362 // continue;
363 }
364 len = urb->iso_frame_desc[i].actual_length / stride;
365 if (! len)
366 continue;
367 /* update the current pointer */
368 spin_lock_irqsave(&subs->lock, flags);
369 oldptr = subs->hwptr_done;
370 subs->hwptr_done += len;
371 if (subs->hwptr_done >= runtime->buffer_size)
372 subs->hwptr_done -= runtime->buffer_size;
373 subs->transfer_done += len;
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200374 if (subs->transfer_done >= runtime->period_size) {
375 subs->transfer_done -= runtime->period_size;
376 period_elapsed = 1;
377 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 spin_unlock_irqrestore(&subs->lock, flags);
379 /* copy a data chunk */
380 if (oldptr + len > runtime->buffer_size) {
381 unsigned int cnt = runtime->buffer_size - oldptr;
382 unsigned int blen = cnt * stride;
383 memcpy(runtime->dma_area + oldptr * stride, cp, blen);
384 memcpy(runtime->dma_area, cp + blen, len * stride - blen);
385 } else {
386 memcpy(runtime->dma_area + oldptr * stride, cp, len * stride);
387 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 }
Clemens Ladischb263a9b2005-08-15 08:22:39 +0200389 if (period_elapsed)
390 snd_pcm_period_elapsed(subs->pcm_substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 return 0;
392}
393
394
395/*
396 * prepare urb for full speed playback sync pipe
397 *
398 * set up the offset and length to receive the current frequency.
399 */
400
Takashi Iwai86e07d32005-11-17 15:08:02 +0100401static int prepare_playback_sync_urb(struct snd_usb_substream *subs,
402 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 struct urb *urb)
404{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100405 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200408 urb->iso_frame_desc[0].length = 3;
409 urb->iso_frame_desc[0].offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 return 0;
411}
412
413/*
414 * prepare urb for high speed playback sync pipe
415 *
416 * set up the offset and length to receive the current frequency.
417 */
418
Takashi Iwai86e07d32005-11-17 15:08:02 +0100419static int prepare_playback_sync_urb_hs(struct snd_usb_substream *subs,
420 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 struct urb *urb)
422{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100423 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 urb->dev = ctx->subs->dev; /* we need to set this at each time */
Clemens Ladischca810902005-05-02 08:55:54 +0200426 urb->iso_frame_desc[0].length = 4;
427 urb->iso_frame_desc[0].offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 return 0;
429}
430
431/*
432 * process after full speed playback sync complete
433 *
434 * retrieve the current 10.14 frequency from pipe, and set it.
435 * the value is referred in prepare_playback_urb().
436 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100437static int retire_playback_sync_urb(struct snd_usb_substream *subs,
438 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 struct urb *urb)
440{
Clemens Ladischca810902005-05-02 08:55:54 +0200441 unsigned int f;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 unsigned long flags;
443
Clemens Ladischca810902005-05-02 08:55:54 +0200444 if (urb->iso_frame_desc[0].status == 0 &&
445 urb->iso_frame_desc[0].actual_length == 3) {
446 f = combine_triple((u8*)urb->transfer_buffer) << 2;
Clemens Ladisch50cdbf12005-05-13 07:44:13 +0200447 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
448 spin_lock_irqsave(&subs->lock, flags);
449 subs->freqm = f;
450 spin_unlock_irqrestore(&subs->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 }
453
454 return 0;
455}
456
457/*
458 * process after high speed playback sync complete
459 *
460 * retrieve the current 12.13 frequency from pipe, and set it.
461 * the value is referred in prepare_playback_urb().
462 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100463static int retire_playback_sync_urb_hs(struct snd_usb_substream *subs,
464 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 struct urb *urb)
466{
Clemens Ladischca810902005-05-02 08:55:54 +0200467 unsigned int f;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 unsigned long flags;
469
Clemens Ladischca810902005-05-02 08:55:54 +0200470 if (urb->iso_frame_desc[0].status == 0 &&
471 urb->iso_frame_desc[0].actual_length == 4) {
472 f = combine_quad((u8*)urb->transfer_buffer) & 0x0fffffff;
Clemens Ladisch50cdbf12005-05-13 07:44:13 +0200473 if (f >= subs->freqn - subs->freqn / 8 && f <= subs->freqmax) {
474 spin_lock_irqsave(&subs->lock, flags);
475 subs->freqm = f;
476 spin_unlock_irqrestore(&subs->lock, flags);
477 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 }
479
480 return 0;
481}
482
Clemens Ladisch9568f462006-01-12 08:19:21 +0100483/* determine the number of frames in the next packet */
484static int snd_usb_audio_next_packet_size(struct snd_usb_substream *subs)
485{
486 if (subs->fill_max)
487 return subs->maxframesize;
488 else {
489 subs->phase = (subs->phase & 0xffff)
490 + (subs->freqm << subs->datainterval);
491 return min(subs->phase >> 16, subs->maxframesize);
492 }
493}
494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495/*
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100496 * Prepare urb for streaming before playback starts.
497 *
Clemens Ladisch4b284922006-01-12 08:17:49 +0100498 * We don't yet have data, so we send a frame of silence.
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100499 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100500static int prepare_startup_playback_urb(struct snd_usb_substream *subs,
501 struct snd_pcm_runtime *runtime,
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100502 struct urb *urb)
503{
Clemens Ladisch4b284922006-01-12 08:17:49 +0100504 unsigned int i, offs, counts;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100505 struct snd_urb_ctx *ctx = urb->context;
Clemens Ladisch4b284922006-01-12 08:17:49 +0100506 int stride = runtime->frame_bits >> 3;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100507
Clemens Ladisch4b284922006-01-12 08:17:49 +0100508 offs = 0;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100509 urb->dev = ctx->subs->dev;
510 urb->number_of_packets = subs->packs_per_ms;
511 for (i = 0; i < subs->packs_per_ms; ++i) {
Clemens Ladisch9568f462006-01-12 08:19:21 +0100512 counts = snd_usb_audio_next_packet_size(subs);
Clemens Ladisch4b284922006-01-12 08:17:49 +0100513 urb->iso_frame_desc[i].offset = offs * stride;
514 urb->iso_frame_desc[i].length = counts * stride;
515 offs += counts;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100516 }
Clemens Ladisch4b284922006-01-12 08:17:49 +0100517 urb->transfer_buffer_length = offs * stride;
518 memset(urb->transfer_buffer,
519 subs->cur_audiofmt->format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0,
520 offs * stride);
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100521 return 0;
522}
523
524/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 * prepare urb for playback data pipe
526 *
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200527 * Since a URB can handle only a single linear buffer, we must use double
528 * buffering when the data to be transferred overflows the buffer boundary.
529 * To avoid inconsistencies when updating hwptr_done, we use double buffering
530 * for all URBs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100532static int prepare_playback_urb(struct snd_usb_substream *subs,
533 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 struct urb *urb)
535{
536 int i, stride, offs;
537 unsigned int counts;
538 unsigned long flags;
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200539 int period_elapsed = 0;
Takashi Iwai86e07d32005-11-17 15:08:02 +0100540 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542 stride = runtime->frame_bits >> 3;
543
544 offs = 0;
545 urb->dev = ctx->subs->dev; /* we need to set this at each time */
546 urb->number_of_packets = 0;
547 spin_lock_irqsave(&subs->lock, flags);
548 for (i = 0; i < ctx->packets; i++) {
Clemens Ladisch9568f462006-01-12 08:19:21 +0100549 counts = snd_usb_audio_next_packet_size(subs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 /* set up descriptor */
551 urb->iso_frame_desc[i].offset = offs * stride;
552 urb->iso_frame_desc[i].length = counts * stride;
553 offs += counts;
554 urb->number_of_packets++;
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200555 subs->transfer_done += counts;
556 if (subs->transfer_done >= runtime->period_size) {
557 subs->transfer_done -= runtime->period_size;
558 period_elapsed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 if (subs->fmt_type == USB_FORMAT_TYPE_II) {
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200560 if (subs->transfer_done > 0) {
561 /* FIXME: fill-max mode is not
562 * supported yet */
563 offs -= subs->transfer_done;
564 counts -= subs->transfer_done;
565 urb->iso_frame_desc[i].length =
566 counts * stride;
567 subs->transfer_done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 }
569 i++;
570 if (i < ctx->packets) {
571 /* add a transfer delimiter */
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200572 urb->iso_frame_desc[i].offset =
573 offs * stride;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 urb->iso_frame_desc[i].length = 0;
575 urb->number_of_packets++;
576 }
Clemens Ladisch9624ea82005-08-15 08:25:24 +0200577 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
Clemens Ladisch9624ea82005-08-15 08:25:24 +0200580 /* finish at the frame boundary at/after the period boundary */
581 if (period_elapsed &&
582 (i & (subs->packs_per_ms - 1)) == subs->packs_per_ms - 1)
583 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 }
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200585 if (subs->hwptr_done + offs > runtime->buffer_size) {
586 /* err, the transferred area goes over buffer boundary. */
587 unsigned int len = runtime->buffer_size - subs->hwptr_done;
588 memcpy(urb->transfer_buffer,
589 runtime->dma_area + subs->hwptr_done * stride,
590 len * stride);
591 memcpy(urb->transfer_buffer + len * stride,
592 runtime->dma_area,
593 (offs - len) * stride);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 } else {
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200595 memcpy(urb->transfer_buffer,
596 runtime->dma_area + subs->hwptr_done * stride,
597 offs * stride);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 }
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200599 subs->hwptr_done += offs;
600 if (subs->hwptr_done >= runtime->buffer_size)
601 subs->hwptr_done -= runtime->buffer_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 spin_unlock_irqrestore(&subs->lock, flags);
603 urb->transfer_buffer_length = offs * stride;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100604 if (period_elapsed)
605 snd_pcm_period_elapsed(subs->pcm_substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return 0;
607}
608
609/*
610 * process after playback data complete
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +0200611 * - nothing to do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100613static int retire_playback_urb(struct snd_usb_substream *subs,
614 struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 struct urb *urb)
616{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 return 0;
618}
619
620
621/*
622 */
623static struct snd_urb_ops audio_urb_ops[2] = {
624 {
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100625 .prepare = prepare_startup_playback_urb,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 .retire = retire_playback_urb,
627 .prepare_sync = prepare_playback_sync_urb,
628 .retire_sync = retire_playback_sync_urb,
629 },
630 {
631 .prepare = prepare_capture_urb,
632 .retire = retire_capture_urb,
633 .prepare_sync = prepare_capture_sync_urb,
634 .retire_sync = retire_capture_sync_urb,
635 },
636};
637
638static struct snd_urb_ops audio_urb_ops_high_speed[2] = {
639 {
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100640 .prepare = prepare_startup_playback_urb,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 .retire = retire_playback_urb,
642 .prepare_sync = prepare_playback_sync_urb_hs,
643 .retire_sync = retire_playback_sync_urb_hs,
644 },
645 {
646 .prepare = prepare_capture_urb,
647 .retire = retire_capture_urb,
648 .prepare_sync = prepare_capture_sync_urb_hs,
649 .retire_sync = retire_capture_sync_urb,
650 },
651};
652
653/*
654 * complete callback from data urb
655 */
656static void snd_complete_urb(struct urb *urb, struct pt_regs *regs)
657{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100658 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
659 struct snd_usb_substream *subs = ctx->subs;
660 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 int err = 0;
662
663 if ((subs->running && subs->ops.retire(subs, substream->runtime, urb)) ||
664 ! subs->running || /* can be stopped during retire callback */
665 (err = subs->ops.prepare(subs, substream->runtime, urb)) < 0 ||
666 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
667 clear_bit(ctx->index, &subs->active_mask);
668 if (err < 0) {
669 snd_printd(KERN_ERR "cannot submit urb (err = %d)\n", err);
670 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
671 }
672 }
673}
674
675
676/*
677 * complete callback from sync urb
678 */
679static void snd_complete_sync_urb(struct urb *urb, struct pt_regs *regs)
680{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100681 struct snd_urb_ctx *ctx = (struct snd_urb_ctx *)urb->context;
682 struct snd_usb_substream *subs = ctx->subs;
683 struct snd_pcm_substream *substream = ctx->subs->pcm_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 int err = 0;
685
686 if ((subs->running && subs->ops.retire_sync(subs, substream->runtime, urb)) ||
687 ! subs->running || /* can be stopped during retire callback */
688 (err = subs->ops.prepare_sync(subs, substream->runtime, urb)) < 0 ||
689 (err = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
690 clear_bit(ctx->index + 16, &subs->active_mask);
691 if (err < 0) {
692 snd_printd(KERN_ERR "cannot submit sync urb (err = %d)\n", err);
693 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
694 }
695 }
696}
697
698
Clemens Ladisch6207e512005-08-15 08:35:25 +0200699/* get the physical page pointer at the given offset */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100700static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
Clemens Ladisch6207e512005-08-15 08:35:25 +0200701 unsigned long offset)
702{
703 void *pageptr = subs->runtime->dma_area + offset;
704 return vmalloc_to_page(pageptr);
705}
706
707/* allocate virtual buffer; may be called more than once */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100708static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs, size_t size)
Clemens Ladisch6207e512005-08-15 08:35:25 +0200709{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100710 struct snd_pcm_runtime *runtime = subs->runtime;
Clemens Ladisch6207e512005-08-15 08:35:25 +0200711 if (runtime->dma_area) {
712 if (runtime->dma_bytes >= size)
713 return 0; /* already large enough */
Takashi Iwaib1d57762005-10-10 11:56:31 +0200714 vfree(runtime->dma_area);
Clemens Ladisch6207e512005-08-15 08:35:25 +0200715 }
Takashi Iwaib1d57762005-10-10 11:56:31 +0200716 runtime->dma_area = vmalloc(size);
Clemens Ladisch6207e512005-08-15 08:35:25 +0200717 if (! runtime->dma_area)
718 return -ENOMEM;
719 runtime->dma_bytes = size;
720 return 0;
721}
722
723/* free virtual buffer; may be called more than once */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100724static int snd_pcm_free_vmalloc_buffer(struct snd_pcm_substream *subs)
Clemens Ladisch6207e512005-08-15 08:35:25 +0200725{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100726 struct snd_pcm_runtime *runtime = subs->runtime;
Jesper Juhl9c4be3d2006-02-09 20:04:16 +0100727
728 vfree(runtime->dma_area);
729 runtime->dma_area = NULL;
Clemens Ladisch6207e512005-08-15 08:35:25 +0200730 return 0;
731}
732
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734/*
735 * unlink active urbs.
736 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100737static int deactivate_urbs(struct snd_usb_substream *subs, int force, int can_sleep)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
739 unsigned int i;
740 int async;
741
742 subs->running = 0;
743
744 if (!force && subs->stream->chip->shutdown) /* to be sure... */
745 return -EBADFD;
746
747 async = !can_sleep && async_unlink;
748
749 if (! async && in_interrupt())
750 return 0;
751
752 for (i = 0; i < subs->nurbs; i++) {
753 if (test_bit(i, &subs->active_mask)) {
754 if (! test_and_set_bit(i, &subs->unlink_mask)) {
755 struct urb *u = subs->dataurb[i].urb;
Alan Sternb375a042005-07-29 16:11:07 -0400756 if (async)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 usb_unlink_urb(u);
Alan Sternb375a042005-07-29 16:11:07 -0400758 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 usb_kill_urb(u);
760 }
761 }
762 }
763 if (subs->syncpipe) {
764 for (i = 0; i < SYNC_URBS; i++) {
765 if (test_bit(i+16, &subs->active_mask)) {
766 if (! test_and_set_bit(i+16, &subs->unlink_mask)) {
767 struct urb *u = subs->syncurb[i].urb;
Alan Sternb375a042005-07-29 16:11:07 -0400768 if (async)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 usb_unlink_urb(u);
Alan Sternb375a042005-07-29 16:11:07 -0400770 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 usb_kill_urb(u);
772 }
773 }
774 }
775 }
776 return 0;
777}
778
779
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100780static const char *usb_error_string(int err)
781{
782 switch (err) {
783 case -ENODEV:
784 return "no device";
785 case -ENOENT:
786 return "endpoint not enabled";
787 case -EPIPE:
788 return "endpoint stalled";
789 case -ENOSPC:
790 return "not enough bandwidth";
791 case -ESHUTDOWN:
792 return "device disabled";
793 case -EHOSTUNREACH:
794 return "device suspended";
Clemens Ladisch3e964432006-03-14 08:06:12 +0100795#ifndef CONFIG_USB_EHCI_SPLIT_ISO
796 case -ENOSYS:
797 return "enable CONFIG_USB_EHCI_SPLIT_ISO to play through a hub";
798#endif
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100799 case -EINVAL:
800 case -EAGAIN:
801 case -EFBIG:
802 case -EMSGSIZE:
803 return "internal error";
804 default:
805 return "unknown error";
806 }
807}
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809/*
810 * set up and start data/sync urbs
811 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100812static int start_urbs(struct snd_usb_substream *subs, struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813{
814 unsigned int i;
815 int err;
816
817 if (subs->stream->chip->shutdown)
818 return -EBADFD;
819
820 for (i = 0; i < subs->nurbs; i++) {
821 snd_assert(subs->dataurb[i].urb, return -EINVAL);
822 if (subs->ops.prepare(subs, runtime, subs->dataurb[i].urb) < 0) {
823 snd_printk(KERN_ERR "cannot prepare datapipe for urb %d\n", i);
824 goto __error;
825 }
826 }
827 if (subs->syncpipe) {
828 for (i = 0; i < SYNC_URBS; i++) {
829 snd_assert(subs->syncurb[i].urb, return -EINVAL);
830 if (subs->ops.prepare_sync(subs, runtime, subs->syncurb[i].urb) < 0) {
831 snd_printk(KERN_ERR "cannot prepare syncpipe for urb %d\n", i);
832 goto __error;
833 }
834 }
835 }
836
837 subs->active_mask = 0;
838 subs->unlink_mask = 0;
839 subs->running = 1;
840 for (i = 0; i < subs->nurbs; i++) {
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100841 err = usb_submit_urb(subs->dataurb[i].urb, GFP_ATOMIC);
842 if (err < 0) {
843 snd_printk(KERN_ERR "cannot submit datapipe "
844 "for urb %d, error %d: %s\n",
845 i, err, usb_error_string(err));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 goto __error;
847 }
848 set_bit(i, &subs->active_mask);
849 }
850 if (subs->syncpipe) {
851 for (i = 0; i < SYNC_URBS; i++) {
Clemens Ladisch32e19e82006-03-09 07:58:39 +0100852 err = usb_submit_urb(subs->syncurb[i].urb, GFP_ATOMIC);
853 if (err < 0) {
854 snd_printk(KERN_ERR "cannot submit syncpipe "
855 "for urb %d, error %d: %s\n",
856 i, err, usb_error_string(err));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 goto __error;
858 }
859 set_bit(i + 16, &subs->active_mask);
860 }
861 }
862 return 0;
863
864 __error:
865 // snd_pcm_stop(subs->pcm_substream, SNDRV_PCM_STATE_XRUN);
866 deactivate_urbs(subs, 0, 0);
867 return -EPIPE;
868}
869
870
871/*
872 * wait until all urbs are processed.
873 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100874static int wait_clear_urbs(struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875{
Nishanth Aravamudanb27c1872005-07-09 10:54:37 +0200876 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 unsigned int i;
878 int alive;
879
880 do {
881 alive = 0;
882 for (i = 0; i < subs->nurbs; i++) {
883 if (test_bit(i, &subs->active_mask))
884 alive++;
885 }
886 if (subs->syncpipe) {
887 for (i = 0; i < SYNC_URBS; i++) {
888 if (test_bit(i + 16, &subs->active_mask))
889 alive++;
890 }
891 }
892 if (! alive)
893 break;
Nishanth Aravamudan8433a502005-10-24 15:02:37 +0200894 schedule_timeout_uninterruptible(1);
Nishanth Aravamudanb27c1872005-07-09 10:54:37 +0200895 } while (time_before(jiffies, end_time));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 if (alive)
897 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
898 return 0;
899}
900
901
902/*
903 * return the current pcm pointer. just return the hwptr_done value.
904 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100905static snd_pcm_uframes_t snd_usb_pcm_pointer(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100907 struct snd_usb_substream *subs;
Clemens Ladischdaa150e2005-08-15 08:25:50 +0200908 snd_pcm_uframes_t hwptr_done;
909
Takashi Iwai86e07d32005-11-17 15:08:02 +0100910 subs = (struct snd_usb_substream *)substream->runtime->private_data;
Clemens Ladischdaa150e2005-08-15 08:25:50 +0200911 spin_lock(&subs->lock);
912 hwptr_done = subs->hwptr_done;
913 spin_unlock(&subs->lock);
914 return hwptr_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915}
916
917
918/*
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100919 * start/stop playback substream
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100921static int snd_usb_pcm_playback_trigger(struct snd_pcm_substream *substream,
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100922 int cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100924 struct snd_usb_substream *subs = substream->runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
926 switch (cmd) {
927 case SNDRV_PCM_TRIGGER_START:
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100928 subs->ops.prepare = prepare_playback_urb;
929 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 case SNDRV_PCM_TRIGGER_STOP:
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100931 return deactivate_urbs(subs, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 default:
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100933 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 }
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100935}
936
937/*
938 * start/stop capture substream
939 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100940static int snd_usb_pcm_capture_trigger(struct snd_pcm_substream *substream,
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100941 int cmd)
942{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100943 struct snd_usb_substream *subs = substream->runtime->private_data;
Clemens Ladischb55bbf02005-11-02 11:32:52 +0100944
945 switch (cmd) {
946 case SNDRV_PCM_TRIGGER_START:
947 return start_urbs(subs, substream->runtime);
948 case SNDRV_PCM_TRIGGER_STOP:
949 return deactivate_urbs(subs, 0, 0);
950 default:
951 return -EINVAL;
952 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953}
954
955
956/*
957 * release a urb data
958 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100959static void release_urb_ctx(struct snd_urb_ctx *u)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960{
961 if (u->urb) {
Clemens Ladisch55851f72005-08-15 08:34:16 +0200962 if (u->buffer_size)
963 usb_buffer_free(u->subs->dev, u->buffer_size,
964 u->urb->transfer_buffer,
965 u->urb->transfer_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 usb_free_urb(u->urb);
967 u->urb = NULL;
968 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969}
970
971/*
972 * release a substream
973 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100974static void release_substream_urbs(struct snd_usb_substream *subs, int force)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975{
976 int i;
977
978 /* stop urbs (to be sure) */
979 deactivate_urbs(subs, force, 1);
980 wait_clear_urbs(subs);
981
982 for (i = 0; i < MAX_URBS; i++)
983 release_urb_ctx(&subs->dataurb[i]);
984 for (i = 0; i < SYNC_URBS; i++)
985 release_urb_ctx(&subs->syncurb[i]);
Clemens Ladisch55851f72005-08-15 08:34:16 +0200986 usb_buffer_free(subs->dev, SYNC_URBS * 4,
987 subs->syncbuf, subs->sync_dma);
988 subs->syncbuf = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 subs->nurbs = 0;
990}
991
992/*
993 * initialize a substream for plaback/capture
994 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100995static int init_substream_urbs(struct snd_usb_substream *subs, unsigned int period_bytes,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 unsigned int rate, unsigned int frame_bits)
997{
998 unsigned int maxsize, n, i;
999 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001000 unsigned int npacks[MAX_URBS], urb_packs, total_packs, packs_per_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
1002 /* calculate the frequency in 16.16 format */
1003 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
1004 subs->freqn = get_usb_full_speed_rate(rate);
1005 else
1006 subs->freqn = get_usb_high_speed_rate(rate);
1007 subs->freqm = subs->freqn;
Clemens Ladisch573567e2005-06-27 08:17:30 +02001008 /* calculate max. frequency */
1009 if (subs->maxpacksize) {
1010 /* whatever fits into a max. size packet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 maxsize = subs->maxpacksize;
Clemens Ladisch573567e2005-06-27 08:17:30 +02001012 subs->freqmax = (maxsize / (frame_bits >> 3))
1013 << (16 - subs->datainterval);
1014 } else {
1015 /* no max. packet size: just take 25% higher than nominal */
1016 subs->freqmax = subs->freqn + (subs->freqn >> 2);
1017 maxsize = ((subs->freqmax + 0xffff) * (frame_bits >> 3))
1018 >> (16 - subs->datainterval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 }
Clemens Ladisch573567e2005-06-27 08:17:30 +02001020 subs->phase = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
1022 if (subs->fill_max)
1023 subs->curpacksize = subs->maxpacksize;
1024 else
1025 subs->curpacksize = maxsize;
1026
Clemens Ladischa93bf992005-08-12 15:19:39 +02001027 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH)
1028 packs_per_ms = 8 >> subs->datainterval;
1029 else
1030 packs_per_ms = 1;
Clemens Ladisch9624ea82005-08-15 08:25:24 +02001031 subs->packs_per_ms = packs_per_ms;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001032
Clemens Ladisch71d848c2005-08-12 15:18:00 +02001033 if (is_playback) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 urb_packs = nrpacks;
Clemens Ladisch71d848c2005-08-12 15:18:00 +02001035 urb_packs = max(urb_packs, (unsigned int)MIN_PACKS_URB);
1036 urb_packs = min(urb_packs, (unsigned int)MAX_PACKS);
1037 } else
Clemens Ladisch15a24c02005-08-12 08:25:26 +02001038 urb_packs = 1;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001039 urb_packs *= packs_per_ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 /* decide how many packets to be used */
Clemens Ladisch15a24c02005-08-12 08:25:26 +02001042 if (is_playback) {
Clemens Ladischd6db3922005-08-12 08:28:27 +02001043 unsigned int minsize;
1044 /* determine how small a packet can be */
1045 minsize = (subs->freqn >> (16 - subs->datainterval))
1046 * (frame_bits >> 3);
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +02001047 /* with sync from device, assume it can be 12% lower */
Clemens Ladischd6db3922005-08-12 08:28:27 +02001048 if (subs->syncpipe)
Clemens Ladisch7efd8bc2005-08-15 08:24:44 +02001049 minsize -= minsize >> 3;
Clemens Ladischd6db3922005-08-12 08:28:27 +02001050 minsize = max(minsize, 1u);
1051 total_packs = (period_bytes + minsize - 1) / minsize;
Clemens Ladischa93bf992005-08-12 15:19:39 +02001052 /* round up to multiple of packs_per_ms */
1053 total_packs = (total_packs + packs_per_ms - 1)
1054 & ~(packs_per_ms - 1);
1055 /* we need at least two URBs for queueing */
1056 if (total_packs < 2 * MIN_PACKS_URB * packs_per_ms)
1057 total_packs = 2 * MIN_PACKS_URB * packs_per_ms;
Clemens Ladisch15a24c02005-08-12 08:25:26 +02001058 } else {
1059 total_packs = MAX_URBS * urb_packs;
1060 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 subs->nurbs = (total_packs + urb_packs - 1) / urb_packs;
1062 if (subs->nurbs > MAX_URBS) {
1063 /* too much... */
1064 subs->nurbs = MAX_URBS;
1065 total_packs = MAX_URBS * urb_packs;
1066 }
1067 n = total_packs;
1068 for (i = 0; i < subs->nurbs; i++) {
1069 npacks[i] = n > urb_packs ? urb_packs : n;
1070 n -= urb_packs;
1071 }
1072 if (subs->nurbs <= 1) {
1073 /* too little - we need at least two packets
1074 * to ensure contiguous playback/capture
1075 */
1076 subs->nurbs = 2;
1077 npacks[0] = (total_packs + 1) / 2;
1078 npacks[1] = total_packs - npacks[0];
Clemens Ladischa93bf992005-08-12 15:19:39 +02001079 } else if (npacks[subs->nurbs-1] < MIN_PACKS_URB * packs_per_ms) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 /* the last packet is too small.. */
1081 if (subs->nurbs > 2) {
1082 /* merge to the first one */
1083 npacks[0] += npacks[subs->nurbs - 1];
1084 subs->nurbs--;
1085 } else {
1086 /* divide to two */
1087 subs->nurbs = 2;
1088 npacks[0] = (total_packs + 1) / 2;
1089 npacks[1] = total_packs - npacks[0];
1090 }
1091 }
1092
1093 /* allocate and initialize data urbs */
1094 for (i = 0; i < subs->nurbs; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001095 struct snd_urb_ctx *u = &subs->dataurb[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 u->index = i;
1097 u->subs = subs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 u->packets = npacks[i];
Clemens Ladisch55851f72005-08-15 08:34:16 +02001099 u->buffer_size = maxsize * u->packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 if (subs->fmt_type == USB_FORMAT_TYPE_II)
1101 u->packets++; /* for transfer delimiter */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
Clemens Ladisch55851f72005-08-15 08:34:16 +02001103 if (! u->urb)
1104 goto out_of_memory;
1105 u->urb->transfer_buffer =
1106 usb_buffer_alloc(subs->dev, u->buffer_size, GFP_KERNEL,
1107 &u->urb->transfer_dma);
1108 if (! u->urb->transfer_buffer)
1109 goto out_of_memory;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 u->urb->pipe = subs->datapipe;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001111 u->urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
Clemens Ladisch573567e2005-06-27 08:17:30 +02001112 u->urb->interval = 1 << subs->datainterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 u->urb->context = u;
Clemens Ladisch3527a002005-09-26 10:03:09 +02001114 u->urb->complete = snd_complete_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 }
1116
1117 if (subs->syncpipe) {
1118 /* allocate and initialize sync urbs */
Clemens Ladisch55851f72005-08-15 08:34:16 +02001119 subs->syncbuf = usb_buffer_alloc(subs->dev, SYNC_URBS * 4,
1120 GFP_KERNEL, &subs->sync_dma);
1121 if (! subs->syncbuf)
1122 goto out_of_memory;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 for (i = 0; i < SYNC_URBS; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001124 struct snd_urb_ctx *u = &subs->syncurb[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 u->index = i;
1126 u->subs = subs;
Clemens Ladischca810902005-05-02 08:55:54 +02001127 u->packets = 1;
1128 u->urb = usb_alloc_urb(1, GFP_KERNEL);
Clemens Ladisch55851f72005-08-15 08:34:16 +02001129 if (! u->urb)
1130 goto out_of_memory;
Clemens Ladischca810902005-05-02 08:55:54 +02001131 u->urb->transfer_buffer = subs->syncbuf + i * 4;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001132 u->urb->transfer_dma = subs->sync_dma + i * 4;
Clemens Ladischca810902005-05-02 08:55:54 +02001133 u->urb->transfer_buffer_length = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 u->urb->pipe = subs->syncpipe;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001135 u->urb->transfer_flags = URB_ISO_ASAP |
1136 URB_NO_TRANSFER_DMA_MAP;
Clemens Ladischca810902005-05-02 08:55:54 +02001137 u->urb->number_of_packets = 1;
Clemens Ladisch1149a642005-05-02 08:53:46 +02001138 u->urb->interval = 1 << subs->syncinterval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 u->urb->context = u;
Clemens Ladisch3527a002005-09-26 10:03:09 +02001140 u->urb->complete = snd_complete_sync_urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 }
1142 }
1143 return 0;
Clemens Ladisch55851f72005-08-15 08:34:16 +02001144
1145out_of_memory:
1146 release_substream_urbs(subs, 0);
1147 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148}
1149
1150
1151/*
1152 * find a matching audio format
1153 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001154static struct audioformat *find_format(struct snd_usb_substream *subs, unsigned int format,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 unsigned int rate, unsigned int channels)
1156{
1157 struct list_head *p;
1158 struct audioformat *found = NULL;
1159 int cur_attr = 0, attr;
1160
1161 list_for_each(p, &subs->fmt_list) {
1162 struct audioformat *fp;
1163 fp = list_entry(p, struct audioformat, list);
1164 if (fp->format != format || fp->channels != channels)
1165 continue;
1166 if (rate < fp->rate_min || rate > fp->rate_max)
1167 continue;
1168 if (! (fp->rates & SNDRV_PCM_RATE_CONTINUOUS)) {
1169 unsigned int i;
1170 for (i = 0; i < fp->nr_rates; i++)
1171 if (fp->rate_table[i] == rate)
1172 break;
1173 if (i >= fp->nr_rates)
1174 continue;
1175 }
1176 attr = fp->ep_attr & EP_ATTR_MASK;
1177 if (! found) {
1178 found = fp;
1179 cur_attr = attr;
1180 continue;
1181 }
1182 /* avoid async out and adaptive in if the other method
1183 * supports the same format.
1184 * this is a workaround for the case like
1185 * M-audio audiophile USB.
1186 */
1187 if (attr != cur_attr) {
1188 if ((attr == EP_ATTR_ASYNC &&
1189 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1190 (attr == EP_ATTR_ADAPTIVE &&
1191 subs->direction == SNDRV_PCM_STREAM_CAPTURE))
1192 continue;
1193 if ((cur_attr == EP_ATTR_ASYNC &&
1194 subs->direction == SNDRV_PCM_STREAM_PLAYBACK) ||
1195 (cur_attr == EP_ATTR_ADAPTIVE &&
1196 subs->direction == SNDRV_PCM_STREAM_CAPTURE)) {
1197 found = fp;
1198 cur_attr = attr;
1199 continue;
1200 }
1201 }
1202 /* find the format with the largest max. packet size */
1203 if (fp->maxpacksize > found->maxpacksize) {
1204 found = fp;
1205 cur_attr = attr;
1206 }
1207 }
1208 return found;
1209}
1210
1211
1212/*
1213 * initialize the picth control and sample rate
1214 */
1215static int init_usb_pitch(struct usb_device *dev, int iface,
1216 struct usb_host_interface *alts,
1217 struct audioformat *fmt)
1218{
1219 unsigned int ep;
1220 unsigned char data[1];
1221 int err;
1222
1223 ep = get_endpoint(alts, 0)->bEndpointAddress;
1224 /* if endpoint has pitch control, enable it */
1225 if (fmt->attributes & EP_CS_ATTR_PITCH_CONTROL) {
1226 data[0] = 1;
1227 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1228 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1229 PITCH_CONTROL << 8, ep, data, 1, 1000)) < 0) {
1230 snd_printk(KERN_ERR "%d:%d:%d: cannot set enable PITCH\n",
1231 dev->devnum, iface, ep);
1232 return err;
1233 }
1234 }
1235 return 0;
1236}
1237
1238static int init_usb_sample_rate(struct usb_device *dev, int iface,
1239 struct usb_host_interface *alts,
1240 struct audioformat *fmt, int rate)
1241{
1242 unsigned int ep;
1243 unsigned char data[3];
1244 int err;
1245
1246 ep = get_endpoint(alts, 0)->bEndpointAddress;
1247 /* if endpoint has sampling rate control, set it */
1248 if (fmt->attributes & EP_CS_ATTR_SAMPLE_RATE) {
1249 int crate;
1250 data[0] = rate;
1251 data[1] = rate >> 8;
1252 data[2] = rate >> 16;
1253 if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), SET_CUR,
1254 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_OUT,
1255 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1256 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep 0x%x\n",
1257 dev->devnum, iface, fmt->altsetting, rate, ep);
1258 return err;
1259 }
1260 if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), GET_CUR,
1261 USB_TYPE_CLASS|USB_RECIP_ENDPOINT|USB_DIR_IN,
1262 SAMPLING_FREQ_CONTROL << 8, ep, data, 3, 1000)) < 0) {
1263 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep 0x%x\n",
1264 dev->devnum, iface, fmt->altsetting, ep);
1265 return 0; /* some devices don't support reading */
1266 }
1267 crate = data[0] | (data[1] << 8) | (data[2] << 16);
1268 if (crate != rate) {
1269 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
1270 // runtime->rate = crate;
1271 }
1272 }
1273 return 0;
1274}
1275
1276/*
1277 * find a matching format and set up the interface
1278 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001279static int set_format(struct snd_usb_substream *subs, struct audioformat *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280{
1281 struct usb_device *dev = subs->dev;
1282 struct usb_host_interface *alts;
1283 struct usb_interface_descriptor *altsd;
1284 struct usb_interface *iface;
1285 unsigned int ep, attr;
1286 int is_playback = subs->direction == SNDRV_PCM_STREAM_PLAYBACK;
1287 int err;
1288
1289 iface = usb_ifnum_to_if(dev, fmt->iface);
1290 snd_assert(iface, return -EINVAL);
1291 alts = &iface->altsetting[fmt->altset_idx];
1292 altsd = get_iface_desc(alts);
1293 snd_assert(altsd->bAlternateSetting == fmt->altsetting, return -EINVAL);
1294
1295 if (fmt == subs->cur_audiofmt)
1296 return 0;
1297
1298 /* close the old interface */
1299 if (subs->interface >= 0 && subs->interface != fmt->iface) {
1300 usb_set_interface(subs->dev, subs->interface, 0);
1301 subs->interface = -1;
1302 subs->format = 0;
1303 }
1304
1305 /* set interface */
1306 if (subs->interface != fmt->iface || subs->format != fmt->altset_idx) {
1307 if (usb_set_interface(dev, fmt->iface, fmt->altsetting) < 0) {
1308 snd_printk(KERN_ERR "%d:%d:%d: usb_set_interface failed\n",
1309 dev->devnum, fmt->iface, fmt->altsetting);
1310 return -EIO;
1311 }
1312 snd_printdd(KERN_INFO "setting usb interface %d:%d\n", fmt->iface, fmt->altsetting);
1313 subs->interface = fmt->iface;
1314 subs->format = fmt->altset_idx;
1315 }
1316
1317 /* create a data pipe */
1318 ep = fmt->endpoint & USB_ENDPOINT_NUMBER_MASK;
1319 if (is_playback)
1320 subs->datapipe = usb_sndisocpipe(dev, ep);
1321 else
1322 subs->datapipe = usb_rcvisocpipe(dev, ep);
Clemens Ladisch573567e2005-06-27 08:17:30 +02001323 if (snd_usb_get_speed(subs->dev) == USB_SPEED_HIGH &&
1324 get_endpoint(alts, 0)->bInterval >= 1 &&
1325 get_endpoint(alts, 0)->bInterval <= 4)
1326 subs->datainterval = get_endpoint(alts, 0)->bInterval - 1;
1327 else
1328 subs->datainterval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 subs->syncpipe = subs->syncinterval = 0;
1330 subs->maxpacksize = fmt->maxpacksize;
1331 subs->fill_max = 0;
1332
1333 /* we need a sync pipe in async OUT or adaptive IN mode */
1334 /* check the number of EP, since some devices have broken
1335 * descriptors which fool us. if it has only one EP,
1336 * assume it as adaptive-out or sync-in.
1337 */
1338 attr = fmt->ep_attr & EP_ATTR_MASK;
1339 if (((is_playback && attr == EP_ATTR_ASYNC) ||
1340 (! is_playback && attr == EP_ATTR_ADAPTIVE)) &&
1341 altsd->bNumEndpoints >= 2) {
1342 /* check sync-pipe endpoint */
1343 /* ... and check descriptor size before accessing bSynchAddress
1344 because there is a version of the SB Audigy 2 NX firmware lacking
1345 the audio fields in the endpoint descriptors */
1346 if ((get_endpoint(alts, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 0x01 ||
1347 (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1348 get_endpoint(alts, 1)->bSynchAddress != 0)) {
1349 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1350 dev->devnum, fmt->iface, fmt->altsetting);
1351 return -EINVAL;
1352 }
1353 ep = get_endpoint(alts, 1)->bEndpointAddress;
1354 if (get_endpoint(alts, 0)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1355 (( is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress | USB_DIR_IN)) ||
1356 (!is_playback && ep != (unsigned int)(get_endpoint(alts, 0)->bSynchAddress & ~USB_DIR_IN)))) {
1357 snd_printk(KERN_ERR "%d:%d:%d : invalid synch pipe\n",
1358 dev->devnum, fmt->iface, fmt->altsetting);
1359 return -EINVAL;
1360 }
1361 ep &= USB_ENDPOINT_NUMBER_MASK;
1362 if (is_playback)
1363 subs->syncpipe = usb_rcvisocpipe(dev, ep);
1364 else
1365 subs->syncpipe = usb_sndisocpipe(dev, ep);
Clemens Ladisch1149a642005-05-02 08:53:46 +02001366 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
1367 get_endpoint(alts, 1)->bRefresh >= 1 &&
1368 get_endpoint(alts, 1)->bRefresh <= 9)
1369 subs->syncinterval = get_endpoint(alts, 1)->bRefresh;
Clemens Ladisch604cf492005-05-17 09:15:27 +02001370 else if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
Clemens Ladisch1149a642005-05-02 08:53:46 +02001371 subs->syncinterval = 1;
Clemens Ladisch604cf492005-05-17 09:15:27 +02001372 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
1373 get_endpoint(alts, 1)->bInterval <= 16)
1374 subs->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
1375 else
1376 subs->syncinterval = 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 }
1378
1379 /* always fill max packet size */
1380 if (fmt->attributes & EP_CS_ATTR_FILL_MAX)
1381 subs->fill_max = 1;
1382
1383 if ((err = init_usb_pitch(dev, subs->interface, alts, fmt)) < 0)
1384 return err;
1385
1386 subs->cur_audiofmt = fmt;
1387
1388#if 0
1389 printk("setting done: format = %d, rate = %d, channels = %d\n",
1390 fmt->format, fmt->rate, fmt->channels);
1391 printk(" datapipe = 0x%0x, syncpipe = 0x%0x\n",
1392 subs->datapipe, subs->syncpipe);
1393#endif
1394
1395 return 0;
1396}
1397
1398/*
1399 * hw_params callback
1400 *
1401 * allocate a buffer and set the given audio format.
1402 *
1403 * so far we use a physically linear buffer although packetize transfer
1404 * doesn't need a continuous area.
1405 * if sg buffer is supported on the later version of alsa, we'll follow
1406 * that.
1407 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001408static int snd_usb_hw_params(struct snd_pcm_substream *substream,
1409 struct snd_pcm_hw_params *hw_params)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001411 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 struct audioformat *fmt;
1413 unsigned int channels, rate, format;
1414 int ret, changed;
1415
Clemens Ladisch6207e512005-08-15 08:35:25 +02001416 ret = snd_pcm_alloc_vmalloc_buffer(substream,
1417 params_buffer_bytes(hw_params));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 if (ret < 0)
1419 return ret;
1420
1421 format = params_format(hw_params);
1422 rate = params_rate(hw_params);
1423 channels = params_channels(hw_params);
1424 fmt = find_format(subs, format, rate, channels);
1425 if (! fmt) {
Jaroslav Kysela21a34792006-01-13 09:12:11 +01001426 snd_printd(KERN_DEBUG "cannot set format: format = 0x%x, rate = %d, channels = %d\n",
1427 format, rate, channels);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 return -EINVAL;
1429 }
1430
1431 changed = subs->cur_audiofmt != fmt ||
1432 subs->period_bytes != params_period_bytes(hw_params) ||
1433 subs->cur_rate != rate;
1434 if ((ret = set_format(subs, fmt)) < 0)
1435 return ret;
1436
1437 if (subs->cur_rate != rate) {
1438 struct usb_host_interface *alts;
1439 struct usb_interface *iface;
1440 iface = usb_ifnum_to_if(subs->dev, fmt->iface);
1441 alts = &iface->altsetting[fmt->altset_idx];
1442 ret = init_usb_sample_rate(subs->dev, subs->interface, alts, fmt, rate);
1443 if (ret < 0)
1444 return ret;
1445 subs->cur_rate = rate;
1446 }
1447
1448 if (changed) {
1449 /* format changed */
1450 release_substream_urbs(subs, 0);
1451 /* influenced: period_bytes, channels, rate, format, */
1452 ret = init_substream_urbs(subs, params_period_bytes(hw_params),
1453 params_rate(hw_params),
1454 snd_pcm_format_physical_width(params_format(hw_params)) * params_channels(hw_params));
1455 }
1456
1457 return ret;
1458}
1459
1460/*
1461 * hw_free callback
1462 *
1463 * reset the audio format and release the buffer
1464 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001465static int snd_usb_hw_free(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001467 struct snd_usb_substream *subs = (struct snd_usb_substream *)substream->runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
1469 subs->cur_audiofmt = NULL;
1470 subs->cur_rate = 0;
1471 subs->period_bytes = 0;
1472 release_substream_urbs(subs, 0);
Clemens Ladisch6207e512005-08-15 08:35:25 +02001473 return snd_pcm_free_vmalloc_buffer(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474}
1475
1476/*
1477 * prepare callback
1478 *
1479 * only a few subtle things...
1480 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001481static int snd_usb_pcm_prepare(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001483 struct snd_pcm_runtime *runtime = substream->runtime;
1484 struct snd_usb_substream *subs = runtime->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
1486 if (! subs->cur_audiofmt) {
1487 snd_printk(KERN_ERR "usbaudio: no format is specified!\n");
1488 return -ENXIO;
1489 }
1490
1491 /* some unit conversions in runtime */
1492 subs->maxframesize = bytes_to_frames(runtime, subs->maxpacksize);
1493 subs->curframesize = bytes_to_frames(runtime, subs->curpacksize);
1494
1495 /* reset the pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 subs->hwptr_done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 subs->transfer_done = 0;
1498 subs->phase = 0;
1499
1500 /* clear urbs (to be sure) */
1501 deactivate_urbs(subs, 0, 1);
1502 wait_clear_urbs(subs);
1503
Clemens Ladischb55bbf02005-11-02 11:32:52 +01001504 /* for playback, submit the URBs now; otherwise, the first hwptr_done
1505 * updates for all URBs would happen at the same time when starting */
1506 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1507 subs->ops.prepare = prepare_startup_playback_urb;
1508 return start_urbs(subs, runtime);
1509 } else
1510 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511}
1512
Takashi Iwai86e07d32005-11-17 15:08:02 +01001513static struct snd_pcm_hardware snd_usb_playback =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514{
Clemens Ladisch49045d32005-09-05 10:31:05 +02001515 .info = SNDRV_PCM_INFO_MMAP |
1516 SNDRV_PCM_INFO_MMAP_VALID |
1517 SNDRV_PCM_INFO_BATCH |
1518 SNDRV_PCM_INFO_INTERLEAVED |
1519 SNDRV_PCM_INFO_BLOCK_TRANSFER,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001520 .buffer_bytes_max = 1024 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 .period_bytes_min = 64,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001522 .period_bytes_max = 512 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 .periods_min = 2,
1524 .periods_max = 1024,
1525};
1526
Takashi Iwai86e07d32005-11-17 15:08:02 +01001527static struct snd_pcm_hardware snd_usb_capture =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528{
Clemens Ladisch49045d32005-09-05 10:31:05 +02001529 .info = SNDRV_PCM_INFO_MMAP |
1530 SNDRV_PCM_INFO_MMAP_VALID |
1531 SNDRV_PCM_INFO_BATCH |
1532 SNDRV_PCM_INFO_INTERLEAVED |
1533 SNDRV_PCM_INFO_BLOCK_TRANSFER,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001534 .buffer_bytes_max = 1024 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 .period_bytes_min = 64,
Clemens Ladischd31cbbf2005-09-26 09:59:57 +02001536 .period_bytes_max = 512 * 1024,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 .periods_min = 2,
1538 .periods_max = 1024,
1539};
1540
1541/*
1542 * h/w constraints
1543 */
1544
1545#ifdef HW_CONST_DEBUG
1546#define hwc_debug(fmt, args...) printk(KERN_DEBUG fmt, ##args)
1547#else
1548#define hwc_debug(fmt, args...) /**/
1549#endif
1550
Takashi Iwai86e07d32005-11-17 15:08:02 +01001551static int hw_check_valid_format(struct snd_pcm_hw_params *params, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001553 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1554 struct snd_interval *ct = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
1555 struct snd_mask *fmts = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
1557 /* check the format */
1558 if (! snd_mask_test(fmts, fp->format)) {
1559 hwc_debug(" > check: no supported format %d\n", fp->format);
1560 return 0;
1561 }
1562 /* check the channels */
1563 if (fp->channels < ct->min || fp->channels > ct->max) {
1564 hwc_debug(" > check: no valid channels %d (%d/%d)\n", fp->channels, ct->min, ct->max);
1565 return 0;
1566 }
1567 /* check the rate is within the range */
1568 if (fp->rate_min > it->max || (fp->rate_min == it->max && it->openmax)) {
1569 hwc_debug(" > check: rate_min %d > max %d\n", fp->rate_min, it->max);
1570 return 0;
1571 }
1572 if (fp->rate_max < it->min || (fp->rate_max == it->min && it->openmin)) {
1573 hwc_debug(" > check: rate_max %d < min %d\n", fp->rate_max, it->min);
1574 return 0;
1575 }
1576 return 1;
1577}
1578
Takashi Iwai86e07d32005-11-17 15:08:02 +01001579static int hw_rule_rate(struct snd_pcm_hw_params *params,
1580 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001582 struct snd_usb_substream *subs = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001584 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 unsigned int rmin, rmax;
1586 int changed;
1587
1588 hwc_debug("hw_rule_rate: (%d,%d)\n", it->min, it->max);
1589 changed = 0;
1590 rmin = rmax = 0;
1591 list_for_each(p, &subs->fmt_list) {
1592 struct audioformat *fp;
1593 fp = list_entry(p, struct audioformat, list);
1594 if (! hw_check_valid_format(params, fp))
1595 continue;
1596 if (changed++) {
1597 if (rmin > fp->rate_min)
1598 rmin = fp->rate_min;
1599 if (rmax < fp->rate_max)
1600 rmax = fp->rate_max;
1601 } else {
1602 rmin = fp->rate_min;
1603 rmax = fp->rate_max;
1604 }
1605 }
1606
1607 if (! changed) {
1608 hwc_debug(" --> get empty\n");
1609 it->empty = 1;
1610 return -EINVAL;
1611 }
1612
1613 changed = 0;
1614 if (it->min < rmin) {
1615 it->min = rmin;
1616 it->openmin = 0;
1617 changed = 1;
1618 }
1619 if (it->max > rmax) {
1620 it->max = rmax;
1621 it->openmax = 0;
1622 changed = 1;
1623 }
1624 if (snd_interval_checkempty(it)) {
1625 it->empty = 1;
1626 return -EINVAL;
1627 }
1628 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1629 return changed;
1630}
1631
1632
Takashi Iwai86e07d32005-11-17 15:08:02 +01001633static int hw_rule_channels(struct snd_pcm_hw_params *params,
1634 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001636 struct snd_usb_substream *subs = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001638 struct snd_interval *it = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 unsigned int rmin, rmax;
1640 int changed;
1641
1642 hwc_debug("hw_rule_channels: (%d,%d)\n", it->min, it->max);
1643 changed = 0;
1644 rmin = rmax = 0;
1645 list_for_each(p, &subs->fmt_list) {
1646 struct audioformat *fp;
1647 fp = list_entry(p, struct audioformat, list);
1648 if (! hw_check_valid_format(params, fp))
1649 continue;
1650 if (changed++) {
1651 if (rmin > fp->channels)
1652 rmin = fp->channels;
1653 if (rmax < fp->channels)
1654 rmax = fp->channels;
1655 } else {
1656 rmin = fp->channels;
1657 rmax = fp->channels;
1658 }
1659 }
1660
1661 if (! changed) {
1662 hwc_debug(" --> get empty\n");
1663 it->empty = 1;
1664 return -EINVAL;
1665 }
1666
1667 changed = 0;
1668 if (it->min < rmin) {
1669 it->min = rmin;
1670 it->openmin = 0;
1671 changed = 1;
1672 }
1673 if (it->max > rmax) {
1674 it->max = rmax;
1675 it->openmax = 0;
1676 changed = 1;
1677 }
1678 if (snd_interval_checkempty(it)) {
1679 it->empty = 1;
1680 return -EINVAL;
1681 }
1682 hwc_debug(" --> (%d, %d) (changed = %d)\n", it->min, it->max, changed);
1683 return changed;
1684}
1685
Takashi Iwai86e07d32005-11-17 15:08:02 +01001686static int hw_rule_format(struct snd_pcm_hw_params *params,
1687 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001689 struct snd_usb_substream *subs = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001691 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 u64 fbits;
1693 u32 oldbits[2];
1694 int changed;
1695
1696 hwc_debug("hw_rule_format: %x:%x\n", fmt->bits[0], fmt->bits[1]);
1697 fbits = 0;
1698 list_for_each(p, &subs->fmt_list) {
1699 struct audioformat *fp;
1700 fp = list_entry(p, struct audioformat, list);
1701 if (! hw_check_valid_format(params, fp))
1702 continue;
1703 fbits |= (1ULL << fp->format);
1704 }
1705
1706 oldbits[0] = fmt->bits[0];
1707 oldbits[1] = fmt->bits[1];
1708 fmt->bits[0] &= (u32)fbits;
1709 fmt->bits[1] &= (u32)(fbits >> 32);
1710 if (! fmt->bits[0] && ! fmt->bits[1]) {
1711 hwc_debug(" --> get empty\n");
1712 return -EINVAL;
1713 }
1714 changed = (oldbits[0] != fmt->bits[0] || oldbits[1] != fmt->bits[1]);
1715 hwc_debug(" --> %x:%x (changed = %d)\n", fmt->bits[0], fmt->bits[1], changed);
1716 return changed;
1717}
1718
1719#define MAX_MASK 64
1720
1721/*
1722 * check whether the registered audio formats need special hw-constraints
1723 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001724static int check_hw_params_convention(struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725{
1726 int i;
1727 u32 *channels;
1728 u32 *rates;
1729 u32 cmaster, rmaster;
1730 u32 rate_min = 0, rate_max = 0;
1731 struct list_head *p;
1732 int err = 1;
1733
1734 channels = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1735 rates = kcalloc(MAX_MASK, sizeof(u32), GFP_KERNEL);
1736
1737 list_for_each(p, &subs->fmt_list) {
1738 struct audioformat *f;
1739 f = list_entry(p, struct audioformat, list);
1740 /* unconventional channels? */
1741 if (f->channels > 32)
1742 goto __out;
1743 /* continuous rate min/max matches? */
1744 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1745 if (rate_min && f->rate_min != rate_min)
1746 goto __out;
1747 if (rate_max && f->rate_max != rate_max)
1748 goto __out;
1749 rate_min = f->rate_min;
1750 rate_max = f->rate_max;
1751 }
1752 /* combination of continuous rates and fixed rates? */
1753 if (rates[f->format] & SNDRV_PCM_RATE_CONTINUOUS) {
1754 if (f->rates != rates[f->format])
1755 goto __out;
1756 }
1757 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS) {
1758 if (rates[f->format] && rates[f->format] != f->rates)
1759 goto __out;
1760 }
1761 channels[f->format] |= (1 << f->channels);
1762 rates[f->format] |= f->rates;
Luke Rossa79eee82006-08-29 10:46:32 +02001763 /* needs knot? */
1764 if (f->needs_knot)
1765 goto __out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 }
1767 /* check whether channels and rates match for all formats */
1768 cmaster = rmaster = 0;
1769 for (i = 0; i < MAX_MASK; i++) {
1770 if (cmaster != channels[i] && cmaster && channels[i])
1771 goto __out;
1772 if (rmaster != rates[i] && rmaster && rates[i])
1773 goto __out;
1774 if (channels[i])
1775 cmaster = channels[i];
1776 if (rates[i])
1777 rmaster = rates[i];
1778 }
1779 /* check whether channels match for all distinct rates */
1780 memset(channels, 0, MAX_MASK * sizeof(u32));
1781 list_for_each(p, &subs->fmt_list) {
1782 struct audioformat *f;
1783 f = list_entry(p, struct audioformat, list);
1784 if (f->rates & SNDRV_PCM_RATE_CONTINUOUS)
1785 continue;
1786 for (i = 0; i < 32; i++) {
1787 if (f->rates & (1 << i))
1788 channels[i] |= (1 << f->channels);
1789 }
1790 }
1791 cmaster = 0;
1792 for (i = 0; i < 32; i++) {
1793 if (cmaster != channels[i] && cmaster && channels[i])
1794 goto __out;
1795 if (channels[i])
1796 cmaster = channels[i];
1797 }
1798 err = 0;
1799
1800 __out:
1801 kfree(channels);
1802 kfree(rates);
1803 return err;
1804}
1805
Luke Rossa79eee82006-08-29 10:46:32 +02001806/*
1807 * If the device supports unusual bit rates, does the request meet these?
1808 */
1809static int snd_usb_pcm_check_knot(struct snd_pcm_runtime *runtime,
1810 struct snd_usb_substream *subs)
1811{
1812 struct list_head *p;
1813 struct snd_pcm_hw_constraint_list constraints_rates;
1814 int err;
1815
1816 list_for_each(p, &subs->fmt_list) {
1817 struct audioformat *fp;
1818 fp = list_entry(p, struct audioformat, list);
1819
1820 if (!fp->needs_knot)
1821 continue;
1822
1823 constraints_rates.count = fp->nr_rates;
1824 constraints_rates.list = fp->rate_table;
1825 constraints_rates.mask = 0;
1826
1827 err = snd_pcm_hw_constraint_list(runtime, 0,
1828 SNDRV_PCM_HW_PARAM_RATE,
1829 &constraints_rates);
1830
1831 if (err < 0)
1832 return err;
1833 }
1834
1835 return 0;
1836}
1837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
1839/*
1840 * set up the runtime hardware information.
1841 */
1842
Takashi Iwai86e07d32005-11-17 15:08:02 +01001843static int setup_hw_info(struct snd_pcm_runtime *runtime, struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844{
1845 struct list_head *p;
1846 int err;
1847
1848 runtime->hw.formats = subs->formats;
1849
1850 runtime->hw.rate_min = 0x7fffffff;
1851 runtime->hw.rate_max = 0;
1852 runtime->hw.channels_min = 256;
1853 runtime->hw.channels_max = 0;
1854 runtime->hw.rates = 0;
1855 /* check min/max rates and channels */
1856 list_for_each(p, &subs->fmt_list) {
1857 struct audioformat *fp;
1858 fp = list_entry(p, struct audioformat, list);
1859 runtime->hw.rates |= fp->rates;
1860 if (runtime->hw.rate_min > fp->rate_min)
1861 runtime->hw.rate_min = fp->rate_min;
1862 if (runtime->hw.rate_max < fp->rate_max)
1863 runtime->hw.rate_max = fp->rate_max;
1864 if (runtime->hw.channels_min > fp->channels)
1865 runtime->hw.channels_min = fp->channels;
1866 if (runtime->hw.channels_max < fp->channels)
1867 runtime->hw.channels_max = fp->channels;
1868 if (fp->fmt_type == USB_FORMAT_TYPE_II && fp->frame_size > 0) {
1869 /* FIXME: there might be more than one audio formats... */
1870 runtime->hw.period_bytes_min = runtime->hw.period_bytes_max =
1871 fp->frame_size;
1872 }
1873 }
1874
1875 /* set the period time minimum 1ms */
1876 snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1877 1000 * MIN_PACKS_URB,
1878 /*(nrpacks * MAX_URBS) * 1000*/ UINT_MAX);
1879
1880 if (check_hw_params_convention(subs)) {
1881 hwc_debug("setting extra hw constraints...\n");
1882 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
1883 hw_rule_rate, subs,
1884 SNDRV_PCM_HW_PARAM_FORMAT,
1885 SNDRV_PCM_HW_PARAM_CHANNELS,
1886 -1)) < 0)
1887 return err;
1888 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
1889 hw_rule_channels, subs,
1890 SNDRV_PCM_HW_PARAM_FORMAT,
1891 SNDRV_PCM_HW_PARAM_RATE,
1892 -1)) < 0)
1893 return err;
1894 if ((err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
1895 hw_rule_format, subs,
1896 SNDRV_PCM_HW_PARAM_RATE,
1897 SNDRV_PCM_HW_PARAM_CHANNELS,
1898 -1)) < 0)
1899 return err;
Luke Rossa79eee82006-08-29 10:46:32 +02001900 if ((err = snd_usb_pcm_check_knot(runtime, subs)) < 0)
1901 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 }
1903 return 0;
1904}
1905
Takashi Iwai86e07d32005-11-17 15:08:02 +01001906static int snd_usb_pcm_open(struct snd_pcm_substream *substream, int direction,
1907 struct snd_pcm_hardware *hw)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001909 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1910 struct snd_pcm_runtime *runtime = substream->runtime;
1911 struct snd_usb_substream *subs = &as->substream[direction];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912
1913 subs->interface = -1;
1914 subs->format = 0;
1915 runtime->hw = *hw;
1916 runtime->private_data = subs;
1917 subs->pcm_substream = substream;
1918 return setup_hw_info(runtime, subs);
1919}
1920
Takashi Iwai86e07d32005-11-17 15:08:02 +01001921static int snd_usb_pcm_close(struct snd_pcm_substream *substream, int direction)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001923 struct snd_usb_stream *as = snd_pcm_substream_chip(substream);
1924 struct snd_usb_substream *subs = &as->substream[direction];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
1926 if (subs->interface >= 0) {
1927 usb_set_interface(subs->dev, subs->interface, 0);
1928 subs->interface = -1;
1929 }
1930 subs->pcm_substream = NULL;
1931 return 0;
1932}
1933
Takashi Iwai86e07d32005-11-17 15:08:02 +01001934static int snd_usb_playback_open(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935{
1936 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_PLAYBACK, &snd_usb_playback);
1937}
1938
Takashi Iwai86e07d32005-11-17 15:08:02 +01001939static int snd_usb_playback_close(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940{
1941 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_PLAYBACK);
1942}
1943
Takashi Iwai86e07d32005-11-17 15:08:02 +01001944static int snd_usb_capture_open(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945{
1946 return snd_usb_pcm_open(substream, SNDRV_PCM_STREAM_CAPTURE, &snd_usb_capture);
1947}
1948
Takashi Iwai86e07d32005-11-17 15:08:02 +01001949static int snd_usb_capture_close(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950{
1951 return snd_usb_pcm_close(substream, SNDRV_PCM_STREAM_CAPTURE);
1952}
1953
Takashi Iwai86e07d32005-11-17 15:08:02 +01001954static struct snd_pcm_ops snd_usb_playback_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 .open = snd_usb_playback_open,
1956 .close = snd_usb_playback_close,
1957 .ioctl = snd_pcm_lib_ioctl,
1958 .hw_params = snd_usb_hw_params,
1959 .hw_free = snd_usb_hw_free,
1960 .prepare = snd_usb_pcm_prepare,
Clemens Ladischb55bbf02005-11-02 11:32:52 +01001961 .trigger = snd_usb_pcm_playback_trigger,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 .pointer = snd_usb_pcm_pointer,
Clemens Ladisch6207e512005-08-15 08:35:25 +02001963 .page = snd_pcm_get_vmalloc_page,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964};
1965
Takashi Iwai86e07d32005-11-17 15:08:02 +01001966static struct snd_pcm_ops snd_usb_capture_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 .open = snd_usb_capture_open,
1968 .close = snd_usb_capture_close,
1969 .ioctl = snd_pcm_lib_ioctl,
1970 .hw_params = snd_usb_hw_params,
1971 .hw_free = snd_usb_hw_free,
1972 .prepare = snd_usb_pcm_prepare,
Clemens Ladischb55bbf02005-11-02 11:32:52 +01001973 .trigger = snd_usb_pcm_capture_trigger,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 .pointer = snd_usb_pcm_pointer,
Clemens Ladisch6207e512005-08-15 08:35:25 +02001975 .page = snd_pcm_get_vmalloc_page,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976};
1977
1978
1979
1980/*
1981 * helper functions
1982 */
1983
1984/*
1985 * combine bytes and get an integer value
1986 */
1987unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size)
1988{
1989 switch (size) {
1990 case 1: return *bytes;
1991 case 2: return combine_word(bytes);
1992 case 3: return combine_triple(bytes);
1993 case 4: return combine_quad(bytes);
1994 default: return 0;
1995 }
1996}
1997
1998/*
1999 * parse descriptor buffer and return the pointer starting the given
2000 * descriptor type.
2001 */
2002void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype)
2003{
2004 u8 *p, *end, *next;
2005
2006 p = descstart;
2007 end = p + desclen;
2008 for (; p < end;) {
2009 if (p[0] < 2)
2010 return NULL;
2011 next = p + p[0];
2012 if (next > end)
2013 return NULL;
2014 if (p[1] == dtype && (!after || (void *)p > after)) {
2015 return p;
2016 }
2017 p = next;
2018 }
2019 return NULL;
2020}
2021
2022/*
2023 * find a class-specified interface descriptor with the given subtype.
2024 */
2025void *snd_usb_find_csint_desc(void *buffer, int buflen, void *after, u8 dsubtype)
2026{
2027 unsigned char *p = after;
2028
2029 while ((p = snd_usb_find_desc(buffer, buflen, p,
2030 USB_DT_CS_INTERFACE)) != NULL) {
2031 if (p[0] >= 3 && p[2] == dsubtype)
2032 return p;
2033 }
2034 return NULL;
2035}
2036
2037/*
2038 * Wrapper for usb_control_msg().
2039 * Allocates a temp buffer to prevent dmaing from/to the stack.
2040 */
2041int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
2042 __u8 requesttype, __u16 value, __u16 index, void *data,
2043 __u16 size, int timeout)
2044{
2045 int err;
2046 void *buf = NULL;
2047
2048 if (size > 0) {
2049 buf = kmalloc(size, GFP_KERNEL);
2050 if (!buf)
2051 return -ENOMEM;
2052 memcpy(buf, data, size);
2053 }
2054 err = usb_control_msg(dev, pipe, request, requesttype,
2055 value, index, buf, size, timeout);
2056 if (size > 0) {
2057 memcpy(data, buf, size);
2058 kfree(buf);
2059 }
2060 return err;
2061}
2062
2063
2064/*
2065 * entry point for linux usb interface
2066 */
2067
2068static int usb_audio_probe(struct usb_interface *intf,
2069 const struct usb_device_id *id);
2070static void usb_audio_disconnect(struct usb_interface *intf);
2071
2072static struct usb_device_id usb_audio_ids [] = {
2073#include "usbquirks.h"
2074 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
2075 .bInterfaceClass = USB_CLASS_AUDIO,
2076 .bInterfaceSubClass = USB_SUBCLASS_AUDIO_CONTROL },
2077 { } /* Terminating entry */
2078};
2079
2080MODULE_DEVICE_TABLE (usb, usb_audio_ids);
2081
2082static struct usb_driver usb_audio_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 .name = "snd-usb-audio",
2084 .probe = usb_audio_probe,
2085 .disconnect = usb_audio_disconnect,
2086 .id_table = usb_audio_ids,
2087};
2088
2089
Takashi Iwai727f3172006-08-04 19:08:03 +02002090#if defined(CONFIG_PROC_FS) && defined(CONFIG_SND_VERBOSE_PROCFS)
Jaroslav Kysela21a34792006-01-13 09:12:11 +01002091
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092/*
2093 * proc interface for list the supported pcm formats
2094 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002095static void proc_dump_substream_formats(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096{
2097 struct list_head *p;
2098 static char *sync_types[4] = {
2099 "NONE", "ASYNC", "ADAPTIVE", "SYNC"
2100 };
2101
2102 list_for_each(p, &subs->fmt_list) {
2103 struct audioformat *fp;
2104 fp = list_entry(p, struct audioformat, list);
2105 snd_iprintf(buffer, " Interface %d\n", fp->iface);
2106 snd_iprintf(buffer, " Altset %d\n", fp->altsetting);
Jaroslav Kysela3f72a302006-01-18 11:50:40 +01002107 snd_iprintf(buffer, " Format: 0x%x\n", fp->format);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 snd_iprintf(buffer, " Channels: %d\n", fp->channels);
2109 snd_iprintf(buffer, " Endpoint: %d %s (%s)\n",
2110 fp->endpoint & USB_ENDPOINT_NUMBER_MASK,
2111 fp->endpoint & USB_DIR_IN ? "IN" : "OUT",
2112 sync_types[(fp->ep_attr & EP_ATTR_MASK) >> 2]);
2113 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
2114 snd_iprintf(buffer, " Rates: %d - %d (continuous)\n",
2115 fp->rate_min, fp->rate_max);
2116 } else {
2117 unsigned int i;
2118 snd_iprintf(buffer, " Rates: ");
2119 for (i = 0; i < fp->nr_rates; i++) {
2120 if (i > 0)
2121 snd_iprintf(buffer, ", ");
2122 snd_iprintf(buffer, "%d", fp->rate_table[i]);
2123 }
2124 snd_iprintf(buffer, "\n");
2125 }
2126 // snd_iprintf(buffer, " Max Packet Size = %d\n", fp->maxpacksize);
2127 // snd_iprintf(buffer, " EP Attribute = 0x%x\n", fp->attributes);
2128 }
2129}
2130
Takashi Iwai86e07d32005-11-17 15:08:02 +01002131static void proc_dump_substream_status(struct snd_usb_substream *subs, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132{
2133 if (subs->running) {
2134 unsigned int i;
2135 snd_iprintf(buffer, " Status: Running\n");
2136 snd_iprintf(buffer, " Interface = %d\n", subs->interface);
2137 snd_iprintf(buffer, " Altset = %d\n", subs->format);
2138 snd_iprintf(buffer, " URBs = %d [ ", subs->nurbs);
2139 for (i = 0; i < subs->nurbs; i++)
2140 snd_iprintf(buffer, "%d ", subs->dataurb[i].packets);
2141 snd_iprintf(buffer, "]\n");
2142 snd_iprintf(buffer, " Packet Size = %d\n", subs->curpacksize);
Clemens Ladisch08fe1582005-04-22 15:33:01 +02002143 snd_iprintf(buffer, " Momentary freq = %u Hz (%#x.%04x)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 snd_usb_get_speed(subs->dev) == USB_SPEED_FULL
2145 ? get_full_speed_hz(subs->freqm)
Clemens Ladisch08fe1582005-04-22 15:33:01 +02002146 : get_high_speed_hz(subs->freqm),
2147 subs->freqm >> 16, subs->freqm & 0xffff);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 } else {
2149 snd_iprintf(buffer, " Status: Stop\n");
2150 }
2151}
2152
Takashi Iwai86e07d32005-11-17 15:08:02 +01002153static void proc_pcm_format_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002155 struct snd_usb_stream *stream = entry->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156
2157 snd_iprintf(buffer, "%s : %s\n", stream->chip->card->longname, stream->pcm->name);
2158
2159 if (stream->substream[SNDRV_PCM_STREAM_PLAYBACK].num_formats) {
2160 snd_iprintf(buffer, "\nPlayback:\n");
2161 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2162 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_PLAYBACK], buffer);
2163 }
2164 if (stream->substream[SNDRV_PCM_STREAM_CAPTURE].num_formats) {
2165 snd_iprintf(buffer, "\nCapture:\n");
2166 proc_dump_substream_status(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2167 proc_dump_substream_formats(&stream->substream[SNDRV_PCM_STREAM_CAPTURE], buffer);
2168 }
2169}
2170
Takashi Iwai86e07d32005-11-17 15:08:02 +01002171static void proc_pcm_format_add(struct snd_usb_stream *stream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002173 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 char name[32];
Takashi Iwai86e07d32005-11-17 15:08:02 +01002175 struct snd_card *card = stream->chip->card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176
2177 sprintf(name, "stream%d", stream->pcm_index);
2178 if (! snd_card_proc_new(card, name, &entry))
Takashi Iwaibf850202006-04-28 15:13:41 +02002179 snd_info_set_text_ops(entry, stream, proc_pcm_format_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180}
2181
Jaroslav Kysela21a34792006-01-13 09:12:11 +01002182#else
2183
2184static inline void proc_pcm_format_add(struct snd_usb_stream *stream)
2185{
2186}
2187
2188#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
2190/*
2191 * initialize the substream instance.
2192 */
2193
Takashi Iwai86e07d32005-11-17 15:08:02 +01002194static void init_substream(struct snd_usb_stream *as, int stream, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002196 struct snd_usb_substream *subs = &as->substream[stream];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197
2198 INIT_LIST_HEAD(&subs->fmt_list);
2199 spin_lock_init(&subs->lock);
2200
2201 subs->stream = as;
2202 subs->direction = stream;
2203 subs->dev = as->chip->dev;
2204 if (snd_usb_get_speed(subs->dev) == USB_SPEED_FULL)
2205 subs->ops = audio_urb_ops[stream];
2206 else
2207 subs->ops = audio_urb_ops_high_speed[stream];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 snd_pcm_set_ops(as->pcm, stream,
2209 stream == SNDRV_PCM_STREAM_PLAYBACK ?
2210 &snd_usb_playback_ops : &snd_usb_capture_ops);
2211
2212 list_add_tail(&fp->list, &subs->fmt_list);
2213 subs->formats |= 1ULL << fp->format;
2214 subs->endpoint = fp->endpoint;
2215 subs->num_formats++;
2216 subs->fmt_type = fp->fmt_type;
2217}
2218
2219
2220/*
2221 * free a substream
2222 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002223static void free_substream(struct snd_usb_substream *subs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224{
2225 struct list_head *p, *n;
2226
2227 if (! subs->num_formats)
2228 return; /* not initialized */
2229 list_for_each_safe(p, n, &subs->fmt_list) {
2230 struct audioformat *fp = list_entry(p, struct audioformat, list);
2231 kfree(fp->rate_table);
2232 kfree(fp);
2233 }
2234}
2235
2236
2237/*
2238 * free a usb stream instance
2239 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002240static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241{
2242 free_substream(&stream->substream[0]);
2243 free_substream(&stream->substream[1]);
2244 list_del(&stream->list);
2245 kfree(stream);
2246}
2247
Takashi Iwai86e07d32005-11-17 15:08:02 +01002248static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002250 struct snd_usb_stream *stream = pcm->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 if (stream) {
2252 stream->pcm = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 snd_usb_audio_stream_free(stream);
2254 }
2255}
2256
2257
2258/*
2259 * add this endpoint to the chip instance.
2260 * if a stream with the same endpoint already exists, append to it.
2261 * if not, create a new pcm stream.
2262 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002263static int add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
2265 struct list_head *p;
Takashi Iwai86e07d32005-11-17 15:08:02 +01002266 struct snd_usb_stream *as;
2267 struct snd_usb_substream *subs;
2268 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 int err;
2270
2271 list_for_each(p, &chip->pcm_list) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002272 as = list_entry(p, struct snd_usb_stream, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 if (as->fmt_type != fp->fmt_type)
2274 continue;
2275 subs = &as->substream[stream];
2276 if (! subs->endpoint)
2277 continue;
2278 if (subs->endpoint == fp->endpoint) {
2279 list_add_tail(&fp->list, &subs->fmt_list);
2280 subs->num_formats++;
2281 subs->formats |= 1ULL << fp->format;
2282 return 0;
2283 }
2284 }
2285 /* look for an empty stream */
2286 list_for_each(p, &chip->pcm_list) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002287 as = list_entry(p, struct snd_usb_stream, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 if (as->fmt_type != fp->fmt_type)
2289 continue;
2290 subs = &as->substream[stream];
2291 if (subs->endpoint)
2292 continue;
2293 err = snd_pcm_new_stream(as->pcm, stream, 1);
2294 if (err < 0)
2295 return err;
2296 init_substream(as, stream, fp);
2297 return 0;
2298 }
2299
2300 /* create a new pcm */
Panagiotis Issaris59feddb2006-07-25 15:28:03 +02002301 as = kzalloc(sizeof(*as), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 if (! as)
2303 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 as->pcm_index = chip->pcm_devs;
2305 as->chip = chip;
2306 as->fmt_type = fp->fmt_type;
2307 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
2308 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
2309 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
2310 &pcm);
2311 if (err < 0) {
2312 kfree(as);
2313 return err;
2314 }
2315 as->pcm = pcm;
2316 pcm->private_data = as;
2317 pcm->private_free = snd_usb_audio_pcm_free;
2318 pcm->info_flags = 0;
2319 if (chip->pcm_devs > 0)
2320 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
2321 else
2322 strcpy(pcm->name, "USB Audio");
2323
2324 init_substream(as, stream, fp);
2325
2326 list_add(&as->list, &chip->pcm_list);
2327 chip->pcm_devs++;
2328
2329 proc_pcm_format_add(as);
2330
2331 return 0;
2332}
2333
2334
2335/*
2336 * check if the device uses big-endian samples
2337 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002338static int is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339{
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002340 switch (chip->usb_id) {
2341 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
2342 if (fp->endpoint & USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 return 1;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002344 break;
2345 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2346 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 }
2348 return 0;
2349}
2350
2351/*
2352 * parse the audio format type I descriptor
2353 * and returns the corresponding pcm format
2354 *
2355 * @dev: usb device
2356 * @fp: audioformat record
2357 * @format: the format tag (wFormatTag)
2358 * @fmt: the format type descriptor
2359 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002360static int parse_audio_format_i_type(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 int format, unsigned char *fmt)
2362{
2363 int pcm_format;
2364 int sample_width, sample_bytes;
2365
2366 /* FIXME: correct endianess and sign? */
2367 pcm_format = -1;
2368 sample_width = fmt[6];
2369 sample_bytes = fmt[5];
2370 switch (format) {
2371 case 0: /* some devices don't define this correctly... */
2372 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002373 chip->dev->devnum, fp->iface, fp->altsetting);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 /* fall-through */
2375 case USB_AUDIO_FORMAT_PCM:
2376 if (sample_width > sample_bytes * 8) {
2377 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002378 chip->dev->devnum, fp->iface, fp->altsetting,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 sample_width, sample_bytes);
2380 }
2381 /* check the format byte size */
2382 switch (fmt[5]) {
2383 case 1:
2384 pcm_format = SNDRV_PCM_FORMAT_S8;
2385 break;
2386 case 2:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002387 if (is_big_endian_format(chip, fp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 pcm_format = SNDRV_PCM_FORMAT_S16_BE; /* grrr, big endian!! */
2389 else
2390 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2391 break;
2392 case 3:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002393 if (is_big_endian_format(chip, fp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 pcm_format = SNDRV_PCM_FORMAT_S24_3BE; /* grrr, big endian!! */
2395 else
2396 pcm_format = SNDRV_PCM_FORMAT_S24_3LE;
2397 break;
2398 case 4:
2399 pcm_format = SNDRV_PCM_FORMAT_S32_LE;
2400 break;
2401 default:
2402 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002403 chip->dev->devnum, fp->iface,
2404 fp->altsetting, sample_width, sample_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 break;
2406 }
2407 break;
2408 case USB_AUDIO_FORMAT_PCM8:
2409 /* Dallas DS4201 workaround */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002410 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 pcm_format = SNDRV_PCM_FORMAT_S8;
2412 else
2413 pcm_format = SNDRV_PCM_FORMAT_U8;
2414 break;
2415 case USB_AUDIO_FORMAT_IEEE_FLOAT:
2416 pcm_format = SNDRV_PCM_FORMAT_FLOAT_LE;
2417 break;
2418 case USB_AUDIO_FORMAT_ALAW:
2419 pcm_format = SNDRV_PCM_FORMAT_A_LAW;
2420 break;
2421 case USB_AUDIO_FORMAT_MU_LAW:
2422 pcm_format = SNDRV_PCM_FORMAT_MU_LAW;
2423 break;
2424 default:
2425 snd_printk(KERN_INFO "%d:%u:%d : unsupported format type %d\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002426 chip->dev->devnum, fp->iface, fp->altsetting, format);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 break;
2428 }
2429 return pcm_format;
2430}
2431
2432
2433/*
2434 * parse the format descriptor and stores the possible sample rates
2435 * on the audioformat table.
2436 *
2437 * @dev: usb device
2438 * @fp: audioformat record
2439 * @fmt: the format descriptor
2440 * @offset: the start offset of descriptor pointing the rate type
2441 * (7 for type I and II, 8 for type II)
2442 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002443static int parse_audio_format_rates(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 unsigned char *fmt, int offset)
2445{
2446 int nr_rates = fmt[offset];
Luke Rossa79eee82006-08-29 10:46:32 +02002447 int found;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2449 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002450 chip->dev->devnum, fp->iface, fp->altsetting);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 return -1;
2452 }
2453
2454 if (nr_rates) {
2455 /*
2456 * build the rate table and bitmap flags
2457 */
2458 int r, idx, c;
2459 /* this table corresponds to the SNDRV_PCM_RATE_XXX bit */
2460 static unsigned int conv_rates[] = {
2461 5512, 8000, 11025, 16000, 22050, 32000, 44100, 48000,
2462 64000, 88200, 96000, 176400, 192000
2463 };
2464 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
2465 if (fp->rate_table == NULL) {
2466 snd_printk(KERN_ERR "cannot malloc\n");
2467 return -1;
2468 }
2469
Luke Rossa79eee82006-08-29 10:46:32 +02002470 fp->needs_knot = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 fp->nr_rates = nr_rates;
2472 fp->rate_min = fp->rate_max = combine_triple(&fmt[8]);
2473 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
2474 unsigned int rate = fp->rate_table[r] = combine_triple(&fmt[idx]);
2475 if (rate < fp->rate_min)
2476 fp->rate_min = rate;
2477 else if (rate > fp->rate_max)
2478 fp->rate_max = rate;
Luke Rossa79eee82006-08-29 10:46:32 +02002479 found = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 for (c = 0; c < (int)ARRAY_SIZE(conv_rates); c++) {
2481 if (rate == conv_rates[c]) {
Luke Rossa79eee82006-08-29 10:46:32 +02002482 found = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 fp->rates |= (1 << c);
2484 break;
2485 }
2486 }
Luke Rossa79eee82006-08-29 10:46:32 +02002487 if (!found)
2488 fp->needs_knot = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 }
Luke Rossa79eee82006-08-29 10:46:32 +02002490 if (fp->needs_knot)
2491 fp->rates |= SNDRV_PCM_RATE_KNOT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 } else {
2493 /* continuous rates */
2494 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
2495 fp->rate_min = combine_triple(&fmt[offset + 1]);
2496 fp->rate_max = combine_triple(&fmt[offset + 4]);
2497 }
2498 return 0;
2499}
2500
2501/*
2502 * parse the format type I and III descriptors
2503 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002504static int parse_audio_format_i(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 int format, unsigned char *fmt)
2506{
2507 int pcm_format;
2508
2509 if (fmt[3] == USB_FORMAT_TYPE_III) {
2510 /* FIXME: the format type is really IECxxx
2511 * but we give normal PCM format to get the existing
2512 * apps working...
2513 */
2514 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
2515 } else {
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002516 pcm_format = parse_audio_format_i_type(chip, fp, format, fmt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 if (pcm_format < 0)
2518 return -1;
2519 }
2520 fp->format = pcm_format;
2521 fp->channels = fmt[4];
2522 if (fp->channels < 1) {
2523 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002524 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 return -1;
2526 }
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002527 return parse_audio_format_rates(chip, fp, fmt, 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528}
2529
2530/*
2531 * prase the format type II descriptor
2532 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002533static int parse_audio_format_ii(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 int format, unsigned char *fmt)
2535{
2536 int brate, framesize;
2537 switch (format) {
2538 case USB_AUDIO_FORMAT_AC3:
2539 /* FIXME: there is no AC3 format defined yet */
2540 // fp->format = SNDRV_PCM_FORMAT_AC3;
2541 fp->format = SNDRV_PCM_FORMAT_U8; /* temporarily hack to receive byte streams */
2542 break;
2543 case USB_AUDIO_FORMAT_MPEG:
2544 fp->format = SNDRV_PCM_FORMAT_MPEG;
2545 break;
2546 default:
2547 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 +02002548 chip->dev->devnum, fp->iface, fp->altsetting, format);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 fp->format = SNDRV_PCM_FORMAT_MPEG;
2550 break;
2551 }
2552 fp->channels = 1;
2553 brate = combine_word(&fmt[4]); /* fmt[4,5] : wMaxBitRate (in kbps) */
2554 framesize = combine_word(&fmt[6]); /* fmt[6,7]: wSamplesPerFrame */
2555 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
2556 fp->frame_size = framesize;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002557 return parse_audio_format_rates(chip, fp, fmt, 8); /* fmt[8..] sample rates */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558}
2559
Takashi Iwai86e07d32005-11-17 15:08:02 +01002560static int parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561 int format, unsigned char *fmt, int stream)
2562{
2563 int err;
2564
2565 switch (fmt[3]) {
2566 case USB_FORMAT_TYPE_I:
2567 case USB_FORMAT_TYPE_III:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002568 err = parse_audio_format_i(chip, fp, format, fmt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 break;
2570 case USB_FORMAT_TYPE_II:
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002571 err = parse_audio_format_ii(chip, fp, format, fmt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 break;
2573 default:
2574 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002575 chip->dev->devnum, fp->iface, fp->altsetting, fmt[3]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 return -1;
2577 }
2578 fp->fmt_type = fmt[3];
2579 if (err < 0)
2580 return err;
2581#if 1
Clemens Ladisch33159372006-01-13 08:11:22 +01002582 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 /* extigy apparently supports sample rates other than 48k
2584 * but not in ordinary way. so we enable only 48k atm.
2585 */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002586 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
Clemens Ladisch33159372006-01-13 08:11:22 +01002587 chip->usb_id == USB_ID(0x041e, 0x3020) ||
2588 chip->usb_id == USB_ID(0x041e, 0x3061)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589 if (fmt[3] == USB_FORMAT_TYPE_I &&
Clemens Ladisch8c1872d2005-04-28 09:31:53 +02002590 fp->rates != SNDRV_PCM_RATE_48000 &&
2591 fp->rates != SNDRV_PCM_RATE_96000)
Clemens Ladischb4d3f9d2005-06-27 08:18:27 +02002592 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 }
2594#endif
2595 return 0;
2596}
2597
Thibault LE MEURe3113342006-03-14 11:44:53 +01002598static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
2599 int iface, int altno);
Takashi Iwai86e07d32005-11-17 15:08:02 +01002600static int parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601{
2602 struct usb_device *dev;
2603 struct usb_interface *iface;
2604 struct usb_host_interface *alts;
2605 struct usb_interface_descriptor *altsd;
2606 int i, altno, err, stream;
2607 int format;
2608 struct audioformat *fp;
2609 unsigned char *fmt, *csep;
2610
2611 dev = chip->dev;
2612
2613 /* parse the interface's altsettings */
2614 iface = usb_ifnum_to_if(dev, iface_no);
2615 for (i = 0; i < iface->num_altsetting; i++) {
2616 alts = &iface->altsetting[i];
2617 altsd = get_iface_desc(alts);
2618 /* skip invalid one */
2619 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2620 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2621 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING &&
2622 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
2623 altsd->bNumEndpoints < 1 ||
2624 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
2625 continue;
2626 /* must be isochronous */
2627 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
2628 USB_ENDPOINT_XFER_ISOC)
2629 continue;
2630 /* check direction */
2631 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
2632 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2633 altno = altsd->bAlternateSetting;
Thibault LE MEURe3113342006-03-14 11:44:53 +01002634
2635 /* audiophile usb: skip altsets incompatible with device_setup
2636 */
2637 if (chip->usb_id == USB_ID(0x0763, 0x2003) &&
2638 audiophile_skip_setting_quirk(chip, iface_no, altno))
2639 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640
2641 /* get audio formats */
2642 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, AS_GENERAL);
2643 if (!fmt) {
2644 snd_printk(KERN_ERR "%d:%u:%d : AS_GENERAL descriptor not found\n",
2645 dev->devnum, iface_no, altno);
2646 continue;
2647 }
2648
2649 if (fmt[0] < 7) {
2650 snd_printk(KERN_ERR "%d:%u:%d : invalid AS_GENERAL desc\n",
2651 dev->devnum, iface_no, altno);
2652 continue;
2653 }
2654
2655 format = (fmt[6] << 8) | fmt[5]; /* remember the format value */
2656
2657 /* get format type */
2658 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, FORMAT_TYPE);
2659 if (!fmt) {
2660 snd_printk(KERN_ERR "%d:%u:%d : no FORMAT_TYPE desc\n",
2661 dev->devnum, iface_no, altno);
2662 continue;
2663 }
2664 if (fmt[0] < 8) {
2665 snd_printk(KERN_ERR "%d:%u:%d : invalid FORMAT_TYPE desc\n",
2666 dev->devnum, iface_no, altno);
2667 continue;
2668 }
2669
2670 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
2671 /* Creamware Noah has this descriptor after the 2nd endpoint */
2672 if (!csep && altsd->bNumEndpoints >= 2)
2673 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
2674 if (!csep || csep[0] < 7 || csep[2] != EP_GENERAL) {
Takashi Iwaif8c75792006-05-18 14:47:03 +02002675 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
Clemens Ladischfaf8d112006-05-18 09:35:15 +02002676 " class specific endpoint descriptor\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677 dev->devnum, iface_no, altno);
Clemens Ladischfaf8d112006-05-18 09:35:15 +02002678 csep = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 }
2680
Panagiotis Issaris59feddb2006-07-25 15:28:03 +02002681 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 if (! fp) {
2683 snd_printk(KERN_ERR "cannot malloc\n");
2684 return -ENOMEM;
2685 }
2686
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 fp->iface = iface_no;
2688 fp->altsetting = altno;
2689 fp->altset_idx = i;
2690 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2691 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
Clemens Ladisch573567e2005-06-27 08:17:30 +02002693 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
2694 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
2695 * (fp->maxpacksize & 0x7ff);
Clemens Ladischfaf8d112006-05-18 09:35:15 +02002696 fp->attributes = csep ? csep[3] : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697
2698 /* some quirks for attributes here */
2699
Clemens Ladischc3f93292005-05-04 14:56:04 +02002700 switch (chip->usb_id) {
2701 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 /* Optoplay sets the sample rate attribute although
2703 * it seems not supporting it in fact.
2704 */
2705 fp->attributes &= ~EP_CS_ATTR_SAMPLE_RATE;
Clemens Ladischc3f93292005-05-04 14:56:04 +02002706 break;
2707 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2708 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 /* doesn't set the sample rate attribute, but supports it */
2710 fp->attributes |= EP_CS_ATTR_SAMPLE_RATE;
Clemens Ladischc3f93292005-05-04 14:56:04 +02002711 break;
2712 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2713 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2714 an older model 77d:223) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715 /*
2716 * plantronics headset and Griffin iMic have set adaptive-in
2717 * although it's really not...
2718 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002719 fp->ep_attr &= ~EP_ATTR_MASK;
2720 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2721 fp->ep_attr |= EP_ATTR_ADAPTIVE;
2722 else
2723 fp->ep_attr |= EP_ATTR_SYNC;
Clemens Ladischc3f93292005-05-04 14:56:04 +02002724 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 }
2726
2727 /* ok, let's parse further... */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002728 if (parse_audio_format(chip, fp, format, fmt, stream) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729 kfree(fp->rate_table);
2730 kfree(fp);
2731 continue;
2732 }
2733
Thibault LE MEURe3113342006-03-14 11:44:53 +01002734 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 -07002735 err = add_audio_endpoint(chip, stream, fp);
2736 if (err < 0) {
2737 kfree(fp->rate_table);
2738 kfree(fp);
2739 return err;
2740 }
2741 /* try to set the interface... */
2742 usb_set_interface(chip->dev, iface_no, altno);
2743 init_usb_pitch(chip->dev, iface_no, alts, fp);
2744 init_usb_sample_rate(chip->dev, iface_no, alts, fp, fp->rate_max);
2745 }
2746 return 0;
2747}
2748
2749
2750/*
2751 * disconnect streams
2752 * called from snd_usb_audio_disconnect()
2753 */
Clemens Ladischee733392005-04-25 10:34:13 +02002754static void snd_usb_stream_disconnect(struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755{
2756 int idx;
Takashi Iwai86e07d32005-11-17 15:08:02 +01002757 struct snd_usb_stream *as;
2758 struct snd_usb_substream *subs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759
Takashi Iwai86e07d32005-11-17 15:08:02 +01002760 as = list_entry(head, struct snd_usb_stream, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 for (idx = 0; idx < 2; idx++) {
2762 subs = &as->substream[idx];
2763 if (!subs->num_formats)
2764 return;
2765 release_substream_urbs(subs, 1);
2766 subs->interface = -1;
2767 }
2768}
2769
2770/*
2771 * parse audio control descriptor and create pcm/midi streams
2772 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002773static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774{
2775 struct usb_device *dev = chip->dev;
2776 struct usb_host_interface *host_iface;
2777 struct usb_interface *iface;
2778 unsigned char *p1;
2779 int i, j;
2780
2781 /* find audiocontrol interface */
2782 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
2783 if (!(p1 = snd_usb_find_csint_desc(host_iface->extra, host_iface->extralen, NULL, HEADER))) {
2784 snd_printk(KERN_ERR "cannot find HEADER\n");
2785 return -EINVAL;
2786 }
2787 if (! p1[7] || p1[0] < 8 + p1[7]) {
2788 snd_printk(KERN_ERR "invalid HEADER\n");
2789 return -EINVAL;
2790 }
2791
2792 /*
2793 * parse all USB audio streaming interfaces
2794 */
2795 for (i = 0; i < p1[7]; i++) {
2796 struct usb_host_interface *alts;
2797 struct usb_interface_descriptor *altsd;
2798 j = p1[8 + i];
2799 iface = usb_ifnum_to_if(dev, j);
2800 if (!iface) {
2801 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
2802 dev->devnum, ctrlif, j);
2803 continue;
2804 }
2805 if (usb_interface_claimed(iface)) {
2806 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n", dev->devnum, ctrlif, j);
2807 continue;
2808 }
2809 alts = &iface->altsetting[0];
2810 altsd = get_iface_desc(alts);
2811 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
2812 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
2813 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDI_STREAMING) {
2814 if (snd_usb_create_midi_interface(chip, iface, NULL) < 0) {
2815 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n", dev->devnum, ctrlif, j);
2816 continue;
2817 }
2818 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2819 continue;
2820 }
2821 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
2822 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
2823 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIO_STREAMING) {
2824 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n", dev->devnum, ctrlif, j, altsd->bInterfaceClass);
2825 /* skip non-supported classes */
2826 continue;
2827 }
2828 if (! parse_audio_endpoints(chip, j)) {
2829 usb_set_interface(dev, j, 0); /* reset the current interface */
2830 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
2831 }
2832 }
2833
2834 return 0;
2835}
2836
2837/*
2838 * create a stream for an endpoint/altsetting without proper descriptors
2839 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002840static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002842 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843{
2844 struct audioformat *fp;
2845 struct usb_host_interface *alts;
2846 int stream, err;
2847 int *rate_table = NULL;
2848
2849 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2850 if (! fp) {
2851 snd_printk(KERN_ERR "cannot malloc\n");
2852 return -ENOMEM;
2853 }
2854 memcpy(fp, quirk->data, sizeof(*fp));
2855 if (fp->nr_rates > 0) {
2856 rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
2857 if (!rate_table) {
2858 kfree(fp);
2859 return -ENOMEM;
2860 }
2861 memcpy(rate_table, fp->rate_table, sizeof(int) * fp->nr_rates);
2862 fp->rate_table = rate_table;
2863 }
2864
2865 stream = (fp->endpoint & USB_DIR_IN)
2866 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2867 err = add_audio_endpoint(chip, stream, fp);
2868 if (err < 0) {
2869 kfree(fp);
2870 kfree(rate_table);
2871 return err;
2872 }
2873 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
2874 fp->altset_idx >= iface->num_altsetting) {
2875 kfree(fp);
2876 kfree(rate_table);
2877 return -EINVAL;
2878 }
2879 alts = &iface->altsetting[fp->altset_idx];
2880 usb_set_interface(chip->dev, fp->iface, 0);
2881 init_usb_pitch(chip->dev, fp->iface, alts, fp);
2882 init_usb_sample_rate(chip->dev, fp->iface, alts, fp, fp->rate_max);
2883 return 0;
2884}
2885
2886/*
2887 * create a stream for an interface with proper descriptors
2888 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002889static int create_standard_audio_quirk(struct snd_usb_audio *chip,
Clemens Ladischd1bda042005-09-14 08:36:03 +02002890 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002891 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892{
2893 struct usb_host_interface *alts;
2894 struct usb_interface_descriptor *altsd;
2895 int err;
2896
2897 alts = &iface->altsetting[0];
2898 altsd = get_iface_desc(alts);
Clemens Ladischd1bda042005-09-14 08:36:03 +02002899 err = parse_audio_endpoints(chip, altsd->bInterfaceNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 if (err < 0) {
2901 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
2902 altsd->bInterfaceNumber, err);
2903 return err;
2904 }
Clemens Ladischd1bda042005-09-14 08:36:03 +02002905 /* reset the current interface */
2906 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907 return 0;
2908}
2909
2910/*
2911 * Create a stream for an Edirol UA-700/UA-25 interface. The only way
2912 * to detect the sample rate is by looking at wMaxPacketSize.
2913 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002914static int create_ua700_ua25_quirk(struct snd_usb_audio *chip,
Clemens Ladisch854af952005-07-25 16:19:10 +02002915 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01002916 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917{
2918 static const struct audioformat ua_format = {
2919 .format = SNDRV_PCM_FORMAT_S24_3LE,
2920 .channels = 2,
2921 .fmt_type = USB_FORMAT_TYPE_I,
2922 .altsetting = 1,
2923 .altset_idx = 1,
2924 .rates = SNDRV_PCM_RATE_CONTINUOUS,
2925 };
2926 struct usb_host_interface *alts;
2927 struct usb_interface_descriptor *altsd;
2928 struct audioformat *fp;
2929 int stream, err;
2930
2931 /* both PCM and MIDI interfaces have 2 altsettings */
2932 if (iface->num_altsetting != 2)
2933 return -ENXIO;
2934 alts = &iface->altsetting[1];
2935 altsd = get_iface_desc(alts);
2936
2937 if (altsd->bNumEndpoints == 2) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002938 static const struct snd_usb_midi_endpoint_info ua700_ep = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939 .out_cables = 0x0003,
2940 .in_cables = 0x0003
2941 };
Takashi Iwai86e07d32005-11-17 15:08:02 +01002942 static const struct snd_usb_audio_quirk ua700_quirk = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2944 .data = &ua700_ep
2945 };
Takashi Iwai86e07d32005-11-17 15:08:02 +01002946 static const struct snd_usb_midi_endpoint_info ua25_ep = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002947 .out_cables = 0x0001,
2948 .in_cables = 0x0001
2949 };
Takashi Iwai86e07d32005-11-17 15:08:02 +01002950 static const struct snd_usb_audio_quirk ua25_quirk = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951 .type = QUIRK_MIDI_FIXED_ENDPOINT,
2952 .data = &ua25_ep
2953 };
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002954 if (chip->usb_id == USB_ID(0x0582, 0x002b))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955 return snd_usb_create_midi_interface(chip, iface,
2956 &ua700_quirk);
2957 else
2958 return snd_usb_create_midi_interface(chip, iface,
2959 &ua25_quirk);
2960 }
2961
2962 if (altsd->bNumEndpoints != 1)
2963 return -ENXIO;
2964
2965 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
2966 if (!fp)
2967 return -ENOMEM;
2968 memcpy(fp, &ua_format, sizeof(*fp));
2969
2970 fp->iface = altsd->bInterfaceNumber;
2971 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
2972 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
2973 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
2974
2975 switch (fp->maxpacksize) {
2976 case 0x120:
2977 fp->rate_max = fp->rate_min = 44100;
2978 break;
2979 case 0x138:
2980 case 0x140:
2981 fp->rate_max = fp->rate_min = 48000;
2982 break;
2983 case 0x258:
2984 case 0x260:
2985 fp->rate_max = fp->rate_min = 96000;
2986 break;
2987 default:
2988 snd_printk(KERN_ERR "unknown sample rate\n");
2989 kfree(fp);
2990 return -ENXIO;
2991 }
2992
2993 stream = (fp->endpoint & USB_DIR_IN)
2994 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
2995 err = add_audio_endpoint(chip, stream, fp);
2996 if (err < 0) {
2997 kfree(fp);
2998 return err;
2999 }
3000 usb_set_interface(chip->dev, fp->iface, 0);
3001 return 0;
3002}
3003
3004/*
3005 * Create a stream for an Edirol UA-1000 interface.
3006 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003007static int create_ua1000_quirk(struct snd_usb_audio *chip,
Clemens Ladisch854af952005-07-25 16:19:10 +02003008 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003009 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010{
3011 static const struct audioformat ua1000_format = {
3012 .format = SNDRV_PCM_FORMAT_S32_LE,
3013 .fmt_type = USB_FORMAT_TYPE_I,
3014 .altsetting = 1,
3015 .altset_idx = 1,
3016 .attributes = 0,
3017 .rates = SNDRV_PCM_RATE_CONTINUOUS,
3018 };
3019 struct usb_host_interface *alts;
3020 struct usb_interface_descriptor *altsd;
3021 struct audioformat *fp;
3022 int stream, err;
3023
3024 if (iface->num_altsetting != 2)
3025 return -ENXIO;
3026 alts = &iface->altsetting[1];
3027 altsd = get_iface_desc(alts);
Ben Williamsonc4a87ef2006-06-19 17:20:09 +02003028 if (alts->extralen != 11 || alts->extra[1] != USB_DT_CS_INTERFACE ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029 altsd->bNumEndpoints != 1)
3030 return -ENXIO;
3031
3032 fp = kmalloc(sizeof(*fp), GFP_KERNEL);
3033 if (!fp)
3034 return -ENOMEM;
3035 memcpy(fp, &ua1000_format, sizeof(*fp));
3036
3037 fp->channels = alts->extra[4];
3038 fp->iface = altsd->bInterfaceNumber;
3039 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
3040 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
3041 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3042 fp->rate_max = fp->rate_min = combine_triple(&alts->extra[8]);
3043
3044 stream = (fp->endpoint & USB_DIR_IN)
3045 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
3046 err = add_audio_endpoint(chip, stream, fp);
3047 if (err < 0) {
3048 kfree(fp);
3049 return err;
3050 }
3051 /* FIXME: playback must be synchronized to capture */
3052 usb_set_interface(chip->dev, fp->iface, 0);
3053 return 0;
3054}
3055
Takashi Iwai86e07d32005-11-17 15:08:02 +01003056static int snd_usb_create_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003058 const struct snd_usb_audio_quirk *quirk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059
3060/*
3061 * handle the quirks for the contained interfaces
3062 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003063static int create_composite_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003065 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066{
3067 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
3068 int err;
3069
3070 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
3071 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
3072 if (!iface)
3073 continue;
3074 if (quirk->ifnum != probed_ifnum &&
3075 usb_interface_claimed(iface))
3076 continue;
3077 err = snd_usb_create_quirk(chip, iface, quirk);
3078 if (err < 0)
3079 return err;
3080 if (quirk->ifnum != probed_ifnum)
3081 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
3082 }
3083 return 0;
3084}
3085
Takashi Iwai86e07d32005-11-17 15:08:02 +01003086static int ignore_interface_quirk(struct snd_usb_audio *chip,
Clemens Ladisch854af952005-07-25 16:19:10 +02003087 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003088 const struct snd_usb_audio_quirk *quirk)
Clemens Ladisch854af952005-07-25 16:19:10 +02003089{
3090 return 0;
3091}
3092
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093
3094/*
3095 * boot quirks
3096 */
3097
3098#define EXTIGY_FIRMWARE_SIZE_OLD 794
3099#define EXTIGY_FIRMWARE_SIZE_NEW 483
3100
3101static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
3102{
3103 struct usb_host_config *config = dev->actconfig;
3104 int err;
3105
3106 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
3107 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
3108 snd_printdd("sending Extigy boot sequence...\n");
3109 /* Send message to force it to reconnect with full interface. */
3110 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
3111 0x10, 0x43, 0x0001, 0x000a, NULL, 0, 1000);
3112 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
3113 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
3114 &dev->descriptor, sizeof(dev->descriptor));
3115 config = dev->actconfig;
3116 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
3117 err = usb_reset_configuration(dev);
3118 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
3119 snd_printdd("extigy_boot: new boot length = %d\n",
3120 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
3121 return -ENODEV; /* quit this anyway */
3122 }
3123 return 0;
3124}
3125
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003126static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
3127{
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003128 u8 buf = 1;
3129
3130 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
3131 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3132 0, 0, &buf, 1, 1000);
3133 if (buf == 0) {
3134 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
3135 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
3136 1, 2000, NULL, 0, 1000);
3137 return -ENODEV;
3138 }
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003139 return 0;
3140}
3141
Thibault LE MEURe3113342006-03-14 11:44:53 +01003142/*
Sam Revitche217e302006-06-23 15:10:18 +02003143 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
3144 * documented in the device's data sheet.
3145 */
3146static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
3147{
3148 u8 buf[4];
3149 buf[0] = 0x20;
3150 buf[1] = value & 0xff;
3151 buf[2] = (value >> 8) & 0xff;
3152 buf[3] = reg;
3153 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
3154 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
3155 0, 0, &buf, 4, 1000);
3156}
3157
3158static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
3159{
3160 /*
3161 * Enable line-out driver mode, set headphone source to front
3162 * channels, enable stereo mic.
3163 */
3164 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
3165}
3166
3167
3168/*
Thibault LE MEURe3113342006-03-14 11:44:53 +01003169 * Setup quirks
3170 */
3171#define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
3172#define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
3173#define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
3174#define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
3175#define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
3176#define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
3177#define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
3178#define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
3179#define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
3180#define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
3181
3182static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
3183 int iface, int altno)
3184{
3185 if (device_setup[chip->index] & AUDIOPHILE_SET) {
3186 if ((device_setup[chip->index] & AUDIOPHILE_SET_DTS)
3187 && altno != 6)
3188 return 1; /* skip this altsetting */
3189 if ((device_setup[chip->index] & AUDIOPHILE_SET_96K)
3190 && altno != 1)
3191 return 1; /* skip this altsetting */
3192 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3193 AUDIOPHILE_SET_24B_48K_DI && altno != 2)
3194 return 1; /* skip this altsetting */
3195 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3196 AUDIOPHILE_SET_24B_48K_NOTDI && altno != 3)
3197 return 1; /* skip this altsetting */
3198 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3199 AUDIOPHILE_SET_16B_48K_DI && altno != 4)
3200 return 1; /* skip this altsetting */
3201 if ((device_setup[chip->index] & AUDIOPHILE_SET_MASK) ==
3202 AUDIOPHILE_SET_16B_48K_NOTDI && altno != 5)
3203 return 1; /* skip this altsetting */
3204 }
3205 return 0; /* keep this altsetting */
3206}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207
3208/*
3209 * audio-interface quirks
3210 *
3211 * returns zero if no standard audio/MIDI parsing is needed.
3212 * returns a postive value if standard audio/midi interfaces are parsed
3213 * after this.
3214 * returns a negative value at error.
3215 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003216static int snd_usb_create_quirk(struct snd_usb_audio *chip,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217 struct usb_interface *iface,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003218 const struct snd_usb_audio_quirk *quirk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003220 typedef int (*quirk_func_t)(struct snd_usb_audio *, struct usb_interface *,
3221 const struct snd_usb_audio_quirk *);
Clemens Ladisch854af952005-07-25 16:19:10 +02003222 static const quirk_func_t quirk_funcs[] = {
3223 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
3224 [QUIRK_COMPOSITE] = create_composite_quirk,
3225 [QUIRK_MIDI_STANDARD_INTERFACE] = snd_usb_create_midi_interface,
3226 [QUIRK_MIDI_FIXED_ENDPOINT] = snd_usb_create_midi_interface,
3227 [QUIRK_MIDI_YAMAHA] = snd_usb_create_midi_interface,
3228 [QUIRK_MIDI_MIDIMAN] = snd_usb_create_midi_interface,
3229 [QUIRK_MIDI_NOVATION] = snd_usb_create_midi_interface,
3230 [QUIRK_MIDI_RAW] = snd_usb_create_midi_interface,
3231 [QUIRK_MIDI_EMAGIC] = snd_usb_create_midi_interface,
Clemens Ladischcc7a59b2006-02-07 17:11:06 +01003232 [QUIRK_MIDI_CME] = snd_usb_create_midi_interface,
Clemens Ladischd1bda042005-09-14 08:36:03 +02003233 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
Clemens Ladisch854af952005-07-25 16:19:10 +02003234 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
3235 [QUIRK_AUDIO_EDIROL_UA700_UA25] = create_ua700_ua25_quirk,
3236 [QUIRK_AUDIO_EDIROL_UA1000] = create_ua1000_quirk,
3237 };
3238
3239 if (quirk->type < QUIRK_TYPE_COUNT) {
3240 return quirk_funcs[quirk->type](chip, iface, quirk);
3241 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
3243 return -ENXIO;
3244 }
3245}
3246
3247
3248/*
3249 * common proc files to show the usb device info
3250 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01003251static void proc_audio_usbbus_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003253 struct snd_usb_audio *chip = entry->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254 if (! chip->shutdown)
3255 snd_iprintf(buffer, "%03d/%03d\n", chip->dev->bus->busnum, chip->dev->devnum);
3256}
3257
Takashi Iwai86e07d32005-11-17 15:08:02 +01003258static void proc_audio_usbid_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003260 struct snd_usb_audio *chip = entry->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 if (! chip->shutdown)
3262 snd_iprintf(buffer, "%04x:%04x\n",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003263 USB_ID_VENDOR(chip->usb_id),
3264 USB_ID_PRODUCT(chip->usb_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265}
3266
Takashi Iwai86e07d32005-11-17 15:08:02 +01003267static void snd_usb_audio_create_proc(struct snd_usb_audio *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003269 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270 if (! snd_card_proc_new(chip->card, "usbbus", &entry))
Takashi Iwaibf850202006-04-28 15:13:41 +02003271 snd_info_set_text_ops(entry, chip, proc_audio_usbbus_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003272 if (! snd_card_proc_new(chip->card, "usbid", &entry))
Takashi Iwaibf850202006-04-28 15:13:41 +02003273 snd_info_set_text_ops(entry, chip, proc_audio_usbid_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274}
3275
3276/*
3277 * free the chip instance
3278 *
3279 * here we have to do not much, since pcm and controls are already freed
3280 *
3281 */
3282
Takashi Iwai86e07d32005-11-17 15:08:02 +01003283static int snd_usb_audio_free(struct snd_usb_audio *chip)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284{
3285 kfree(chip);
3286 return 0;
3287}
3288
Takashi Iwai86e07d32005-11-17 15:08:02 +01003289static int snd_usb_audio_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003291 struct snd_usb_audio *chip = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292 return snd_usb_audio_free(chip);
3293}
3294
3295
3296/*
3297 * create a chip instance and set its names.
3298 */
3299static int snd_usb_audio_create(struct usb_device *dev, int idx,
Takashi Iwai86e07d32005-11-17 15:08:02 +01003300 const struct snd_usb_audio_quirk *quirk,
3301 struct snd_usb_audio **rchip)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003303 struct snd_card *card;
3304 struct snd_usb_audio *chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305 int err, len;
3306 char component[14];
Takashi Iwai86e07d32005-11-17 15:08:02 +01003307 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003308 .dev_free = snd_usb_audio_dev_free,
3309 };
3310
3311 *rchip = NULL;
3312
3313 if (snd_usb_get_speed(dev) != USB_SPEED_FULL &&
3314 snd_usb_get_speed(dev) != USB_SPEED_HIGH) {
3315 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
3316 return -ENXIO;
3317 }
3318
3319 card = snd_card_new(index[idx], id[idx], THIS_MODULE, 0);
3320 if (card == NULL) {
3321 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
3322 return -ENOMEM;
3323 }
3324
Takashi Iwai561b2202005-09-09 14:22:34 +02003325 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003326 if (! chip) {
3327 snd_card_free(card);
3328 return -ENOMEM;
3329 }
3330
3331 chip->index = idx;
3332 chip->dev = dev;
3333 chip->card = card;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003334 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3335 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336 INIT_LIST_HEAD(&chip->pcm_list);
3337 INIT_LIST_HEAD(&chip->midi_list);
Clemens Ladisch84957a82005-04-29 16:23:13 +02003338 INIT_LIST_HEAD(&chip->mixer_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339
3340 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
3341 snd_usb_audio_free(chip);
3342 snd_card_free(card);
3343 return err;
3344 }
3345
3346 strcpy(card->driver, "USB-Audio");
3347 sprintf(component, "USB%04x:%04x",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003348 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349 snd_component_add(card, component);
3350
3351 /* retrieve the device string as shortname */
3352 if (quirk && quirk->product_name) {
3353 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
3354 } else {
3355 if (!dev->descriptor.iProduct ||
3356 usb_string(dev, dev->descriptor.iProduct,
3357 card->shortname, sizeof(card->shortname)) <= 0) {
3358 /* no name available from anywhere, so use ID */
3359 sprintf(card->shortname, "USB Device %#04x:%#04x",
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003360 USB_ID_VENDOR(chip->usb_id),
3361 USB_ID_PRODUCT(chip->usb_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003362 }
3363 }
3364
3365 /* retrieve the vendor and device strings as longname */
3366 if (quirk && quirk->vendor_name) {
3367 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
3368 } else {
3369 if (dev->descriptor.iManufacturer)
3370 len = usb_string(dev, dev->descriptor.iManufacturer,
3371 card->longname, sizeof(card->longname));
3372 else
3373 len = 0;
3374 /* we don't really care if there isn't any vendor string */
3375 }
3376 if (len > 0)
3377 strlcat(card->longname, " ", sizeof(card->longname));
3378
3379 strlcat(card->longname, card->shortname, sizeof(card->longname));
3380
3381 len = strlcat(card->longname, " at ", sizeof(card->longname));
3382
3383 if (len < sizeof(card->longname))
3384 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
3385
3386 strlcat(card->longname,
3387 snd_usb_get_speed(dev) == USB_SPEED_FULL ? ", full speed" : ", high speed",
3388 sizeof(card->longname));
3389
3390 snd_usb_audio_create_proc(chip);
3391
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392 *rchip = chip;
3393 return 0;
3394}
3395
3396
3397/*
3398 * probe the active usb device
3399 *
3400 * note that this can be called multiple times per a device, when it
3401 * includes multiple audio control interfaces.
3402 *
3403 * thus we check the usb device pointer and creates the card instance
3404 * only at the first time. the successive calls of this function will
3405 * append the pcm interface to the corresponding card.
3406 */
3407static void *snd_usb_audio_probe(struct usb_device *dev,
3408 struct usb_interface *intf,
3409 const struct usb_device_id *usb_id)
3410{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003411 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003412 int i, err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01003413 struct snd_usb_audio *chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003414 struct usb_host_interface *alts;
3415 int ifnum;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003416 u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417
3418 alts = &intf->altsetting[0];
3419 ifnum = get_iface_desc(alts)->bInterfaceNumber;
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003420 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
3421 le16_to_cpu(dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003422
3423 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
3424 goto __err_val;
3425
3426 /* SB Extigy needs special boot-up sequence */
3427 /* if more models come, this will go to the quirk list. */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003428 if (id == USB_ID(0x041e, 0x3000)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429 if (snd_usb_extigy_boot_quirk(dev, intf) < 0)
3430 goto __err_val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431 }
Clemens Ladisch3a2f0852005-05-09 09:20:31 +02003432 /* SB Audigy 2 NX needs its own boot-up magic, too */
3433 if (id == USB_ID(0x041e, 0x3020)) {
3434 if (snd_usb_audigy2nx_boot_quirk(dev) < 0)
3435 goto __err_val;
3436 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003437
Sam Revitche217e302006-06-23 15:10:18 +02003438 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
3439 if (id == USB_ID(0x10f5, 0x0200)) {
3440 if (snd_usb_cm106_boot_quirk(dev) < 0)
3441 goto __err_val;
3442 }
3443
Linus Torvalds1da177e2005-04-16 15:20:36 -07003444 /*
3445 * found a config. now register to ALSA
3446 */
3447
3448 /* check whether it's already registered */
3449 chip = NULL;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003450 mutex_lock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451 for (i = 0; i < SNDRV_CARDS; i++) {
3452 if (usb_chip[i] && usb_chip[i]->dev == dev) {
3453 if (usb_chip[i]->shutdown) {
3454 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
3455 goto __error;
3456 }
3457 chip = usb_chip[i];
3458 break;
3459 }
3460 }
3461 if (! chip) {
3462 /* it's a fresh one.
3463 * now look for an empty slot and create a new card instance
3464 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003465 for (i = 0; i < SNDRV_CARDS; i++)
3466 if (enable[i] && ! usb_chip[i] &&
Clemens Ladisch27d10f52005-05-02 08:51:26 +02003467 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
3468 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003469 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
3470 goto __error;
3471 }
Clemens Ladisch1dcd3ec2005-05-10 14:51:40 +02003472 snd_card_set_dev(chip->card, &intf->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003473 break;
3474 }
3475 if (! chip) {
3476 snd_printk(KERN_ERR "no available usb audio device\n");
3477 goto __error;
3478 }
3479 }
3480
3481 err = 1; /* continue */
3482 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
3483 /* need some special handlings */
3484 if ((err = snd_usb_create_quirk(chip, intf, quirk)) < 0)
3485 goto __error;
3486 }
3487
3488 if (err > 0) {
3489 /* create normal USB audio interfaces */
3490 if (snd_usb_create_streams(chip, ifnum) < 0 ||
3491 snd_usb_create_mixer(chip, ifnum) < 0) {
3492 goto __error;
3493 }
3494 }
3495
3496 /* we are allowed to call snd_card_register() many times */
3497 if (snd_card_register(chip->card) < 0) {
3498 goto __error;
3499 }
3500
3501 usb_chip[chip->index] = chip;
3502 chip->num_interfaces++;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003503 mutex_unlock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003504 return chip;
3505
3506 __error:
3507 if (chip && !chip->num_interfaces)
3508 snd_card_free(chip->card);
Ingo Molnar12aa7572006-01-16 16:36:05 +01003509 mutex_unlock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510 __err_val:
3511 return NULL;
3512}
3513
3514/*
3515 * we need to take care of counter, since disconnection can be called also
3516 * many times as well as usb_audio_probe().
3517 */
3518static void snd_usb_audio_disconnect(struct usb_device *dev, void *ptr)
3519{
Takashi Iwai86e07d32005-11-17 15:08:02 +01003520 struct snd_usb_audio *chip;
3521 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003522 struct list_head *p;
3523
3524 if (ptr == (void *)-1L)
3525 return;
3526
3527 chip = ptr;
3528 card = chip->card;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003529 mutex_lock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530 chip->shutdown = 1;
3531 chip->num_interfaces--;
3532 if (chip->num_interfaces <= 0) {
3533 snd_card_disconnect(card);
3534 /* release the pcm resources */
3535 list_for_each(p, &chip->pcm_list) {
Clemens Ladischee733392005-04-25 10:34:13 +02003536 snd_usb_stream_disconnect(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537 }
3538 /* release the midi resources */
3539 list_for_each(p, &chip->midi_list) {
Clemens Ladischee733392005-04-25 10:34:13 +02003540 snd_usbmidi_disconnect(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003541 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02003542 /* release mixer resources */
3543 list_for_each(p, &chip->mixer_list) {
3544 snd_usb_mixer_disconnect(p);
3545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003546 usb_chip[chip->index] = NULL;
Ingo Molnar12aa7572006-01-16 16:36:05 +01003547 mutex_unlock(&register_mutex);
Takashi Iwaic4614822006-06-23 14:38:23 +02003548 snd_card_free_when_closed(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549 } else {
Ingo Molnar12aa7572006-01-16 16:36:05 +01003550 mutex_unlock(&register_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 }
3552}
3553
3554/*
3555 * new 2.5 USB kernel API
3556 */
3557static int usb_audio_probe(struct usb_interface *intf,
3558 const struct usb_device_id *id)
3559{
3560 void *chip;
3561 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
3562 if (chip) {
3563 dev_set_drvdata(&intf->dev, chip);
3564 return 0;
3565 } else
3566 return -EIO;
3567}
3568
3569static void usb_audio_disconnect(struct usb_interface *intf)
3570{
3571 snd_usb_audio_disconnect(interface_to_usbdev(intf),
3572 dev_get_drvdata(&intf->dev));
3573}
3574
3575
3576static int __init snd_usb_audio_init(void)
3577{
3578 if (nrpacks < MIN_PACKS_URB || nrpacks > MAX_PACKS) {
3579 printk(KERN_WARNING "invalid nrpacks value.\n");
3580 return -EINVAL;
3581 }
3582 usb_register(&usb_audio_driver);
3583 return 0;
3584}
3585
3586
3587static void __exit snd_usb_audio_cleanup(void)
3588{
3589 usb_deregister(&usb_audio_driver);
3590}
3591
3592module_init(snd_usb_audio_init);
3593module_exit(snd_usb_audio_cleanup);