1 /*
2  * bebob_stream.c - a part of driver for BeBoB based devices
3  *
4  * Copyright (c) 2013-2014 Takashi Sakamoto
5  *
6  * Licensed under the terms of the GNU General Public License, version 2.
7  */
8 
9 #include "./bebob.h"
10 
11 #define CALLBACK_TIMEOUT	2000
12 #define FW_ISO_RESOURCE_DELAY	1000
13 
14 /*
15  * NOTE;
16  * For BeBoB streams, Both of input and output CMP connection are important.
17  *
18  * For most devices, each CMP connection starts to transmit/receive a
19  * corresponding stream. But for a few devices, both of CMP connection needs
20  * to start transmitting stream. An example is 'M-Audio Firewire 410'.
21  */
22 
23 /* 128 is an arbitrary length but it seems to be enough */
24 #define FORMAT_MAXIMUM_LENGTH 128
25 
26 const unsigned int snd_bebob_rate_table[SND_BEBOB_STRM_FMT_ENTRIES] = {
27 	[0] = 32000,
28 	[1] = 44100,
29 	[2] = 48000,
30 	[3] = 88200,
31 	[4] = 96000,
32 	[5] = 176400,
33 	[6] = 192000,
34 };
35 
36 /*
37  * See: Table 51: Extended Stream Format Info ‘Sampling Frequency’
38  * in Additional AVC commands (Nov 2003, BridgeCo)
39  */
40 static const unsigned int bridgeco_freq_table[] = {
41 	[0] = 0x02,
42 	[1] = 0x03,
43 	[2] = 0x04,
44 	[3] = 0x0a,
45 	[4] = 0x05,
46 	[5] = 0x06,
47 	[6] = 0x07,
48 };
49 
50 static int
51 get_formation_index(unsigned int rate, unsigned int *index)
52 {
53 	unsigned int i;
54 
55 	for (i = 0; i < ARRAY_SIZE(snd_bebob_rate_table); i++) {
56 		if (snd_bebob_rate_table[i] == rate) {
57 			*index = i;
58 			return 0;
59 		}
60 	}
61 	return -EINVAL;
62 }
63 
64 int
65 snd_bebob_stream_get_rate(struct snd_bebob *bebob, unsigned int *curr_rate)
66 {
67 	unsigned int tx_rate, rx_rate, trials;
68 	int err;
69 
70 	trials = 0;
71 	do {
72 		err = avc_general_get_sig_fmt(bebob->unit, &tx_rate,
73 					      AVC_GENERAL_PLUG_DIR_OUT, 0);
74 	} while (err == -EAGAIN && ++trials < 3);
75 	if (err < 0)
76 		goto end;
77 
78 	trials = 0;
79 	do {
80 		err = avc_general_get_sig_fmt(bebob->unit, &rx_rate,
81 					      AVC_GENERAL_PLUG_DIR_IN, 0);
82 	} while (err == -EAGAIN && ++trials < 3);
83 	if (err < 0)
84 		goto end;
85 
86 	*curr_rate = rx_rate;
87 	if (rx_rate == tx_rate)
88 		goto end;
89 
90 	/* synchronize receive stream rate to transmit stream rate */
91 	err = avc_general_set_sig_fmt(bebob->unit, rx_rate,
92 				      AVC_GENERAL_PLUG_DIR_IN, 0);
93 end:
94 	return err;
95 }
96 
97 int
98 snd_bebob_stream_set_rate(struct snd_bebob *bebob, unsigned int rate)
99 {
100 	int err;
101 
102 	err = avc_general_set_sig_fmt(bebob->unit, rate,
103 				      AVC_GENERAL_PLUG_DIR_OUT, 0);
104 	if (err < 0)
105 		goto end;
106 
107 	err = avc_general_set_sig_fmt(bebob->unit, rate,
108 				      AVC_GENERAL_PLUG_DIR_IN, 0);
109 	if (err < 0)
110 		goto end;
111 
112 	/*
113 	 * Some devices need a bit time for transition.
114 	 * 300msec is got by some experiments.
115 	 */
116 	msleep(300);
117 end:
118 	return err;
119 }
120 
121 int snd_bebob_stream_get_clock_src(struct snd_bebob *bebob,
122 				   enum snd_bebob_clock_type *src)
123 {
124 	const struct snd_bebob_clock_spec *clk_spec = bebob->spec->clock;
125 	u8 addr[AVC_BRIDGECO_ADDR_BYTES], input[7];
126 	unsigned int id;
127 	enum avc_bridgeco_plug_type type;
128 	int err = 0;
129 
130 	/* 1.The device has its own operation to switch source of clock */
131 	if (clk_spec) {
132 		err = clk_spec->get(bebob, &id);
133 		if (err < 0) {
134 			dev_err(&bebob->unit->device,
135 				"fail to get clock source: %d\n", err);
136 			goto end;
137 		}
138 
139 		if (id >= clk_spec->num) {
140 			dev_err(&bebob->unit->device,
141 				"clock source %d out of range 0..%d\n",
142 				id, clk_spec->num - 1);
143 			err = -EIO;
144 			goto end;
145 		}
146 
147 		*src = clk_spec->types[id];
148 		goto end;
149 	}
150 
151 	/*
152 	 * 2.The device don't support to switch source of clock then assumed
153 	 *   to use internal clock always
154 	 */
155 	if (bebob->sync_input_plug < 0) {
156 		*src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
157 		goto end;
158 	}
159 
160 	/*
161 	 * 3.The device supports to switch source of clock by an usual way.
162 	 *   Let's check input for 'Music Sub Unit Sync Input' plug.
163 	 */
164 	avc_bridgeco_fill_msu_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
165 				   bebob->sync_input_plug);
166 	err = avc_bridgeco_get_plug_input(bebob->unit, addr, input);
167 	if (err < 0) {
168 		dev_err(&bebob->unit->device,
169 			"fail to get an input for MSU in plug %d: %d\n",
170 			bebob->sync_input_plug, err);
171 		goto end;
172 	}
173 
174 	/*
175 	 * If there are no input plugs, all of fields are 0xff.
176 	 * Here check the first field. This field is used for direction.
177 	 */
178 	if (input[0] == 0xff) {
179 		*src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
180 		goto end;
181 	}
182 
183 	/* The source from any output plugs is for one purpose only. */
184 	if (input[0] == AVC_BRIDGECO_PLUG_DIR_OUT) {
185 		/*
186 		 * In BeBoB architecture, the source from music subunit may
187 		 * bypass from oPCR[0]. This means that this source gives
188 		 * synchronization to IEEE 1394 cycle start packet.
189 		 */
190 		if (input[1] == AVC_BRIDGECO_PLUG_MODE_SUBUNIT &&
191 		    input[2] == 0x0c) {
192 			*src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
193 			goto end;
194 		}
195 	/* The source from any input units is for several purposes. */
196 	} else if (input[1] == AVC_BRIDGECO_PLUG_MODE_UNIT) {
197 		if (input[2] == AVC_BRIDGECO_PLUG_UNIT_ISOC) {
198 			if (input[3] == 0x00) {
199 				/*
200 				 * This source comes from iPCR[0]. This means
201 				 * that presentation timestamp calculated by
202 				 * SYT series of the received packets. In
203 				 * short, this driver is the master of
204 				 * synchronization.
205 				 */
206 				*src = SND_BEBOB_CLOCK_TYPE_SYT;
207 				goto end;
208 			} else {
209 				/*
210 				 * This source comes from iPCR[1-29]. This
211 				 * means that the synchronization stream is not
212 				 * the Audio/MIDI compound stream.
213 				 */
214 				*src = SND_BEBOB_CLOCK_TYPE_EXTERNAL;
215 				goto end;
216 			}
217 		} else if (input[2] == AVC_BRIDGECO_PLUG_UNIT_EXT) {
218 			/* Check type of this plug.  */
219 			avc_bridgeco_fill_unit_addr(addr,
220 						    AVC_BRIDGECO_PLUG_DIR_IN,
221 						    AVC_BRIDGECO_PLUG_UNIT_EXT,
222 						    input[3]);
223 			err = avc_bridgeco_get_plug_type(bebob->unit, addr,
224 							 &type);
225 			if (err < 0)
226 				goto end;
227 
228 			if (type == AVC_BRIDGECO_PLUG_TYPE_DIG) {
229 				/*
230 				 * SPDIF/ADAT or sometimes (not always) word
231 				 * clock.
232 				 */
233 				*src = SND_BEBOB_CLOCK_TYPE_EXTERNAL;
234 				goto end;
235 			} else if (type == AVC_BRIDGECO_PLUG_TYPE_SYNC) {
236 				/* Often word clock. */
237 				*src = SND_BEBOB_CLOCK_TYPE_EXTERNAL;
238 				goto end;
239 			} else if (type == AVC_BRIDGECO_PLUG_TYPE_ADDITION) {
240 				/*
241 				 * Not standard.
242 				 * Mostly, additional internal clock.
243 				 */
244 				*src = SND_BEBOB_CLOCK_TYPE_INTERNAL;
245 				goto end;
246 			}
247 		}
248 	}
249 
250 	/* Not supported. */
251 	err = -EIO;
252 end:
253 	return err;
254 }
255 
256 static unsigned int
257 map_data_channels(struct snd_bebob *bebob, struct amdtp_stream *s)
258 {
259 	unsigned int sec, sections, ch, channels;
260 	unsigned int pcm, midi, location;
261 	unsigned int stm_pos, sec_loc, pos;
262 	u8 *buf, addr[AVC_BRIDGECO_ADDR_BYTES], type;
263 	enum avc_bridgeco_plug_dir dir;
264 	int err;
265 
266 	/*
267 	 * The length of return value of this command cannot be expected. Here
268 	 * use the maximum length of FCP.
269 	 */
270 	buf = kzalloc(256, GFP_KERNEL);
271 	if (buf == NULL)
272 		return -ENOMEM;
273 
274 	if (s == &bebob->tx_stream)
275 		dir = AVC_BRIDGECO_PLUG_DIR_OUT;
276 	else
277 		dir = AVC_BRIDGECO_PLUG_DIR_IN;
278 
279 	avc_bridgeco_fill_unit_addr(addr, dir, AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
280 	err = avc_bridgeco_get_plug_ch_pos(bebob->unit, addr, buf, 256);
281 	if (err < 0) {
282 		dev_err(&bebob->unit->device,
283 			"fail to get channel position for isoc %s plug 0: %d\n",
284 			(dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" : "out",
285 			err);
286 		goto end;
287 	}
288 	pos = 0;
289 
290 	/* positions in I/O buffer */
291 	pcm = 0;
292 	midi = 0;
293 
294 	/* the number of sections in AMDTP packet */
295 	sections = buf[pos++];
296 
297 	for (sec = 0; sec < sections; sec++) {
298 		/* type of this section */
299 		avc_bridgeco_fill_unit_addr(addr, dir,
300 					    AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
301 		err = avc_bridgeco_get_plug_section_type(bebob->unit, addr,
302 							 sec, &type);
303 		if (err < 0) {
304 			dev_err(&bebob->unit->device,
305 			"fail to get section type for isoc %s plug 0: %d\n",
306 				(dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" :
307 								    "out",
308 				err);
309 			goto end;
310 		}
311 		/* NoType */
312 		if (type == 0xff) {
313 			err = -ENOSYS;
314 			goto end;
315 		}
316 
317 		/* the number of channels in this section */
318 		channels = buf[pos++];
319 
320 		for (ch = 0; ch < channels; ch++) {
321 			/* position of this channel in AMDTP packet */
322 			stm_pos = buf[pos++] - 1;
323 			/* location of this channel in this section */
324 			sec_loc = buf[pos++] - 1;
325 
326 			/*
327 			 * Basically the number of location is within the
328 			 * number of channels in this section. But some models
329 			 * of M-Audio don't follow this. Its location for MIDI
330 			 * is the position of MIDI channels in AMDTP packet.
331 			 */
332 			if (sec_loc >= channels)
333 				sec_loc = ch;
334 
335 			switch (type) {
336 			/* for MIDI conformant data channel */
337 			case 0x0a:
338 				/* AMDTP_MAX_CHANNELS_FOR_MIDI is 1. */
339 				if ((midi > 0) && (stm_pos != midi)) {
340 					err = -ENOSYS;
341 					goto end;
342 				}
343 				amdtp_am824_set_midi_position(s, stm_pos);
344 				midi = stm_pos;
345 				break;
346 			/* for PCM data channel */
347 			case 0x01:	/* Headphone */
348 			case 0x02:	/* Microphone */
349 			case 0x03:	/* Line */
350 			case 0x04:	/* SPDIF */
351 			case 0x05:	/* ADAT */
352 			case 0x06:	/* TDIF */
353 			case 0x07:	/* MADI */
354 			/* for undefined/changeable signal  */
355 			case 0x08:	/* Analog */
356 			case 0x09:	/* Digital */
357 			default:
358 				location = pcm + sec_loc;
359 				if (location >= AM824_MAX_CHANNELS_FOR_PCM) {
360 					err = -ENOSYS;
361 					goto end;
362 				}
363 				amdtp_am824_set_pcm_position(s, location,
364 							     stm_pos);
365 				break;
366 			}
367 		}
368 
369 		if (type != 0x0a)
370 			pcm += channels;
371 		else
372 			midi += channels;
373 	}
374 end:
375 	kfree(buf);
376 	return err;
377 }
378 
379 static int
380 init_both_connections(struct snd_bebob *bebob)
381 {
382 	int err;
383 
384 	err = cmp_connection_init(&bebob->in_conn,
385 				  bebob->unit, CMP_INPUT, 0);
386 	if (err < 0)
387 		goto end;
388 
389 	err = cmp_connection_init(&bebob->out_conn,
390 				  bebob->unit, CMP_OUTPUT, 0);
391 	if (err < 0)
392 		cmp_connection_destroy(&bebob->in_conn);
393 end:
394 	return err;
395 }
396 
397 static int
398 check_connection_used_by_others(struct snd_bebob *bebob, struct amdtp_stream *s)
399 {
400 	struct cmp_connection *conn;
401 	bool used;
402 	int err;
403 
404 	if (s == &bebob->tx_stream)
405 		conn = &bebob->out_conn;
406 	else
407 		conn = &bebob->in_conn;
408 
409 	err = cmp_connection_check_used(conn, &used);
410 	if ((err >= 0) && used && !amdtp_stream_running(s)) {
411 		dev_err(&bebob->unit->device,
412 			"Connection established by others: %cPCR[%d]\n",
413 			(conn->direction == CMP_OUTPUT) ? 'o' : 'i',
414 			conn->pcr_index);
415 		err = -EBUSY;
416 	}
417 
418 	return err;
419 }
420 
421 static int
422 make_both_connections(struct snd_bebob *bebob, unsigned int rate)
423 {
424 	int index, pcm_channels, midi_channels, err = 0;
425 
426 	if (bebob->connected)
427 		goto end;
428 
429 	/* confirm params for both streams */
430 	err = get_formation_index(rate, &index);
431 	if (err < 0)
432 		goto end;
433 	pcm_channels = bebob->tx_stream_formations[index].pcm;
434 	midi_channels = bebob->tx_stream_formations[index].midi;
435 	err = amdtp_am824_set_parameters(&bebob->tx_stream, rate,
436 					 pcm_channels, midi_channels * 8,
437 					 false);
438 	if (err < 0)
439 		goto end;
440 
441 	pcm_channels = bebob->rx_stream_formations[index].pcm;
442 	midi_channels = bebob->rx_stream_formations[index].midi;
443 	err = amdtp_am824_set_parameters(&bebob->rx_stream, rate,
444 					 pcm_channels, midi_channels * 8,
445 					 false);
446 	if (err < 0)
447 		goto end;
448 
449 	/* establish connections for both streams */
450 	err = cmp_connection_establish(&bebob->out_conn,
451 			amdtp_stream_get_max_payload(&bebob->tx_stream));
452 	if (err < 0)
453 		goto end;
454 	err = cmp_connection_establish(&bebob->in_conn,
455 			amdtp_stream_get_max_payload(&bebob->rx_stream));
456 	if (err < 0) {
457 		cmp_connection_break(&bebob->out_conn);
458 		goto end;
459 	}
460 
461 	bebob->connected = true;
462 end:
463 	return err;
464 }
465 
466 static void
467 break_both_connections(struct snd_bebob *bebob)
468 {
469 	cmp_connection_break(&bebob->in_conn);
470 	cmp_connection_break(&bebob->out_conn);
471 
472 	bebob->connected = false;
473 
474 	/* These models seems to be in transition state for a longer time. */
475 	if (bebob->maudio_special_quirk != NULL)
476 		msleep(200);
477 }
478 
479 static void
480 destroy_both_connections(struct snd_bebob *bebob)
481 {
482 	cmp_connection_destroy(&bebob->in_conn);
483 	cmp_connection_destroy(&bebob->out_conn);
484 }
485 
486 static int
487 start_stream(struct snd_bebob *bebob, struct amdtp_stream *stream,
488 	     unsigned int rate)
489 {
490 	struct cmp_connection *conn;
491 	int err = 0;
492 
493 	if (stream == &bebob->rx_stream)
494 		conn = &bebob->in_conn;
495 	else
496 		conn = &bebob->out_conn;
497 
498 	/* channel mapping */
499 	if (bebob->maudio_special_quirk == NULL) {
500 		err = map_data_channels(bebob, stream);
501 		if (err < 0)
502 			goto end;
503 	}
504 
505 	/* start amdtp stream */
506 	err = amdtp_stream_start(stream,
507 				 conn->resources.channel,
508 				 conn->speed);
509 end:
510 	return err;
511 }
512 
513 int snd_bebob_stream_init_duplex(struct snd_bebob *bebob)
514 {
515 	int err;
516 
517 	err = init_both_connections(bebob);
518 	if (err < 0)
519 		goto end;
520 
521 	err = amdtp_am824_init(&bebob->tx_stream, bebob->unit,
522 			       AMDTP_IN_STREAM, CIP_BLOCKING);
523 	if (err < 0) {
524 		amdtp_stream_destroy(&bebob->tx_stream);
525 		destroy_both_connections(bebob);
526 		goto end;
527 	}
528 
529 	/*
530 	 * BeBoB v3 transfers packets with these qurks:
531 	 *  - In the beginning of streaming, the value of dbc is incremented
532 	 *    even if no data blocks are transferred.
533 	 *  - The value of dbc is reset suddenly.
534 	 */
535 	if (bebob->version > 2)
536 		bebob->tx_stream.flags |= CIP_EMPTY_HAS_WRONG_DBC |
537 					  CIP_SKIP_DBC_ZERO_CHECK;
538 
539 	/*
540 	 * At high sampling rate, M-Audio special firmware transmits empty
541 	 * packet with the value of dbc incremented by 8 but the others are
542 	 * valid to IEC 61883-1.
543 	 */
544 	if (bebob->maudio_special_quirk)
545 		bebob->tx_stream.flags |= CIP_EMPTY_HAS_WRONG_DBC;
546 
547 	err = amdtp_am824_init(&bebob->rx_stream, bebob->unit,
548 			       AMDTP_OUT_STREAM, CIP_BLOCKING);
549 	if (err < 0) {
550 		amdtp_stream_destroy(&bebob->tx_stream);
551 		amdtp_stream_destroy(&bebob->rx_stream);
552 		destroy_both_connections(bebob);
553 	}
554 end:
555 	return err;
556 }
557 
558 int snd_bebob_stream_start_duplex(struct snd_bebob *bebob, unsigned int rate)
559 {
560 	const struct snd_bebob_rate_spec *rate_spec = bebob->spec->rate;
561 	unsigned int curr_rate;
562 	int err = 0;
563 
564 	/* Need no substreams */
565 	if (bebob->substreams_counter == 0)
566 		goto end;
567 
568 	/*
569 	 * Considering JACK/FFADO streaming:
570 	 * TODO: This can be removed hwdep functionality becomes popular.
571 	 */
572 	err = check_connection_used_by_others(bebob, &bebob->rx_stream);
573 	if (err < 0)
574 		goto end;
575 
576 	/*
577 	 * packet queueing error or detecting discontinuity
578 	 *
579 	 * At bus reset, connections should not be broken here. So streams need
580 	 * to be re-started. This is a reason to use SKIP_INIT_DBC_CHECK flag.
581 	 */
582 	if (amdtp_streaming_error(&bebob->rx_stream))
583 		amdtp_stream_stop(&bebob->rx_stream);
584 	if (amdtp_streaming_error(&bebob->tx_stream))
585 		amdtp_stream_stop(&bebob->tx_stream);
586 	if (!amdtp_stream_running(&bebob->rx_stream) &&
587 	    !amdtp_stream_running(&bebob->tx_stream))
588 		break_both_connections(bebob);
589 
590 	/* stop streams if rate is different */
591 	err = rate_spec->get(bebob, &curr_rate);
592 	if (err < 0) {
593 		dev_err(&bebob->unit->device,
594 			"fail to get sampling rate: %d\n", err);
595 		goto end;
596 	}
597 	if (rate == 0)
598 		rate = curr_rate;
599 	if (rate != curr_rate) {
600 		amdtp_stream_stop(&bebob->rx_stream);
601 		amdtp_stream_stop(&bebob->tx_stream);
602 		break_both_connections(bebob);
603 	}
604 
605 	/* master should be always running */
606 	if (!amdtp_stream_running(&bebob->rx_stream)) {
607 		/*
608 		 * NOTE:
609 		 * If establishing connections at first, Yamaha GO46
610 		 * (and maybe Terratec X24) don't generate sound.
611 		 *
612 		 * For firmware customized by M-Audio, refer to next NOTE.
613 		 */
614 		if (bebob->maudio_special_quirk == NULL) {
615 			err = rate_spec->set(bebob, rate);
616 			if (err < 0) {
617 				dev_err(&bebob->unit->device,
618 					"fail to set sampling rate: %d\n",
619 					err);
620 				goto end;
621 			}
622 		}
623 
624 		err = make_both_connections(bebob, rate);
625 		if (err < 0)
626 			goto end;
627 
628 		err = start_stream(bebob, &bebob->rx_stream, rate);
629 		if (err < 0) {
630 			dev_err(&bebob->unit->device,
631 				"fail to run AMDTP master stream:%d\n", err);
632 			break_both_connections(bebob);
633 			goto end;
634 		}
635 
636 		/*
637 		 * NOTE:
638 		 * The firmware customized by M-Audio uses these commands to
639 		 * start transmitting stream. This is not usual way.
640 		 */
641 		if (bebob->maudio_special_quirk != NULL) {
642 			err = rate_spec->set(bebob, rate);
643 			if (err < 0) {
644 				dev_err(&bebob->unit->device,
645 					"fail to ensure sampling rate: %d\n",
646 					err);
647 				amdtp_stream_stop(&bebob->rx_stream);
648 				break_both_connections(bebob);
649 				goto end;
650 			}
651 		}
652 
653 		/* wait first callback */
654 		if (!amdtp_stream_wait_callback(&bebob->rx_stream,
655 						CALLBACK_TIMEOUT)) {
656 			amdtp_stream_stop(&bebob->rx_stream);
657 			break_both_connections(bebob);
658 			err = -ETIMEDOUT;
659 			goto end;
660 		}
661 	}
662 
663 	/* start slave if needed */
664 	if (!amdtp_stream_running(&bebob->tx_stream)) {
665 		err = start_stream(bebob, &bebob->tx_stream, rate);
666 		if (err < 0) {
667 			dev_err(&bebob->unit->device,
668 				"fail to run AMDTP slave stream:%d\n", err);
669 			amdtp_stream_stop(&bebob->rx_stream);
670 			break_both_connections(bebob);
671 			goto end;
672 		}
673 
674 		/* wait first callback */
675 		if (!amdtp_stream_wait_callback(&bebob->tx_stream,
676 						CALLBACK_TIMEOUT)) {
677 			amdtp_stream_stop(&bebob->tx_stream);
678 			amdtp_stream_stop(&bebob->rx_stream);
679 			break_both_connections(bebob);
680 			err = -ETIMEDOUT;
681 		}
682 	}
683 end:
684 	return err;
685 }
686 
687 void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob)
688 {
689 	if (bebob->substreams_counter == 0) {
690 		amdtp_stream_pcm_abort(&bebob->rx_stream);
691 		amdtp_stream_stop(&bebob->rx_stream);
692 
693 		amdtp_stream_pcm_abort(&bebob->tx_stream);
694 		amdtp_stream_stop(&bebob->tx_stream);
695 
696 		break_both_connections(bebob);
697 	}
698 }
699 
700 /*
701  * This function should be called before starting streams or after stopping
702  * streams.
703  */
704 void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob)
705 {
706 	amdtp_stream_destroy(&bebob->rx_stream);
707 	amdtp_stream_destroy(&bebob->tx_stream);
708 
709 	destroy_both_connections(bebob);
710 }
711 
712 /*
713  * See: Table 50: Extended Stream Format Info Format Hierarchy Level 2’
714  * in Additional AVC commands (Nov 2003, BridgeCo)
715  * Also 'Clause 12 AM824 sequence adaption layers' in IEC 61883-6:2005
716  */
717 static int
718 parse_stream_formation(u8 *buf, unsigned int len,
719 		       struct snd_bebob_stream_formation *formation)
720 {
721 	unsigned int i, e, channels, format;
722 
723 	/*
724 	 * this module can support a hierarchy combination that:
725 	 *  Root:	Audio and Music (0x90)
726 	 *  Level 1:	AM824 Compound  (0x40)
727 	 */
728 	if ((buf[0] != 0x90) || (buf[1] != 0x40))
729 		return -ENOSYS;
730 
731 	/* check sampling rate */
732 	for (i = 0; i < ARRAY_SIZE(bridgeco_freq_table); i++) {
733 		if (buf[2] == bridgeco_freq_table[i])
734 			break;
735 	}
736 	if (i == ARRAY_SIZE(bridgeco_freq_table))
737 		return -ENOSYS;
738 
739 	/* Avoid double count by different entries for the same rate. */
740 	memset(&formation[i], 0, sizeof(struct snd_bebob_stream_formation));
741 
742 	for (e = 0; e < buf[4]; e++) {
743 		channels = buf[5 + e * 2];
744 		format = buf[6 + e * 2];
745 
746 		switch (format) {
747 		/* IEC 60958 Conformant, currently handled as MBLA */
748 		case 0x00:
749 		/* Multi bit linear audio */
750 		case 0x06:	/* Raw */
751 			formation[i].pcm += channels;
752 			break;
753 		/* MIDI Conformant */
754 		case 0x0d:
755 			formation[i].midi += channels;
756 			break;
757 		/* IEC 61937-3 to 7 */
758 		case 0x01:
759 		case 0x02:
760 		case 0x03:
761 		case 0x04:
762 		case 0x05:
763 		/* Multi bit linear audio */
764 		case 0x07:	/* DVD-Audio */
765 		case 0x0c:	/* High Precision */
766 		/* One Bit Audio */
767 		case 0x08:	/* (Plain) Raw */
768 		case 0x09:	/* (Plain) SACD */
769 		case 0x0a:	/* (Encoded) Raw */
770 		case 0x0b:	/* (Encoded) SACD */
771 		/* Synchronization Stream (Stereo Raw audio) */
772 		case 0x40:
773 		/* Don't care */
774 		case 0xff:
775 		default:
776 			return -ENOSYS;	/* not supported */
777 		}
778 	}
779 
780 	if (formation[i].pcm  > AM824_MAX_CHANNELS_FOR_PCM ||
781 	    formation[i].midi > AM824_MAX_CHANNELS_FOR_MIDI)
782 		return -ENOSYS;
783 
784 	return 0;
785 }
786 
787 static int
788 fill_stream_formations(struct snd_bebob *bebob, enum avc_bridgeco_plug_dir dir,
789 		       unsigned short pid)
790 {
791 	u8 *buf;
792 	struct snd_bebob_stream_formation *formations;
793 	unsigned int len, eid;
794 	u8 addr[AVC_BRIDGECO_ADDR_BYTES];
795 	int err;
796 
797 	buf = kmalloc(FORMAT_MAXIMUM_LENGTH, GFP_KERNEL);
798 	if (buf == NULL)
799 		return -ENOMEM;
800 
801 	if (dir == AVC_BRIDGECO_PLUG_DIR_IN)
802 		formations = bebob->rx_stream_formations;
803 	else
804 		formations = bebob->tx_stream_formations;
805 
806 	for (eid = 0; eid < SND_BEBOB_STRM_FMT_ENTRIES; eid++) {
807 		len = FORMAT_MAXIMUM_LENGTH;
808 		avc_bridgeco_fill_unit_addr(addr, dir,
809 					    AVC_BRIDGECO_PLUG_UNIT_ISOC, pid);
810 		err = avc_bridgeco_get_plug_strm_fmt(bebob->unit, addr, buf,
811 						     &len, eid);
812 		/* No entries remained. */
813 		if (err == -EINVAL && eid > 0) {
814 			err = 0;
815 			break;
816 		} else if (err < 0) {
817 			dev_err(&bebob->unit->device,
818 			"fail to get stream format %d for isoc %s plug %d:%d\n",
819 				eid,
820 				(dir == AVC_BRIDGECO_PLUG_DIR_IN) ? "in" :
821 								    "out",
822 				pid, err);
823 			break;
824 		}
825 
826 		err = parse_stream_formation(buf, len, formations);
827 		if (err < 0)
828 			break;
829 	}
830 
831 	kfree(buf);
832 	return err;
833 }
834 
835 static int
836 seek_msu_sync_input_plug(struct snd_bebob *bebob)
837 {
838 	u8 plugs[AVC_PLUG_INFO_BUF_BYTES], addr[AVC_BRIDGECO_ADDR_BYTES];
839 	unsigned int i;
840 	enum avc_bridgeco_plug_type type;
841 	int err;
842 
843 	/* Get the number of Music Sub Unit for both direction. */
844 	err = avc_general_get_plug_info(bebob->unit, 0x0c, 0x00, 0x00, plugs);
845 	if (err < 0) {
846 		dev_err(&bebob->unit->device,
847 			"fail to get info for MSU in/out plugs: %d\n",
848 			err);
849 		goto end;
850 	}
851 
852 	/* seek destination plugs for 'MSU sync input' */
853 	bebob->sync_input_plug = -1;
854 	for (i = 0; i < plugs[0]; i++) {
855 		avc_bridgeco_fill_msu_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN, i);
856 		err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
857 		if (err < 0) {
858 			dev_err(&bebob->unit->device,
859 				"fail to get type for MSU in plug %d: %d\n",
860 				i, err);
861 			goto end;
862 		}
863 
864 		if (type == AVC_BRIDGECO_PLUG_TYPE_SYNC) {
865 			bebob->sync_input_plug = i;
866 			break;
867 		}
868 	}
869 end:
870 	return err;
871 }
872 
873 int snd_bebob_stream_discover(struct snd_bebob *bebob)
874 {
875 	const struct snd_bebob_clock_spec *clk_spec = bebob->spec->clock;
876 	u8 plugs[AVC_PLUG_INFO_BUF_BYTES], addr[AVC_BRIDGECO_ADDR_BYTES];
877 	enum avc_bridgeco_plug_type type;
878 	unsigned int i;
879 	int err;
880 
881 	/* the number of plugs for isoc in/out, ext in/out  */
882 	err = avc_general_get_plug_info(bebob->unit, 0x1f, 0x07, 0x00, plugs);
883 	if (err < 0) {
884 		dev_err(&bebob->unit->device,
885 		"fail to get info for isoc/external in/out plugs: %d\n",
886 			err);
887 		goto end;
888 	}
889 
890 	/*
891 	 * This module supports at least one isoc input plug and one isoc
892 	 * output plug.
893 	 */
894 	if ((plugs[0] == 0) || (plugs[1] == 0)) {
895 		err = -ENOSYS;
896 		goto end;
897 	}
898 
899 	avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
900 				    AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
901 	err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
902 	if (err < 0) {
903 		dev_err(&bebob->unit->device,
904 			"fail to get type for isoc in plug 0: %d\n", err);
905 		goto end;
906 	} else if (type != AVC_BRIDGECO_PLUG_TYPE_ISOC) {
907 		err = -ENOSYS;
908 		goto end;
909 	}
910 	err = fill_stream_formations(bebob, AVC_BRIDGECO_PLUG_DIR_IN, 0);
911 	if (err < 0)
912 		goto end;
913 
914 	avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_OUT,
915 				    AVC_BRIDGECO_PLUG_UNIT_ISOC, 0);
916 	err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
917 	if (err < 0) {
918 		dev_err(&bebob->unit->device,
919 			"fail to get type for isoc out plug 0: %d\n", err);
920 		goto end;
921 	} else if (type != AVC_BRIDGECO_PLUG_TYPE_ISOC) {
922 		err = -ENOSYS;
923 		goto end;
924 	}
925 	err = fill_stream_formations(bebob, AVC_BRIDGECO_PLUG_DIR_OUT, 0);
926 	if (err < 0)
927 		goto end;
928 
929 	/* count external input plugs for MIDI */
930 	bebob->midi_input_ports = 0;
931 	for (i = 0; i < plugs[2]; i++) {
932 		avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_IN,
933 					    AVC_BRIDGECO_PLUG_UNIT_EXT, i);
934 		err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
935 		if (err < 0) {
936 			dev_err(&bebob->unit->device,
937 			"fail to get type for external in plug %d: %d\n",
938 				i, err);
939 			goto end;
940 		} else if (type == AVC_BRIDGECO_PLUG_TYPE_MIDI) {
941 			bebob->midi_input_ports++;
942 		}
943 	}
944 
945 	/* count external output plugs for MIDI */
946 	bebob->midi_output_ports = 0;
947 	for (i = 0; i < plugs[3]; i++) {
948 		avc_bridgeco_fill_unit_addr(addr, AVC_BRIDGECO_PLUG_DIR_OUT,
949 					    AVC_BRIDGECO_PLUG_UNIT_EXT, i);
950 		err = avc_bridgeco_get_plug_type(bebob->unit, addr, &type);
951 		if (err < 0) {
952 			dev_err(&bebob->unit->device,
953 			"fail to get type for external out plug %d: %d\n",
954 				i, err);
955 			goto end;
956 		} else if (type == AVC_BRIDGECO_PLUG_TYPE_MIDI) {
957 			bebob->midi_output_ports++;
958 		}
959 	}
960 
961 	/* for check source of clock later */
962 	if (!clk_spec)
963 		err = seek_msu_sync_input_plug(bebob);
964 end:
965 	return err;
966 }
967 
968 void snd_bebob_stream_lock_changed(struct snd_bebob *bebob)
969 {
970 	bebob->dev_lock_changed = true;
971 	wake_up(&bebob->hwdep_wait);
972 }
973 
974 int snd_bebob_stream_lock_try(struct snd_bebob *bebob)
975 {
976 	int err;
977 
978 	spin_lock_irq(&bebob->lock);
979 
980 	/* user land lock this */
981 	if (bebob->dev_lock_count < 0) {
982 		err = -EBUSY;
983 		goto end;
984 	}
985 
986 	/* this is the first time */
987 	if (bebob->dev_lock_count++ == 0)
988 		snd_bebob_stream_lock_changed(bebob);
989 	err = 0;
990 end:
991 	spin_unlock_irq(&bebob->lock);
992 	return err;
993 }
994 
995 void snd_bebob_stream_lock_release(struct snd_bebob *bebob)
996 {
997 	spin_lock_irq(&bebob->lock);
998 
999 	if (WARN_ON(bebob->dev_lock_count <= 0))
1000 		goto end;
1001 	if (--bebob->dev_lock_count == 0)
1002 		snd_bebob_stream_lock_changed(bebob);
1003 end:
1004 	spin_unlock_irq(&bebob->lock);
1005 }
1006