1 // SPDX-License-Identifier: GPL-2.0-only
3 * oxfw.c - a part of driver for OXFW970/971 based devices
5 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
10 #define OXFORD_FIRMWARE_ID_ADDRESS (CSR_REGISTER_BASE + 0x50000)
11 /* 0x970?vvvv or 0x971?vvvv, where vvvv = firmware version */
13 #define OXFORD_HARDWARE_ID_ADDRESS (CSR_REGISTER_BASE + 0x90020)
14 #define OXFORD_HARDWARE_ID_OXFW970 0x39443841
15 #define OXFORD_HARDWARE_ID_OXFW971 0x39373100
17 #define VENDOR_LOUD 0x000ff2
18 #define VENDOR_GRIFFIN 0x001292
19 #define VENDOR_BEHRINGER 0x001564
20 #define VENDOR_LACIE 0x00d04b
21 #define VENDOR_TASCAM 0x00022e
22 #define OUI_STANTON 0x001260
23 #define OUI_APOGEE 0x0003db
25 #define MODEL_SATELLITE 0x00200f
26 #define MODEL_SCS1M 0x001000
27 #define MODEL_DUET_FW 0x01dddd
29 #define SPECIFIER_1394TA 0x00a02d
30 #define VERSION_AVC 0x010001
32 MODULE_DESCRIPTION("Oxford Semiconductor FW970/971 driver");
33 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
34 MODULE_LICENSE("GPL v2");
35 MODULE_ALIAS("snd-firewire-speakers");
36 MODULE_ALIAS("snd-scs1x");
39 const char *driver_name;
40 const char *vendor_name;
41 const char *model_name;
44 static bool detect_loud_models(struct fw_unit *unit)
46 const char *const models[] = {
55 err = fw_csr_string(unit->directory, CSR_MODEL,
56 model, sizeof(model));
60 return match_string(models, ARRAY_SIZE(models), model) >= 0;
63 static int name_card(struct snd_oxfw *oxfw, const struct ieee1394_device_id *entry)
65 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
66 const struct compat_info *info;
69 const char *d, *v, *m;
73 /* get vendor name from root directory */
74 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
75 vendor, sizeof(vendor));
79 /* get model name from unit directory */
80 err = fw_csr_string(oxfw->unit->directory, CSR_MODEL,
81 model, sizeof(model));
85 err = snd_fw_transaction(oxfw->unit, TCODE_READ_QUADLET_REQUEST,
86 OXFORD_FIRMWARE_ID_ADDRESS, &firmware, 4, 0);
89 be32_to_cpus(&firmware);
91 if (firmware >> 20 == 0x970)
92 oxfw->quirks |= SND_OXFW_QUIRK_JUMBO_PAYLOAD;
94 /* to apply card definitions */
95 if (entry->vendor_id == VENDOR_GRIFFIN || entry->vendor_id == VENDOR_LACIE) {
96 info = (const struct compat_info *)entry->driver_data;
97 d = info->driver_name;
98 v = info->vendor_name;
106 strcpy(oxfw->card->driver, d);
107 strcpy(oxfw->card->mixername, m);
108 strcpy(oxfw->card->shortname, m);
110 snprintf(oxfw->card->longname, sizeof(oxfw->card->longname),
111 "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d",
112 v, m, firmware >> 20, firmware & 0xffff,
113 fw_dev->config_rom[3], fw_dev->config_rom[4],
114 dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed);
119 static void oxfw_card_free(struct snd_card *card)
121 struct snd_oxfw *oxfw = card->private_data;
123 if (oxfw->has_output || oxfw->has_input)
124 snd_oxfw_stream_destroy_duplex(oxfw);
126 mutex_destroy(&oxfw->mutex);
127 fw_unit_put(oxfw->unit);
130 static int detect_quirks(struct snd_oxfw *oxfw, const struct ieee1394_device_id *entry)
132 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
133 struct fw_csr_iterator it;
138 * Add ALSA control elements for two models to keep compatibility to
139 * old firewire-speaker module.
141 if (entry->vendor_id == VENDOR_GRIFFIN)
142 return snd_oxfw_add_spkr(oxfw, false);
143 if (entry->vendor_id == VENDOR_LACIE)
144 return snd_oxfw_add_spkr(oxfw, true);
147 * Stanton models supports asynchronous transactions for unique MIDI
150 if (entry->vendor_id == OUI_STANTON) {
151 oxfw->quirks |= SND_OXFW_QUIRK_SCS_TRANSACTION;
152 if (entry->model_id == MODEL_SCS1M)
153 oxfw->quirks |= SND_OXFW_QUIRK_BLOCKING_TRANSMISSION;
155 // No physical MIDI ports.
156 oxfw->midi_input_ports = 0;
157 oxfw->midi_output_ports = 0;
159 return snd_oxfw_scs1x_add(oxfw);
162 if (entry->vendor_id == OUI_APOGEE && entry->model_id == MODEL_DUET_FW) {
163 oxfw->quirks |= SND_OXFW_QUIRK_BLOCKING_TRANSMISSION |
164 SND_OXFW_QUIRK_IGNORE_NO_INFO_PACKET;
168 * TASCAM FireOne has physical control and requires a pair of additional
171 if (entry->vendor_id == VENDOR_TASCAM) {
172 oxfw->midi_input_ports++;
173 oxfw->midi_output_ports++;
177 /* Seek from Root Directory of Config ROM. */
179 fw_csr_iterator_init(&it, fw_dev->config_rom + 5);
180 while (fw_csr_iterator_next(&it, &key, &val)) {
181 if (key == CSR_VENDOR)
183 else if (key == CSR_MODEL)
187 if (vendor == VENDOR_LOUD) {
188 // Mackie Onyx Satellite with base station has a quirk to report a wrong
189 // value in 'dbs' field of CIP header against its format information.
190 oxfw->quirks |= SND_OXFW_QUIRK_WRONG_DBS;
192 // OXFW971-based models may transfer events by blocking method.
193 if (!(oxfw->quirks & SND_OXFW_QUIRK_JUMBO_PAYLOAD))
194 oxfw->quirks |= SND_OXFW_QUIRK_BLOCKING_TRANSMISSION;
200 static int oxfw_probe(struct fw_unit *unit, const struct ieee1394_device_id *entry)
202 struct snd_card *card;
203 struct snd_oxfw *oxfw;
206 if (entry->vendor_id == VENDOR_LOUD && entry->model_id == 0 && !detect_loud_models(unit))
209 err = snd_card_new(&unit->device, -1, NULL, THIS_MODULE, sizeof(*oxfw), &card);
212 card->private_free = oxfw_card_free;
214 oxfw = card->private_data;
215 oxfw->unit = fw_unit_get(unit);
216 dev_set_drvdata(&unit->device, oxfw);
219 mutex_init(&oxfw->mutex);
220 spin_lock_init(&oxfw->lock);
221 init_waitqueue_head(&oxfw->hwdep_wait);
223 err = name_card(oxfw, entry);
227 err = snd_oxfw_stream_discover(oxfw);
231 err = detect_quirks(oxfw, entry);
235 if (oxfw->has_output || oxfw->has_input) {
236 err = snd_oxfw_stream_init_duplex(oxfw);
240 err = snd_oxfw_create_pcm(oxfw);
244 snd_oxfw_proc_init(oxfw);
246 err = snd_oxfw_create_midi(oxfw);
250 err = snd_oxfw_create_hwdep(oxfw);
255 err = snd_card_register(card);
265 static void oxfw_bus_reset(struct fw_unit *unit)
267 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
269 fcp_bus_reset(oxfw->unit);
271 if (oxfw->has_output || oxfw->has_input) {
272 mutex_lock(&oxfw->mutex);
273 snd_oxfw_stream_update_duplex(oxfw);
274 mutex_unlock(&oxfw->mutex);
277 if (oxfw->quirks & SND_OXFW_QUIRK_SCS_TRANSACTION)
278 snd_oxfw_scs1x_update(oxfw);
281 static void oxfw_remove(struct fw_unit *unit)
283 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
285 // Block till all of ALSA character devices are released.
286 snd_card_free(oxfw->card);
289 static const struct compat_info griffin_firewave = {
290 .driver_name = "FireWave",
291 .vendor_name = "Griffin",
292 .model_name = "FireWave",
295 static const struct compat_info lacie_speakers = {
296 .driver_name = "FWSpeakers",
297 .vendor_name = "LaCie",
298 .model_name = "FireWire Speakers",
301 #define OXFW_DEV_ENTRY(vendor, model, data) \
303 .match_flags = IEEE1394_MATCH_VENDOR_ID | \
304 IEEE1394_MATCH_MODEL_ID | \
305 IEEE1394_MATCH_SPECIFIER_ID | \
306 IEEE1394_MATCH_VERSION, \
307 .vendor_id = vendor, \
309 .specifier_id = SPECIFIER_1394TA, \
310 .version = VERSION_AVC, \
311 .driver_data = (kernel_ulong_t)data, \
314 static const struct ieee1394_device_id oxfw_id_table[] = {
317 // Initial firmware has a quirk to postpone isoc packet transmission during finishing async
318 // transaction. As a result, several isochronous cycles are skipped to transfer the packets
319 // and the audio data frames which should have been transferred during the cycles are put
320 // into packet at the first isoc cycle after the postpone. Furthermore, the value of SYT
321 // field in CIP header is not reliable as synchronization timing,
323 OXFW_DEV_ENTRY(VENDOR_GRIFFIN, 0x00f970, &griffin_firewave),
324 OXFW_DEV_ENTRY(VENDOR_LACIE, 0x00f970, &lacie_speakers),
325 // Behringer,F-Control Audio 202. The value of SYT field is not reliable at all.
326 OXFW_DEV_ENTRY(VENDOR_BEHRINGER, 0x00fc22, NULL),
327 // Loud Technologies, Tapco Link.FireWire 4x6. The value of SYT field is always 0xffff.
328 OXFW_DEV_ENTRY(VENDOR_LOUD, 0x000460, NULL),
329 // Loud Technologies, Mackie Onyx Satellite. Although revised version of firmware is
330 // installed to avoid the postpone, the value of SYT field is always 0xffff.
331 OXFW_DEV_ENTRY(VENDOR_LOUD, MODEL_SATELLITE, NULL),
332 // Miglia HarmonyAudio. Not yet identified.
336 // The value of SYT field in CIP header is enough reliable. Both of blocking and non-blocking
337 // transmission methods are available.
339 // Any Mackie(Loud) models (name string/model id):
340 // Onyx-i series (former models): 0x081216
341 // Onyx 1640i: 0x001640
342 // d.2 pro/d.4 pro (built-in card): Unknown
346 .match_flags = IEEE1394_MATCH_VENDOR_ID |
347 IEEE1394_MATCH_SPECIFIER_ID |
348 IEEE1394_MATCH_VERSION,
349 .vendor_id = VENDOR_LOUD,
351 .specifier_id = SPECIFIER_1394TA,
352 .version = VERSION_AVC,
355 OXFW_DEV_ENTRY(VENDOR_TASCAM, 0x800007, NULL),
356 // Stanton, Stanton Controllers & Systems 1 Mixer (SCS.1m).
357 OXFW_DEV_ENTRY(OUI_STANTON, MODEL_SCS1M, NULL),
358 // Stanton, Stanton Controllers & Systems 1 Deck (SCS.1d).
359 OXFW_DEV_ENTRY(OUI_STANTON, 0x002000, NULL),
360 // APOGEE, duet FireWire.
361 OXFW_DEV_ENTRY(OUI_APOGEE, MODEL_DUET_FW, NULL),
364 MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table);
366 static struct fw_driver oxfw_driver = {
368 .owner = THIS_MODULE,
369 .name = KBUILD_MODNAME,
373 .update = oxfw_bus_reset,
374 .remove = oxfw_remove,
375 .id_table = oxfw_id_table,
378 static int __init snd_oxfw_init(void)
380 return driver_register(&oxfw_driver.driver);
383 static void __exit snd_oxfw_exit(void)
385 driver_unregister(&oxfw_driver.driver);
388 module_init(snd_oxfw_init);
389 module_exit(snd_oxfw_exit);