~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/sound/firewire/oxfw/oxfw.c

Version: ~ [ linux-5.2-rc6 ] ~ [ linux-5.1.15 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.56 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.130 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.183 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.183 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.69 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp