2 * oxfw_stream.c - a part of driver for OXFW970/971 based devices
4 * Copyright (c) 2014 Takashi Sakamoto
6 * Licensed under the terms of the GNU General Public License, version 2.
10 #include <linux/delay.h>
12 #define AVC_GENERIC_FRAME_MAXIMUM_BYTES 512
13 #define CALLBACK_TIMEOUT 200
16 * According to datasheet of Oxford Semiconductor:
17 * OXFW970: 32.0/44.1/48.0/96.0 Khz, 8 audio channels I/O
18 * OXFW971: 32.0/44.1/48.0/88.2/96.0/192.0 kHz, 16 audio channels I/O, MIDI I/O
20 static const unsigned int oxfw_rate_table[] = {
30 * See Table 5.7 – Sampling frequency for Multi-bit Audio
31 * in AV/C Stream Format Information Specification 1.1 (Apr 2005, 1394TA)
33 static const unsigned int avc_stream_rate_table[] = {
42 static int set_rate(struct snd_oxfw *oxfw, unsigned int rate)
46 err = avc_general_set_sig_fmt(oxfw->unit, rate,
47 AVC_GENERAL_PLUG_DIR_IN, 0);
52 err = avc_general_set_sig_fmt(oxfw->unit, rate,
53 AVC_GENERAL_PLUG_DIR_OUT, 0);
58 static int set_stream_format(struct snd_oxfw *oxfw, struct amdtp_stream *s,
59 unsigned int rate, unsigned int pcm_channels)
62 struct snd_oxfw_stream_formation formation;
63 enum avc_general_plug_dir dir;
67 if (s == &oxfw->tx_stream) {
68 formats = oxfw->tx_stream_formats;
69 dir = AVC_GENERAL_PLUG_DIR_OUT;
71 formats = oxfw->rx_stream_formats;
72 dir = AVC_GENERAL_PLUG_DIR_IN;
75 /* Seek stream format for requirements. */
76 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) {
77 err = snd_oxfw_stream_parse_format(formats[i], &formation);
81 if ((formation.rate == rate) && (formation.pcm == pcm_channels))
84 if (i == SND_OXFW_STREAM_FORMAT_ENTRIES)
87 /* If assumed, just change rate. */
89 return set_rate(oxfw, rate);
91 /* Calculate format length. */
92 len = 5 + formats[i][4] * 2;
94 err = avc_stream_set_format(oxfw->unit, dir, 0, formats[i], len);
98 /* Some requests just after changing format causes freezing. */
104 static void stop_stream(struct snd_oxfw *oxfw, struct amdtp_stream *stream)
106 amdtp_stream_pcm_abort(stream);
107 amdtp_stream_stop(stream);
109 if (stream == &oxfw->tx_stream)
110 cmp_connection_break(&oxfw->out_conn);
112 cmp_connection_break(&oxfw->in_conn);
115 static int start_stream(struct snd_oxfw *oxfw, struct amdtp_stream *stream,
116 unsigned int rate, unsigned int pcm_channels)
119 struct cmp_connection *conn;
120 struct snd_oxfw_stream_formation formation;
121 unsigned int i, midi_ports;
124 if (stream == &oxfw->rx_stream) {
125 formats = oxfw->rx_stream_formats;
126 conn = &oxfw->in_conn;
128 formats = oxfw->tx_stream_formats;
129 conn = &oxfw->out_conn;
132 /* Get stream format */
133 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) {
134 if (formats[i] == NULL)
137 err = snd_oxfw_stream_parse_format(formats[i], &formation);
140 if (rate != formation.rate)
142 if (pcm_channels == 0 || pcm_channels == formation.pcm)
145 if (i == SND_OXFW_STREAM_FORMAT_ENTRIES) {
150 pcm_channels = formation.pcm;
151 midi_ports = DIV_ROUND_UP(formation.midi, 8);
153 /* The stream should have one pcm channels at least */
154 if (pcm_channels == 0) {
158 amdtp_stream_set_parameters(stream, rate, pcm_channels, midi_ports);
160 err = cmp_connection_establish(conn,
161 amdtp_stream_get_max_payload(stream));
165 err = amdtp_stream_start(stream,
166 conn->resources.channel,
169 cmp_connection_break(conn);
173 /* Wait first packet */
174 err = amdtp_stream_wait_callback(stream, CALLBACK_TIMEOUT);
176 stop_stream(oxfw, stream);
181 static int check_connection_used_by_others(struct snd_oxfw *oxfw,
182 struct amdtp_stream *stream)
184 struct cmp_connection *conn;
188 if (stream == &oxfw->tx_stream)
189 conn = &oxfw->out_conn;
191 conn = &oxfw->in_conn;
193 err = cmp_connection_check_used(conn, &used);
194 if ((err >= 0) && used && !amdtp_stream_running(stream)) {
195 dev_err(&oxfw->unit->device,
196 "Connection established by others: %cPCR[%d]\n",
197 (conn->direction == CMP_OUTPUT) ? 'o' : 'i',
205 int snd_oxfw_stream_init_simplex(struct snd_oxfw *oxfw,
206 struct amdtp_stream *stream)
208 struct cmp_connection *conn;
209 enum cmp_direction c_dir;
210 enum amdtp_stream_direction s_dir;
213 if (stream == &oxfw->tx_stream) {
214 conn = &oxfw->out_conn;
216 s_dir = AMDTP_IN_STREAM;
218 conn = &oxfw->in_conn;
220 s_dir = AMDTP_OUT_STREAM;
223 err = cmp_connection_init(conn, oxfw->unit, c_dir, 0);
227 err = amdtp_stream_init(stream, oxfw->unit, s_dir, CIP_NONBLOCKING);
229 amdtp_stream_destroy(stream);
230 cmp_connection_destroy(conn);
234 /* OXFW starts to transmit packets with non-zero dbc. */
235 if (stream == &oxfw->tx_stream)
236 oxfw->tx_stream.flags |= CIP_SKIP_INIT_DBC_CHECK;
241 int snd_oxfw_stream_start_simplex(struct snd_oxfw *oxfw,
242 struct amdtp_stream *stream,
243 unsigned int rate, unsigned int pcm_channels)
245 struct amdtp_stream *opposite;
246 struct snd_oxfw_stream_formation formation;
247 enum avc_general_plug_dir dir;
248 unsigned int substreams, opposite_substreams;
251 if (stream == &oxfw->tx_stream) {
252 substreams = oxfw->capture_substreams;
253 opposite = &oxfw->rx_stream;
254 opposite_substreams = oxfw->playback_substreams;
255 dir = AVC_GENERAL_PLUG_DIR_OUT;
257 substreams = oxfw->playback_substreams;
258 opposite_substreams = oxfw->capture_substreams;
260 if (oxfw->has_output)
261 opposite = &oxfw->rx_stream;
265 dir = AVC_GENERAL_PLUG_DIR_IN;
272 * Considering JACK/FFADO streaming:
273 * TODO: This can be removed hwdep functionality becomes popular.
275 err = check_connection_used_by_others(oxfw, stream);
279 /* packet queueing error */
280 if (amdtp_streaming_error(stream))
281 stop_stream(oxfw, stream);
283 err = snd_oxfw_stream_get_current_formation(oxfw, dir, &formation);
287 rate = formation.rate;
288 if (pcm_channels == 0)
289 pcm_channels = formation.pcm;
291 if ((formation.rate != rate) || (formation.pcm != pcm_channels)) {
292 if (opposite != NULL) {
293 err = check_connection_used_by_others(oxfw, opposite);
296 stop_stream(oxfw, opposite);
298 stop_stream(oxfw, stream);
300 err = set_stream_format(oxfw, stream, rate, pcm_channels);
302 dev_err(&oxfw->unit->device,
303 "fail to set stream format: %d\n", err);
307 /* Start opposite stream if needed. */
308 if (opposite && !amdtp_stream_running(opposite) &&
309 (opposite_substreams > 0)) {
310 err = start_stream(oxfw, opposite, rate, 0);
312 dev_err(&oxfw->unit->device,
313 "fail to restart stream: %d\n", err);
319 /* Start requested stream. */
320 if (!amdtp_stream_running(stream)) {
321 err = start_stream(oxfw, stream, rate, pcm_channels);
323 dev_err(&oxfw->unit->device,
324 "fail to start stream: %d\n", err);
330 void snd_oxfw_stream_stop_simplex(struct snd_oxfw *oxfw,
331 struct amdtp_stream *stream)
333 if (((stream == &oxfw->tx_stream) && (oxfw->capture_substreams > 0)) ||
334 ((stream == &oxfw->rx_stream) && (oxfw->playback_substreams > 0)))
337 stop_stream(oxfw, stream);
341 * This function should be called before starting the stream or after stopping
344 void snd_oxfw_stream_destroy_simplex(struct snd_oxfw *oxfw,
345 struct amdtp_stream *stream)
347 struct cmp_connection *conn;
349 if (stream == &oxfw->tx_stream)
350 conn = &oxfw->out_conn;
352 conn = &oxfw->in_conn;
354 amdtp_stream_destroy(stream);
355 cmp_connection_destroy(conn);
358 void snd_oxfw_stream_update_simplex(struct snd_oxfw *oxfw,
359 struct amdtp_stream *stream)
361 struct cmp_connection *conn;
363 if (stream == &oxfw->tx_stream)
364 conn = &oxfw->out_conn;
366 conn = &oxfw->in_conn;
368 if (cmp_connection_update(conn) < 0)
369 stop_stream(oxfw, stream);
371 amdtp_stream_update(stream);
374 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
375 enum avc_general_plug_dir dir,
376 struct snd_oxfw_stream_formation *formation)
382 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
383 format = kmalloc(len, GFP_KERNEL);
387 err = avc_stream_get_format_single(oxfw->unit, dir, 0, format, &len);
395 err = snd_oxfw_stream_parse_format(format, formation);
402 * See Table 6.16 - AM824 Stream Format
403 * Figure 6.19 - format_information field for AM824 Compound
404 * in AV/C Stream Format Information Specification 1.1 (Apr 2005, 1394TA)
405 * Also 'Clause 12 AM824 sequence adaption layers' in IEC 61883-6:2005
407 int snd_oxfw_stream_parse_format(u8 *format,
408 struct snd_oxfw_stream_formation *formation)
410 unsigned int i, e, channels, type;
412 memset(formation, 0, sizeof(struct snd_oxfw_stream_formation));
415 * this module can support a hierarchy combination that:
416 * Root: Audio and Music (0x90)
417 * Level 1: AM824 Compound (0x40)
419 if ((format[0] != 0x90) || (format[1] != 0x40))
422 /* check the sampling rate */
423 for (i = 0; i < ARRAY_SIZE(avc_stream_rate_table); i++) {
424 if (format[2] == avc_stream_rate_table[i])
427 if (i == ARRAY_SIZE(avc_stream_rate_table))
430 formation->rate = oxfw_rate_table[i];
432 for (e = 0; e < format[4]; e++) {
433 channels = format[5 + e * 2];
434 type = format[6 + e * 2];
437 /* IEC 60958 Conformant, currently handled as MBLA */
439 /* Multi Bit Linear Audio (Raw) */
441 formation->pcm += channels;
443 /* MIDI Conformant */
445 formation->midi = channels;
447 /* IEC 61937-3 to 7 */
453 /* Multi Bit Linear Audio */
454 case 0x07: /* DVD-Audio */
455 case 0x0c: /* High Precision */
457 case 0x08: /* (Plain) Raw */
458 case 0x09: /* (Plain) SACD */
459 case 0x0a: /* (Encoded) Raw */
460 case 0x0b: /* (Encoded) SACD */
461 /* SMPTE Time-Code conformant */
467 /* Synchronization Stream (Stereo Raw audio) */
472 return -ENOSYS; /* not supported */
476 if (formation->pcm > AMDTP_MAX_CHANNELS_FOR_PCM ||
477 formation->midi > AMDTP_MAX_CHANNELS_FOR_MIDI)
484 assume_stream_formats(struct snd_oxfw *oxfw, enum avc_general_plug_dir dir,
485 unsigned int pid, u8 *buf, unsigned int *len,
488 struct snd_oxfw_stream_formation formation;
492 /* get format at current sampling rate */
493 err = avc_stream_get_format_single(oxfw->unit, dir, pid, buf, len);
495 dev_err(&oxfw->unit->device,
496 "fail to get current stream format for isoc %s plug %d:%d\n",
497 (dir == AVC_GENERAL_PLUG_DIR_IN) ? "in" : "out",
502 /* parse and set stream format */
504 err = snd_oxfw_stream_parse_format(buf, &formation);
508 formats[eid] = kmalloc(*len, GFP_KERNEL);
509 if (formats[eid] == NULL) {
513 memcpy(formats[eid], buf, *len);
515 /* apply the format for each available sampling rate */
516 for (i = 0; i < ARRAY_SIZE(oxfw_rate_table); i++) {
517 if (formation.rate == oxfw_rate_table[i])
520 err = avc_general_inquiry_sig_fmt(oxfw->unit,
527 formats[eid] = kmalloc(*len, GFP_KERNEL);
528 if (formats[eid] == NULL) {
532 memcpy(formats[eid], buf, *len);
533 formats[eid][2] = avc_stream_rate_table[i];
537 oxfw->assumed = true;
542 static int fill_stream_formats(struct snd_oxfw *oxfw,
543 enum avc_general_plug_dir dir,
547 unsigned int len, eid = 0;
548 struct snd_oxfw_stream_formation dummy;
551 buf = kmalloc(AVC_GENERIC_FRAME_MAXIMUM_BYTES, GFP_KERNEL);
555 if (dir == AVC_GENERAL_PLUG_DIR_OUT)
556 formats = oxfw->tx_stream_formats;
558 formats = oxfw->rx_stream_formats;
560 /* get first entry */
561 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
562 err = avc_stream_get_format_list(oxfw->unit, dir, 0, buf, &len, 0);
563 if (err == -ENOSYS) {
564 /* LIST subfunction is not implemented */
565 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
566 err = assume_stream_formats(oxfw, dir, pid, buf, &len,
569 } else if (err < 0) {
570 dev_err(&oxfw->unit->device,
571 "fail to get stream format %d for isoc %s plug %d:%d\n",
572 eid, (dir == AVC_GENERAL_PLUG_DIR_IN) ? "in" : "out",
577 /* LIST subfunction is implemented */
578 while (eid < SND_OXFW_STREAM_FORMAT_ENTRIES) {
579 /* The format is too short. */
585 /* parse and set stream format */
586 err = snd_oxfw_stream_parse_format(buf, &dummy);
590 formats[eid] = kmalloc(len, GFP_KERNEL);
591 if (formats[eid] == NULL) {
595 memcpy(formats[eid], buf, len);
598 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
599 err = avc_stream_get_format_list(oxfw->unit, dir, 0,
601 /* No entries remained. */
602 if (err == -EINVAL) {
605 } else if (err < 0) {
606 dev_err(&oxfw->unit->device,
607 "fail to get stream format %d for isoc %s plug %d:%d\n",
608 eid, (dir == AVC_GENERAL_PLUG_DIR_IN) ? "in" :
619 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw)
621 u8 plugs[AVC_PLUG_INFO_BUF_BYTES];
624 /* the number of plugs for isoc in/out, ext in/out */
625 err = avc_general_get_plug_info(oxfw->unit, 0x1f, 0x07, 0x00, plugs);
627 dev_err(&oxfw->unit->device,
628 "fail to get info for isoc/external in/out plugs: %d\n",
631 } else if ((plugs[0] == 0) && (plugs[1] == 0)) {
636 /* use oPCR[0] if exists */
638 err = fill_stream_formats(oxfw, AVC_GENERAL_PLUG_DIR_OUT, 0);
641 oxfw->has_output = true;
644 /* use iPCR[0] if exists */
646 err = fill_stream_formats(oxfw, AVC_GENERAL_PLUG_DIR_IN, 0);
651 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw)
653 oxfw->dev_lock_changed = true;
654 wake_up(&oxfw->hwdep_wait);
657 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw)
661 spin_lock_irq(&oxfw->lock);
663 /* user land lock this */
664 if (oxfw->dev_lock_count < 0) {
669 /* this is the first time */
670 if (oxfw->dev_lock_count++ == 0)
671 snd_oxfw_stream_lock_changed(oxfw);
674 spin_unlock_irq(&oxfw->lock);
678 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw)
680 spin_lock_irq(&oxfw->lock);
682 if (WARN_ON(oxfw->dev_lock_count <= 0))
684 if (--oxfw->dev_lock_count == 0)
685 snd_oxfw_stream_lock_changed(oxfw);
687 spin_unlock_irq(&oxfw->lock);