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