1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 */
4
5
6 #include <linux/init.h>
7 #include <linux/slab.h>
8 #include <linux/usb.h>
9 #include <linux/usb/audio.h>
10 #include <linux/usb/audio-v2.h>
11 #include <linux/usb/audio-v3.h>
12
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/control.h>
16 #include <sound/tlv.h>
17
18 #include "usbaudio.h"
19 #include "card.h"
20 #include "proc.h"
21 #include "quirks.h"
22 #include "endpoint.h"
23 #include "pcm.h"
24 #include "helper.h"
25 #include "format.h"
26 #include "clock.h"
27 #include "stream.h"
28 #include "power.h"
29 #include "media.h"
30
audioformat_free(struct audioformat * fp)31 static void audioformat_free(struct audioformat *fp)
32 {
33 list_del(&fp->list); /* unlink for avoiding double-free */
34 kfree(fp->rate_table);
35 kfree(fp->chmap);
36 kfree(fp);
37 }
38
39 /*
40 * free a substream
41 */
free_substream(struct snd_usb_substream * subs)42 static void free_substream(struct snd_usb_substream *subs)
43 {
44 struct audioformat *fp, *n;
45
46 if (!subs->num_formats)
47 return; /* not initialized */
48 list_for_each_entry_safe(fp, n, &subs->fmt_list, list)
49 audioformat_free(fp);
50 kfree(subs->rate_list.list);
51 kfree(subs->str_pd);
52 snd_media_stream_delete(subs);
53 }
54
55
56 /*
57 * free a usb stream instance
58 */
snd_usb_audio_stream_free(struct snd_usb_stream * stream)59 static 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
snd_usb_audio_pcm_free(struct snd_pcm * pcm)67 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
68 {
69 struct snd_usb_stream *stream = pcm->private_data;
70 struct snd_usb_audio *chip;
71 if (stream) {
72 mutex_lock(&stream->chip->dev_lock);
73 chip = stream->chip;
74 stream->pcm = NULL;
75 snd_usb_audio_stream_free(stream);
76 mutex_unlock(&chip->dev_lock);
77 }
78 }
79
80 /*
81 * initialize the substream instance.
82 */
83
snd_usb_init_substream(struct snd_usb_stream * as,int stream,struct audioformat * fp,struct snd_usb_power_domain * pd)84 static void snd_usb_init_substream(struct snd_usb_stream *as,
85 int stream,
86 struct audioformat *fp,
87 struct snd_usb_power_domain *pd)
88 {
89 struct snd_usb_substream *subs = &as->substream[stream];
90
91 INIT_LIST_HEAD(&subs->fmt_list);
92 spin_lock_init(&subs->lock);
93
94 subs->stream = as;
95 subs->direction = stream;
96 subs->dev = as->chip->dev;
97 subs->txfr_quirk = as->chip->txfr_quirk;
98 subs->tx_length_quirk = as->chip->tx_length_quirk;
99 subs->speed = snd_usb_get_speed(subs->dev);
100 subs->pkt_offset_adj = 0;
101
102 snd_usb_set_pcm_ops(as->pcm, stream);
103
104 list_add_tail(&fp->list, &subs->fmt_list);
105 subs->formats |= fp->formats;
106 subs->num_formats++;
107 subs->fmt_type = fp->fmt_type;
108 subs->ep_num = fp->endpoint;
109 if (fp->channels > subs->channels_max)
110 subs->channels_max = fp->channels;
111
112 if (pd) {
113 subs->str_pd = pd;
114 /* Initialize Power Domain to idle status D1 */
115 snd_usb_power_domain_set(subs->stream->chip, pd,
116 UAC3_PD_STATE_D1);
117 }
118
119 snd_usb_preallocate_buffer(subs);
120 }
121
122 /* kctl callbacks for usb-audio channel maps */
usb_chmap_ctl_info(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_info * uinfo)123 static int usb_chmap_ctl_info(struct snd_kcontrol *kcontrol,
124 struct snd_ctl_elem_info *uinfo)
125 {
126 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
127 struct snd_usb_substream *subs = info->private_data;
128
129 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
130 uinfo->count = subs->channels_max;
131 uinfo->value.integer.min = 0;
132 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
133 return 0;
134 }
135
136 /* check whether a duplicated entry exists in the audiofmt list */
have_dup_chmap(struct snd_usb_substream * subs,struct audioformat * fp)137 static bool have_dup_chmap(struct snd_usb_substream *subs,
138 struct audioformat *fp)
139 {
140 struct audioformat *prev = fp;
141
142 list_for_each_entry_continue_reverse(prev, &subs->fmt_list, list) {
143 if (prev->chmap &&
144 !memcmp(prev->chmap, fp->chmap, sizeof(*fp->chmap)))
145 return true;
146 }
147 return false;
148 }
149
usb_chmap_ctl_tlv(struct snd_kcontrol * kcontrol,int op_flag,unsigned int size,unsigned int __user * tlv)150 static int usb_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
151 unsigned int size, unsigned int __user *tlv)
152 {
153 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
154 struct snd_usb_substream *subs = info->private_data;
155 struct audioformat *fp;
156 unsigned int __user *dst;
157 int count = 0;
158
159 if (size < 8)
160 return -ENOMEM;
161 if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
162 return -EFAULT;
163 size -= 8;
164 dst = tlv + 2;
165 list_for_each_entry(fp, &subs->fmt_list, list) {
166 int i, ch_bytes;
167
168 if (!fp->chmap)
169 continue;
170 if (have_dup_chmap(subs, fp))
171 continue;
172 /* copy the entry */
173 ch_bytes = fp->chmap->channels * 4;
174 if (size < 8 + ch_bytes)
175 return -ENOMEM;
176 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
177 put_user(ch_bytes, dst + 1))
178 return -EFAULT;
179 dst += 2;
180 for (i = 0; i < fp->chmap->channels; i++, dst++) {
181 if (put_user(fp->chmap->map[i], dst))
182 return -EFAULT;
183 }
184
185 count += 8 + ch_bytes;
186 size -= 8 + ch_bytes;
187 }
188 if (put_user(count, tlv + 1))
189 return -EFAULT;
190 return 0;
191 }
192
usb_chmap_ctl_get(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)193 static int usb_chmap_ctl_get(struct snd_kcontrol *kcontrol,
194 struct snd_ctl_elem_value *ucontrol)
195 {
196 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
197 struct snd_usb_substream *subs = info->private_data;
198 struct snd_pcm_chmap_elem *chmap = NULL;
199 int i = 0;
200
201 if (subs->cur_audiofmt)
202 chmap = subs->cur_audiofmt->chmap;
203 if (chmap) {
204 for (i = 0; i < chmap->channels; i++)
205 ucontrol->value.integer.value[i] = chmap->map[i];
206 }
207 for (; i < subs->channels_max; i++)
208 ucontrol->value.integer.value[i] = 0;
209 return 0;
210 }
211
212 /* create a chmap kctl assigned to the given USB substream */
add_chmap(struct snd_pcm * pcm,int stream,struct snd_usb_substream * subs)213 static int add_chmap(struct snd_pcm *pcm, int stream,
214 struct snd_usb_substream *subs)
215 {
216 struct audioformat *fp;
217 struct snd_pcm_chmap *chmap;
218 struct snd_kcontrol *kctl;
219 int err;
220
221 list_for_each_entry(fp, &subs->fmt_list, list)
222 if (fp->chmap)
223 goto ok;
224 /* no chmap is found */
225 return 0;
226
227 ok:
228 err = snd_pcm_add_chmap_ctls(pcm, stream, NULL, 0, 0, &chmap);
229 if (err < 0)
230 return err;
231
232 /* override handlers */
233 chmap->private_data = subs;
234 kctl = chmap->kctl;
235 kctl->info = usb_chmap_ctl_info;
236 kctl->get = usb_chmap_ctl_get;
237 kctl->tlv.c = usb_chmap_ctl_tlv;
238
239 return 0;
240 }
241
242 /* convert from USB ChannelConfig bits to ALSA chmap element */
convert_chmap(int channels,unsigned int bits,int protocol)243 static struct snd_pcm_chmap_elem *convert_chmap(int channels, unsigned int bits,
244 int protocol)
245 {
246 static const unsigned int uac1_maps[] = {
247 SNDRV_CHMAP_FL, /* left front */
248 SNDRV_CHMAP_FR, /* right front */
249 SNDRV_CHMAP_FC, /* center front */
250 SNDRV_CHMAP_LFE, /* LFE */
251 SNDRV_CHMAP_SL, /* left surround */
252 SNDRV_CHMAP_SR, /* right surround */
253 SNDRV_CHMAP_FLC, /* left of center */
254 SNDRV_CHMAP_FRC, /* right of center */
255 SNDRV_CHMAP_RC, /* surround */
256 SNDRV_CHMAP_SL, /* side left */
257 SNDRV_CHMAP_SR, /* side right */
258 SNDRV_CHMAP_TC, /* top */
259 0 /* terminator */
260 };
261 static const unsigned int uac2_maps[] = {
262 SNDRV_CHMAP_FL, /* front left */
263 SNDRV_CHMAP_FR, /* front right */
264 SNDRV_CHMAP_FC, /* front center */
265 SNDRV_CHMAP_LFE, /* LFE */
266 SNDRV_CHMAP_RL, /* back left */
267 SNDRV_CHMAP_RR, /* back right */
268 SNDRV_CHMAP_FLC, /* front left of center */
269 SNDRV_CHMAP_FRC, /* front right of center */
270 SNDRV_CHMAP_RC, /* back center */
271 SNDRV_CHMAP_SL, /* side left */
272 SNDRV_CHMAP_SR, /* side right */
273 SNDRV_CHMAP_TC, /* top center */
274 SNDRV_CHMAP_TFL, /* top front left */
275 SNDRV_CHMAP_TFC, /* top front center */
276 SNDRV_CHMAP_TFR, /* top front right */
277 SNDRV_CHMAP_TRL, /* top back left */
278 SNDRV_CHMAP_TRC, /* top back center */
279 SNDRV_CHMAP_TRR, /* top back right */
280 SNDRV_CHMAP_TFLC, /* top front left of center */
281 SNDRV_CHMAP_TFRC, /* top front right of center */
282 SNDRV_CHMAP_LLFE, /* left LFE */
283 SNDRV_CHMAP_RLFE, /* right LFE */
284 SNDRV_CHMAP_TSL, /* top side left */
285 SNDRV_CHMAP_TSR, /* top side right */
286 SNDRV_CHMAP_BC, /* bottom center */
287 SNDRV_CHMAP_RLC, /* back left of center */
288 SNDRV_CHMAP_RRC, /* back right of center */
289 0 /* terminator */
290 };
291 struct snd_pcm_chmap_elem *chmap;
292 const unsigned int *maps;
293 int c;
294
295 if (channels > ARRAY_SIZE(chmap->map))
296 return NULL;
297
298 chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
299 if (!chmap)
300 return NULL;
301
302 maps = protocol == UAC_VERSION_2 ? uac2_maps : uac1_maps;
303 chmap->channels = channels;
304 c = 0;
305
306 if (bits) {
307 for (; bits && *maps; maps++, bits >>= 1) {
308 if (bits & 1)
309 chmap->map[c++] = *maps;
310 if (c == chmap->channels)
311 break;
312 }
313 } else {
314 /* If we're missing wChannelConfig, then guess something
315 to make sure the channel map is not skipped entirely */
316 if (channels == 1)
317 chmap->map[c++] = SNDRV_CHMAP_MONO;
318 else
319 for (; c < channels && *maps; maps++)
320 chmap->map[c++] = *maps;
321 }
322
323 for (; c < channels; c++)
324 chmap->map[c] = SNDRV_CHMAP_UNKNOWN;
325
326 return chmap;
327 }
328
329 /* UAC3 device stores channels information in Cluster Descriptors */
330 static struct
convert_chmap_v3(struct uac3_cluster_header_descriptor * cluster)331 snd_pcm_chmap_elem *convert_chmap_v3(struct uac3_cluster_header_descriptor
332 *cluster)
333 {
334 unsigned int channels = cluster->bNrChannels;
335 struct snd_pcm_chmap_elem *chmap;
336 void *p = cluster;
337 int len, c;
338
339 if (channels > ARRAY_SIZE(chmap->map))
340 return NULL;
341
342 chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
343 if (!chmap)
344 return NULL;
345
346 len = le16_to_cpu(cluster->wLength);
347 c = 0;
348 p += sizeof(struct uac3_cluster_header_descriptor);
349
350 while (((p - (void *)cluster) < len) && (c < channels)) {
351 struct uac3_cluster_segment_descriptor *cs_desc = p;
352 u16 cs_len;
353 u8 cs_type;
354
355 cs_len = le16_to_cpu(cs_desc->wLength);
356 cs_type = cs_desc->bSegmentType;
357
358 if (cs_type == UAC3_CHANNEL_INFORMATION) {
359 struct uac3_cluster_information_segment_descriptor *is = p;
360 unsigned char map;
361
362 /*
363 * TODO: this conversion is not complete, update it
364 * after adding UAC3 values to asound.h
365 */
366 switch (is->bChRelationship) {
367 case UAC3_CH_MONO:
368 map = SNDRV_CHMAP_MONO;
369 break;
370 case UAC3_CH_LEFT:
371 case UAC3_CH_FRONT_LEFT:
372 case UAC3_CH_HEADPHONE_LEFT:
373 map = SNDRV_CHMAP_FL;
374 break;
375 case UAC3_CH_RIGHT:
376 case UAC3_CH_FRONT_RIGHT:
377 case UAC3_CH_HEADPHONE_RIGHT:
378 map = SNDRV_CHMAP_FR;
379 break;
380 case UAC3_CH_FRONT_CENTER:
381 map = SNDRV_CHMAP_FC;
382 break;
383 case UAC3_CH_FRONT_LEFT_OF_CENTER:
384 map = SNDRV_CHMAP_FLC;
385 break;
386 case UAC3_CH_FRONT_RIGHT_OF_CENTER:
387 map = SNDRV_CHMAP_FRC;
388 break;
389 case UAC3_CH_SIDE_LEFT:
390 map = SNDRV_CHMAP_SL;
391 break;
392 case UAC3_CH_SIDE_RIGHT:
393 map = SNDRV_CHMAP_SR;
394 break;
395 case UAC3_CH_BACK_LEFT:
396 map = SNDRV_CHMAP_RL;
397 break;
398 case UAC3_CH_BACK_RIGHT:
399 map = SNDRV_CHMAP_RR;
400 break;
401 case UAC3_CH_BACK_CENTER:
402 map = SNDRV_CHMAP_RC;
403 break;
404 case UAC3_CH_BACK_LEFT_OF_CENTER:
405 map = SNDRV_CHMAP_RLC;
406 break;
407 case UAC3_CH_BACK_RIGHT_OF_CENTER:
408 map = SNDRV_CHMAP_RRC;
409 break;
410 case UAC3_CH_TOP_CENTER:
411 map = SNDRV_CHMAP_TC;
412 break;
413 case UAC3_CH_TOP_FRONT_LEFT:
414 map = SNDRV_CHMAP_TFL;
415 break;
416 case UAC3_CH_TOP_FRONT_RIGHT:
417 map = SNDRV_CHMAP_TFR;
418 break;
419 case UAC3_CH_TOP_FRONT_CENTER:
420 map = SNDRV_CHMAP_TFC;
421 break;
422 case UAC3_CH_TOP_FRONT_LOC:
423 map = SNDRV_CHMAP_TFLC;
424 break;
425 case UAC3_CH_TOP_FRONT_ROC:
426 map = SNDRV_CHMAP_TFRC;
427 break;
428 case UAC3_CH_TOP_SIDE_LEFT:
429 map = SNDRV_CHMAP_TSL;
430 break;
431 case UAC3_CH_TOP_SIDE_RIGHT:
432 map = SNDRV_CHMAP_TSR;
433 break;
434 case UAC3_CH_TOP_BACK_LEFT:
435 map = SNDRV_CHMAP_TRL;
436 break;
437 case UAC3_CH_TOP_BACK_RIGHT:
438 map = SNDRV_CHMAP_TRR;
439 break;
440 case UAC3_CH_TOP_BACK_CENTER:
441 map = SNDRV_CHMAP_TRC;
442 break;
443 case UAC3_CH_BOTTOM_CENTER:
444 map = SNDRV_CHMAP_BC;
445 break;
446 case UAC3_CH_LOW_FREQUENCY_EFFECTS:
447 map = SNDRV_CHMAP_LFE;
448 break;
449 case UAC3_CH_LFE_LEFT:
450 map = SNDRV_CHMAP_LLFE;
451 break;
452 case UAC3_CH_LFE_RIGHT:
453 map = SNDRV_CHMAP_RLFE;
454 break;
455 case UAC3_CH_RELATIONSHIP_UNDEFINED:
456 default:
457 map = SNDRV_CHMAP_UNKNOWN;
458 break;
459 }
460 chmap->map[c++] = map;
461 }
462 p += cs_len;
463 }
464
465 if (channels < c)
466 pr_err("%s: channel number mismatch\n", __func__);
467
468 chmap->channels = channels;
469
470 for (; c < channels; c++)
471 chmap->map[c] = SNDRV_CHMAP_UNKNOWN;
472
473 return chmap;
474 }
475
476 /*
477 * add this endpoint to the chip instance.
478 * if a stream with the same endpoint already exists, append to it.
479 * if not, create a new pcm stream. note, fp is added to the substream
480 * fmt_list and will be freed on the chip instance release. do not free
481 * fp or do remove it from the substream fmt_list to avoid double-free.
482 */
__snd_usb_add_audio_stream(struct snd_usb_audio * chip,int stream,struct audioformat * fp,struct snd_usb_power_domain * pd)483 static int __snd_usb_add_audio_stream(struct snd_usb_audio *chip,
484 int stream,
485 struct audioformat *fp,
486 struct snd_usb_power_domain *pd)
487
488 {
489 struct snd_usb_stream *as;
490 struct snd_usb_substream *subs;
491 struct snd_pcm *pcm;
492 int err;
493
494 list_for_each_entry(as, &chip->pcm_list, list) {
495 if (as->fmt_type != fp->fmt_type)
496 continue;
497 subs = &as->substream[stream];
498 if (subs->ep_num == fp->endpoint) {
499 list_add_tail(&fp->list, &subs->fmt_list);
500 subs->num_formats++;
501 subs->formats |= fp->formats;
502 return 0;
503 }
504 }
505 /* look for an empty stream */
506 list_for_each_entry(as, &chip->pcm_list, list) {
507 if (as->fmt_type != fp->fmt_type)
508 continue;
509 subs = &as->substream[stream];
510 if (subs->ep_num)
511 continue;
512 err = snd_pcm_new_stream(as->pcm, stream, 1);
513 if (err < 0)
514 return err;
515 snd_usb_init_substream(as, stream, fp, pd);
516 return add_chmap(as->pcm, stream, subs);
517 }
518
519 /* create a new pcm */
520 as = kzalloc(sizeof(*as), GFP_KERNEL);
521 if (!as)
522 return -ENOMEM;
523 as->pcm_index = chip->pcm_devs;
524 as->chip = chip;
525 as->fmt_type = fp->fmt_type;
526 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
527 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
528 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
529 &pcm);
530 if (err < 0) {
531 kfree(as);
532 return err;
533 }
534 as->pcm = pcm;
535 pcm->private_data = as;
536 pcm->private_free = snd_usb_audio_pcm_free;
537 pcm->info_flags = 0;
538 if (chip->pcm_devs > 0)
539 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
540 else
541 strcpy(pcm->name, "USB Audio");
542
543 snd_usb_init_substream(as, stream, fp, pd);
544
545 /*
546 * Keep using head insertion for M-Audio Audiophile USB (tm) which has a
547 * fix to swap capture stream order in conf/cards/USB-audio.conf
548 */
549 if (chip->usb_id == USB_ID(0x0763, 0x2003))
550 list_add(&as->list, &chip->pcm_list);
551 else
552 list_add_tail(&as->list, &chip->pcm_list);
553
554 chip->pcm_devs++;
555
556 snd_usb_proc_pcm_format_add(as);
557
558 return add_chmap(pcm, stream, &as->substream[stream]);
559 }
560
snd_usb_add_audio_stream(struct snd_usb_audio * chip,int stream,struct audioformat * fp)561 int snd_usb_add_audio_stream(struct snd_usb_audio *chip,
562 int stream,
563 struct audioformat *fp)
564 {
565 return __snd_usb_add_audio_stream(chip, stream, fp, NULL);
566 }
567
snd_usb_add_audio_stream_v3(struct snd_usb_audio * chip,int stream,struct audioformat * fp,struct snd_usb_power_domain * pd)568 static int snd_usb_add_audio_stream_v3(struct snd_usb_audio *chip,
569 int stream,
570 struct audioformat *fp,
571 struct snd_usb_power_domain *pd)
572 {
573 return __snd_usb_add_audio_stream(chip, stream, fp, pd);
574 }
575
parse_uac_endpoint_attributes(struct snd_usb_audio * chip,struct usb_host_interface * alts,int protocol,int iface_no)576 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
577 struct usb_host_interface *alts,
578 int protocol, int iface_no)
579 {
580 /* parsed with a v1 header here. that's ok as we only look at the
581 * header first which is the same for both versions */
582 struct uac_iso_endpoint_descriptor *csep;
583 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
584 int attributes = 0;
585
586 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
587
588 /* Creamware Noah has this descriptor after the 2nd endpoint */
589 if (!csep && altsd->bNumEndpoints >= 2)
590 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
591
592 /*
593 * If we can't locate the USB_DT_CS_ENDPOINT descriptor in the extra
594 * bytes after the first endpoint, go search the entire interface.
595 * Some devices have it directly *before* the standard endpoint.
596 */
597 if (!csep)
598 csep = snd_usb_find_desc(alts->extra, alts->extralen, NULL, USB_DT_CS_ENDPOINT);
599
600 if (!csep || csep->bLength < 7 ||
601 csep->bDescriptorSubtype != UAC_EP_GENERAL)
602 goto error;
603
604 if (protocol == UAC_VERSION_1) {
605 attributes = csep->bmAttributes;
606 } else if (protocol == UAC_VERSION_2) {
607 struct uac2_iso_endpoint_descriptor *csep2 =
608 (struct uac2_iso_endpoint_descriptor *) csep;
609
610 if (csep2->bLength < sizeof(*csep2))
611 goto error;
612 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
613
614 /* emulate the endpoint attributes of a v1 device */
615 if (csep2->bmControls & UAC2_CONTROL_PITCH)
616 attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
617 } else { /* UAC_VERSION_3 */
618 struct uac3_iso_endpoint_descriptor *csep3 =
619 (struct uac3_iso_endpoint_descriptor *) csep;
620
621 if (csep3->bLength < sizeof(*csep3))
622 goto error;
623 /* emulate the endpoint attributes of a v1 device */
624 if (le32_to_cpu(csep3->bmControls) & UAC2_CONTROL_PITCH)
625 attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
626 }
627
628 return attributes;
629
630 error:
631 usb_audio_warn(chip,
632 "%u:%d : no or invalid class specific endpoint descriptor\n",
633 iface_no, altsd->bAlternateSetting);
634 return 0;
635 }
636
637 /* find an input terminal descriptor (either UAC1 or UAC2) with the given
638 * terminal id
639 */
640 static void *
snd_usb_find_input_terminal_descriptor(struct usb_host_interface * ctrl_iface,int terminal_id,int protocol)641 snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface,
642 int terminal_id, int protocol)
643 {
644 struct uac2_input_terminal_descriptor *term = NULL;
645
646 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
647 ctrl_iface->extralen,
648 term, UAC_INPUT_TERMINAL))) {
649 if (!snd_usb_validate_audio_desc(term, protocol))
650 continue;
651 if (term->bTerminalID == terminal_id)
652 return term;
653 }
654
655 return NULL;
656 }
657
658 static void *
snd_usb_find_output_terminal_descriptor(struct usb_host_interface * ctrl_iface,int terminal_id,int protocol)659 snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface,
660 int terminal_id, int protocol)
661 {
662 /* OK to use with both UAC2 and UAC3 */
663 struct uac2_output_terminal_descriptor *term = NULL;
664
665 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
666 ctrl_iface->extralen,
667 term, UAC_OUTPUT_TERMINAL))) {
668 if (!snd_usb_validate_audio_desc(term, protocol))
669 continue;
670 if (term->bTerminalID == terminal_id)
671 return term;
672 }
673
674 return NULL;
675 }
676
677 static struct audioformat *
audio_format_alloc_init(struct snd_usb_audio * chip,struct usb_host_interface * alts,int protocol,int iface_no,int altset_idx,int altno,int num_channels,int clock)678 audio_format_alloc_init(struct snd_usb_audio *chip,
679 struct usb_host_interface *alts,
680 int protocol, int iface_no, int altset_idx,
681 int altno, int num_channels, int clock)
682 {
683 struct audioformat *fp;
684
685 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
686 if (!fp)
687 return NULL;
688
689 fp->iface = iface_no;
690 fp->altsetting = altno;
691 fp->altset_idx = altset_idx;
692 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
693 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
694 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
695 fp->protocol = protocol;
696 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
697 fp->channels = num_channels;
698 if (snd_usb_get_speed(chip->dev) == USB_SPEED_HIGH)
699 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
700 * (fp->maxpacksize & 0x7ff);
701 fp->clock = clock;
702 INIT_LIST_HEAD(&fp->list);
703
704 return fp;
705 }
706
707 static struct audioformat *
snd_usb_get_audioformat_uac12(struct snd_usb_audio * chip,struct usb_host_interface * alts,int protocol,int iface_no,int altset_idx,int altno,int stream,int bm_quirk)708 snd_usb_get_audioformat_uac12(struct snd_usb_audio *chip,
709 struct usb_host_interface *alts,
710 int protocol, int iface_no, int altset_idx,
711 int altno, int stream, int bm_quirk)
712 {
713 struct usb_device *dev = chip->dev;
714 struct uac_format_type_i_continuous_descriptor *fmt;
715 unsigned int num_channels = 0, chconfig = 0;
716 struct audioformat *fp;
717 int clock = 0;
718 u64 format;
719
720 /* get audio formats */
721 if (protocol == UAC_VERSION_1) {
722 struct uac1_as_header_descriptor *as =
723 snd_usb_find_csint_desc(alts->extra, alts->extralen,
724 NULL, UAC_AS_GENERAL);
725 struct uac_input_terminal_descriptor *iterm;
726
727 if (!as) {
728 dev_err(&dev->dev,
729 "%u:%d : UAC_AS_GENERAL descriptor not found\n",
730 iface_no, altno);
731 return NULL;
732 }
733
734 if (as->bLength < sizeof(*as)) {
735 dev_err(&dev->dev,
736 "%u:%d : invalid UAC_AS_GENERAL desc\n",
737 iface_no, altno);
738 return NULL;
739 }
740
741 format = le16_to_cpu(as->wFormatTag); /* remember the format value */
742
743 iterm = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
744 as->bTerminalLink,
745 protocol);
746 if (iterm) {
747 num_channels = iterm->bNrChannels;
748 chconfig = le16_to_cpu(iterm->wChannelConfig);
749 }
750 } else { /* UAC_VERSION_2 */
751 struct uac2_input_terminal_descriptor *input_term;
752 struct uac2_output_terminal_descriptor *output_term;
753 struct uac2_as_header_descriptor *as =
754 snd_usb_find_csint_desc(alts->extra, alts->extralen,
755 NULL, UAC_AS_GENERAL);
756
757 if (!as) {
758 dev_err(&dev->dev,
759 "%u:%d : UAC_AS_GENERAL descriptor not found\n",
760 iface_no, altno);
761 return NULL;
762 }
763
764 if (as->bLength < sizeof(*as)) {
765 dev_err(&dev->dev,
766 "%u:%d : invalid UAC_AS_GENERAL desc\n",
767 iface_no, altno);
768 return NULL;
769 }
770
771 num_channels = as->bNrChannels;
772 format = le32_to_cpu(as->bmFormats);
773 chconfig = le32_to_cpu(as->bmChannelConfig);
774
775 /*
776 * lookup the terminal associated to this interface
777 * to extract the clock
778 */
779 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
780 as->bTerminalLink,
781 protocol);
782 if (input_term) {
783 clock = input_term->bCSourceID;
784 if (!chconfig && (num_channels == input_term->bNrChannels))
785 chconfig = le32_to_cpu(input_term->bmChannelConfig);
786 goto found_clock;
787 }
788
789 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
790 as->bTerminalLink,
791 protocol);
792 if (output_term) {
793 clock = output_term->bCSourceID;
794 goto found_clock;
795 }
796
797 dev_err(&dev->dev,
798 "%u:%d : bogus bTerminalLink %d\n",
799 iface_no, altno, as->bTerminalLink);
800 return NULL;
801 }
802
803 found_clock:
804 /* get format type */
805 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
806 NULL, UAC_FORMAT_TYPE);
807 if (!fmt) {
808 dev_err(&dev->dev,
809 "%u:%d : no UAC_FORMAT_TYPE desc\n",
810 iface_no, altno);
811 return NULL;
812 }
813 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8))
814 || ((protocol == UAC_VERSION_2) &&
815 (fmt->bLength < 6))) {
816 dev_err(&dev->dev,
817 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
818 iface_no, altno);
819 return NULL;
820 }
821
822 /*
823 * Blue Microphones workaround: The last altsetting is
824 * identical with the previous one, except for a larger
825 * packet size, but is actually a mislabeled two-channel
826 * setting; ignore it.
827 *
828 * Part 2: analyze quirk flag and format
829 */
830 if (bm_quirk && fmt->bNrChannels == 1 && fmt->bSubframeSize == 2)
831 return NULL;
832
833 fp = audio_format_alloc_init(chip, alts, protocol, iface_no,
834 altset_idx, altno, num_channels, clock);
835 if (!fp)
836 return ERR_PTR(-ENOMEM);
837
838 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol,
839 iface_no);
840
841 /* some quirks for attributes here */
842 snd_usb_audioformat_attributes_quirk(chip, fp, stream);
843
844 /* ok, let's parse further... */
845 if (snd_usb_parse_audio_format(chip, fp, format,
846 fmt, stream) < 0) {
847 audioformat_free(fp);
848 return NULL;
849 }
850
851 /* Create chmap */
852 if (fp->channels != num_channels)
853 chconfig = 0;
854
855 fp->chmap = convert_chmap(fp->channels, chconfig, protocol);
856
857 return fp;
858 }
859
860 static struct audioformat *
snd_usb_get_audioformat_uac3(struct snd_usb_audio * chip,struct usb_host_interface * alts,struct snd_usb_power_domain ** pd_out,int iface_no,int altset_idx,int altno,int stream)861 snd_usb_get_audioformat_uac3(struct snd_usb_audio *chip,
862 struct usb_host_interface *alts,
863 struct snd_usb_power_domain **pd_out,
864 int iface_no, int altset_idx,
865 int altno, int stream)
866 {
867 struct usb_device *dev = chip->dev;
868 struct uac3_input_terminal_descriptor *input_term;
869 struct uac3_output_terminal_descriptor *output_term;
870 struct uac3_cluster_header_descriptor *cluster;
871 struct uac3_as_header_descriptor *as = NULL;
872 struct uac3_hc_descriptor_header hc_header;
873 struct snd_pcm_chmap_elem *chmap;
874 struct snd_usb_power_domain *pd;
875 unsigned char badd_profile;
876 u64 badd_formats = 0;
877 unsigned int num_channels;
878 struct audioformat *fp;
879 u16 cluster_id, wLength;
880 int clock = 0;
881 int err;
882
883 badd_profile = chip->badd_profile;
884
885 if (badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
886 unsigned int maxpacksize =
887 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
888
889 switch (maxpacksize) {
890 default:
891 dev_err(&dev->dev,
892 "%u:%d : incorrect wMaxPacketSize for BADD profile\n",
893 iface_no, altno);
894 return NULL;
895 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
896 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
897 badd_formats = SNDRV_PCM_FMTBIT_S16_LE;
898 num_channels = 1;
899 break;
900 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
901 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
902 badd_formats = SNDRV_PCM_FMTBIT_S24_3LE;
903 num_channels = 1;
904 break;
905 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
906 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
907 badd_formats = SNDRV_PCM_FMTBIT_S16_LE;
908 num_channels = 2;
909 break;
910 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
911 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
912 badd_formats = SNDRV_PCM_FMTBIT_S24_3LE;
913 num_channels = 2;
914 break;
915 }
916
917 chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
918 if (!chmap)
919 return ERR_PTR(-ENOMEM);
920
921 if (num_channels == 1) {
922 chmap->map[0] = SNDRV_CHMAP_MONO;
923 } else {
924 chmap->map[0] = SNDRV_CHMAP_FL;
925 chmap->map[1] = SNDRV_CHMAP_FR;
926 }
927
928 chmap->channels = num_channels;
929 clock = UAC3_BADD_CS_ID9;
930 goto found_clock;
931 }
932
933 as = snd_usb_find_csint_desc(alts->extra, alts->extralen,
934 NULL, UAC_AS_GENERAL);
935 if (!as) {
936 dev_err(&dev->dev,
937 "%u:%d : UAC_AS_GENERAL descriptor not found\n",
938 iface_no, altno);
939 return NULL;
940 }
941
942 if (as->bLength < sizeof(*as)) {
943 dev_err(&dev->dev,
944 "%u:%d : invalid UAC_AS_GENERAL desc\n",
945 iface_no, altno);
946 return NULL;
947 }
948
949 cluster_id = le16_to_cpu(as->wClusterDescrID);
950 if (!cluster_id) {
951 dev_err(&dev->dev,
952 "%u:%d : no cluster descriptor\n",
953 iface_no, altno);
954 return NULL;
955 }
956
957 /*
958 * Get number of channels and channel map through
959 * High Capability Cluster Descriptor
960 *
961 * First step: get High Capability header and
962 * read size of Cluster Descriptor
963 */
964 err = snd_usb_ctl_msg(chip->dev,
965 usb_rcvctrlpipe(chip->dev, 0),
966 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
967 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
968 cluster_id,
969 snd_usb_ctrl_intf(chip),
970 &hc_header, sizeof(hc_header));
971 if (err < 0)
972 return ERR_PTR(err);
973 else if (err != sizeof(hc_header)) {
974 dev_err(&dev->dev,
975 "%u:%d : can't get High Capability descriptor\n",
976 iface_no, altno);
977 return ERR_PTR(-EIO);
978 }
979
980 /*
981 * Second step: allocate needed amount of memory
982 * and request Cluster Descriptor
983 */
984 wLength = le16_to_cpu(hc_header.wLength);
985 cluster = kzalloc(wLength, GFP_KERNEL);
986 if (!cluster)
987 return ERR_PTR(-ENOMEM);
988 err = snd_usb_ctl_msg(chip->dev,
989 usb_rcvctrlpipe(chip->dev, 0),
990 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
991 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
992 cluster_id,
993 snd_usb_ctrl_intf(chip),
994 cluster, wLength);
995 if (err < 0) {
996 kfree(cluster);
997 return ERR_PTR(err);
998 } else if (err != wLength) {
999 dev_err(&dev->dev,
1000 "%u:%d : can't get Cluster Descriptor\n",
1001 iface_no, altno);
1002 kfree(cluster);
1003 return ERR_PTR(-EIO);
1004 }
1005
1006 num_channels = cluster->bNrChannels;
1007 chmap = convert_chmap_v3(cluster);
1008 kfree(cluster);
1009
1010 /*
1011 * lookup the terminal associated to this interface
1012 * to extract the clock
1013 */
1014 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
1015 as->bTerminalLink,
1016 UAC_VERSION_3);
1017 if (input_term) {
1018 clock = input_term->bCSourceID;
1019 goto found_clock;
1020 }
1021
1022 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
1023 as->bTerminalLink,
1024 UAC_VERSION_3);
1025 if (output_term) {
1026 clock = output_term->bCSourceID;
1027 goto found_clock;
1028 }
1029
1030 dev_err(&dev->dev, "%u:%d : bogus bTerminalLink %d\n",
1031 iface_no, altno, as->bTerminalLink);
1032 kfree(chmap);
1033 return NULL;
1034
1035 found_clock:
1036 fp = audio_format_alloc_init(chip, alts, UAC_VERSION_3, iface_no,
1037 altset_idx, altno, num_channels, clock);
1038 if (!fp) {
1039 kfree(chmap);
1040 return ERR_PTR(-ENOMEM);
1041 }
1042
1043 fp->chmap = chmap;
1044
1045 if (badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
1046 fp->attributes = 0; /* No attributes */
1047
1048 fp->fmt_type = UAC_FORMAT_TYPE_I;
1049 fp->formats = badd_formats;
1050
1051 fp->nr_rates = 0; /* SNDRV_PCM_RATE_CONTINUOUS */
1052 fp->rate_min = UAC3_BADD_SAMPLING_RATE;
1053 fp->rate_max = UAC3_BADD_SAMPLING_RATE;
1054 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
1055
1056 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
1057 if (!pd) {
1058 audioformat_free(fp);
1059 return NULL;
1060 }
1061 pd->pd_id = (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
1062 UAC3_BADD_PD_ID10 : UAC3_BADD_PD_ID11;
1063 pd->pd_d1d0_rec = UAC3_BADD_PD_RECOVER_D1D0;
1064 pd->pd_d2d0_rec = UAC3_BADD_PD_RECOVER_D2D0;
1065
1066 } else {
1067 fp->attributes = parse_uac_endpoint_attributes(chip, alts,
1068 UAC_VERSION_3,
1069 iface_no);
1070
1071 pd = snd_usb_find_power_domain(chip->ctrl_intf,
1072 as->bTerminalLink);
1073
1074 /* ok, let's parse further... */
1075 if (snd_usb_parse_audio_format_v3(chip, fp, as, stream) < 0) {
1076 kfree(pd);
1077 audioformat_free(fp);
1078 return NULL;
1079 }
1080 }
1081
1082 if (pd)
1083 *pd_out = pd;
1084
1085 return fp;
1086 }
1087
__snd_usb_parse_audio_interface(struct snd_usb_audio * chip,int iface_no,bool * has_non_pcm,bool non_pcm)1088 static int __snd_usb_parse_audio_interface(struct snd_usb_audio *chip,
1089 int iface_no,
1090 bool *has_non_pcm, bool non_pcm)
1091 {
1092 struct usb_device *dev;
1093 struct usb_interface *iface;
1094 struct usb_host_interface *alts;
1095 struct usb_interface_descriptor *altsd;
1096 int i, altno, err, stream;
1097 struct audioformat *fp = NULL;
1098 struct snd_usb_power_domain *pd = NULL;
1099 int num, protocol;
1100
1101 dev = chip->dev;
1102
1103 /* parse the interface's altsettings */
1104 iface = usb_ifnum_to_if(dev, iface_no);
1105
1106 num = iface->num_altsetting;
1107
1108 /*
1109 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
1110 * one misses syncpipe, and does not produce any sound.
1111 */
1112 if (chip->usb_id == USB_ID(0x04fa, 0x4201) && num >= 4)
1113 num = 4;
1114
1115 for (i = 0; i < num; i++) {
1116 alts = &iface->altsetting[i];
1117 altsd = get_iface_desc(alts);
1118 protocol = altsd->bInterfaceProtocol;
1119 /* skip invalid one */
1120 if (((altsd->bInterfaceClass != USB_CLASS_AUDIO ||
1121 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
1122 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC)) &&
1123 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
1124 altsd->bNumEndpoints < 1 ||
1125 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
1126 continue;
1127 /* must be isochronous */
1128 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1129 USB_ENDPOINT_XFER_ISOC)
1130 continue;
1131 /* check direction */
1132 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
1133 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
1134 altno = altsd->bAlternateSetting;
1135
1136 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
1137 continue;
1138
1139 /*
1140 * Roland audio streaming interfaces are marked with protocols
1141 * 0/1/2, but are UAC 1 compatible.
1142 */
1143 if (USB_ID_VENDOR(chip->usb_id) == 0x0582 &&
1144 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
1145 protocol <= 2)
1146 protocol = UAC_VERSION_1;
1147
1148 switch (protocol) {
1149 default:
1150 dev_dbg(&dev->dev, "%u:%d: unknown interface protocol %#02x, assuming v1\n",
1151 iface_no, altno, protocol);
1152 protocol = UAC_VERSION_1;
1153 /* fall through */
1154 case UAC_VERSION_1:
1155 /* fall through */
1156 case UAC_VERSION_2: {
1157 int bm_quirk = 0;
1158
1159 /*
1160 * Blue Microphones workaround: The last altsetting is
1161 * identical with the previous one, except for a larger
1162 * packet size, but is actually a mislabeled two-channel
1163 * setting; ignore it.
1164 *
1165 * Part 1: prepare quirk flag
1166 */
1167 if (altno == 2 && num == 3 &&
1168 fp && fp->altsetting == 1 && fp->channels == 1 &&
1169 fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
1170 protocol == UAC_VERSION_1 &&
1171 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
1172 fp->maxpacksize * 2)
1173 bm_quirk = 1;
1174
1175 fp = snd_usb_get_audioformat_uac12(chip, alts, protocol,
1176 iface_no, i, altno,
1177 stream, bm_quirk);
1178 break;
1179 }
1180 case UAC_VERSION_3:
1181 fp = snd_usb_get_audioformat_uac3(chip, alts, &pd,
1182 iface_no, i, altno, stream);
1183 break;
1184 }
1185
1186 if (!fp)
1187 continue;
1188 else if (IS_ERR(fp))
1189 return PTR_ERR(fp);
1190
1191 if (fp->fmt_type != UAC_FORMAT_TYPE_I)
1192 *has_non_pcm = true;
1193 if ((fp->fmt_type == UAC_FORMAT_TYPE_I) == non_pcm) {
1194 audioformat_free(fp);
1195 kfree(pd);
1196 fp = NULL;
1197 pd = NULL;
1198 continue;
1199 }
1200
1201 dev_dbg(&dev->dev, "%u:%d: add audio endpoint %#x\n", iface_no, altno, fp->endpoint);
1202 if (protocol == UAC_VERSION_3)
1203 err = snd_usb_add_audio_stream_v3(chip, stream, fp, pd);
1204 else
1205 err = snd_usb_add_audio_stream(chip, stream, fp);
1206
1207 if (err < 0) {
1208 audioformat_free(fp);
1209 kfree(pd);
1210 return err;
1211 }
1212 /* try to set the interface... */
1213 usb_set_interface(chip->dev, iface_no, altno);
1214 snd_usb_init_pitch(chip, iface_no, alts, fp);
1215 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);
1216 }
1217 return 0;
1218 }
1219
snd_usb_parse_audio_interface(struct snd_usb_audio * chip,int iface_no)1220 int snd_usb_parse_audio_interface(struct snd_usb_audio *chip, int iface_no)
1221 {
1222 int err;
1223 bool has_non_pcm = false;
1224
1225 /* parse PCM formats */
1226 err = __snd_usb_parse_audio_interface(chip, iface_no, &has_non_pcm, false);
1227 if (err < 0)
1228 return err;
1229
1230 if (has_non_pcm) {
1231 /* parse non-PCM formats */
1232 err = __snd_usb_parse_audio_interface(chip, iface_no, &has_non_pcm, true);
1233 if (err < 0)
1234 return err;
1235 }
1236
1237 return 0;
1238 }
1239
1240