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
= formation
.midi
* 8;
153 /* The stream should have one pcm channels at least */
154 if (pcm_channels
== 0) {
158 err
= amdtp_am824_set_parameters(stream
, rate
, pcm_channels
, midi_ports
,
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
|
248 oxfw
->tx_stream
.flags
|= CIP_WRONG_DBS
;
254 int snd_oxfw_stream_start_simplex(struct snd_oxfw
*oxfw
,
255 struct amdtp_stream
*stream
,
256 unsigned int rate
, unsigned int pcm_channels
)
258 struct amdtp_stream
*opposite
;
259 struct snd_oxfw_stream_formation formation
;
260 enum avc_general_plug_dir dir
;
261 unsigned int substreams
, opposite_substreams
;
264 if (stream
== &oxfw
->tx_stream
) {
265 substreams
= oxfw
->capture_substreams
;
266 opposite
= &oxfw
->rx_stream
;
267 opposite_substreams
= oxfw
->playback_substreams
;
268 dir
= AVC_GENERAL_PLUG_DIR_OUT
;
270 substreams
= oxfw
->playback_substreams
;
271 opposite_substreams
= oxfw
->capture_substreams
;
273 if (oxfw
->has_output
)
274 opposite
= &oxfw
->rx_stream
;
278 dir
= AVC_GENERAL_PLUG_DIR_IN
;
285 * Considering JACK/FFADO streaming:
286 * TODO: This can be removed hwdep functionality becomes popular.
288 err
= check_connection_used_by_others(oxfw
, stream
);
292 /* packet queueing error */
293 if (amdtp_streaming_error(stream
))
294 stop_stream(oxfw
, stream
);
296 err
= snd_oxfw_stream_get_current_formation(oxfw
, dir
, &formation
);
300 rate
= formation
.rate
;
301 if (pcm_channels
== 0)
302 pcm_channels
= formation
.pcm
;
304 if ((formation
.rate
!= rate
) || (formation
.pcm
!= pcm_channels
)) {
305 if (opposite
!= NULL
) {
306 err
= check_connection_used_by_others(oxfw
, opposite
);
309 stop_stream(oxfw
, opposite
);
311 stop_stream(oxfw
, stream
);
313 err
= set_stream_format(oxfw
, stream
, rate
, pcm_channels
);
315 dev_err(&oxfw
->unit
->device
,
316 "fail to set stream format: %d\n", err
);
320 /* Start opposite stream if needed. */
321 if (opposite
&& !amdtp_stream_running(opposite
) &&
322 (opposite_substreams
> 0)) {
323 err
= start_stream(oxfw
, opposite
, rate
, 0);
325 dev_err(&oxfw
->unit
->device
,
326 "fail to restart stream: %d\n", err
);
332 /* Start requested stream. */
333 if (!amdtp_stream_running(stream
)) {
334 err
= start_stream(oxfw
, stream
, rate
, pcm_channels
);
336 dev_err(&oxfw
->unit
->device
,
337 "fail to start stream: %d\n", err
);
343 void snd_oxfw_stream_stop_simplex(struct snd_oxfw
*oxfw
,
344 struct amdtp_stream
*stream
)
346 if (((stream
== &oxfw
->tx_stream
) && (oxfw
->capture_substreams
> 0)) ||
347 ((stream
== &oxfw
->rx_stream
) && (oxfw
->playback_substreams
> 0)))
350 stop_stream(oxfw
, stream
);
354 * This function should be called before starting the stream or after stopping
357 void snd_oxfw_stream_destroy_simplex(struct snd_oxfw
*oxfw
,
358 struct amdtp_stream
*stream
)
360 struct cmp_connection
*conn
;
362 if (stream
== &oxfw
->tx_stream
)
363 conn
= &oxfw
->out_conn
;
365 conn
= &oxfw
->in_conn
;
367 amdtp_stream_destroy(stream
);
368 cmp_connection_destroy(conn
);
371 void snd_oxfw_stream_update_simplex(struct snd_oxfw
*oxfw
,
372 struct amdtp_stream
*stream
)
374 struct cmp_connection
*conn
;
376 if (stream
== &oxfw
->tx_stream
)
377 conn
= &oxfw
->out_conn
;
379 conn
= &oxfw
->in_conn
;
381 if (cmp_connection_update(conn
) < 0)
382 stop_stream(oxfw
, stream
);
384 amdtp_stream_update(stream
);
387 int snd_oxfw_stream_get_current_formation(struct snd_oxfw
*oxfw
,
388 enum avc_general_plug_dir dir
,
389 struct snd_oxfw_stream_formation
*formation
)
395 len
= AVC_GENERIC_FRAME_MAXIMUM_BYTES
;
396 format
= kmalloc(len
, GFP_KERNEL
);
400 err
= avc_stream_get_format_single(oxfw
->unit
, dir
, 0, format
, &len
);
408 err
= snd_oxfw_stream_parse_format(format
, formation
);
415 * See Table 6.16 - AM824 Stream Format
416 * Figure 6.19 - format_information field for AM824 Compound
417 * in AV/C Stream Format Information Specification 1.1 (Apr 2005, 1394TA)
418 * Also 'Clause 12 AM824 sequence adaption layers' in IEC 61883-6:2005
420 int snd_oxfw_stream_parse_format(u8
*format
,
421 struct snd_oxfw_stream_formation
*formation
)
423 unsigned int i
, e
, channels
, type
;
425 memset(formation
, 0, sizeof(struct snd_oxfw_stream_formation
));
428 * this module can support a hierarchy combination that:
429 * Root: Audio and Music (0x90)
430 * Level 1: AM824 Compound (0x40)
432 if ((format
[0] != 0x90) || (format
[1] != 0x40))
435 /* check the sampling rate */
436 for (i
= 0; i
< ARRAY_SIZE(avc_stream_rate_table
); i
++) {
437 if (format
[2] == avc_stream_rate_table
[i
])
440 if (i
== ARRAY_SIZE(avc_stream_rate_table
))
443 formation
->rate
= oxfw_rate_table
[i
];
445 for (e
= 0; e
< format
[4]; e
++) {
446 channels
= format
[5 + e
* 2];
447 type
= format
[6 + e
* 2];
450 /* IEC 60958 Conformant, currently handled as MBLA */
452 /* Multi Bit Linear Audio (Raw) */
454 formation
->pcm
+= channels
;
456 /* MIDI Conformant */
458 formation
->midi
= channels
;
460 /* IEC 61937-3 to 7 */
466 /* Multi Bit Linear Audio */
467 case 0x07: /* DVD-Audio */
468 case 0x0c: /* High Precision */
470 case 0x08: /* (Plain) Raw */
471 case 0x09: /* (Plain) SACD */
472 case 0x0a: /* (Encoded) Raw */
473 case 0x0b: /* (Encoded) SACD */
474 /* SMPTE Time-Code conformant */
480 /* Synchronization Stream (Stereo Raw audio) */
485 return -ENOSYS
; /* not supported */
489 if (formation
->pcm
> AM824_MAX_CHANNELS_FOR_PCM
||
490 formation
->midi
> AM824_MAX_CHANNELS_FOR_MIDI
)
497 assume_stream_formats(struct snd_oxfw
*oxfw
, enum avc_general_plug_dir dir
,
498 unsigned int pid
, u8
*buf
, unsigned int *len
,
501 struct snd_oxfw_stream_formation formation
;
505 /* get format at current sampling rate */
506 err
= avc_stream_get_format_single(oxfw
->unit
, dir
, pid
, buf
, len
);
508 dev_err(&oxfw
->unit
->device
,
509 "fail to get current stream format for isoc %s plug %d:%d\n",
510 (dir
== AVC_GENERAL_PLUG_DIR_IN
) ? "in" : "out",
515 /* parse and set stream format */
517 err
= snd_oxfw_stream_parse_format(buf
, &formation
);
521 formats
[eid
] = kmemdup(buf
, *len
, GFP_KERNEL
);
522 if (formats
[eid
] == NULL
) {
527 /* apply the format for each available sampling rate */
528 for (i
= 0; i
< ARRAY_SIZE(oxfw_rate_table
); i
++) {
529 if (formation
.rate
== oxfw_rate_table
[i
])
532 err
= avc_general_inquiry_sig_fmt(oxfw
->unit
,
539 formats
[eid
] = kmemdup(buf
, *len
, GFP_KERNEL
);
540 if (formats
[eid
] == NULL
) {
544 formats
[eid
][2] = avc_stream_rate_table
[i
];
548 oxfw
->assumed
= true;
553 static int fill_stream_formats(struct snd_oxfw
*oxfw
,
554 enum avc_general_plug_dir dir
,
558 unsigned int len
, eid
= 0;
559 struct snd_oxfw_stream_formation dummy
;
562 buf
= kmalloc(AVC_GENERIC_FRAME_MAXIMUM_BYTES
, GFP_KERNEL
);
566 if (dir
== AVC_GENERAL_PLUG_DIR_OUT
)
567 formats
= oxfw
->tx_stream_formats
;
569 formats
= oxfw
->rx_stream_formats
;
571 /* get first entry */
572 len
= AVC_GENERIC_FRAME_MAXIMUM_BYTES
;
573 err
= avc_stream_get_format_list(oxfw
->unit
, dir
, 0, buf
, &len
, 0);
574 if (err
== -ENOSYS
) {
575 /* LIST subfunction is not implemented */
576 len
= AVC_GENERIC_FRAME_MAXIMUM_BYTES
;
577 err
= assume_stream_formats(oxfw
, dir
, pid
, buf
, &len
,
580 } else if (err
< 0) {
581 dev_err(&oxfw
->unit
->device
,
582 "fail to get stream format %d for isoc %s plug %d:%d\n",
583 eid
, (dir
== AVC_GENERAL_PLUG_DIR_IN
) ? "in" : "out",
588 /* LIST subfunction is implemented */
589 while (eid
< SND_OXFW_STREAM_FORMAT_ENTRIES
) {
590 /* The format is too short. */
596 /* parse and set stream format */
597 err
= snd_oxfw_stream_parse_format(buf
, &dummy
);
601 formats
[eid
] = kmemdup(buf
, len
, GFP_KERNEL
);
602 if (formats
[eid
] == NULL
) {
608 len
= AVC_GENERIC_FRAME_MAXIMUM_BYTES
;
609 err
= avc_stream_get_format_list(oxfw
->unit
, dir
, 0,
611 /* No entries remained. */
612 if (err
== -EINVAL
) {
615 } else if (err
< 0) {
616 dev_err(&oxfw
->unit
->device
,
617 "fail to get stream format %d for isoc %s plug %d:%d\n",
618 eid
, (dir
== AVC_GENERAL_PLUG_DIR_IN
) ? "in" :
629 int snd_oxfw_stream_discover(struct snd_oxfw
*oxfw
)
631 u8 plugs
[AVC_PLUG_INFO_BUF_BYTES
];
632 struct snd_oxfw_stream_formation formation
;
637 /* the number of plugs for isoc in/out, ext in/out */
638 err
= avc_general_get_plug_info(oxfw
->unit
, 0x1f, 0x07, 0x00, plugs
);
640 dev_err(&oxfw
->unit
->device
,
641 "fail to get info for isoc/external in/out plugs: %d\n",
644 } else if ((plugs
[0] == 0) && (plugs
[1] == 0)) {
649 /* use oPCR[0] if exists */
651 err
= fill_stream_formats(oxfw
, AVC_GENERAL_PLUG_DIR_OUT
, 0);
655 for (i
= 0; i
< SND_OXFW_STREAM_FORMAT_ENTRIES
; i
++) {
656 format
= oxfw
->tx_stream_formats
[i
];
659 err
= snd_oxfw_stream_parse_format(format
, &formation
);
663 /* Add one MIDI port. */
664 if (formation
.midi
> 0)
665 oxfw
->midi_input_ports
= 1;
668 oxfw
->has_output
= true;
671 /* use iPCR[0] if exists */
673 err
= fill_stream_formats(oxfw
, AVC_GENERAL_PLUG_DIR_IN
, 0);
677 for (i
= 0; i
< SND_OXFW_STREAM_FORMAT_ENTRIES
; i
++) {
678 format
= oxfw
->rx_stream_formats
[i
];
681 err
= snd_oxfw_stream_parse_format(format
, &formation
);
685 /* Add one MIDI port. */
686 if (formation
.midi
> 0)
687 oxfw
->midi_output_ports
= 1;
694 void snd_oxfw_stream_lock_changed(struct snd_oxfw
*oxfw
)
696 oxfw
->dev_lock_changed
= true;
697 wake_up(&oxfw
->hwdep_wait
);
700 int snd_oxfw_stream_lock_try(struct snd_oxfw
*oxfw
)
704 spin_lock_irq(&oxfw
->lock
);
706 /* user land lock this */
707 if (oxfw
->dev_lock_count
< 0) {
712 /* this is the first time */
713 if (oxfw
->dev_lock_count
++ == 0)
714 snd_oxfw_stream_lock_changed(oxfw
);
717 spin_unlock_irq(&oxfw
->lock
);
721 void snd_oxfw_stream_lock_release(struct snd_oxfw
*oxfw
)
723 spin_lock_irq(&oxfw
->lock
);
725 if (WARN_ON(oxfw
->dev_lock_count
<= 0))
727 if (--oxfw
->dev_lock_count
== 0)
728 snd_oxfw_stream_lock_changed(oxfw
);
730 spin_unlock_irq(&oxfw
->lock
);