1 // SPDX-License-Identifier: GPL-2.0-only
3 * dice_stream.c - a part of driver for DICE based devices
5 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
6 * Copyright (c) 2014 Takashi Sakamoto <o-takashi@sakamocchi.jp>
11 #define CALLBACK_TIMEOUT 200
12 #define NOTIFICATION_TIMEOUT_MS (2 * MSEC_PER_SEC)
19 const unsigned int snd_dice_rates[SND_DICE_RATES_COUNT] = {
32 int snd_dice_stream_get_rate_mode(struct snd_dice *dice, unsigned int rate,
33 enum snd_dice_rate_mode *mode)
35 /* Corresponding to each entry in snd_dice_rates. */
36 static const enum snd_dice_rate_mode modes[] = {
37 [0] = SND_DICE_RATE_MODE_LOW,
38 [1] = SND_DICE_RATE_MODE_LOW,
39 [2] = SND_DICE_RATE_MODE_LOW,
40 [3] = SND_DICE_RATE_MODE_MIDDLE,
41 [4] = SND_DICE_RATE_MODE_MIDDLE,
42 [5] = SND_DICE_RATE_MODE_HIGH,
43 [6] = SND_DICE_RATE_MODE_HIGH,
47 for (i = 0; i < ARRAY_SIZE(snd_dice_rates); i++) {
48 if (!(dice->clock_caps & BIT(i)))
50 if (snd_dice_rates[i] != rate)
61 * This operation has an effect to synchronize GLOBAL_STATUS/GLOBAL_SAMPLE_RATE
62 * to GLOBAL_STATUS. Especially, just after powering on, these are different.
64 static int ensure_phase_lock(struct snd_dice *dice, unsigned int rate)
71 err = snd_dice_transaction_read_global(dice, GLOBAL_CLOCK_SELECT,
76 data = be32_to_cpu(reg);
78 data &= ~CLOCK_RATE_MASK;
79 for (i = 0; i < ARRAY_SIZE(snd_dice_rates); ++i) {
80 if (snd_dice_rates[i] == rate)
83 if (i == ARRAY_SIZE(snd_dice_rates))
85 data |= i << CLOCK_RATE_SHIFT;
87 if (completion_done(&dice->clock_accepted))
88 reinit_completion(&dice->clock_accepted);
90 reg = cpu_to_be32(data);
91 err = snd_dice_transaction_write_global(dice, GLOBAL_CLOCK_SELECT,
96 if (wait_for_completion_timeout(&dice->clock_accepted,
97 msecs_to_jiffies(NOTIFICATION_TIMEOUT_MS)) == 0) {
99 * Old versions of Dice firmware transfer no notification when
100 * the same clock status as current one is set. In this case,
101 * just check current clock status.
103 err = snd_dice_transaction_read_global(dice, GLOBAL_STATUS,
104 &nominal, sizeof(nominal));
107 if (!(be32_to_cpu(nominal) & STATUS_SOURCE_LOCKED))
114 static int get_register_params(struct snd_dice *dice,
115 struct reg_params *tx_params,
116 struct reg_params *rx_params)
121 err = snd_dice_transaction_read_tx(dice, TX_NUMBER, reg, sizeof(reg));
125 min_t(unsigned int, be32_to_cpu(reg[0]), MAX_STREAMS);
126 tx_params->size = be32_to_cpu(reg[1]) * 4;
128 err = snd_dice_transaction_read_rx(dice, RX_NUMBER, reg, sizeof(reg));
132 min_t(unsigned int, be32_to_cpu(reg[0]), MAX_STREAMS);
133 rx_params->size = be32_to_cpu(reg[1]) * 4;
138 static void release_resources(struct snd_dice *dice)
142 for (i = 0; i < MAX_STREAMS; ++i) {
143 fw_iso_resources_free(&dice->tx_resources[i]);
144 fw_iso_resources_free(&dice->rx_resources[i]);
148 static void stop_streams(struct snd_dice *dice, enum amdtp_stream_direction dir,
149 struct reg_params *params)
154 for (i = 0; i < params->count; i++) {
155 reg = cpu_to_be32((u32)-1);
156 if (dir == AMDTP_IN_STREAM) {
157 snd_dice_transaction_write_tx(dice,
158 params->size * i + TX_ISOCHRONOUS,
161 snd_dice_transaction_write_rx(dice,
162 params->size * i + RX_ISOCHRONOUS,
168 static int keep_resources(struct snd_dice *dice, struct amdtp_stream *stream,
169 struct fw_iso_resources *resources, unsigned int rate,
170 unsigned int pcm_chs, unsigned int midi_ports)
172 bool double_pcm_frames;
176 // At 176.4/192.0 kHz, Dice has a quirk to transfer two PCM frames in
177 // one data block of AMDTP packet. Thus sampling transfer frequency is
178 // a half of PCM sampling frequency, i.e. PCM frames at 192.0 kHz are
179 // transferred on AMDTP packets at 96 kHz. Two successive samples of a
180 // channel are stored consecutively in the packet. This quirk is called
182 // For this quirk, blocking mode is required and PCM buffer size should
183 // be aligned to SYT_INTERVAL.
184 double_pcm_frames = rate > 96000;
185 if (double_pcm_frames) {
190 err = amdtp_am824_set_parameters(stream, rate, pcm_chs, midi_ports,
195 if (double_pcm_frames) {
198 for (i = 0; i < pcm_chs; i++) {
199 amdtp_am824_set_pcm_position(stream, i, i * 2);
200 amdtp_am824_set_pcm_position(stream, i + pcm_chs,
205 return fw_iso_resources_allocate(resources,
206 amdtp_stream_get_max_payload(stream),
207 fw_parent_device(dice->unit)->max_speed);
210 static int keep_dual_resources(struct snd_dice *dice, unsigned int rate,
211 enum amdtp_stream_direction dir,
212 struct reg_params *params)
214 enum snd_dice_rate_mode mode;
218 err = snd_dice_stream_get_rate_mode(dice, rate, &mode);
222 for (i = 0; i < params->count; ++i) {
224 struct amdtp_stream *stream;
225 struct fw_iso_resources *resources;
226 unsigned int pcm_cache;
227 unsigned int midi_cache;
228 unsigned int pcm_chs;
229 unsigned int midi_ports;
231 if (dir == AMDTP_IN_STREAM) {
232 stream = &dice->tx_stream[i];
233 resources = &dice->tx_resources[i];
235 pcm_cache = dice->tx_pcm_chs[i][mode];
236 midi_cache = dice->tx_midi_ports[i];
237 err = snd_dice_transaction_read_tx(dice,
238 params->size * i + TX_NUMBER_AUDIO,
241 stream = &dice->rx_stream[i];
242 resources = &dice->rx_resources[i];
244 pcm_cache = dice->rx_pcm_chs[i][mode];
245 midi_cache = dice->rx_midi_ports[i];
246 err = snd_dice_transaction_read_rx(dice,
247 params->size * i + RX_NUMBER_AUDIO,
252 pcm_chs = be32_to_cpu(reg[0]);
253 midi_ports = be32_to_cpu(reg[1]);
255 // These are important for developer of this driver.
256 if (pcm_chs != pcm_cache || midi_ports != midi_cache) {
257 dev_info(&dice->unit->device,
258 "cache mismatch: pcm: %u:%u, midi: %u:%u\n",
259 pcm_chs, pcm_cache, midi_ports, midi_cache);
263 err = keep_resources(dice, stream, resources, rate, pcm_chs,
272 static void finish_session(struct snd_dice *dice, struct reg_params *tx_params,
273 struct reg_params *rx_params)
275 stop_streams(dice, AMDTP_IN_STREAM, tx_params);
276 stop_streams(dice, AMDTP_OUT_STREAM, rx_params);
278 snd_dice_transaction_clear_enable(dice);
281 int snd_dice_stream_reserve_duplex(struct snd_dice *dice, unsigned int rate)
283 unsigned int curr_rate;
286 // Check sampling transmission frequency.
287 err = snd_dice_transaction_get_rate(dice, &curr_rate);
293 if (dice->substreams_counter == 0 || curr_rate != rate) {
294 struct reg_params tx_params, rx_params;
296 amdtp_domain_stop(&dice->domain);
298 err = get_register_params(dice, &tx_params, &rx_params);
301 finish_session(dice, &tx_params, &rx_params);
303 release_resources(dice);
305 // Just after owning the unit (GLOBAL_OWNER), the unit can
306 // return invalid stream formats. Selecting clock parameters
307 // have an effect for the unit to refine it.
308 err = ensure_phase_lock(dice, rate);
312 // After changing sampling transfer frequency, the value of
313 // register can be changed.
314 err = get_register_params(dice, &tx_params, &rx_params);
318 err = keep_dual_resources(dice, rate, AMDTP_IN_STREAM,
323 err = keep_dual_resources(dice, rate, AMDTP_OUT_STREAM,
331 release_resources(dice);
335 static int start_streams(struct snd_dice *dice, enum amdtp_stream_direction dir,
336 unsigned int rate, struct reg_params *params)
338 unsigned int max_speed = fw_parent_device(dice->unit)->max_speed;
342 for (i = 0; i < params->count; i++) {
343 struct amdtp_stream *stream;
344 struct fw_iso_resources *resources;
347 if (dir == AMDTP_IN_STREAM) {
348 stream = dice->tx_stream + i;
349 resources = dice->tx_resources + i;
351 stream = dice->rx_stream + i;
352 resources = dice->rx_resources + i;
355 reg = cpu_to_be32(resources->channel);
356 if (dir == AMDTP_IN_STREAM) {
357 err = snd_dice_transaction_write_tx(dice,
358 params->size * i + TX_ISOCHRONOUS,
361 err = snd_dice_transaction_write_rx(dice,
362 params->size * i + RX_ISOCHRONOUS,
368 if (dir == AMDTP_IN_STREAM) {
369 reg = cpu_to_be32(max_speed);
370 err = snd_dice_transaction_write_tx(dice,
371 params->size * i + TX_SPEED,
377 err = amdtp_domain_add_stream(&dice->domain, stream,
378 resources->channel, max_speed);
387 * MEMO: After this function, there're two states of streams:
388 * - None streams are running.
389 * - All streams are running.
391 int snd_dice_stream_start_duplex(struct snd_dice *dice)
393 unsigned int generation = dice->rx_resources[0].generation;
394 struct reg_params tx_params, rx_params;
397 enum snd_dice_rate_mode mode;
400 if (dice->substreams_counter == 0)
403 err = get_register_params(dice, &tx_params, &rx_params);
407 // Check error of packet streaming.
408 for (i = 0; i < MAX_STREAMS; ++i) {
409 if (amdtp_streaming_error(&dice->tx_stream[i]) ||
410 amdtp_streaming_error(&dice->rx_stream[i])) {
411 amdtp_domain_stop(&dice->domain);
412 finish_session(dice, &tx_params, &rx_params);
417 if (generation != fw_parent_device(dice->unit)->card->generation) {
418 for (i = 0; i < MAX_STREAMS; ++i) {
419 if (i < tx_params.count)
420 fw_iso_resources_update(dice->tx_resources + i);
421 if (i < rx_params.count)
422 fw_iso_resources_update(dice->rx_resources + i);
426 // Check required streams are running or not.
427 err = snd_dice_transaction_get_rate(dice, &rate);
430 err = snd_dice_stream_get_rate_mode(dice, rate, &mode);
433 for (i = 0; i < MAX_STREAMS; ++i) {
434 if (dice->tx_pcm_chs[i][mode] > 0 &&
435 !amdtp_stream_running(&dice->tx_stream[i]))
437 if (dice->rx_pcm_chs[i][mode] > 0 &&
438 !amdtp_stream_running(&dice->rx_stream[i]))
441 if (i < MAX_STREAMS) {
442 // Start both streams.
443 err = start_streams(dice, AMDTP_IN_STREAM, rate, &tx_params);
447 err = start_streams(dice, AMDTP_OUT_STREAM, rate, &rx_params);
451 err = snd_dice_transaction_set_enable(dice);
453 dev_err(&dice->unit->device,
454 "fail to enable interface\n");
458 err = amdtp_domain_start(&dice->domain);
462 for (i = 0; i < MAX_STREAMS; i++) {
463 if ((i < tx_params.count &&
464 !amdtp_stream_wait_callback(&dice->tx_stream[i],
465 CALLBACK_TIMEOUT)) ||
466 (i < rx_params.count &&
467 !amdtp_stream_wait_callback(&dice->rx_stream[i],
468 CALLBACK_TIMEOUT))) {
477 amdtp_domain_stop(&dice->domain);
478 finish_session(dice, &tx_params, &rx_params);
483 * MEMO: After this function, there're two states of streams:
484 * - None streams are running.
485 * - All streams are running.
487 void snd_dice_stream_stop_duplex(struct snd_dice *dice)
489 struct reg_params tx_params, rx_params;
491 if (dice->substreams_counter == 0) {
492 if (get_register_params(dice, &tx_params, &rx_params) >= 0)
493 finish_session(dice, &tx_params, &rx_params);
495 amdtp_domain_stop(&dice->domain);
496 release_resources(dice);
500 static int init_stream(struct snd_dice *dice, enum amdtp_stream_direction dir,
503 struct amdtp_stream *stream;
504 struct fw_iso_resources *resources;
507 if (dir == AMDTP_IN_STREAM) {
508 stream = &dice->tx_stream[index];
509 resources = &dice->tx_resources[index];
511 stream = &dice->rx_stream[index];
512 resources = &dice->rx_resources[index];
515 err = fw_iso_resources_init(resources, dice->unit);
518 resources->channels_mask = 0x00000000ffffffffuLL;
520 err = amdtp_am824_init(stream, dice->unit, dir, CIP_BLOCKING);
522 amdtp_stream_destroy(stream);
523 fw_iso_resources_destroy(resources);
530 * This function should be called before starting streams or after stopping
533 static void destroy_stream(struct snd_dice *dice,
534 enum amdtp_stream_direction dir,
537 struct amdtp_stream *stream;
538 struct fw_iso_resources *resources;
540 if (dir == AMDTP_IN_STREAM) {
541 stream = &dice->tx_stream[index];
542 resources = &dice->tx_resources[index];
544 stream = &dice->rx_stream[index];
545 resources = &dice->rx_resources[index];
548 amdtp_stream_destroy(stream);
549 fw_iso_resources_destroy(resources);
552 int snd_dice_stream_init_duplex(struct snd_dice *dice)
556 for (i = 0; i < MAX_STREAMS; i++) {
557 err = init_stream(dice, AMDTP_IN_STREAM, i);
560 destroy_stream(dice, AMDTP_IN_STREAM, i);
565 for (i = 0; i < MAX_STREAMS; i++) {
566 err = init_stream(dice, AMDTP_OUT_STREAM, i);
569 destroy_stream(dice, AMDTP_OUT_STREAM, i);
570 for (i = 0; i < MAX_STREAMS; i++)
571 destroy_stream(dice, AMDTP_IN_STREAM, i);
576 err = amdtp_domain_init(&dice->domain);
578 for (i = 0; i < MAX_STREAMS; ++i) {
579 destroy_stream(dice, AMDTP_OUT_STREAM, i);
580 destroy_stream(dice, AMDTP_IN_STREAM, i);
587 void snd_dice_stream_destroy_duplex(struct snd_dice *dice)
591 for (i = 0; i < MAX_STREAMS; i++) {
592 destroy_stream(dice, AMDTP_IN_STREAM, i);
593 destroy_stream(dice, AMDTP_OUT_STREAM, i);
596 amdtp_domain_destroy(&dice->domain);
599 void snd_dice_stream_update_duplex(struct snd_dice *dice)
601 struct reg_params tx_params, rx_params;
604 * On a bus reset, the DICE firmware disables streaming and then goes
605 * off contemplating its own navel for hundreds of milliseconds before
606 * it can react to any of our attempts to reenable streaming. This
607 * means that we lose synchronization anyway, so we force our streams
608 * to stop so that the application can restart them in an orderly
611 dice->global_enabled = false;
613 if (get_register_params(dice, &tx_params, &rx_params) == 0) {
614 amdtp_domain_stop(&dice->domain);
616 stop_streams(dice, AMDTP_IN_STREAM, &tx_params);
617 stop_streams(dice, AMDTP_OUT_STREAM, &rx_params);
621 int snd_dice_stream_detect_current_formats(struct snd_dice *dice)
624 enum snd_dice_rate_mode mode;
626 struct reg_params tx_params, rx_params;
630 /* If extended protocol is available, detect detail spec. */
631 err = snd_dice_detect_extension_formats(dice);
636 * Available stream format is restricted at current mode of sampling
639 err = snd_dice_transaction_get_rate(dice, &rate);
643 err = snd_dice_stream_get_rate_mode(dice, rate, &mode);
648 * Just after owning the unit (GLOBAL_OWNER), the unit can return
649 * invalid stream formats. Selecting clock parameters have an effect
650 * for the unit to refine it.
652 err = ensure_phase_lock(dice, rate);
656 err = get_register_params(dice, &tx_params, &rx_params);
660 for (i = 0; i < tx_params.count; ++i) {
661 err = snd_dice_transaction_read_tx(dice,
662 tx_params.size * i + TX_NUMBER_AUDIO,
666 dice->tx_pcm_chs[i][mode] = be32_to_cpu(reg[0]);
667 dice->tx_midi_ports[i] = max_t(unsigned int,
668 be32_to_cpu(reg[1]), dice->tx_midi_ports[i]);
670 for (i = 0; i < rx_params.count; ++i) {
671 err = snd_dice_transaction_read_rx(dice,
672 rx_params.size * i + RX_NUMBER_AUDIO,
676 dice->rx_pcm_chs[i][mode] = be32_to_cpu(reg[0]);
677 dice->rx_midi_ports[i] = max_t(unsigned int,
678 be32_to_cpu(reg[1]), dice->rx_midi_ports[i]);
684 static void dice_lock_changed(struct snd_dice *dice)
686 dice->dev_lock_changed = true;
687 wake_up(&dice->hwdep_wait);
690 int snd_dice_stream_lock_try(struct snd_dice *dice)
694 spin_lock_irq(&dice->lock);
696 if (dice->dev_lock_count < 0) {
701 if (dice->dev_lock_count++ == 0)
702 dice_lock_changed(dice);
705 spin_unlock_irq(&dice->lock);
709 void snd_dice_stream_lock_release(struct snd_dice *dice)
711 spin_lock_irq(&dice->lock);
713 if (WARN_ON(dice->dev_lock_count <= 0))
716 if (--dice->dev_lock_count == 0)
717 dice_lock_changed(dice);
719 spin_unlock_irq(&dice->lock);