1 // SPDX-License-Identifier: GPL-2.0-only
3 * motu-stream.c - a part of driver for MOTU FireWire series
5 * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
10 #define CALLBACK_TIMEOUT 200
12 #define ISOC_COMM_CONTROL_OFFSET 0x0b00
13 #define ISOC_COMM_CONTROL_MASK 0xffff0000
14 #define CHANGE_RX_ISOC_COMM_STATE 0x80000000
15 #define RX_ISOC_COMM_IS_ACTIVATED 0x40000000
16 #define RX_ISOC_COMM_CHANNEL_MASK 0x3f000000
17 #define RX_ISOC_COMM_CHANNEL_SHIFT 24
18 #define CHANGE_TX_ISOC_COMM_STATE 0x00800000
19 #define TX_ISOC_COMM_IS_ACTIVATED 0x00400000
20 #define TX_ISOC_COMM_CHANNEL_MASK 0x003f0000
21 #define TX_ISOC_COMM_CHANNEL_SHIFT 16
23 #define PACKET_FORMAT_OFFSET 0x0b10
24 #define TX_PACKET_EXCLUDE_DIFFERED_DATA_CHUNKS 0x00000080
25 #define RX_PACKET_EXCLUDE_DIFFERED_DATA_CHUNKS 0x00000040
26 #define TX_PACKET_TRANSMISSION_SPEED_MASK 0x0000000f
28 static int keep_resources(struct snd_motu *motu, unsigned int rate,
29 struct amdtp_stream *stream)
31 struct fw_iso_resources *resources;
32 struct snd_motu_packet_format *packet_format;
33 unsigned int midi_ports = 0;
36 if (stream == &motu->rx_stream) {
37 resources = &motu->rx_resources;
38 packet_format = &motu->rx_packet_formats;
40 if ((motu->spec->flags & SND_MOTU_SPEC_RX_MIDI_2ND_Q) ||
41 (motu->spec->flags & SND_MOTU_SPEC_RX_MIDI_3RD_Q))
44 resources = &motu->tx_resources;
45 packet_format = &motu->tx_packet_formats;
47 if ((motu->spec->flags & SND_MOTU_SPEC_TX_MIDI_2ND_Q) ||
48 (motu->spec->flags & SND_MOTU_SPEC_TX_MIDI_3RD_Q))
52 err = amdtp_motu_set_parameters(stream, rate, midi_ports,
57 return fw_iso_resources_allocate(resources,
58 amdtp_stream_get_max_payload(stream),
59 fw_parent_device(motu->unit)->max_speed);
62 static int begin_session(struct snd_motu *motu)
68 // Configure the unit to start isochronous communication.
69 err = snd_motu_transaction_read(motu, ISOC_COMM_CONTROL_OFFSET, ®,
73 data = be32_to_cpu(reg) & ~ISOC_COMM_CONTROL_MASK;
75 data |= CHANGE_RX_ISOC_COMM_STATE | RX_ISOC_COMM_IS_ACTIVATED |
76 (motu->rx_resources.channel << RX_ISOC_COMM_CHANNEL_SHIFT) |
77 CHANGE_TX_ISOC_COMM_STATE | TX_ISOC_COMM_IS_ACTIVATED |
78 (motu->tx_resources.channel << TX_ISOC_COMM_CHANNEL_SHIFT);
80 reg = cpu_to_be32(data);
81 return snd_motu_transaction_write(motu, ISOC_COMM_CONTROL_OFFSET, ®,
85 static void finish_session(struct snd_motu *motu)
91 err = motu->spec->protocol->switch_fetching_mode(motu, false);
95 err = snd_motu_transaction_read(motu, ISOC_COMM_CONTROL_OFFSET, ®,
99 data = be32_to_cpu(reg);
101 data &= ~(RX_ISOC_COMM_IS_ACTIVATED | TX_ISOC_COMM_IS_ACTIVATED);
102 data |= CHANGE_RX_ISOC_COMM_STATE | CHANGE_TX_ISOC_COMM_STATE;
104 reg = cpu_to_be32(data);
105 snd_motu_transaction_write(motu, ISOC_COMM_CONTROL_OFFSET, ®,
109 int snd_motu_stream_cache_packet_formats(struct snd_motu *motu)
113 err = motu->spec->protocol->cache_packet_formats(motu);
117 if (motu->spec->flags & SND_MOTU_SPEC_TX_MIDI_2ND_Q) {
118 motu->tx_packet_formats.midi_flag_offset = 4;
119 motu->tx_packet_formats.midi_byte_offset = 6;
120 } else if (motu->spec->flags & SND_MOTU_SPEC_TX_MIDI_3RD_Q) {
121 motu->tx_packet_formats.midi_flag_offset = 8;
122 motu->tx_packet_formats.midi_byte_offset = 7;
125 if (motu->spec->flags & SND_MOTU_SPEC_RX_MIDI_2ND_Q) {
126 motu->rx_packet_formats.midi_flag_offset = 4;
127 motu->rx_packet_formats.midi_byte_offset = 6;
128 } else if (motu->spec->flags & SND_MOTU_SPEC_RX_MIDI_3RD_Q) {
129 motu->rx_packet_formats.midi_flag_offset = 8;
130 motu->rx_packet_formats.midi_byte_offset = 7;
136 int snd_motu_stream_reserve_duplex(struct snd_motu *motu, unsigned int rate,
137 unsigned int frames_per_period)
139 unsigned int curr_rate;
142 err = motu->spec->protocol->get_clock_rate(motu, &curr_rate);
148 if (motu->substreams_counter == 0 || curr_rate != rate) {
149 amdtp_domain_stop(&motu->domain);
150 finish_session(motu);
152 fw_iso_resources_free(&motu->tx_resources);
153 fw_iso_resources_free(&motu->rx_resources);
155 err = motu->spec->protocol->set_clock_rate(motu, rate);
157 dev_err(&motu->unit->device,
158 "fail to set sampling rate: %d\n", err);
162 err = snd_motu_stream_cache_packet_formats(motu);
166 err = keep_resources(motu, rate, &motu->tx_stream);
170 err = keep_resources(motu, rate, &motu->rx_stream);
172 fw_iso_resources_free(&motu->tx_resources);
176 err = amdtp_domain_set_events_per_period(&motu->domain,
179 fw_iso_resources_free(&motu->tx_resources);
180 fw_iso_resources_free(&motu->rx_resources);
188 static int ensure_packet_formats(struct snd_motu *motu)
194 err = snd_motu_transaction_read(motu, PACKET_FORMAT_OFFSET, ®,
198 data = be32_to_cpu(reg);
200 data &= ~(TX_PACKET_EXCLUDE_DIFFERED_DATA_CHUNKS |
201 RX_PACKET_EXCLUDE_DIFFERED_DATA_CHUNKS|
202 TX_PACKET_TRANSMISSION_SPEED_MASK);
203 if (motu->tx_packet_formats.differed_part_pcm_chunks[0] == 0)
204 data |= TX_PACKET_EXCLUDE_DIFFERED_DATA_CHUNKS;
205 if (motu->rx_packet_formats.differed_part_pcm_chunks[0] == 0)
206 data |= RX_PACKET_EXCLUDE_DIFFERED_DATA_CHUNKS;
207 data |= fw_parent_device(motu->unit)->max_speed;
209 reg = cpu_to_be32(data);
210 return snd_motu_transaction_write(motu, PACKET_FORMAT_OFFSET, ®,
214 int snd_motu_stream_start_duplex(struct snd_motu *motu)
216 unsigned int generation = motu->rx_resources.generation;
219 if (motu->substreams_counter == 0)
222 if (amdtp_streaming_error(&motu->rx_stream) ||
223 amdtp_streaming_error(&motu->tx_stream)) {
224 amdtp_domain_stop(&motu->domain);
225 finish_session(motu);
228 if (generation != fw_parent_device(motu->unit)->card->generation) {
229 err = fw_iso_resources_update(&motu->rx_resources);
233 err = fw_iso_resources_update(&motu->tx_resources);
238 if (!amdtp_stream_running(&motu->rx_stream)) {
239 int spd = fw_parent_device(motu->unit)->max_speed;
241 err = ensure_packet_formats(motu);
245 err = begin_session(motu);
247 dev_err(&motu->unit->device,
248 "fail to start isochronous comm: %d\n", err);
252 err = amdtp_domain_add_stream(&motu->domain, &motu->tx_stream,
253 motu->tx_resources.channel, spd);
257 err = amdtp_domain_add_stream(&motu->domain, &motu->rx_stream,
258 motu->rx_resources.channel, spd);
262 err = amdtp_domain_start(&motu->domain);
266 if (!amdtp_stream_wait_callback(&motu->tx_stream,
268 !amdtp_stream_wait_callback(&motu->rx_stream,
274 err = motu->spec->protocol->switch_fetching_mode(motu, true);
276 dev_err(&motu->unit->device,
277 "fail to enable frame fetching: %d\n", err);
285 amdtp_domain_stop(&motu->domain);
286 finish_session(motu);
290 void snd_motu_stream_stop_duplex(struct snd_motu *motu)
292 if (motu->substreams_counter == 0) {
293 amdtp_domain_stop(&motu->domain);
294 finish_session(motu);
296 fw_iso_resources_free(&motu->tx_resources);
297 fw_iso_resources_free(&motu->rx_resources);
301 static int init_stream(struct snd_motu *motu, struct amdtp_stream *s)
303 struct fw_iso_resources *resources;
304 enum amdtp_stream_direction dir;
307 if (s == &motu->tx_stream) {
308 resources = &motu->tx_resources;
309 dir = AMDTP_IN_STREAM;
311 resources = &motu->rx_resources;
312 dir = AMDTP_OUT_STREAM;
315 err = fw_iso_resources_init(resources, motu->unit);
319 err = amdtp_motu_init(s, motu->unit, dir, motu->spec->protocol);
321 fw_iso_resources_destroy(resources);
326 static void destroy_stream(struct snd_motu *motu, struct amdtp_stream *s)
328 amdtp_stream_destroy(s);
330 if (s == &motu->tx_stream)
331 fw_iso_resources_destroy(&motu->tx_resources);
333 fw_iso_resources_destroy(&motu->rx_resources);
336 int snd_motu_stream_init_duplex(struct snd_motu *motu)
340 err = init_stream(motu, &motu->tx_stream);
344 err = init_stream(motu, &motu->rx_stream);
346 destroy_stream(motu, &motu->tx_stream);
350 err = amdtp_domain_init(&motu->domain);
352 destroy_stream(motu, &motu->tx_stream);
353 destroy_stream(motu, &motu->rx_stream);
359 // This function should be called before starting streams or after stopping
361 void snd_motu_stream_destroy_duplex(struct snd_motu *motu)
363 amdtp_domain_destroy(&motu->domain);
365 destroy_stream(motu, &motu->rx_stream);
366 destroy_stream(motu, &motu->tx_stream);
368 motu->substreams_counter = 0;
371 static void motu_lock_changed(struct snd_motu *motu)
373 motu->dev_lock_changed = true;
374 wake_up(&motu->hwdep_wait);
377 int snd_motu_stream_lock_try(struct snd_motu *motu)
381 spin_lock_irq(&motu->lock);
383 if (motu->dev_lock_count < 0) {
388 if (motu->dev_lock_count++ == 0)
389 motu_lock_changed(motu);
392 spin_unlock_irq(&motu->lock);
396 void snd_motu_stream_lock_release(struct snd_motu *motu)
398 spin_lock_irq(&motu->lock);
400 if (WARN_ON(motu->dev_lock_count <= 0))
403 if (--motu->dev_lock_count == 0)
404 motu_lock_changed(motu);
406 spin_unlock_irq(&motu->lock);