Loading...
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 */
17
18#include <linux/init.h>
19#include <linux/slab.h>
20#include <linux/usb.h>
21#include <linux/usb/audio.h>
22#include <linux/usb/audio-v2.h>
23
24#include <sound/core.h>
25#include <sound/pcm.h>
26
27#include "usbaudio.h"
28#include "card.h"
29#include "proc.h"
30#include "quirks.h"
31#include "endpoint.h"
32#include "urb.h"
33#include "pcm.h"
34#include "helper.h"
35#include "format.h"
36#include "clock.h"
37
38/*
39 * free a substream
40 */
41static void free_substream(struct snd_usb_substream *subs)
42{
43 struct list_head *p, *n;
44
45 if (!subs->num_formats)
46 return; /* not initialized */
47 list_for_each_safe(p, n, &subs->fmt_list) {
48 struct audioformat *fp = list_entry(p, struct audioformat, list);
49 kfree(fp->rate_table);
50 kfree(fp);
51 }
52 kfree(subs->rate_list.list);
53}
54
55
56/*
57 * free a usb stream instance
58 */
59static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
60{
61 free_substream(&stream->substream[0]);
62 free_substream(&stream->substream[1]);
63 list_del(&stream->list);
64 kfree(stream);
65}
66
67static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
68{
69 struct snd_usb_stream *stream = pcm->private_data;
70 if (stream) {
71 stream->pcm = NULL;
72 snd_usb_audio_stream_free(stream);
73 }
74}
75
76
77/*
78 * add this endpoint to the chip instance.
79 * if a stream with the same endpoint already exists, append to it.
80 * if not, create a new pcm stream.
81 */
82int snd_usb_add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
83{
84 struct list_head *p;
85 struct snd_usb_stream *as;
86 struct snd_usb_substream *subs;
87 struct snd_pcm *pcm;
88 int err;
89
90 list_for_each(p, &chip->pcm_list) {
91 as = list_entry(p, struct snd_usb_stream, list);
92 if (as->fmt_type != fp->fmt_type)
93 continue;
94 subs = &as->substream[stream];
95 if (!subs->endpoint)
96 continue;
97 if (subs->endpoint == fp->endpoint) {
98 list_add_tail(&fp->list, &subs->fmt_list);
99 subs->num_formats++;
100 subs->formats |= fp->formats;
101 return 0;
102 }
103 }
104 /* look for an empty stream */
105 list_for_each(p, &chip->pcm_list) {
106 as = list_entry(p, struct snd_usb_stream, list);
107 if (as->fmt_type != fp->fmt_type)
108 continue;
109 subs = &as->substream[stream];
110 if (subs->endpoint)
111 continue;
112 err = snd_pcm_new_stream(as->pcm, stream, 1);
113 if (err < 0)
114 return err;
115 snd_usb_init_substream(as, stream, fp);
116 return 0;
117 }
118
119 /* create a new pcm */
120 as = kzalloc(sizeof(*as), GFP_KERNEL);
121 if (!as)
122 return -ENOMEM;
123 as->pcm_index = chip->pcm_devs;
124 as->chip = chip;
125 as->fmt_type = fp->fmt_type;
126 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
127 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
128 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
129 &pcm);
130 if (err < 0) {
131 kfree(as);
132 return err;
133 }
134 as->pcm = pcm;
135 pcm->private_data = as;
136 pcm->private_free = snd_usb_audio_pcm_free;
137 pcm->info_flags = 0;
138 if (chip->pcm_devs > 0)
139 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
140 else
141 strcpy(pcm->name, "USB Audio");
142
143 snd_usb_init_substream(as, stream, fp);
144
145 list_add(&as->list, &chip->pcm_list);
146 chip->pcm_devs++;
147
148 snd_usb_proc_pcm_format_add(as);
149
150 return 0;
151}
152
153static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
154 struct usb_host_interface *alts,
155 int protocol, int iface_no)
156{
157 /* parsed with a v1 header here. that's ok as we only look at the
158 * header first which is the same for both versions */
159 struct uac_iso_endpoint_descriptor *csep;
160 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
161 int attributes = 0;
162
163 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
164
165 /* Creamware Noah has this descriptor after the 2nd endpoint */
166 if (!csep && altsd->bNumEndpoints >= 2)
167 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
168
169 if (!csep || csep->bLength < 7 ||
170 csep->bDescriptorSubtype != UAC_EP_GENERAL) {
171 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
172 " class specific endpoint descriptor\n",
173 chip->dev->devnum, iface_no,
174 altsd->bAlternateSetting);
175 return 0;
176 }
177
178 if (protocol == UAC_VERSION_1) {
179 attributes = csep->bmAttributes;
180 } else {
181 struct uac2_iso_endpoint_descriptor *csep2 =
182 (struct uac2_iso_endpoint_descriptor *) csep;
183
184 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
185
186 /* emulate the endpoint attributes of a v1 device */
187 if (csep2->bmControls & UAC2_CONTROL_PITCH)
188 attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
189 }
190
191 return attributes;
192}
193
194static struct uac2_input_terminal_descriptor *
195 snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface,
196 int terminal_id)
197{
198 struct uac2_input_terminal_descriptor *term = NULL;
199
200 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
201 ctrl_iface->extralen,
202 term, UAC_INPUT_TERMINAL))) {
203 if (term->bTerminalID == terminal_id)
204 return term;
205 }
206
207 return NULL;
208}
209
210static struct uac2_output_terminal_descriptor *
211 snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface,
212 int terminal_id)
213{
214 struct uac2_output_terminal_descriptor *term = NULL;
215
216 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
217 ctrl_iface->extralen,
218 term, UAC_OUTPUT_TERMINAL))) {
219 if (term->bTerminalID == terminal_id)
220 return term;
221 }
222
223 return NULL;
224}
225
226int snd_usb_parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
227{
228 struct usb_device *dev;
229 struct usb_interface *iface;
230 struct usb_host_interface *alts;
231 struct usb_interface_descriptor *altsd;
232 int i, altno, err, stream;
233 int format = 0, num_channels = 0;
234 struct audioformat *fp = NULL;
235 int num, protocol, clock = 0;
236 struct uac_format_type_i_continuous_descriptor *fmt;
237
238 dev = chip->dev;
239
240 /* parse the interface's altsettings */
241 iface = usb_ifnum_to_if(dev, iface_no);
242
243 num = iface->num_altsetting;
244
245 /*
246 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
247 * one misses syncpipe, and does not produce any sound.
248 */
249 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
250 num = 4;
251
252 for (i = 0; i < num; i++) {
253 alts = &iface->altsetting[i];
254 altsd = get_iface_desc(alts);
255 protocol = altsd->bInterfaceProtocol;
256 /* skip invalid one */
257 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
258 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
259 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
260 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
261 altsd->bNumEndpoints < 1 ||
262 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
263 continue;
264 /* must be isochronous */
265 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
266 USB_ENDPOINT_XFER_ISOC)
267 continue;
268 /* check direction */
269 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
270 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
271 altno = altsd->bAlternateSetting;
272
273 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
274 continue;
275
276 /* get audio formats */
277 switch (protocol) {
278 default:
279 snd_printdd(KERN_WARNING "%d:%u:%d: unknown interface protocol %#02x, assuming v1\n",
280 dev->devnum, iface_no, altno, protocol);
281 protocol = UAC_VERSION_1;
282 /* fall through */
283
284 case UAC_VERSION_1: {
285 struct uac1_as_header_descriptor *as =
286 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
287
288 if (!as) {
289 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
290 dev->devnum, iface_no, altno);
291 continue;
292 }
293
294 if (as->bLength < sizeof(*as)) {
295 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
296 dev->devnum, iface_no, altno);
297 continue;
298 }
299
300 format = le16_to_cpu(as->wFormatTag); /* remember the format value */
301 break;
302 }
303
304 case UAC_VERSION_2: {
305 struct uac2_input_terminal_descriptor *input_term;
306 struct uac2_output_terminal_descriptor *output_term;
307 struct uac2_as_header_descriptor *as =
308 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
309
310 if (!as) {
311 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
312 dev->devnum, iface_no, altno);
313 continue;
314 }
315
316 if (as->bLength < sizeof(*as)) {
317 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
318 dev->devnum, iface_no, altno);
319 continue;
320 }
321
322 num_channels = as->bNrChannels;
323 format = le32_to_cpu(as->bmFormats);
324
325 /* lookup the terminal associated to this interface
326 * to extract the clock */
327 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
328 as->bTerminalLink);
329 if (input_term) {
330 clock = input_term->bCSourceID;
331 break;
332 }
333
334 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
335 as->bTerminalLink);
336 if (output_term) {
337 clock = output_term->bCSourceID;
338 break;
339 }
340
341 snd_printk(KERN_ERR "%d:%u:%d : bogus bTerminalLink %d\n",
342 dev->devnum, iface_no, altno, as->bTerminalLink);
343 continue;
344 }
345 }
346
347 /* get format type */
348 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE);
349 if (!fmt) {
350 snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
351 dev->devnum, iface_no, altno);
352 continue;
353 }
354 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) ||
355 ((protocol == UAC_VERSION_2) && (fmt->bLength < 6))) {
356 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
357 dev->devnum, iface_no, altno);
358 continue;
359 }
360
361 /*
362 * Blue Microphones workaround: The last altsetting is identical
363 * with the previous one, except for a larger packet size, but
364 * is actually a mislabeled two-channel setting; ignore it.
365 */
366 if (fmt->bNrChannels == 1 &&
367 fmt->bSubframeSize == 2 &&
368 altno == 2 && num == 3 &&
369 fp && fp->altsetting == 1 && fp->channels == 1 &&
370 fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
371 protocol == UAC_VERSION_1 &&
372 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
373 fp->maxpacksize * 2)
374 continue;
375
376 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
377 if (! fp) {
378 snd_printk(KERN_ERR "cannot malloc\n");
379 return -ENOMEM;
380 }
381
382 fp->iface = iface_no;
383 fp->altsetting = altno;
384 fp->altset_idx = i;
385 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
386 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
387 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
388 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
389 /* num_channels is only set for v2 interfaces */
390 fp->channels = num_channels;
391 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
392 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
393 * (fp->maxpacksize & 0x7ff);
394 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol, iface_no);
395 fp->clock = clock;
396
397 /* some quirks for attributes here */
398
399 switch (chip->usb_id) {
400 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
401 /* Optoplay sets the sample rate attribute although
402 * it seems not supporting it in fact.
403 */
404 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
405 break;
406 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
407 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
408 /* doesn't set the sample rate attribute, but supports it */
409 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
410 break;
411 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
412 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
413 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
414 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
415 an older model 77d:223) */
416 /*
417 * plantronics headset and Griffin iMic have set adaptive-in
418 * although it's really not...
419 */
420 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
421 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
422 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
423 else
424 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
425 break;
426 }
427
428 /* ok, let's parse further... */
429 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) {
430 kfree(fp->rate_table);
431 kfree(fp);
432 fp = NULL;
433 continue;
434 }
435
436 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
437 err = snd_usb_add_audio_endpoint(chip, stream, fp);
438 if (err < 0) {
439 kfree(fp->rate_table);
440 kfree(fp);
441 return err;
442 }
443 /* try to set the interface... */
444 usb_set_interface(chip->dev, iface_no, altno);
445 snd_usb_init_pitch(chip, iface_no, alts, fp);
446 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);
447 }
448 return 0;
449}
450
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 */
17
18#include <linux/gfp.h>
19#include <linux/init.h>
20#include <linux/ratelimit.h>
21#include <linux/usb.h>
22#include <linux/usb/audio.h>
23#include <linux/slab.h>
24
25#include <sound/core.h>
26#include <sound/pcm.h>
27#include <sound/pcm_params.h>
28
29#include "usbaudio.h"
30#include "helper.h"
31#include "card.h"
32#include "endpoint.h"
33#include "pcm.h"
34#include "quirks.h"
35
36#define EP_FLAG_RUNNING 1
37#define EP_FLAG_STOPPING 2
38
39/*
40 * snd_usb_endpoint is a model that abstracts everything related to an
41 * USB endpoint and its streaming.
42 *
43 * There are functions to activate and deactivate the streaming URBs and
44 * optional callbacks to let the pcm logic handle the actual content of the
45 * packets for playback and record. Thus, the bus streaming and the audio
46 * handlers are fully decoupled.
47 *
48 * There are two different types of endpoints in audio applications.
49 *
50 * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
51 * inbound and outbound traffic.
52 *
53 * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
54 * expect the payload to carry Q10.14 / Q16.16 formatted sync information
55 * (3 or 4 bytes).
56 *
57 * Each endpoint has to be configured prior to being used by calling
58 * snd_usb_endpoint_set_params().
59 *
60 * The model incorporates a reference counting, so that multiple users
61 * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
62 * only the first user will effectively start the URBs, and only the last
63 * one to stop it will tear the URBs down again.
64 */
65
66/*
67 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
68 * this will overflow at approx 524 kHz
69 */
70static inline unsigned get_usb_full_speed_rate(unsigned int rate)
71{
72 return ((rate << 13) + 62) / 125;
73}
74
75/*
76 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
77 * this will overflow at approx 4 MHz
78 */
79static inline unsigned get_usb_high_speed_rate(unsigned int rate)
80{
81 return ((rate << 10) + 62) / 125;
82}
83
84/*
85 * release a urb data
86 */
87static void release_urb_ctx(struct snd_urb_ctx *u)
88{
89 if (u->buffer_size)
90 usb_free_coherent(u->ep->chip->dev, u->buffer_size,
91 u->urb->transfer_buffer,
92 u->urb->transfer_dma);
93 usb_free_urb(u->urb);
94 u->urb = NULL;
95}
96
97static const char *usb_error_string(int err)
98{
99 switch (err) {
100 case -ENODEV:
101 return "no device";
102 case -ENOENT:
103 return "endpoint not enabled";
104 case -EPIPE:
105 return "endpoint stalled";
106 case -ENOSPC:
107 return "not enough bandwidth";
108 case -ESHUTDOWN:
109 return "device disabled";
110 case -EHOSTUNREACH:
111 return "device suspended";
112 case -EINVAL:
113 case -EAGAIN:
114 case -EFBIG:
115 case -EMSGSIZE:
116 return "internal error";
117 default:
118 return "unknown error";
119 }
120}
121
122/**
123 * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
124 *
125 * @ep: The snd_usb_endpoint
126 *
127 * Determine whether an endpoint is driven by an implicit feedback
128 * data endpoint source.
129 */
130int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
131{
132 return ep->sync_master &&
133 ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
134 ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
135 usb_pipeout(ep->pipe);
136}
137
138/*
139 * For streaming based on information derived from sync endpoints,
140 * prepare_outbound_urb_sizes() will call next_packet_size() to
141 * determine the number of samples to be sent in the next packet.
142 *
143 * For implicit feedback, next_packet_size() is unused.
144 */
145int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
146{
147 unsigned long flags;
148 int ret;
149
150 if (ep->fill_max)
151 return ep->maxframesize;
152
153 spin_lock_irqsave(&ep->lock, flags);
154 ep->phase = (ep->phase & 0xffff)
155 + (ep->freqm << ep->datainterval);
156 ret = min(ep->phase >> 16, ep->maxframesize);
157 spin_unlock_irqrestore(&ep->lock, flags);
158
159 return ret;
160}
161
162static void retire_outbound_urb(struct snd_usb_endpoint *ep,
163 struct snd_urb_ctx *urb_ctx)
164{
165 if (ep->retire_data_urb)
166 ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
167}
168
169static void retire_inbound_urb(struct snd_usb_endpoint *ep,
170 struct snd_urb_ctx *urb_ctx)
171{
172 struct urb *urb = urb_ctx->urb;
173
174 if (unlikely(ep->skip_packets > 0)) {
175 ep->skip_packets--;
176 return;
177 }
178
179 if (ep->sync_slave)
180 snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
181
182 if (ep->retire_data_urb)
183 ep->retire_data_urb(ep->data_subs, urb);
184}
185
186/*
187 * Prepare a PLAYBACK urb for submission to the bus.
188 */
189static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
190 struct snd_urb_ctx *ctx)
191{
192 int i;
193 struct urb *urb = ctx->urb;
194 unsigned char *cp = urb->transfer_buffer;
195
196 urb->dev = ep->chip->dev; /* we need to set this at each time */
197
198 switch (ep->type) {
199 case SND_USB_ENDPOINT_TYPE_DATA:
200 if (ep->prepare_data_urb) {
201 ep->prepare_data_urb(ep->data_subs, urb);
202 } else {
203 /* no data provider, so send silence */
204 unsigned int offs = 0;
205 for (i = 0; i < ctx->packets; ++i) {
206 int counts;
207
208 if (ctx->packet_size[i])
209 counts = ctx->packet_size[i];
210 else
211 counts = snd_usb_endpoint_next_packet_size(ep);
212
213 urb->iso_frame_desc[i].offset = offs * ep->stride;
214 urb->iso_frame_desc[i].length = counts * ep->stride;
215 offs += counts;
216 }
217
218 urb->number_of_packets = ctx->packets;
219 urb->transfer_buffer_length = offs * ep->stride;
220 memset(urb->transfer_buffer, ep->silence_value,
221 offs * ep->stride);
222 }
223 break;
224
225 case SND_USB_ENDPOINT_TYPE_SYNC:
226 if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
227 /*
228 * fill the length and offset of each urb descriptor.
229 * the fixed 12.13 frequency is passed as 16.16 through the pipe.
230 */
231 urb->iso_frame_desc[0].length = 4;
232 urb->iso_frame_desc[0].offset = 0;
233 cp[0] = ep->freqn;
234 cp[1] = ep->freqn >> 8;
235 cp[2] = ep->freqn >> 16;
236 cp[3] = ep->freqn >> 24;
237 } else {
238 /*
239 * fill the length and offset of each urb descriptor.
240 * the fixed 10.14 frequency is passed through the pipe.
241 */
242 urb->iso_frame_desc[0].length = 3;
243 urb->iso_frame_desc[0].offset = 0;
244 cp[0] = ep->freqn >> 2;
245 cp[1] = ep->freqn >> 10;
246 cp[2] = ep->freqn >> 18;
247 }
248
249 break;
250 }
251}
252
253/*
254 * Prepare a CAPTURE or SYNC urb for submission to the bus.
255 */
256static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
257 struct snd_urb_ctx *urb_ctx)
258{
259 int i, offs;
260 struct urb *urb = urb_ctx->urb;
261
262 urb->dev = ep->chip->dev; /* we need to set this at each time */
263
264 switch (ep->type) {
265 case SND_USB_ENDPOINT_TYPE_DATA:
266 offs = 0;
267 for (i = 0; i < urb_ctx->packets; i++) {
268 urb->iso_frame_desc[i].offset = offs;
269 urb->iso_frame_desc[i].length = ep->curpacksize;
270 offs += ep->curpacksize;
271 }
272
273 urb->transfer_buffer_length = offs;
274 urb->number_of_packets = urb_ctx->packets;
275 break;
276
277 case SND_USB_ENDPOINT_TYPE_SYNC:
278 urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
279 urb->iso_frame_desc[0].offset = 0;
280 break;
281 }
282}
283
284/*
285 * Send output urbs that have been prepared previously. URBs are dequeued
286 * from ep->ready_playback_urbs and in case there there aren't any available
287 * or there are no packets that have been prepared, this function does
288 * nothing.
289 *
290 * The reason why the functionality of sending and preparing URBs is separated
291 * is that host controllers don't guarantee the order in which they return
292 * inbound and outbound packets to their submitters.
293 *
294 * This function is only used for implicit feedback endpoints. For endpoints
295 * driven by dedicated sync endpoints, URBs are immediately re-submitted
296 * from their completion handler.
297 */
298static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
299{
300 while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
301
302 unsigned long flags;
303 struct snd_usb_packet_info *uninitialized_var(packet);
304 struct snd_urb_ctx *ctx = NULL;
305 struct urb *urb;
306 int err, i;
307
308 spin_lock_irqsave(&ep->lock, flags);
309 if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
310 packet = ep->next_packet + ep->next_packet_read_pos;
311 ep->next_packet_read_pos++;
312 ep->next_packet_read_pos %= MAX_URBS;
313
314 /* take URB out of FIFO */
315 if (!list_empty(&ep->ready_playback_urbs))
316 ctx = list_first_entry(&ep->ready_playback_urbs,
317 struct snd_urb_ctx, ready_list);
318 }
319 spin_unlock_irqrestore(&ep->lock, flags);
320
321 if (ctx == NULL)
322 return;
323
324 list_del_init(&ctx->ready_list);
325 urb = ctx->urb;
326
327 /* copy over the length information */
328 for (i = 0; i < packet->packets; i++)
329 ctx->packet_size[i] = packet->packet_size[i];
330
331 /* call the data handler to fill in playback data */
332 prepare_outbound_urb(ep, ctx);
333
334 err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
335 if (err < 0)
336 usb_audio_err(ep->chip,
337 "Unable to submit urb #%d: %d (urb %p)\n",
338 ctx->index, err, ctx->urb);
339 else
340 set_bit(ctx->index, &ep->active_mask);
341 }
342}
343
344/*
345 * complete callback for urbs
346 */
347static void snd_complete_urb(struct urb *urb)
348{
349 struct snd_urb_ctx *ctx = urb->context;
350 struct snd_usb_endpoint *ep = ctx->ep;
351 int err;
352
353 if (unlikely(urb->status == -ENOENT || /* unlinked */
354 urb->status == -ENODEV || /* device removed */
355 urb->status == -ECONNRESET || /* unlinked */
356 urb->status == -ESHUTDOWN || /* device disabled */
357 ep->chip->shutdown)) /* device disconnected */
358 goto exit_clear;
359
360 if (usb_pipeout(ep->pipe)) {
361 retire_outbound_urb(ep, ctx);
362 /* can be stopped during retire callback */
363 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
364 goto exit_clear;
365
366 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
367 unsigned long flags;
368
369 spin_lock_irqsave(&ep->lock, flags);
370 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
371 spin_unlock_irqrestore(&ep->lock, flags);
372 queue_pending_output_urbs(ep);
373
374 goto exit_clear;
375 }
376
377 prepare_outbound_urb(ep, ctx);
378 } else {
379 retire_inbound_urb(ep, ctx);
380 /* can be stopped during retire callback */
381 if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
382 goto exit_clear;
383
384 prepare_inbound_urb(ep, ctx);
385 }
386
387 err = usb_submit_urb(urb, GFP_ATOMIC);
388 if (err == 0)
389 return;
390
391 usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
392 //snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
393
394exit_clear:
395 clear_bit(ctx->index, &ep->active_mask);
396}
397
398/**
399 * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
400 *
401 * @chip: The chip
402 * @alts: The USB host interface
403 * @ep_num: The number of the endpoint to use
404 * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
405 * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
406 *
407 * If the requested endpoint has not been added to the given chip before,
408 * a new instance is created. Otherwise, a pointer to the previoulsy
409 * created instance is returned. In case of any error, NULL is returned.
410 *
411 * New endpoints will be added to chip->ep_list and must be freed by
412 * calling snd_usb_endpoint_free().
413 */
414struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
415 struct usb_host_interface *alts,
416 int ep_num, int direction, int type)
417{
418 struct snd_usb_endpoint *ep;
419 int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
420
421 if (WARN_ON(!alts))
422 return NULL;
423
424 mutex_lock(&chip->mutex);
425
426 list_for_each_entry(ep, &chip->ep_list, list) {
427 if (ep->ep_num == ep_num &&
428 ep->iface == alts->desc.bInterfaceNumber &&
429 ep->altsetting == alts->desc.bAlternateSetting) {
430 usb_audio_dbg(ep->chip,
431 "Re-using EP %x in iface %d,%d @%p\n",
432 ep_num, ep->iface, ep->altsetting, ep);
433 goto __exit_unlock;
434 }
435 }
436
437 usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
438 is_playback ? "playback" : "capture",
439 type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
440 ep_num);
441
442 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
443 if (!ep)
444 goto __exit_unlock;
445
446 ep->chip = chip;
447 spin_lock_init(&ep->lock);
448 ep->type = type;
449 ep->ep_num = ep_num;
450 ep->iface = alts->desc.bInterfaceNumber;
451 ep->altsetting = alts->desc.bAlternateSetting;
452 INIT_LIST_HEAD(&ep->ready_playback_urbs);
453 ep_num &= USB_ENDPOINT_NUMBER_MASK;
454
455 if (is_playback)
456 ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
457 else
458 ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
459
460 if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
461 if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
462 get_endpoint(alts, 1)->bRefresh >= 1 &&
463 get_endpoint(alts, 1)->bRefresh <= 9)
464 ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
465 else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
466 ep->syncinterval = 1;
467 else if (get_endpoint(alts, 1)->bInterval >= 1 &&
468 get_endpoint(alts, 1)->bInterval <= 16)
469 ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
470 else
471 ep->syncinterval = 3;
472
473 ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
474
475 if (chip->usb_id == USB_ID(0x0644, 0x8038) /* TEAC UD-H01 */ &&
476 ep->syncmaxsize == 4)
477 ep->udh01_fb_quirk = 1;
478 }
479
480 list_add_tail(&ep->list, &chip->ep_list);
481
482__exit_unlock:
483 mutex_unlock(&chip->mutex);
484
485 return ep;
486}
487
488/*
489 * wait until all urbs are processed.
490 */
491static int wait_clear_urbs(struct snd_usb_endpoint *ep)
492{
493 unsigned long end_time = jiffies + msecs_to_jiffies(1000);
494 int alive;
495
496 do {
497 alive = bitmap_weight(&ep->active_mask, ep->nurbs);
498 if (!alive)
499 break;
500
501 schedule_timeout_uninterruptible(1);
502 } while (time_before(jiffies, end_time));
503
504 if (alive)
505 usb_audio_err(ep->chip,
506 "timeout: still %d active urbs on EP #%x\n",
507 alive, ep->ep_num);
508 clear_bit(EP_FLAG_STOPPING, &ep->flags);
509
510 return 0;
511}
512
513/* sync the pending stop operation;
514 * this function itself doesn't trigger the stop operation
515 */
516void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
517{
518 if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
519 wait_clear_urbs(ep);
520}
521
522/*
523 * unlink active urbs.
524 */
525static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
526{
527 unsigned int i;
528
529 if (!force && ep->chip->shutdown) /* to be sure... */
530 return -EBADFD;
531
532 clear_bit(EP_FLAG_RUNNING, &ep->flags);
533
534 INIT_LIST_HEAD(&ep->ready_playback_urbs);
535 ep->next_packet_read_pos = 0;
536 ep->next_packet_write_pos = 0;
537
538 for (i = 0; i < ep->nurbs; i++) {
539 if (test_bit(i, &ep->active_mask)) {
540 if (!test_and_set_bit(i, &ep->unlink_mask)) {
541 struct urb *u = ep->urb[i].urb;
542 usb_unlink_urb(u);
543 }
544 }
545 }
546
547 return 0;
548}
549
550/*
551 * release an endpoint's urbs
552 */
553static void release_urbs(struct snd_usb_endpoint *ep, int force)
554{
555 int i;
556
557 /* route incoming urbs to nirvana */
558 ep->retire_data_urb = NULL;
559 ep->prepare_data_urb = NULL;
560
561 /* stop urbs */
562 deactivate_urbs(ep, force);
563 wait_clear_urbs(ep);
564
565 for (i = 0; i < ep->nurbs; i++)
566 release_urb_ctx(&ep->urb[i]);
567
568 if (ep->syncbuf)
569 usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
570 ep->syncbuf, ep->sync_dma);
571
572 ep->syncbuf = NULL;
573 ep->nurbs = 0;
574}
575
576/*
577 * configure a data endpoint
578 */
579static int data_ep_set_params(struct snd_usb_endpoint *ep,
580 snd_pcm_format_t pcm_format,
581 unsigned int channels,
582 unsigned int period_bytes,
583 unsigned int frames_per_period,
584 unsigned int periods_per_buffer,
585 struct audioformat *fmt,
586 struct snd_usb_endpoint *sync_ep)
587{
588 unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
589 unsigned int max_packs_per_period, urbs_per_period, urb_packs;
590 unsigned int max_urbs, i;
591 int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
592
593 if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
594 /*
595 * When operating in DSD DOP mode, the size of a sample frame
596 * in hardware differs from the actual physical format width
597 * because we need to make room for the DOP markers.
598 */
599 frame_bits += channels << 3;
600 }
601
602 ep->datainterval = fmt->datainterval;
603 ep->stride = frame_bits >> 3;
604 ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
605
606 /* assume max. frequency is 25% higher than nominal */
607 ep->freqmax = ep->freqn + (ep->freqn >> 2);
608 maxsize = ((ep->freqmax + 0xffff) * (frame_bits >> 3))
609 >> (16 - ep->datainterval);
610 /* but wMaxPacketSize might reduce this */
611 if (ep->maxpacksize && ep->maxpacksize < maxsize) {
612 /* whatever fits into a max. size packet */
613 maxsize = ep->maxpacksize;
614 ep->freqmax = (maxsize / (frame_bits >> 3))
615 << (16 - ep->datainterval);
616 }
617
618 if (ep->fill_max)
619 ep->curpacksize = ep->maxpacksize;
620 else
621 ep->curpacksize = maxsize;
622
623 if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
624 packs_per_ms = 8 >> ep->datainterval;
625 max_packs_per_urb = MAX_PACKS_HS;
626 } else {
627 packs_per_ms = 1;
628 max_packs_per_urb = MAX_PACKS;
629 }
630 if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
631 max_packs_per_urb = min(max_packs_per_urb,
632 1U << sync_ep->syncinterval);
633 max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
634
635 /*
636 * Capture endpoints need to use small URBs because there's no way
637 * to tell in advance where the next period will end, and we don't
638 * want the next URB to complete much after the period ends.
639 *
640 * Playback endpoints with implicit sync much use the same parameters
641 * as their corresponding capture endpoint.
642 */
643 if (usb_pipein(ep->pipe) ||
644 snd_usb_endpoint_implicit_feedback_sink(ep)) {
645
646 urb_packs = packs_per_ms;
647 /*
648 * Wireless devices can poll at a max rate of once per 4ms.
649 * For dataintervals less than 5, increase the packet count to
650 * allow the host controller to use bursting to fill in the
651 * gaps.
652 */
653 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
654 int interval = ep->datainterval;
655 while (interval < 5) {
656 urb_packs <<= 1;
657 ++interval;
658 }
659 }
660 /* make capture URBs <= 1 ms and smaller than a period */
661 urb_packs = min(max_packs_per_urb, urb_packs);
662 while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
663 urb_packs >>= 1;
664 ep->nurbs = MAX_URBS;
665
666 /*
667 * Playback endpoints without implicit sync are adjusted so that
668 * a period fits as evenly as possible in the smallest number of
669 * URBs. The total number of URBs is adjusted to the size of the
670 * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
671 */
672 } else {
673 /* determine how small a packet can be */
674 minsize = (ep->freqn >> (16 - ep->datainterval)) *
675 (frame_bits >> 3);
676 /* with sync from device, assume it can be 12% lower */
677 if (sync_ep)
678 minsize -= minsize >> 3;
679 minsize = max(minsize, 1u);
680
681 /* how many packets will contain an entire ALSA period? */
682 max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
683
684 /* how many URBs will contain a period? */
685 urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
686 max_packs_per_urb);
687 /* how many packets are needed in each URB? */
688 urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
689
690 /* limit the number of frames in a single URB */
691 ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
692 urbs_per_period);
693
694 /* try to use enough URBs to contain an entire ALSA buffer */
695 max_urbs = min((unsigned) MAX_URBS,
696 MAX_QUEUE * packs_per_ms / urb_packs);
697 ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
698 }
699
700 /* allocate and initialize data urbs */
701 for (i = 0; i < ep->nurbs; i++) {
702 struct snd_urb_ctx *u = &ep->urb[i];
703 u->index = i;
704 u->ep = ep;
705 u->packets = urb_packs;
706 u->buffer_size = maxsize * u->packets;
707
708 if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
709 u->packets++; /* for transfer delimiter */
710 u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
711 if (!u->urb)
712 goto out_of_memory;
713
714 u->urb->transfer_buffer =
715 usb_alloc_coherent(ep->chip->dev, u->buffer_size,
716 GFP_KERNEL, &u->urb->transfer_dma);
717 if (!u->urb->transfer_buffer)
718 goto out_of_memory;
719 u->urb->pipe = ep->pipe;
720 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
721 u->urb->interval = 1 << ep->datainterval;
722 u->urb->context = u;
723 u->urb->complete = snd_complete_urb;
724 INIT_LIST_HEAD(&u->ready_list);
725 }
726
727 return 0;
728
729out_of_memory:
730 release_urbs(ep, 0);
731 return -ENOMEM;
732}
733
734/*
735 * configure a sync endpoint
736 */
737static int sync_ep_set_params(struct snd_usb_endpoint *ep)
738{
739 int i;
740
741 ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
742 GFP_KERNEL, &ep->sync_dma);
743 if (!ep->syncbuf)
744 return -ENOMEM;
745
746 for (i = 0; i < SYNC_URBS; i++) {
747 struct snd_urb_ctx *u = &ep->urb[i];
748 u->index = i;
749 u->ep = ep;
750 u->packets = 1;
751 u->urb = usb_alloc_urb(1, GFP_KERNEL);
752 if (!u->urb)
753 goto out_of_memory;
754 u->urb->transfer_buffer = ep->syncbuf + i * 4;
755 u->urb->transfer_dma = ep->sync_dma + i * 4;
756 u->urb->transfer_buffer_length = 4;
757 u->urb->pipe = ep->pipe;
758 u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
759 u->urb->number_of_packets = 1;
760 u->urb->interval = 1 << ep->syncinterval;
761 u->urb->context = u;
762 u->urb->complete = snd_complete_urb;
763 }
764
765 ep->nurbs = SYNC_URBS;
766
767 return 0;
768
769out_of_memory:
770 release_urbs(ep, 0);
771 return -ENOMEM;
772}
773
774/**
775 * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
776 *
777 * @ep: the snd_usb_endpoint to configure
778 * @pcm_format: the audio fomat.
779 * @channels: the number of audio channels.
780 * @period_bytes: the number of bytes in one alsa period.
781 * @period_frames: the number of frames in one alsa period.
782 * @buffer_periods: the number of periods in one alsa buffer.
783 * @rate: the frame rate.
784 * @fmt: the USB audio format information
785 * @sync_ep: the sync endpoint to use, if any
786 *
787 * Determine the number of URBs to be used on this endpoint.
788 * An endpoint must be configured before it can be started.
789 * An endpoint that is already running can not be reconfigured.
790 */
791int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
792 snd_pcm_format_t pcm_format,
793 unsigned int channels,
794 unsigned int period_bytes,
795 unsigned int period_frames,
796 unsigned int buffer_periods,
797 unsigned int rate,
798 struct audioformat *fmt,
799 struct snd_usb_endpoint *sync_ep)
800{
801 int err;
802
803 if (ep->use_count != 0) {
804 usb_audio_warn(ep->chip,
805 "Unable to change format on ep #%x: already in use\n",
806 ep->ep_num);
807 return -EBUSY;
808 }
809
810 /* release old buffers, if any */
811 release_urbs(ep, 0);
812
813 ep->datainterval = fmt->datainterval;
814 ep->maxpacksize = fmt->maxpacksize;
815 ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
816
817 if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
818 ep->freqn = get_usb_full_speed_rate(rate);
819 else
820 ep->freqn = get_usb_high_speed_rate(rate);
821
822 /* calculate the frequency in 16.16 format */
823 ep->freqm = ep->freqn;
824 ep->freqshift = INT_MIN;
825
826 ep->phase = 0;
827
828 switch (ep->type) {
829 case SND_USB_ENDPOINT_TYPE_DATA:
830 err = data_ep_set_params(ep, pcm_format, channels,
831 period_bytes, period_frames,
832 buffer_periods, fmt, sync_ep);
833 break;
834 case SND_USB_ENDPOINT_TYPE_SYNC:
835 err = sync_ep_set_params(ep);
836 break;
837 default:
838 err = -EINVAL;
839 }
840
841 usb_audio_dbg(ep->chip,
842 "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
843 ep->ep_num, ep->type, ep->nurbs, err);
844
845 return err;
846}
847
848/**
849 * snd_usb_endpoint_start: start an snd_usb_endpoint
850 *
851 * @ep: the endpoint to start
852 * @can_sleep: flag indicating whether the operation is executed in
853 * non-atomic context
854 *
855 * A call to this function will increment the use count of the endpoint.
856 * In case it is not already running, the URBs for this endpoint will be
857 * submitted. Otherwise, this function does nothing.
858 *
859 * Must be balanced to calls of snd_usb_endpoint_stop().
860 *
861 * Returns an error if the URB submission failed, 0 in all other cases.
862 */
863int snd_usb_endpoint_start(struct snd_usb_endpoint *ep, bool can_sleep)
864{
865 int err;
866 unsigned int i;
867
868 if (ep->chip->shutdown)
869 return -EBADFD;
870
871 /* already running? */
872 if (++ep->use_count != 1)
873 return 0;
874
875 /* just to be sure */
876 deactivate_urbs(ep, false);
877 if (can_sleep)
878 wait_clear_urbs(ep);
879
880 ep->active_mask = 0;
881 ep->unlink_mask = 0;
882 ep->phase = 0;
883
884 snd_usb_endpoint_start_quirk(ep);
885
886 /*
887 * If this endpoint has a data endpoint as implicit feedback source,
888 * don't start the urbs here. Instead, mark them all as available,
889 * wait for the record urbs to return and queue the playback urbs
890 * from that context.
891 */
892
893 set_bit(EP_FLAG_RUNNING, &ep->flags);
894
895 if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
896 for (i = 0; i < ep->nurbs; i++) {
897 struct snd_urb_ctx *ctx = ep->urb + i;
898 list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
899 }
900
901 return 0;
902 }
903
904 for (i = 0; i < ep->nurbs; i++) {
905 struct urb *urb = ep->urb[i].urb;
906
907 if (snd_BUG_ON(!urb))
908 goto __error;
909
910 if (usb_pipeout(ep->pipe)) {
911 prepare_outbound_urb(ep, urb->context);
912 } else {
913 prepare_inbound_urb(ep, urb->context);
914 }
915
916 err = usb_submit_urb(urb, GFP_ATOMIC);
917 if (err < 0) {
918 usb_audio_err(ep->chip,
919 "cannot submit urb %d, error %d: %s\n",
920 i, err, usb_error_string(err));
921 goto __error;
922 }
923 set_bit(i, &ep->active_mask);
924 }
925
926 return 0;
927
928__error:
929 clear_bit(EP_FLAG_RUNNING, &ep->flags);
930 ep->use_count--;
931 deactivate_urbs(ep, false);
932 return -EPIPE;
933}
934
935/**
936 * snd_usb_endpoint_stop: stop an snd_usb_endpoint
937 *
938 * @ep: the endpoint to stop (may be NULL)
939 *
940 * A call to this function will decrement the use count of the endpoint.
941 * In case the last user has requested the endpoint stop, the URBs will
942 * actually be deactivated.
943 *
944 * Must be balanced to calls of snd_usb_endpoint_start().
945 *
946 * The caller needs to synchronize the pending stop operation via
947 * snd_usb_endpoint_sync_pending_stop().
948 */
949void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
950{
951 if (!ep)
952 return;
953
954 if (snd_BUG_ON(ep->use_count == 0))
955 return;
956
957 if (--ep->use_count == 0) {
958 deactivate_urbs(ep, false);
959 ep->data_subs = NULL;
960 ep->sync_slave = NULL;
961 ep->retire_data_urb = NULL;
962 ep->prepare_data_urb = NULL;
963 set_bit(EP_FLAG_STOPPING, &ep->flags);
964 }
965}
966
967/**
968 * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
969 *
970 * @ep: the endpoint to deactivate
971 *
972 * If the endpoint is not currently in use, this functions will
973 * deactivate its associated URBs.
974 *
975 * In case of any active users, this functions does nothing.
976 */
977void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
978{
979 if (!ep)
980 return;
981
982 if (ep->use_count != 0)
983 return;
984
985 deactivate_urbs(ep, true);
986 wait_clear_urbs(ep);
987}
988
989/**
990 * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
991 *
992 * @ep: the list header of the endpoint to free
993 *
994 * This function does not care for the endpoint's use count but will tear
995 * down all the streaming URBs immediately and free all resources.
996 */
997void snd_usb_endpoint_free(struct list_head *head)
998{
999 struct snd_usb_endpoint *ep;
1000
1001 ep = list_entry(head, struct snd_usb_endpoint, list);
1002 release_urbs(ep, 1);
1003 kfree(ep);
1004}
1005
1006/**
1007 * snd_usb_handle_sync_urb: parse an USB sync packet
1008 *
1009 * @ep: the endpoint to handle the packet
1010 * @sender: the sending endpoint
1011 * @urb: the received packet
1012 *
1013 * This function is called from the context of an endpoint that received
1014 * the packet and is used to let another endpoint object handle the payload.
1015 */
1016void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
1017 struct snd_usb_endpoint *sender,
1018 const struct urb *urb)
1019{
1020 int shift;
1021 unsigned int f;
1022 unsigned long flags;
1023
1024 snd_BUG_ON(ep == sender);
1025
1026 /*
1027 * In case the endpoint is operating in implicit feedback mode, prepare
1028 * a new outbound URB that has the same layout as the received packet
1029 * and add it to the list of pending urbs. queue_pending_output_urbs()
1030 * will take care of them later.
1031 */
1032 if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
1033 ep->use_count != 0) {
1034
1035 /* implicit feedback case */
1036 int i, bytes = 0;
1037 struct snd_urb_ctx *in_ctx;
1038 struct snd_usb_packet_info *out_packet;
1039
1040 in_ctx = urb->context;
1041
1042 /* Count overall packet size */
1043 for (i = 0; i < in_ctx->packets; i++)
1044 if (urb->iso_frame_desc[i].status == 0)
1045 bytes += urb->iso_frame_desc[i].actual_length;
1046
1047 /*
1048 * skip empty packets. At least M-Audio's Fast Track Ultra stops
1049 * streaming once it received a 0-byte OUT URB
1050 */
1051 if (bytes == 0)
1052 return;
1053
1054 spin_lock_irqsave(&ep->lock, flags);
1055 out_packet = ep->next_packet + ep->next_packet_write_pos;
1056
1057 /*
1058 * Iterate through the inbound packet and prepare the lengths
1059 * for the output packet. The OUT packet we are about to send
1060 * will have the same amount of payload bytes per stride as the
1061 * IN packet we just received. Since the actual size is scaled
1062 * by the stride, use the sender stride to calculate the length
1063 * in case the number of channels differ between the implicitly
1064 * fed-back endpoint and the synchronizing endpoint.
1065 */
1066
1067 out_packet->packets = in_ctx->packets;
1068 for (i = 0; i < in_ctx->packets; i++) {
1069 if (urb->iso_frame_desc[i].status == 0)
1070 out_packet->packet_size[i] =
1071 urb->iso_frame_desc[i].actual_length / sender->stride;
1072 else
1073 out_packet->packet_size[i] = 0;
1074 }
1075
1076 ep->next_packet_write_pos++;
1077 ep->next_packet_write_pos %= MAX_URBS;
1078 spin_unlock_irqrestore(&ep->lock, flags);
1079 queue_pending_output_urbs(ep);
1080
1081 return;
1082 }
1083
1084 /*
1085 * process after playback sync complete
1086 *
1087 * Full speed devices report feedback values in 10.14 format as samples
1088 * per frame, high speed devices in 16.16 format as samples per
1089 * microframe.
1090 *
1091 * Because the Audio Class 1 spec was written before USB 2.0, many high
1092 * speed devices use a wrong interpretation, some others use an
1093 * entirely different format.
1094 *
1095 * Therefore, we cannot predict what format any particular device uses
1096 * and must detect it automatically.
1097 */
1098
1099 if (urb->iso_frame_desc[0].status != 0 ||
1100 urb->iso_frame_desc[0].actual_length < 3)
1101 return;
1102
1103 f = le32_to_cpup(urb->transfer_buffer);
1104 if (urb->iso_frame_desc[0].actual_length == 3)
1105 f &= 0x00ffffff;
1106 else
1107 f &= 0x0fffffff;
1108
1109 if (f == 0)
1110 return;
1111
1112 if (unlikely(sender->udh01_fb_quirk)) {
1113 /*
1114 * The TEAC UD-H01 firmware sometimes changes the feedback value
1115 * by +/- 0x1.0000.
1116 */
1117 if (f < ep->freqn - 0x8000)
1118 f += 0x10000;
1119 else if (f > ep->freqn + 0x8000)
1120 f -= 0x10000;
1121 } else if (unlikely(ep->freqshift == INT_MIN)) {
1122 /*
1123 * The first time we see a feedback value, determine its format
1124 * by shifting it left or right until it matches the nominal
1125 * frequency value. This assumes that the feedback does not
1126 * differ from the nominal value more than +50% or -25%.
1127 */
1128 shift = 0;
1129 while (f < ep->freqn - ep->freqn / 4) {
1130 f <<= 1;
1131 shift++;
1132 }
1133 while (f > ep->freqn + ep->freqn / 2) {
1134 f >>= 1;
1135 shift--;
1136 }
1137 ep->freqshift = shift;
1138 } else if (ep->freqshift >= 0)
1139 f <<= ep->freqshift;
1140 else
1141 f >>= -ep->freqshift;
1142
1143 if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
1144 /*
1145 * If the frequency looks valid, set it.
1146 * This value is referred to in prepare_playback_urb().
1147 */
1148 spin_lock_irqsave(&ep->lock, flags);
1149 ep->freqm = f;
1150 spin_unlock_irqrestore(&ep->lock, flags);
1151 } else {
1152 /*
1153 * Out of range; maybe the shift value is wrong.
1154 * Reset it so that we autodetect again the next time.
1155 */
1156 ep->freqshift = INT_MIN;
1157 }
1158}
1159