1 /*
2 * oxfw.c - a part of driver for OXFW970/971 based devices
3 *
4 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
5 * Licensed under the terms of the GNU General Public License, version 2.
6 */
7
8 #include "oxfw.h"
9
10 #define OXFORD_FIRMWARE_ID_ADDRESS (CSR_REGISTER_BASE + 0x50000)
11 /* 0x970?vvvv or 0x971?vvvv, where vvvv = firmware version */
12
13 #define OXFORD_HARDWARE_ID_ADDRESS (CSR_REGISTER_BASE + 0x90020)
14 #define OXFORD_HARDWARE_ID_OXFW970 0x39443841
15 #define OXFORD_HARDWARE_ID_OXFW971 0x39373100
16
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
24 #define MODEL_SATELLITE 0x00200f
25
26 #define SPECIFIER_1394TA 0x00a02d
27 #define VERSION_AVC 0x010001
28
29 MODULE_DESCRIPTION("Oxford Semiconductor FW970/971 driver");
30 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
31 MODULE_LICENSE("GPL v2");
32 MODULE_ALIAS("snd-firewire-speakers");
33 MODULE_ALIAS("snd-scs1x");
34
35 struct compat_info {
36 const char *driver_name;
37 const char *vendor_name;
38 const char *model_name;
39 };
40
detect_loud_models(struct fw_unit * unit)41 static bool detect_loud_models(struct fw_unit *unit)
42 {
43 const char *const models[] = {
44 "Onyxi",
45 "Onyx-i",
46 "Onyx 1640i",
47 "d.Pro",
48 "Mackie Onyx Satellite",
49 "Tapco LINK.firewire 4x6",
50 "U.420"};
51 char model[32];
52 int err;
53
54 err = fw_csr_string(unit->directory, CSR_MODEL,
55 model, sizeof(model));
56 if (err < 0)
57 return false;
58
59 return match_string(models, ARRAY_SIZE(models), model) >= 0;
60 }
61
name_card(struct snd_oxfw * oxfw)62 static int name_card(struct snd_oxfw *oxfw)
63 {
64 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
65 const struct compat_info *info;
66 char vendor[24];
67 char model[32];
68 const char *d, *v, *m;
69 u32 firmware;
70 int err;
71
72 /* get vendor name from root directory */
73 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
74 vendor, sizeof(vendor));
75 if (err < 0)
76 goto end;
77
78 /* get model name from unit directory */
79 err = fw_csr_string(oxfw->unit->directory, CSR_MODEL,
80 model, sizeof(model));
81 if (err < 0)
82 goto end;
83
84 err = snd_fw_transaction(oxfw->unit, TCODE_READ_QUADLET_REQUEST,
85 OXFORD_FIRMWARE_ID_ADDRESS, &firmware, 4, 0);
86 if (err < 0)
87 goto end;
88 be32_to_cpus(&firmware);
89
90 /* to apply card definitions */
91 if (oxfw->entry->vendor_id == VENDOR_GRIFFIN ||
92 oxfw->entry->vendor_id == VENDOR_LACIE) {
93 info = (const struct compat_info *)oxfw->entry->driver_data;
94 d = info->driver_name;
95 v = info->vendor_name;
96 m = info->model_name;
97 } else {
98 d = "OXFW";
99 v = vendor;
100 m = model;
101 }
102
103 strcpy(oxfw->card->driver, d);
104 strcpy(oxfw->card->mixername, m);
105 strcpy(oxfw->card->shortname, m);
106
107 snprintf(oxfw->card->longname, sizeof(oxfw->card->longname),
108 "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d",
109 v, m, firmware >> 20, firmware & 0xffff,
110 fw_dev->config_rom[3], fw_dev->config_rom[4],
111 dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed);
112 end:
113 return err;
114 }
115
oxfw_free(struct snd_oxfw * oxfw)116 static void oxfw_free(struct snd_oxfw *oxfw)
117 {
118 unsigned int i;
119
120 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream);
121 if (oxfw->has_output)
122 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream);
123
124 fw_unit_put(oxfw->unit);
125
126 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) {
127 kfree(oxfw->tx_stream_formats[i]);
128 kfree(oxfw->rx_stream_formats[i]);
129 }
130
131 kfree(oxfw->spec);
132 mutex_destroy(&oxfw->mutex);
133 kfree(oxfw);
134 }
135
136 /*
137 * This module releases the FireWire unit data after all ALSA character devices
138 * are released by applications. This is for releasing stream data or finishing
139 * transactions safely. Thus at returning from .remove(), this module still keep
140 * references for the unit.
141 */
oxfw_card_free(struct snd_card * card)142 static void oxfw_card_free(struct snd_card *card)
143 {
144 oxfw_free(card->private_data);
145 }
146
detect_quirks(struct snd_oxfw * oxfw)147 static int detect_quirks(struct snd_oxfw *oxfw)
148 {
149 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
150 struct fw_csr_iterator it;
151 int key, val;
152 int vendor, model;
153
154 /*
155 * Add ALSA control elements for two models to keep compatibility to
156 * old firewire-speaker module.
157 */
158 if (oxfw->entry->vendor_id == VENDOR_GRIFFIN)
159 return snd_oxfw_add_spkr(oxfw, false);
160 if (oxfw->entry->vendor_id == VENDOR_LACIE)
161 return snd_oxfw_add_spkr(oxfw, true);
162
163 /*
164 * Stanton models supports asynchronous transactions for unique MIDI
165 * messages.
166 */
167 if (oxfw->entry->vendor_id == OUI_STANTON) {
168 /* No physical MIDI ports. */
169 oxfw->midi_input_ports = 0;
170 oxfw->midi_output_ports = 0;
171
172 /* Output stream exists but no data channels are useful. */
173 oxfw->has_output = false;
174
175 return snd_oxfw_scs1x_add(oxfw);
176 }
177
178 /*
179 * TASCAM FireOne has physical control and requires a pair of additional
180 * MIDI ports.
181 */
182 if (oxfw->entry->vendor_id == VENDOR_TASCAM) {
183 oxfw->midi_input_ports++;
184 oxfw->midi_output_ports++;
185 return 0;
186 }
187
188 /* Seek from Root Directory of Config ROM. */
189 vendor = model = 0;
190 fw_csr_iterator_init(&it, fw_dev->config_rom + 5);
191 while (fw_csr_iterator_next(&it, &key, &val)) {
192 if (key == CSR_VENDOR)
193 vendor = val;
194 else if (key == CSR_MODEL)
195 model = val;
196 }
197
198 /*
199 * Mackie Onyx Satellite with base station has a quirk to report a wrong
200 * value in 'dbs' field of CIP header against its format information.
201 */
202 if (vendor == VENDOR_LOUD && model == MODEL_SATELLITE)
203 oxfw->wrong_dbs = true;
204
205 return 0;
206 }
207
do_registration(struct work_struct * work)208 static void do_registration(struct work_struct *work)
209 {
210 struct snd_oxfw *oxfw = container_of(work, struct snd_oxfw, dwork.work);
211 int i;
212 int err;
213
214 if (oxfw->registered)
215 return;
216
217 err = snd_card_new(&oxfw->unit->device, -1, NULL, THIS_MODULE, 0,
218 &oxfw->card);
219 if (err < 0)
220 return;
221
222 err = name_card(oxfw);
223 if (err < 0)
224 goto error;
225
226 err = snd_oxfw_stream_discover(oxfw);
227 if (err < 0)
228 goto error;
229
230 err = detect_quirks(oxfw);
231 if (err < 0)
232 goto error;
233
234 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->rx_stream);
235 if (err < 0)
236 goto error;
237 if (oxfw->has_output) {
238 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->tx_stream);
239 if (err < 0)
240 goto error;
241 }
242
243 err = snd_oxfw_create_pcm(oxfw);
244 if (err < 0)
245 goto error;
246
247 snd_oxfw_proc_init(oxfw);
248
249 err = snd_oxfw_create_midi(oxfw);
250 if (err < 0)
251 goto error;
252
253 err = snd_oxfw_create_hwdep(oxfw);
254 if (err < 0)
255 goto error;
256
257 err = snd_card_register(oxfw->card);
258 if (err < 0)
259 goto error;
260
261 /*
262 * After registered, oxfw instance can be released corresponding to
263 * releasing the sound card instance.
264 */
265 oxfw->card->private_free = oxfw_card_free;
266 oxfw->card->private_data = oxfw;
267 oxfw->registered = true;
268
269 return;
270 error:
271 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream);
272 if (oxfw->has_output)
273 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream);
274 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; ++i) {
275 kfree(oxfw->tx_stream_formats[i]);
276 oxfw->tx_stream_formats[i] = NULL;
277 kfree(oxfw->rx_stream_formats[i]);
278 oxfw->rx_stream_formats[i] = NULL;
279 }
280 snd_card_free(oxfw->card);
281 kfree(oxfw->spec);
282 oxfw->spec = NULL;
283 dev_info(&oxfw->unit->device,
284 "Sound card registration failed: %d\n", err);
285 }
286
oxfw_probe(struct fw_unit * unit,const struct ieee1394_device_id * entry)287 static int oxfw_probe(struct fw_unit *unit,
288 const struct ieee1394_device_id *entry)
289 {
290 struct snd_oxfw *oxfw;
291
292 if (entry->vendor_id == VENDOR_LOUD && !detect_loud_models(unit))
293 return -ENODEV;
294
295 /* Allocate this independent of sound card instance. */
296 oxfw = kzalloc(sizeof(struct snd_oxfw), GFP_KERNEL);
297 if (oxfw == NULL)
298 return -ENOMEM;
299
300 oxfw->entry = entry;
301 oxfw->unit = fw_unit_get(unit);
302 dev_set_drvdata(&unit->device, oxfw);
303
304 mutex_init(&oxfw->mutex);
305 spin_lock_init(&oxfw->lock);
306 init_waitqueue_head(&oxfw->hwdep_wait);
307
308 /* Allocate and register this sound card later. */
309 INIT_DEFERRABLE_WORK(&oxfw->dwork, do_registration);
310 snd_fw_schedule_registration(unit, &oxfw->dwork);
311
312 return 0;
313 }
314
oxfw_bus_reset(struct fw_unit * unit)315 static void oxfw_bus_reset(struct fw_unit *unit)
316 {
317 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
318
319 if (!oxfw->registered)
320 snd_fw_schedule_registration(unit, &oxfw->dwork);
321
322 fcp_bus_reset(oxfw->unit);
323
324 if (oxfw->registered) {
325 mutex_lock(&oxfw->mutex);
326
327 snd_oxfw_stream_update_simplex(oxfw, &oxfw->rx_stream);
328 if (oxfw->has_output)
329 snd_oxfw_stream_update_simplex(oxfw, &oxfw->tx_stream);
330
331 mutex_unlock(&oxfw->mutex);
332
333 if (oxfw->entry->vendor_id == OUI_STANTON)
334 snd_oxfw_scs1x_update(oxfw);
335 }
336 }
337
oxfw_remove(struct fw_unit * unit)338 static void oxfw_remove(struct fw_unit *unit)
339 {
340 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
341
342 /*
343 * Confirm to stop the work for registration before the sound card is
344 * going to be released. The work is not scheduled again because bus
345 * reset handler is not called anymore.
346 */
347 cancel_delayed_work_sync(&oxfw->dwork);
348
349 if (oxfw->registered) {
350 /* No need to wait for releasing card object in this context. */
351 snd_card_free_when_closed(oxfw->card);
352 } else {
353 /* Don't forget this case. */
354 oxfw_free(oxfw);
355 }
356 }
357
358 static const struct compat_info griffin_firewave = {
359 .driver_name = "FireWave",
360 .vendor_name = "Griffin",
361 .model_name = "FireWave",
362 };
363
364 static const struct compat_info lacie_speakers = {
365 .driver_name = "FWSpeakers",
366 .vendor_name = "LaCie",
367 .model_name = "FireWire Speakers",
368 };
369
370 static const struct ieee1394_device_id oxfw_id_table[] = {
371 {
372 .match_flags = IEEE1394_MATCH_VENDOR_ID |
373 IEEE1394_MATCH_MODEL_ID |
374 IEEE1394_MATCH_SPECIFIER_ID |
375 IEEE1394_MATCH_VERSION,
376 .vendor_id = VENDOR_GRIFFIN,
377 .model_id = 0x00f970,
378 .specifier_id = SPECIFIER_1394TA,
379 .version = VERSION_AVC,
380 .driver_data = (kernel_ulong_t)&griffin_firewave,
381 },
382 {
383 .match_flags = IEEE1394_MATCH_VENDOR_ID |
384 IEEE1394_MATCH_MODEL_ID |
385 IEEE1394_MATCH_SPECIFIER_ID |
386 IEEE1394_MATCH_VERSION,
387 .vendor_id = VENDOR_LACIE,
388 .model_id = 0x00f970,
389 .specifier_id = SPECIFIER_1394TA,
390 .version = VERSION_AVC,
391 .driver_data = (kernel_ulong_t)&lacie_speakers,
392 },
393 /* Behringer,F-Control Audio 202 */
394 {
395 .match_flags = IEEE1394_MATCH_VENDOR_ID |
396 IEEE1394_MATCH_MODEL_ID,
397 .vendor_id = VENDOR_BEHRINGER,
398 .model_id = 0x00fc22,
399 },
400 /*
401 * Any Mackie(Loud) models (name string/model id):
402 * Onyx-i series (former models): 0x081216
403 * Mackie Onyx Satellite: 0x00200f
404 * Tapco LINK.firewire 4x6: 0x000460
405 * d.2 pro: Unknown
406 * d.4 pro: Unknown
407 * U.420: Unknown
408 * U.420d: Unknown
409 */
410 {
411 .match_flags = IEEE1394_MATCH_VENDOR_ID |
412 IEEE1394_MATCH_SPECIFIER_ID |
413 IEEE1394_MATCH_VERSION,
414 .vendor_id = VENDOR_LOUD,
415 .specifier_id = SPECIFIER_1394TA,
416 .version = VERSION_AVC,
417 },
418 /* TASCAM, FireOne */
419 {
420 .match_flags = IEEE1394_MATCH_VENDOR_ID |
421 IEEE1394_MATCH_MODEL_ID,
422 .vendor_id = VENDOR_TASCAM,
423 .model_id = 0x800007,
424 },
425 /* Stanton, Stanton Controllers & Systems 1 Mixer (SCS.1m) */
426 {
427 .match_flags = IEEE1394_MATCH_VENDOR_ID |
428 IEEE1394_MATCH_MODEL_ID,
429 .vendor_id = OUI_STANTON,
430 .model_id = 0x001000,
431 },
432 /* Stanton, Stanton Controllers & Systems 1 Deck (SCS.1d) */
433 {
434 .match_flags = IEEE1394_MATCH_VENDOR_ID |
435 IEEE1394_MATCH_MODEL_ID,
436 .vendor_id = OUI_STANTON,
437 .model_id = 0x002000,
438 },
439 { }
440 };
441 MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table);
442
443 static struct fw_driver oxfw_driver = {
444 .driver = {
445 .owner = THIS_MODULE,
446 .name = KBUILD_MODNAME,
447 .bus = &fw_bus_type,
448 },
449 .probe = oxfw_probe,
450 .update = oxfw_bus_reset,
451 .remove = oxfw_remove,
452 .id_table = oxfw_id_table,
453 };
454
snd_oxfw_init(void)455 static int __init snd_oxfw_init(void)
456 {
457 return driver_register(&oxfw_driver.driver);
458 }
459
snd_oxfw_exit(void)460 static void __exit snd_oxfw_exit(void)
461 {
462 driver_unregister(&oxfw_driver.driver);
463 }
464
465 module_init(snd_oxfw_init);
466 module_exit(snd_oxfw_exit);
467
