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 "d.Pro", 47 "Mackie Onyx Satellite", 48 "Tapco LINK.firewire 4x6", 49 "U.420"}; 50 char model[32]; 51 unsigned int i; 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 for (i = 0; i < ARRAY_SIZE(models); i++) { 60 if (strcmp(models[i], model) == 0) 61 break; 62 } 63 64 return (i < ARRAY_SIZE(models)); 65 } 66 67 static int name_card(struct snd_oxfw *oxfw) 68 { 69 struct fw_device *fw_dev = fw_parent_device(oxfw->unit); 70 const struct compat_info *info; 71 char vendor[24]; 72 char model[32]; 73 const char *d, *v, *m; 74 u32 firmware; 75 int err; 76 77 /* get vendor name from root directory */ 78 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR, 79 vendor, sizeof(vendor)); 80 if (err < 0) 81 goto end; 82 83 /* get model name from unit directory */ 84 err = fw_csr_string(oxfw->unit->directory, CSR_MODEL, 85 model, sizeof(model)); 86 if (err < 0) 87 goto end; 88 89 err = snd_fw_transaction(oxfw->unit, TCODE_READ_QUADLET_REQUEST, 90 OXFORD_FIRMWARE_ID_ADDRESS, &firmware, 4, 0); 91 if (err < 0) 92 goto end; 93 be32_to_cpus(&firmware); 94 95 /* to apply card definitions */ 96 if (oxfw->entry->vendor_id == VENDOR_GRIFFIN || 97 oxfw->entry->vendor_id == VENDOR_LACIE) { 98 info = (const struct compat_info *)oxfw->entry->driver_data; 99 d = info->driver_name; 100 v = info->vendor_name; 101 m = info->model_name; 102 } else { 103 d = "OXFW"; 104 v = vendor; 105 m = model; 106 } 107 108 strcpy(oxfw->card->driver, d); 109 strcpy(oxfw->card->mixername, m); 110 strcpy(oxfw->card->shortname, m); 111 112 snprintf(oxfw->card->longname, sizeof(oxfw->card->longname), 113 "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d", 114 v, m, firmware >> 20, firmware & 0xffff, 115 fw_dev->config_rom[3], fw_dev->config_rom[4], 116 dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed); 117 end: 118 return err; 119 } 120 121 /* 122 * This module releases the FireWire unit data after all ALSA character devices 123 * are released by applications. This is for releasing stream data or finishing 124 * transactions safely. Thus at returning from .remove(), this module still keep 125 * references for the unit. 126 */ 127 static void oxfw_card_free(struct snd_card *card) 128 { 129 struct snd_oxfw *oxfw = card->private_data; 130 unsigned int i; 131 132 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream); 133 if (oxfw->has_output) 134 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream); 135 136 fw_unit_put(oxfw->unit); 137 138 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) { 139 kfree(oxfw->tx_stream_formats[i]); 140 kfree(oxfw->rx_stream_formats[i]); 141 } 142 143 kfree(oxfw->spec); 144 mutex_destroy(&oxfw->mutex); 145 } 146 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 208 static int oxfw_probe(struct fw_unit *unit, 209 const struct ieee1394_device_id *entry) 210 { 211 struct snd_card *card; 212 struct snd_oxfw *oxfw; 213 int err; 214 215 if (entry->vendor_id == VENDOR_LOUD && !detect_loud_models(unit)) 216 return -ENODEV; 217 218 err = snd_card_new(&unit->device, -1, NULL, THIS_MODULE, 219 sizeof(*oxfw), &card); 220 if (err < 0) 221 return err; 222 223 card->private_free = oxfw_card_free; 224 oxfw = card->private_data; 225 oxfw->card = card; 226 mutex_init(&oxfw->mutex); 227 oxfw->unit = fw_unit_get(unit); 228 oxfw->entry = entry; 229 spin_lock_init(&oxfw->lock); 230 init_waitqueue_head(&oxfw->hwdep_wait); 231 232 err = snd_oxfw_stream_discover(oxfw); 233 if (err < 0) 234 goto error; 235 236 err = name_card(oxfw); 237 if (err < 0) 238 goto error; 239 240 err = detect_quirks(oxfw); 241 if (err < 0) 242 goto error; 243 244 err = snd_oxfw_create_pcm(oxfw); 245 if (err < 0) 246 goto error; 247 248 snd_oxfw_proc_init(oxfw); 249 250 err = snd_oxfw_create_midi(oxfw); 251 if (err < 0) 252 goto error; 253 254 err = snd_oxfw_create_hwdep(oxfw); 255 if (err < 0) 256 goto error; 257 258 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->rx_stream); 259 if (err < 0) 260 goto error; 261 if (oxfw->has_output) { 262 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->tx_stream); 263 if (err < 0) 264 goto error; 265 } 266 267 err = snd_card_register(card); 268 if (err < 0) { 269 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream); 270 if (oxfw->has_output) 271 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream); 272 goto error; 273 } 274 dev_set_drvdata(&unit->device, oxfw); 275 276 return 0; 277 error: 278 snd_card_free(card); 279 return err; 280 } 281 282 static void oxfw_bus_reset(struct fw_unit *unit) 283 { 284 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device); 285 286 fcp_bus_reset(oxfw->unit); 287 288 mutex_lock(&oxfw->mutex); 289 290 snd_oxfw_stream_update_simplex(oxfw, &oxfw->rx_stream); 291 if (oxfw->has_output) 292 snd_oxfw_stream_update_simplex(oxfw, &oxfw->tx_stream); 293 294 mutex_unlock(&oxfw->mutex); 295 296 if (oxfw->entry->vendor_id == OUI_STANTON) 297 snd_oxfw_scs1x_update(oxfw); 298 } 299 300 static void oxfw_remove(struct fw_unit *unit) 301 { 302 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device); 303 304 /* No need to wait for releasing card object in this context. */ 305 snd_card_free_when_closed(oxfw->card); 306 } 307 308 static const struct compat_info griffin_firewave = { 309 .driver_name = "FireWave", 310 .vendor_name = "Griffin", 311 .model_name = "FireWave", 312 }; 313 314 static const struct compat_info lacie_speakers = { 315 .driver_name = "FWSpeakers", 316 .vendor_name = "LaCie", 317 .model_name = "FireWire Speakers", 318 }; 319 320 static const struct ieee1394_device_id oxfw_id_table[] = { 321 { 322 .match_flags = IEEE1394_MATCH_VENDOR_ID | 323 IEEE1394_MATCH_MODEL_ID | 324 IEEE1394_MATCH_SPECIFIER_ID | 325 IEEE1394_MATCH_VERSION, 326 .vendor_id = VENDOR_GRIFFIN, 327 .model_id = 0x00f970, 328 .specifier_id = SPECIFIER_1394TA, 329 .version = VERSION_AVC, 330 .driver_data = (kernel_ulong_t)&griffin_firewave, 331 }, 332 { 333 .match_flags = IEEE1394_MATCH_VENDOR_ID | 334 IEEE1394_MATCH_MODEL_ID | 335 IEEE1394_MATCH_SPECIFIER_ID | 336 IEEE1394_MATCH_VERSION, 337 .vendor_id = VENDOR_LACIE, 338 .model_id = 0x00f970, 339 .specifier_id = SPECIFIER_1394TA, 340 .version = VERSION_AVC, 341 .driver_data = (kernel_ulong_t)&lacie_speakers, 342 }, 343 /* Behringer,F-Control Audio 202 */ 344 { 345 .match_flags = IEEE1394_MATCH_VENDOR_ID | 346 IEEE1394_MATCH_MODEL_ID, 347 .vendor_id = VENDOR_BEHRINGER, 348 .model_id = 0x00fc22, 349 }, 350 /* 351 * Any Mackie(Loud) models (name string/model id): 352 * Onyx-i series (former models): 0x081216 353 * Mackie Onyx Satellite: 0x00200f 354 * Tapco LINK.firewire 4x6: 0x000460 355 * d.2 pro: Unknown 356 * d.4 pro: Unknown 357 * U.420: Unknown 358 * U.420d: Unknown 359 */ 360 { 361 .match_flags = IEEE1394_MATCH_VENDOR_ID | 362 IEEE1394_MATCH_SPECIFIER_ID | 363 IEEE1394_MATCH_VERSION, 364 .vendor_id = VENDOR_LOUD, 365 .specifier_id = SPECIFIER_1394TA, 366 .version = VERSION_AVC, 367 }, 368 /* TASCAM, FireOne */ 369 { 370 .match_flags = IEEE1394_MATCH_VENDOR_ID | 371 IEEE1394_MATCH_MODEL_ID, 372 .vendor_id = VENDOR_TASCAM, 373 .model_id = 0x800007, 374 }, 375 /* Stanton, Stanton Controllers & Systems 1 Mixer (SCS.1m) */ 376 { 377 .match_flags = IEEE1394_MATCH_VENDOR_ID | 378 IEEE1394_MATCH_MODEL_ID, 379 .vendor_id = OUI_STANTON, 380 .model_id = 0x001000, 381 }, 382 /* Stanton, Stanton Controllers & Systems 1 Deck (SCS.1d) */ 383 { 384 .match_flags = IEEE1394_MATCH_VENDOR_ID | 385 IEEE1394_MATCH_MODEL_ID, 386 .vendor_id = OUI_STANTON, 387 .model_id = 0x002000, 388 }, 389 { } 390 }; 391 MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table); 392 393 static struct fw_driver oxfw_driver = { 394 .driver = { 395 .owner = THIS_MODULE, 396 .name = KBUILD_MODNAME, 397 .bus = &fw_bus_type, 398 }, 399 .probe = oxfw_probe, 400 .update = oxfw_bus_reset, 401 .remove = oxfw_remove, 402 .id_table = oxfw_id_table, 403 }; 404 405 static int __init snd_oxfw_init(void) 406 { 407 return driver_register(&oxfw_driver.driver); 408 } 409 410 static void __exit snd_oxfw_exit(void) 411 { 412 driver_unregister(&oxfw_driver.driver); 413 } 414 415 module_init(snd_oxfw_init); 416 module_exit(snd_oxfw_exit); 417