1 // SPDX-License-Identifier: GPL-2.0-only
3 * Apple iSight audio driver
5 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
8 #include <asm/byteorder.h>
9 #include <linux/delay.h>
10 #include <linux/device.h>
11 #include <linux/firewire.h>
12 #include <linux/firewire-constants.h>
13 #include <linux/module.h>
14 #include <linux/mod_devicetable.h>
15 #include <linux/mutex.h>
16 #include <linux/string.h>
17 #include <sound/control.h>
18 #include <sound/core.h>
19 #include <sound/initval.h>
20 #include <sound/pcm.h>
21 #include <sound/tlv.h>
23 #include "iso-resources.h"
24 #include "packets-buffer.h"
26 #define OUI_APPLE 0x000a27
27 #define MODEL_APPLE_ISIGHT 0x000008
28 #define SW_ISIGHT_AUDIO 0x000010
30 #define REG_AUDIO_ENABLE 0x000
31 #define AUDIO_ENABLE 0x80000000
32 #define REG_DEF_AUDIO_GAIN 0x204
33 #define REG_GAIN_RAW_START 0x210
34 #define REG_GAIN_RAW_END 0x214
35 #define REG_GAIN_DB_START 0x218
36 #define REG_GAIN_DB_END 0x21c
37 #define REG_SAMPLE_RATE_INQUIRY 0x280
38 #define REG_ISO_TX_CONFIG 0x300
39 #define SPEED_SHIFT 16
40 #define REG_SAMPLE_RATE 0x400
41 #define RATE_48000 0x80000000
42 #define REG_GAIN 0x500
43 #define REG_MUTE 0x504
45 #define MAX_FRAMES_PER_PACKET 475
47 #define QUEUE_LENGTH 20
50 struct snd_card *card;
52 struct fw_device *device;
54 struct snd_pcm_substream *pcm;
56 struct iso_packets_buffer buffer;
57 struct fw_iso_resources resources;
58 struct fw_iso_context *context;
64 unsigned int buffer_pointer;
65 unsigned int period_counter;
66 s32 gain_min, gain_max;
67 unsigned int gain_tlv[4];
70 struct audio_payload {
75 __be16 samples[2 * MAX_FRAMES_PER_PACKET];
78 MODULE_DESCRIPTION("iSight audio driver");
79 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
80 MODULE_LICENSE("GPL v2");
82 static struct fw_iso_packet audio_packet = {
83 .payload_length = sizeof(struct audio_payload),
88 static void isight_update_pointers(struct isight *isight, unsigned int count)
90 struct snd_pcm_runtime *runtime = isight->pcm->runtime;
93 smp_wmb(); /* update buffer data before buffer pointer */
95 ptr = isight->buffer_pointer;
97 if (ptr >= runtime->buffer_size)
98 ptr -= runtime->buffer_size;
99 WRITE_ONCE(isight->buffer_pointer, ptr);
101 isight->period_counter += count;
102 if (isight->period_counter >= runtime->period_size) {
103 isight->period_counter -= runtime->period_size;
104 snd_pcm_period_elapsed(isight->pcm);
108 static void isight_samples(struct isight *isight,
109 const __be16 *samples, unsigned int count)
111 struct snd_pcm_runtime *runtime;
114 if (!READ_ONCE(isight->pcm_running))
117 runtime = isight->pcm->runtime;
118 if (isight->buffer_pointer + count <= runtime->buffer_size) {
119 memcpy(runtime->dma_area + isight->buffer_pointer * 4,
122 count1 = runtime->buffer_size - isight->buffer_pointer;
123 memcpy(runtime->dma_area + isight->buffer_pointer * 4,
124 samples, count1 * 4);
125 samples += count1 * 2;
126 memcpy(runtime->dma_area, samples, (count - count1) * 4);
129 isight_update_pointers(isight, count);
132 static void isight_pcm_abort(struct isight *isight)
134 if (READ_ONCE(isight->pcm_active))
135 snd_pcm_stop_xrun(isight->pcm);
138 static void isight_dropped_samples(struct isight *isight, unsigned int total)
140 struct snd_pcm_runtime *runtime;
144 if (!READ_ONCE(isight->pcm_running))
147 runtime = isight->pcm->runtime;
148 dropped = total - isight->total_samples;
149 if (dropped < runtime->buffer_size) {
150 if (isight->buffer_pointer + dropped <= runtime->buffer_size) {
151 memset(runtime->dma_area + isight->buffer_pointer * 4,
154 count1 = runtime->buffer_size - isight->buffer_pointer;
155 memset(runtime->dma_area + isight->buffer_pointer * 4,
157 memset(runtime->dma_area, 0, (dropped - count1) * 4);
159 isight_update_pointers(isight, dropped);
161 isight_pcm_abort(isight);
165 static void isight_packet(struct fw_iso_context *context, u32 cycle,
166 size_t header_length, void *header, void *data)
168 struct isight *isight = data;
169 const struct audio_payload *payload;
170 unsigned int index, length, count, total;
173 if (isight->packet_index < 0)
175 index = isight->packet_index;
176 payload = isight->buffer.packets[index].buffer;
177 length = be32_to_cpup(header) >> 16;
179 if (likely(length >= 16 &&
180 payload->signature == cpu_to_be32(0x73676874/*"sght"*/))) {
181 count = be32_to_cpu(payload->sample_count);
182 if (likely(count <= (length - 16) / 4)) {
183 total = be32_to_cpu(payload->sample_total);
184 if (unlikely(total != isight->total_samples)) {
185 if (!isight->first_packet)
186 isight_dropped_samples(isight, total);
187 isight->first_packet = false;
188 isight->total_samples = total;
191 isight_samples(isight, payload->samples, count);
192 isight->total_samples += count;
196 err = fw_iso_context_queue(isight->context, &audio_packet,
197 &isight->buffer.iso_buffer,
198 isight->buffer.packets[index].offset);
200 dev_err(&isight->unit->device, "queueing error: %d\n", err);
201 isight_pcm_abort(isight);
202 isight->packet_index = -1;
205 fw_iso_context_queue_flush(isight->context);
207 if (++index >= QUEUE_LENGTH)
209 isight->packet_index = index;
212 static int isight_connect(struct isight *isight)
217 retry_after_bus_reset:
218 ch = fw_iso_resources_allocate(&isight->resources,
219 sizeof(struct audio_payload),
220 isight->device->max_speed);
226 value = cpu_to_be32(ch | (isight->device->max_speed << SPEED_SHIFT));
227 err = snd_fw_transaction(isight->unit, TCODE_WRITE_QUADLET_REQUEST,
228 isight->audio_base + REG_ISO_TX_CONFIG,
229 &value, 4, FW_FIXED_GENERATION |
230 isight->resources.generation);
231 if (err == -EAGAIN) {
232 fw_iso_resources_free(&isight->resources);
233 goto retry_after_bus_reset;
234 } else if (err < 0) {
241 fw_iso_resources_free(&isight->resources);
246 static int isight_open(struct snd_pcm_substream *substream)
248 static const struct snd_pcm_hardware hardware = {
249 .info = SNDRV_PCM_INFO_MMAP |
250 SNDRV_PCM_INFO_MMAP_VALID |
251 SNDRV_PCM_INFO_BATCH |
252 SNDRV_PCM_INFO_INTERLEAVED |
253 SNDRV_PCM_INFO_BLOCK_TRANSFER,
254 .formats = SNDRV_PCM_FMTBIT_S16_BE,
255 .rates = SNDRV_PCM_RATE_48000,
260 .buffer_bytes_max = 4 * 1024 * 1024,
261 .period_bytes_min = MAX_FRAMES_PER_PACKET * 4,
262 .period_bytes_max = 1024 * 1024,
264 .periods_max = UINT_MAX,
266 struct isight *isight = substream->private_data;
268 substream->runtime->hw = hardware;
270 return iso_packets_buffer_init(&isight->buffer, isight->unit,
272 sizeof(struct audio_payload),
276 static int isight_close(struct snd_pcm_substream *substream)
278 struct isight *isight = substream->private_data;
280 iso_packets_buffer_destroy(&isight->buffer, isight->unit);
285 static int isight_hw_params(struct snd_pcm_substream *substream,
286 struct snd_pcm_hw_params *hw_params)
288 struct isight *isight = substream->private_data;
290 WRITE_ONCE(isight->pcm_active, true);
295 static int reg_read(struct isight *isight, int offset, __be32 *value)
297 return snd_fw_transaction(isight->unit, TCODE_READ_QUADLET_REQUEST,
298 isight->audio_base + offset, value, 4, 0);
301 static int reg_write(struct isight *isight, int offset, __be32 value)
303 return snd_fw_transaction(isight->unit, TCODE_WRITE_QUADLET_REQUEST,
304 isight->audio_base + offset, &value, 4, 0);
307 static void isight_stop_streaming(struct isight *isight)
311 if (!isight->context)
314 fw_iso_context_stop(isight->context);
315 fw_iso_context_destroy(isight->context);
316 isight->context = NULL;
317 fw_iso_resources_free(&isight->resources);
319 snd_fw_transaction(isight->unit, TCODE_WRITE_QUADLET_REQUEST,
320 isight->audio_base + REG_AUDIO_ENABLE,
321 &value, 4, FW_QUIET);
324 static int isight_hw_free(struct snd_pcm_substream *substream)
326 struct isight *isight = substream->private_data;
328 WRITE_ONCE(isight->pcm_active, false);
330 mutex_lock(&isight->mutex);
331 isight_stop_streaming(isight);
332 mutex_unlock(&isight->mutex);
337 static int isight_start_streaming(struct isight *isight)
342 if (isight->context) {
343 if (isight->packet_index < 0)
344 isight_stop_streaming(isight);
349 err = reg_write(isight, REG_SAMPLE_RATE, cpu_to_be32(RATE_48000));
353 err = isight_connect(isight);
357 err = reg_write(isight, REG_AUDIO_ENABLE, cpu_to_be32(AUDIO_ENABLE));
361 isight->context = fw_iso_context_create(isight->device->card,
362 FW_ISO_CONTEXT_RECEIVE,
363 isight->resources.channel,
364 isight->device->max_speed,
365 4, isight_packet, isight);
366 if (IS_ERR(isight->context)) {
367 err = PTR_ERR(isight->context);
368 isight->context = NULL;
372 for (i = 0; i < QUEUE_LENGTH; ++i) {
373 err = fw_iso_context_queue(isight->context, &audio_packet,
374 &isight->buffer.iso_buffer,
375 isight->buffer.packets[i].offset);
380 isight->first_packet = true;
381 isight->packet_index = 0;
383 err = fw_iso_context_start(isight->context, -1, 0,
384 FW_ISO_CONTEXT_MATCH_ALL_TAGS/*?*/);
391 fw_iso_context_destroy(isight->context);
392 isight->context = NULL;
394 fw_iso_resources_free(&isight->resources);
395 reg_write(isight, REG_AUDIO_ENABLE, 0);
400 static int isight_prepare(struct snd_pcm_substream *substream)
402 struct isight *isight = substream->private_data;
405 isight->buffer_pointer = 0;
406 isight->period_counter = 0;
408 mutex_lock(&isight->mutex);
409 err = isight_start_streaming(isight);
410 mutex_unlock(&isight->mutex);
415 static int isight_trigger(struct snd_pcm_substream *substream, int cmd)
417 struct isight *isight = substream->private_data;
420 case SNDRV_PCM_TRIGGER_START:
421 WRITE_ONCE(isight->pcm_running, true);
423 case SNDRV_PCM_TRIGGER_STOP:
424 WRITE_ONCE(isight->pcm_running, false);
432 static snd_pcm_uframes_t isight_pointer(struct snd_pcm_substream *substream)
434 struct isight *isight = substream->private_data;
436 return READ_ONCE(isight->buffer_pointer);
439 static int isight_create_pcm(struct isight *isight)
441 static const struct snd_pcm_ops ops = {
443 .close = isight_close,
444 .ioctl = snd_pcm_lib_ioctl,
445 .hw_params = isight_hw_params,
446 .hw_free = isight_hw_free,
447 .prepare = isight_prepare,
448 .trigger = isight_trigger,
449 .pointer = isight_pointer,
454 err = snd_pcm_new(isight->card, "iSight", 0, 0, 1, &pcm);
457 pcm->private_data = isight;
458 strcpy(pcm->name, "iSight");
459 isight->pcm = pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream;
460 isight->pcm->ops = &ops;
461 snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_VMALLOC, NULL, 0, 0);
466 static int isight_gain_info(struct snd_kcontrol *ctl,
467 struct snd_ctl_elem_info *info)
469 struct isight *isight = ctl->private_data;
471 info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
473 info->value.integer.min = isight->gain_min;
474 info->value.integer.max = isight->gain_max;
479 static int isight_gain_get(struct snd_kcontrol *ctl,
480 struct snd_ctl_elem_value *value)
482 struct isight *isight = ctl->private_data;
486 err = reg_read(isight, REG_GAIN, &gain);
490 value->value.integer.value[0] = (s32)be32_to_cpu(gain);
495 static int isight_gain_put(struct snd_kcontrol *ctl,
496 struct snd_ctl_elem_value *value)
498 struct isight *isight = ctl->private_data;
500 if (value->value.integer.value[0] < isight->gain_min ||
501 value->value.integer.value[0] > isight->gain_max)
504 return reg_write(isight, REG_GAIN,
505 cpu_to_be32(value->value.integer.value[0]));
508 static int isight_mute_get(struct snd_kcontrol *ctl,
509 struct snd_ctl_elem_value *value)
511 struct isight *isight = ctl->private_data;
515 err = reg_read(isight, REG_MUTE, &mute);
519 value->value.integer.value[0] = !mute;
524 static int isight_mute_put(struct snd_kcontrol *ctl,
525 struct snd_ctl_elem_value *value)
527 struct isight *isight = ctl->private_data;
529 return reg_write(isight, REG_MUTE,
530 (__force __be32)!value->value.integer.value[0]);
533 static int isight_create_mixer(struct isight *isight)
535 static const struct snd_kcontrol_new gain_control = {
536 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
537 .name = "Mic Capture Volume",
538 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |
539 SNDRV_CTL_ELEM_ACCESS_TLV_READ,
540 .info = isight_gain_info,
541 .get = isight_gain_get,
542 .put = isight_gain_put,
544 static const struct snd_kcontrol_new mute_control = {
545 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
546 .name = "Mic Capture Switch",
547 .info = snd_ctl_boolean_mono_info,
548 .get = isight_mute_get,
549 .put = isight_mute_put,
552 struct snd_kcontrol *ctl;
555 err = reg_read(isight, REG_GAIN_RAW_START, &value);
558 isight->gain_min = be32_to_cpu(value);
560 err = reg_read(isight, REG_GAIN_RAW_END, &value);
563 isight->gain_max = be32_to_cpu(value);
565 isight->gain_tlv[SNDRV_CTL_TLVO_TYPE] = SNDRV_CTL_TLVT_DB_MINMAX;
566 isight->gain_tlv[SNDRV_CTL_TLVO_LEN] = 2 * sizeof(unsigned int);
568 err = reg_read(isight, REG_GAIN_DB_START, &value);
571 isight->gain_tlv[SNDRV_CTL_TLVO_DB_MINMAX_MIN] =
572 (s32)be32_to_cpu(value) * 100;
574 err = reg_read(isight, REG_GAIN_DB_END, &value);
577 isight->gain_tlv[SNDRV_CTL_TLVO_DB_MINMAX_MAX] =
578 (s32)be32_to_cpu(value) * 100;
580 ctl = snd_ctl_new1(&gain_control, isight);
582 ctl->tlv.p = isight->gain_tlv;
583 err = snd_ctl_add(isight->card, ctl);
587 err = snd_ctl_add(isight->card, snd_ctl_new1(&mute_control, isight));
594 static void isight_card_free(struct snd_card *card)
596 struct isight *isight = card->private_data;
598 fw_iso_resources_destroy(&isight->resources);
601 static u64 get_unit_base(struct fw_unit *unit)
603 struct fw_csr_iterator i;
606 fw_csr_iterator_init(&i, unit->directory);
607 while (fw_csr_iterator_next(&i, &key, &value))
608 if (key == CSR_OFFSET)
609 return CSR_REGISTER_BASE + value * 4;
613 static int isight_probe(struct fw_unit *unit,
614 const struct ieee1394_device_id *id)
616 struct fw_device *fw_dev = fw_parent_device(unit);
617 struct snd_card *card;
618 struct isight *isight;
621 err = snd_card_new(&unit->device, -1, NULL, THIS_MODULE,
622 sizeof(*isight), &card);
626 isight = card->private_data;
628 mutex_init(&isight->mutex);
629 isight->unit = fw_unit_get(unit);
630 isight->device = fw_dev;
631 isight->audio_base = get_unit_base(unit);
632 if (!isight->audio_base) {
633 dev_err(&unit->device, "audio unit base not found\n");
637 fw_iso_resources_init(&isight->resources, unit);
639 card->private_free = isight_card_free;
641 strcpy(card->driver, "iSight");
642 strcpy(card->shortname, "Apple iSight");
643 snprintf(card->longname, sizeof(card->longname),
644 "Apple iSight (GUID %08x%08x) at %s, S%d",
645 fw_dev->config_rom[3], fw_dev->config_rom[4],
646 dev_name(&unit->device), 100 << fw_dev->max_speed);
647 strcpy(card->mixername, "iSight");
649 err = isight_create_pcm(isight);
653 err = isight_create_mixer(isight);
657 err = snd_card_register(card);
661 dev_set_drvdata(&unit->device, isight);
667 mutex_destroy(&isight->mutex);
668 fw_unit_put(isight->unit);
673 static void isight_bus_reset(struct fw_unit *unit)
675 struct isight *isight = dev_get_drvdata(&unit->device);
677 if (fw_iso_resources_update(&isight->resources) < 0) {
678 isight_pcm_abort(isight);
680 mutex_lock(&isight->mutex);
681 isight_stop_streaming(isight);
682 mutex_unlock(&isight->mutex);
686 static void isight_remove(struct fw_unit *unit)
688 struct isight *isight = dev_get_drvdata(&unit->device);
690 isight_pcm_abort(isight);
692 snd_card_disconnect(isight->card);
694 mutex_lock(&isight->mutex);
695 isight_stop_streaming(isight);
696 mutex_unlock(&isight->mutex);
698 // Block till all of ALSA character devices are released.
699 snd_card_free(isight->card);
701 mutex_destroy(&isight->mutex);
702 fw_unit_put(isight->unit);
705 static const struct ieee1394_device_id isight_id_table[] = {
707 .match_flags = IEEE1394_MATCH_SPECIFIER_ID |
708 IEEE1394_MATCH_VERSION,
709 .specifier_id = OUI_APPLE,
710 .version = SW_ISIGHT_AUDIO,
714 MODULE_DEVICE_TABLE(ieee1394, isight_id_table);
716 static struct fw_driver isight_driver = {
718 .owner = THIS_MODULE,
719 .name = KBUILD_MODNAME,
722 .probe = isight_probe,
723 .update = isight_bus_reset,
724 .remove = isight_remove,
725 .id_table = isight_id_table,
728 static int __init alsa_isight_init(void)
730 return driver_register(&isight_driver.driver);
733 static void __exit alsa_isight_exit(void)
735 driver_unregister(&isight_driver.driver);
738 module_init(alsa_isight_init);
739 module_exit(alsa_isight_exit);