2 * oxfw.c - a part of driver for OXFW970/971 based devices
4 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
5 * Licensed under the terms of the GNU General Public License, version 2.
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
27 #define SPECIFIER_1394TA 0x00a02d
28 #define VERSION_AVC 0x010001
30 MODULE_DESCRIPTION("Oxford Semiconductor FW970/971 driver");
31 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
32 MODULE_LICENSE("GPL v2");
33 MODULE_ALIAS("snd-firewire-speakers");
34 MODULE_ALIAS("snd-scs1x");
37 const char *driver_name;
38 const char *vendor_name;
39 const char *model_name;
42 static bool detect_loud_models(struct fw_unit *unit)
44 const char *const models[] = {
48 "Mackie Onyx Satellite",
49 "Tapco LINK.firewire 4x6",
55 err = fw_csr_string(unit->directory, CSR_MODEL,
56 model, sizeof(model));
60 for (i = 0; i < ARRAY_SIZE(models); i++) {
61 if (strcmp(models[i], model) == 0)
65 return (i < ARRAY_SIZE(models));
68 static int name_card(struct snd_oxfw *oxfw)
70 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
71 const struct compat_info *info;
74 const char *d, *v, *m;
78 /* get vendor name from root directory */
79 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
80 vendor, sizeof(vendor));
84 /* get model name from unit directory */
85 err = fw_csr_string(oxfw->unit->directory, CSR_MODEL,
86 model, sizeof(model));
90 err = snd_fw_transaction(oxfw->unit, TCODE_READ_QUADLET_REQUEST,
91 OXFORD_FIRMWARE_ID_ADDRESS, &firmware, 4, 0);
94 be32_to_cpus(&firmware);
96 /* to apply card definitions */
97 if (oxfw->entry->vendor_id == VENDOR_GRIFFIN ||
98 oxfw->entry->vendor_id == VENDOR_LACIE) {
99 info = (const struct compat_info *)oxfw->entry->driver_data;
100 d = info->driver_name;
101 v = info->vendor_name;
102 m = info->model_name;
109 strcpy(oxfw->card->driver, d);
110 strcpy(oxfw->card->mixername, m);
111 strcpy(oxfw->card->shortname, m);
113 snprintf(oxfw->card->longname, sizeof(oxfw->card->longname),
114 "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d",
115 v, m, firmware >> 20, firmware & 0xffff,
116 fw_dev->config_rom[3], fw_dev->config_rom[4],
117 dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed);
122 static void oxfw_free(struct snd_oxfw *oxfw)
126 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream);
127 if (oxfw->has_output)
128 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream);
130 fw_unit_put(oxfw->unit);
132 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) {
133 kfree(oxfw->tx_stream_formats[i]);
134 kfree(oxfw->rx_stream_formats[i]);
138 mutex_destroy(&oxfw->mutex);
143 * This module releases the FireWire unit data after all ALSA character devices
144 * are released by applications. This is for releasing stream data or finishing
145 * transactions safely. Thus at returning from .remove(), this module still keep
146 * references for the unit.
148 static void oxfw_card_free(struct snd_card *card)
150 oxfw_free(card->private_data);
153 static int detect_quirks(struct snd_oxfw *oxfw)
155 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
156 struct fw_csr_iterator it;
161 * Add ALSA control elements for two models to keep compatibility to
162 * old firewire-speaker module.
164 if (oxfw->entry->vendor_id == VENDOR_GRIFFIN)
165 return snd_oxfw_add_spkr(oxfw, false);
166 if (oxfw->entry->vendor_id == VENDOR_LACIE)
167 return snd_oxfw_add_spkr(oxfw, true);
170 * Stanton models supports asynchronous transactions for unique MIDI
173 if (oxfw->entry->vendor_id == OUI_STANTON) {
174 /* No physical MIDI ports. */
175 oxfw->midi_input_ports = 0;
176 oxfw->midi_output_ports = 0;
178 return snd_oxfw_scs1x_add(oxfw);
182 * TASCAM FireOne has physical control and requires a pair of additional
185 if (oxfw->entry->vendor_id == VENDOR_TASCAM) {
186 oxfw->midi_input_ports++;
187 oxfw->midi_output_ports++;
191 /* Seek from Root Directory of Config ROM. */
193 fw_csr_iterator_init(&it, fw_dev->config_rom + 5);
194 while (fw_csr_iterator_next(&it, &key, &val)) {
195 if (key == CSR_VENDOR)
197 else if (key == CSR_MODEL)
202 * Mackie Onyx Satellite with base station has a quirk to report a wrong
203 * value in 'dbs' field of CIP header against its format information.
205 if (vendor == VENDOR_LOUD && model == MODEL_SATELLITE)
206 oxfw->wrong_dbs = true;
211 static void do_registration(struct work_struct *work)
213 struct snd_oxfw *oxfw = container_of(work, struct snd_oxfw, dwork.work);
217 if (oxfw->registered)
220 err = snd_card_new(&oxfw->unit->device, -1, NULL, THIS_MODULE, 0,
225 err = name_card(oxfw);
229 err = snd_oxfw_stream_discover(oxfw);
233 err = detect_quirks(oxfw);
237 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->rx_stream);
240 if (oxfw->has_output) {
241 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->tx_stream);
246 err = snd_oxfw_create_pcm(oxfw);
250 snd_oxfw_proc_init(oxfw);
252 err = snd_oxfw_create_midi(oxfw);
256 err = snd_oxfw_create_hwdep(oxfw);
260 err = snd_card_register(oxfw->card);
265 * After registered, oxfw instance can be released corresponding to
266 * releasing the sound card instance.
268 oxfw->card->private_free = oxfw_card_free;
269 oxfw->card->private_data = oxfw;
270 oxfw->registered = true;
274 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream);
275 if (oxfw->has_output)
276 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream);
277 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; ++i) {
278 kfree(oxfw->tx_stream_formats[i]);
279 oxfw->tx_stream_formats[i] = NULL;
280 kfree(oxfw->rx_stream_formats[i]);
281 oxfw->rx_stream_formats[i] = NULL;
283 snd_card_free(oxfw->card);
286 dev_info(&oxfw->unit->device,
287 "Sound card registration failed: %d\n", err);
290 static int oxfw_probe(struct fw_unit *unit,
291 const struct ieee1394_device_id *entry)
293 struct snd_oxfw *oxfw;
295 if (entry->vendor_id == VENDOR_LOUD && !detect_loud_models(unit))
298 /* Allocate this independent of sound card instance. */
299 oxfw = kzalloc(sizeof(struct snd_oxfw), GFP_KERNEL);
304 oxfw->unit = fw_unit_get(unit);
305 dev_set_drvdata(&unit->device, oxfw);
307 mutex_init(&oxfw->mutex);
308 spin_lock_init(&oxfw->lock);
309 init_waitqueue_head(&oxfw->hwdep_wait);
311 /* Allocate and register this sound card later. */
312 INIT_DEFERRABLE_WORK(&oxfw->dwork, do_registration);
313 snd_fw_schedule_registration(unit, &oxfw->dwork);
318 static void oxfw_bus_reset(struct fw_unit *unit)
320 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
322 if (!oxfw->registered)
323 snd_fw_schedule_registration(unit, &oxfw->dwork);
325 fcp_bus_reset(oxfw->unit);
327 if (oxfw->registered) {
328 mutex_lock(&oxfw->mutex);
330 snd_oxfw_stream_update_simplex(oxfw, &oxfw->rx_stream);
331 if (oxfw->has_output)
332 snd_oxfw_stream_update_simplex(oxfw, &oxfw->tx_stream);
334 mutex_unlock(&oxfw->mutex);
336 if (oxfw->entry->vendor_id == OUI_STANTON)
337 snd_oxfw_scs1x_update(oxfw);
341 static void oxfw_remove(struct fw_unit *unit)
343 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
346 * Confirm to stop the work for registration before the sound card is
347 * going to be released. The work is not scheduled again because bus
348 * reset handler is not called anymore.
350 cancel_delayed_work_sync(&oxfw->dwork);
352 if (oxfw->registered) {
353 /* No need to wait for releasing card object in this context. */
354 snd_card_free_when_closed(oxfw->card);
356 /* Don't forget this case. */
361 static const struct compat_info griffin_firewave = {
362 .driver_name = "FireWave",
363 .vendor_name = "Griffin",
364 .model_name = "FireWave",
367 static const struct compat_info lacie_speakers = {
368 .driver_name = "FWSpeakers",
369 .vendor_name = "LaCie",
370 .model_name = "FireWire Speakers",
373 static const struct ieee1394_device_id oxfw_id_table[] = {
375 .match_flags = IEEE1394_MATCH_VENDOR_ID |
376 IEEE1394_MATCH_MODEL_ID |
377 IEEE1394_MATCH_SPECIFIER_ID |
378 IEEE1394_MATCH_VERSION,
379 .vendor_id = VENDOR_GRIFFIN,
380 .model_id = 0x00f970,
381 .specifier_id = SPECIFIER_1394TA,
382 .version = VERSION_AVC,
383 .driver_data = (kernel_ulong_t)&griffin_firewave,
386 .match_flags = IEEE1394_MATCH_VENDOR_ID |
387 IEEE1394_MATCH_MODEL_ID |
388 IEEE1394_MATCH_SPECIFIER_ID |
389 IEEE1394_MATCH_VERSION,
390 .vendor_id = VENDOR_LACIE,
391 .model_id = 0x00f970,
392 .specifier_id = SPECIFIER_1394TA,
393 .version = VERSION_AVC,
394 .driver_data = (kernel_ulong_t)&lacie_speakers,
396 /* Behringer,F-Control Audio 202 */
398 .match_flags = IEEE1394_MATCH_VENDOR_ID |
399 IEEE1394_MATCH_MODEL_ID,
400 .vendor_id = VENDOR_BEHRINGER,
401 .model_id = 0x00fc22,
404 * Any Mackie(Loud) models (name string/model id):
405 * Onyx-i series (former models): 0x081216
406 * Mackie Onyx Satellite: 0x00200f
407 * Tapco LINK.firewire 4x6: 0x000460
408 * d.2 pro/d.4 pro (built-in card): Unknown
413 .match_flags = IEEE1394_MATCH_VENDOR_ID |
414 IEEE1394_MATCH_SPECIFIER_ID |
415 IEEE1394_MATCH_VERSION,
416 .vendor_id = VENDOR_LOUD,
417 .specifier_id = SPECIFIER_1394TA,
418 .version = VERSION_AVC,
420 /* TASCAM, FireOne */
422 .match_flags = IEEE1394_MATCH_VENDOR_ID |
423 IEEE1394_MATCH_MODEL_ID,
424 .vendor_id = VENDOR_TASCAM,
425 .model_id = 0x800007,
427 /* Stanton, Stanton Controllers & Systems 1 Mixer (SCS.1m) */
429 .match_flags = IEEE1394_MATCH_VENDOR_ID |
430 IEEE1394_MATCH_MODEL_ID,
431 .vendor_id = OUI_STANTON,
432 .model_id = 0x001000,
434 /* Stanton, Stanton Controllers & Systems 1 Deck (SCS.1d) */
436 .match_flags = IEEE1394_MATCH_VENDOR_ID |
437 IEEE1394_MATCH_MODEL_ID,
438 .vendor_id = OUI_STANTON,
439 .model_id = 0x002000,
441 // APOGEE, duet FireWire
443 .match_flags = IEEE1394_MATCH_VENDOR_ID |
444 IEEE1394_MATCH_MODEL_ID,
445 .vendor_id = OUI_APOGEE,
446 .model_id = 0x01dddd,
450 MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table);
452 static struct fw_driver oxfw_driver = {
454 .owner = THIS_MODULE,
455 .name = KBUILD_MODNAME,
459 .update = oxfw_bus_reset,
460 .remove = oxfw_remove,
461 .id_table = oxfw_id_table,
464 static int __init snd_oxfw_init(void)
466 return driver_register(&oxfw_driver.driver);
469 static void __exit snd_oxfw_exit(void)
471 driver_unregister(&oxfw_driver.driver);
474 module_init(snd_oxfw_init);
475 module_exit(snd_oxfw_exit);