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 err = amdtp_stream_set_parameters(stream, rate,
159 pcm_channels, midi_ports, false);
163 err = cmp_connection_establish(conn,
164 amdtp_stream_get_max_payload(stream));
168 err = amdtp_stream_start(stream,
169 conn->resources.channel,
172 cmp_connection_break(conn);
176 /* Wait first packet */
177 if (!amdtp_stream_wait_callback(stream, CALLBACK_TIMEOUT)) {
178 stop_stream(oxfw, stream);
185 static int check_connection_used_by_others(struct snd_oxfw *oxfw,
186 struct amdtp_stream *stream)
188 struct cmp_connection *conn;
192 if (stream == &oxfw->tx_stream)
193 conn = &oxfw->out_conn;
195 conn = &oxfw->in_conn;
197 err = cmp_connection_check_used(conn, &used);
198 if ((err >= 0) && used && !amdtp_stream_running(stream)) {
199 dev_err(&oxfw->unit->device,
200 "Connection established by others: %cPCR[%d]\n",
201 (conn->direction == CMP_OUTPUT) ? 'o' : 'i',
209 int snd_oxfw_stream_init_simplex(struct snd_oxfw *oxfw,
210 struct amdtp_stream *stream)
212 struct cmp_connection *conn;
213 enum cmp_direction c_dir;
214 enum amdtp_stream_direction s_dir;
217 if (stream == &oxfw->tx_stream) {
218 conn = &oxfw->out_conn;
220 s_dir = AMDTP_IN_STREAM;
222 conn = &oxfw->in_conn;
224 s_dir = AMDTP_OUT_STREAM;
227 err = cmp_connection_init(conn, oxfw->unit, c_dir, 0);
231 err = amdtp_am824_init(stream, oxfw->unit, s_dir, CIP_NONBLOCKING);
233 amdtp_stream_destroy(stream);
234 cmp_connection_destroy(conn);
239 * OXFW starts to transmit packets with non-zero dbc.
240 * OXFW postpone transferring packets till handling any asynchronous
241 * packets. As a result, next isochronous packet includes more data
242 * blocks than IEC 61883-6 defines.
244 if (stream == &oxfw->tx_stream)
245 oxfw->tx_stream.flags |= CIP_SKIP_INIT_DBC_CHECK |
251 int snd_oxfw_stream_start_simplex(struct snd_oxfw *oxfw,
252 struct amdtp_stream *stream,
253 unsigned int rate, unsigned int pcm_channels)
255 struct amdtp_stream *opposite;
256 struct snd_oxfw_stream_formation formation;
257 enum avc_general_plug_dir dir;
258 unsigned int substreams, opposite_substreams;
261 if (stream == &oxfw->tx_stream) {
262 substreams = oxfw->capture_substreams;
263 opposite = &oxfw->rx_stream;
264 opposite_substreams = oxfw->playback_substreams;
265 dir = AVC_GENERAL_PLUG_DIR_OUT;
267 substreams = oxfw->playback_substreams;
268 opposite_substreams = oxfw->capture_substreams;
270 if (oxfw->has_output)
271 opposite = &oxfw->rx_stream;
275 dir = AVC_GENERAL_PLUG_DIR_IN;
282 * Considering JACK/FFADO streaming:
283 * TODO: This can be removed hwdep functionality becomes popular.
285 err = check_connection_used_by_others(oxfw, stream);
289 /* packet queueing error */
290 if (amdtp_streaming_error(stream))
291 stop_stream(oxfw, stream);
293 err = snd_oxfw_stream_get_current_formation(oxfw, dir, &formation);
297 rate = formation.rate;
298 if (pcm_channels == 0)
299 pcm_channels = formation.pcm;
301 if ((formation.rate != rate) || (formation.pcm != pcm_channels)) {
302 if (opposite != NULL) {
303 err = check_connection_used_by_others(oxfw, opposite);
306 stop_stream(oxfw, opposite);
308 stop_stream(oxfw, stream);
310 err = set_stream_format(oxfw, stream, rate, pcm_channels);
312 dev_err(&oxfw->unit->device,
313 "fail to set stream format: %d\n", err);
317 /* Start opposite stream if needed. */
318 if (opposite && !amdtp_stream_running(opposite) &&
319 (opposite_substreams > 0)) {
320 err = start_stream(oxfw, opposite, rate, 0);
322 dev_err(&oxfw->unit->device,
323 "fail to restart stream: %d\n", err);
329 /* Start requested stream. */
330 if (!amdtp_stream_running(stream)) {
331 err = start_stream(oxfw, stream, rate, pcm_channels);
333 dev_err(&oxfw->unit->device,
334 "fail to start stream: %d\n", err);
340 void snd_oxfw_stream_stop_simplex(struct snd_oxfw *oxfw,
341 struct amdtp_stream *stream)
343 if (((stream == &oxfw->tx_stream) && (oxfw->capture_substreams > 0)) ||
344 ((stream == &oxfw->rx_stream) && (oxfw->playback_substreams > 0)))
347 stop_stream(oxfw, stream);
351 * This function should be called before starting the stream or after stopping
354 void snd_oxfw_stream_destroy_simplex(struct snd_oxfw *oxfw,
355 struct amdtp_stream *stream)
357 struct cmp_connection *conn;
359 if (stream == &oxfw->tx_stream)
360 conn = &oxfw->out_conn;
362 conn = &oxfw->in_conn;
364 amdtp_stream_destroy(stream);
365 cmp_connection_destroy(conn);
368 void snd_oxfw_stream_update_simplex(struct snd_oxfw *oxfw,
369 struct amdtp_stream *stream)
371 struct cmp_connection *conn;
373 if (stream == &oxfw->tx_stream)
374 conn = &oxfw->out_conn;
376 conn = &oxfw->in_conn;
378 if (cmp_connection_update(conn) < 0)
379 stop_stream(oxfw, stream);
381 amdtp_stream_update(stream);
384 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
385 enum avc_general_plug_dir dir,
386 struct snd_oxfw_stream_formation *formation)
392 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
393 format = kmalloc(len, GFP_KERNEL);
397 err = avc_stream_get_format_single(oxfw->unit, dir, 0, format, &len);
405 err = snd_oxfw_stream_parse_format(format, formation);
412 * See Table 6.16 - AM824 Stream Format
413 * Figure 6.19 - format_information field for AM824 Compound
414 * in AV/C Stream Format Information Specification 1.1 (Apr 2005, 1394TA)
415 * Also 'Clause 12 AM824 sequence adaption layers' in IEC 61883-6:2005
417 int snd_oxfw_stream_parse_format(u8 *format,
418 struct snd_oxfw_stream_formation *formation)
420 unsigned int i, e, channels, type;
422 memset(formation, 0, sizeof(struct snd_oxfw_stream_formation));
425 * this module can support a hierarchy combination that:
426 * Root: Audio and Music (0x90)
427 * Level 1: AM824 Compound (0x40)
429 if ((format[0] != 0x90) || (format[1] != 0x40))
432 /* check the sampling rate */
433 for (i = 0; i < ARRAY_SIZE(avc_stream_rate_table); i++) {
434 if (format[2] == avc_stream_rate_table[i])
437 if (i == ARRAY_SIZE(avc_stream_rate_table))
440 formation->rate = oxfw_rate_table[i];
442 for (e = 0; e < format[4]; e++) {
443 channels = format[5 + e * 2];
444 type = format[6 + e * 2];
447 /* IEC 60958 Conformant, currently handled as MBLA */
449 /* Multi Bit Linear Audio (Raw) */
451 formation->pcm += channels;
453 /* MIDI Conformant */
455 formation->midi = channels;
457 /* IEC 61937-3 to 7 */
463 /* Multi Bit Linear Audio */
464 case 0x07: /* DVD-Audio */
465 case 0x0c: /* High Precision */
467 case 0x08: /* (Plain) Raw */
468 case 0x09: /* (Plain) SACD */
469 case 0x0a: /* (Encoded) Raw */
470 case 0x0b: /* (Encoded) SACD */
471 /* SMPTE Time-Code conformant */
477 /* Synchronization Stream (Stereo Raw audio) */
482 return -ENOSYS; /* not supported */
486 if (formation->pcm > AMDTP_MAX_CHANNELS_FOR_PCM ||
487 formation->midi > AMDTP_MAX_CHANNELS_FOR_MIDI)
494 assume_stream_formats(struct snd_oxfw *oxfw, enum avc_general_plug_dir dir,
495 unsigned int pid, u8 *buf, unsigned int *len,
498 struct snd_oxfw_stream_formation formation;
502 /* get format at current sampling rate */
503 err = avc_stream_get_format_single(oxfw->unit, dir, pid, buf, len);
505 dev_err(&oxfw->unit->device,
506 "fail to get current stream format for isoc %s plug %d:%d\n",
507 (dir == AVC_GENERAL_PLUG_DIR_IN) ? "in" : "out",
512 /* parse and set stream format */
514 err = snd_oxfw_stream_parse_format(buf, &formation);
518 formats[eid] = kmemdup(buf, *len, GFP_KERNEL);
519 if (formats[eid] == NULL) {
524 /* apply the format for each available sampling rate */
525 for (i = 0; i < ARRAY_SIZE(oxfw_rate_table); i++) {
526 if (formation.rate == oxfw_rate_table[i])
529 err = avc_general_inquiry_sig_fmt(oxfw->unit,
536 formats[eid] = kmemdup(buf, *len, GFP_KERNEL);
537 if (formats[eid] == NULL) {
541 formats[eid][2] = avc_stream_rate_table[i];
545 oxfw->assumed = true;
550 static int fill_stream_formats(struct snd_oxfw *oxfw,
551 enum avc_general_plug_dir dir,
555 unsigned int len, eid = 0;
556 struct snd_oxfw_stream_formation dummy;
559 buf = kmalloc(AVC_GENERIC_FRAME_MAXIMUM_BYTES, GFP_KERNEL);
563 if (dir == AVC_GENERAL_PLUG_DIR_OUT)
564 formats = oxfw->tx_stream_formats;
566 formats = oxfw->rx_stream_formats;
568 /* get first entry */
569 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
570 err = avc_stream_get_format_list(oxfw->unit, dir, 0, buf, &len, 0);
571 if (err == -ENOSYS) {
572 /* LIST subfunction is not implemented */
573 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
574 err = assume_stream_formats(oxfw, dir, pid, buf, &len,
577 } else if (err < 0) {
578 dev_err(&oxfw->unit->device,
579 "fail to get stream format %d for isoc %s plug %d:%d\n",
580 eid, (dir == AVC_GENERAL_PLUG_DIR_IN) ? "in" : "out",
585 /* LIST subfunction is implemented */
586 while (eid < SND_OXFW_STREAM_FORMAT_ENTRIES) {
587 /* The format is too short. */
593 /* parse and set stream format */
594 err = snd_oxfw_stream_parse_format(buf, &dummy);
598 formats[eid] = kmemdup(buf, len, GFP_KERNEL);
599 if (formats[eid] == NULL) {
605 len = AVC_GENERIC_FRAME_MAXIMUM_BYTES;
606 err = avc_stream_get_format_list(oxfw->unit, dir, 0,
608 /* No entries remained. */
609 if (err == -EINVAL) {
612 } else if (err < 0) {
613 dev_err(&oxfw->unit->device,
614 "fail to get stream format %d for isoc %s plug %d:%d\n",
615 eid, (dir == AVC_GENERAL_PLUG_DIR_IN) ? "in" :
626 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw)
628 u8 plugs[AVC_PLUG_INFO_BUF_BYTES];
631 /* the number of plugs for isoc in/out, ext in/out */
632 err = avc_general_get_plug_info(oxfw->unit, 0x1f, 0x07, 0x00, plugs);
634 dev_err(&oxfw->unit->device,
635 "fail to get info for isoc/external in/out plugs: %d\n",
638 } else if ((plugs[0] == 0) && (plugs[1] == 0)) {
643 /* use oPCR[0] if exists */
645 err = fill_stream_formats(oxfw, AVC_GENERAL_PLUG_DIR_OUT, 0);
648 oxfw->has_output = true;
651 /* use iPCR[0] if exists */
653 err = fill_stream_formats(oxfw, AVC_GENERAL_PLUG_DIR_IN, 0);
658 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw)
660 oxfw->dev_lock_changed = true;
661 wake_up(&oxfw->hwdep_wait);
664 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw)
668 spin_lock_irq(&oxfw->lock);
670 /* user land lock this */
671 if (oxfw->dev_lock_count < 0) {
676 /* this is the first time */
677 if (oxfw->dev_lock_count++ == 0)
678 snd_oxfw_stream_lock_changed(oxfw);
681 spin_unlock_irq(&oxfw->lock);
685 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw)
687 spin_lock_irq(&oxfw->lock);
689 if (WARN_ON(oxfw->dev_lock_count <= 0))
691 if (--oxfw->dev_lock_count == 0)
692 snd_oxfw_stream_lock_changed(oxfw);
694 spin_unlock_irq(&oxfw->lock);