1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * oxfw.c - a part of driver for OXFW970/971 based devices 4 * 5 * Copyright (c) Clemens Ladisch <clemens@ladisch.de> 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 #define MODEL_SCS1M 0x001000 27 #define MODEL_DUET_FW 0x01dddd 28 29 #define SPECIFIER_1394TA 0x00a02d 30 #define VERSION_AVC 0x010001 31 32 MODULE_DESCRIPTION("Oxford Semiconductor FW970/971 driver"); 33 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>"); 34 MODULE_LICENSE("GPL v2"); 35 MODULE_ALIAS("snd-firewire-speakers"); 36 MODULE_ALIAS("snd-scs1x"); 37 38 struct compat_info { 39 const char *driver_name; 40 const char *vendor_name; 41 const char *model_name; 42 }; 43 44 static bool detect_loud_models(struct fw_unit *unit) 45 { 46 const char *const models[] = { 47 "Onyxi", 48 "Onyx-i", 49 "Onyx 1640i", 50 "d.Pro", 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, const struct ieee1394_device_id *entry) 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 if (firmware >> 20 == 0x970) 92 oxfw->quirks |= SND_OXFW_QUIRK_JUMBO_PAYLOAD; 93 94 /* to apply card definitions */ 95 if (entry->vendor_id == VENDOR_GRIFFIN || entry->vendor_id == VENDOR_LACIE) { 96 info = (const struct compat_info *)entry->driver_data; 97 d = info->driver_name; 98 v = info->vendor_name; 99 m = info->model_name; 100 } else { 101 d = "OXFW"; 102 v = vendor; 103 m = model; 104 } 105 106 strcpy(oxfw->card->driver, d); 107 strcpy(oxfw->card->mixername, m); 108 strcpy(oxfw->card->shortname, m); 109 110 snprintf(oxfw->card->longname, sizeof(oxfw->card->longname), 111 "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d", 112 v, m, firmware >> 20, firmware & 0xffff, 113 fw_dev->config_rom[3], fw_dev->config_rom[4], 114 dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed); 115 end: 116 return err; 117 } 118 119 static void oxfw_card_free(struct snd_card *card) 120 { 121 struct snd_oxfw *oxfw = card->private_data; 122 123 if (oxfw->has_output || oxfw->has_input) 124 snd_oxfw_stream_destroy_duplex(oxfw); 125 126 mutex_destroy(&oxfw->mutex); 127 fw_unit_put(oxfw->unit); 128 } 129 130 static int detect_quirks(struct snd_oxfw *oxfw, const struct ieee1394_device_id *entry) 131 { 132 struct fw_device *fw_dev = fw_parent_device(oxfw->unit); 133 struct fw_csr_iterator it; 134 int key, val; 135 int vendor, model; 136 137 /* 138 * Add ALSA control elements for two models to keep compatibility to 139 * old firewire-speaker module. 140 */ 141 if (entry->vendor_id == VENDOR_GRIFFIN) 142 return snd_oxfw_add_spkr(oxfw, false); 143 if (entry->vendor_id == VENDOR_LACIE) 144 return snd_oxfw_add_spkr(oxfw, true); 145 146 /* 147 * Stanton models supports asynchronous transactions for unique MIDI 148 * messages. 149 */ 150 if (entry->vendor_id == OUI_STANTON) { 151 oxfw->quirks |= SND_OXFW_QUIRK_SCS_TRANSACTION; 152 if (entry->model_id == MODEL_SCS1M) 153 oxfw->quirks |= SND_OXFW_QUIRK_BLOCKING_TRANSMISSION; 154 155 // No physical MIDI ports. 156 oxfw->midi_input_ports = 0; 157 oxfw->midi_output_ports = 0; 158 159 return snd_oxfw_scs1x_add(oxfw); 160 } 161 162 if (entry->vendor_id == OUI_APOGEE && entry->model_id == MODEL_DUET_FW) { 163 oxfw->quirks |= SND_OXFW_QUIRK_BLOCKING_TRANSMISSION | 164 SND_OXFW_QUIRK_IGNORE_NO_INFO_PACKET; 165 } 166 167 /* 168 * TASCAM FireOne has physical control and requires a pair of additional 169 * MIDI ports. 170 */ 171 if (entry->vendor_id == VENDOR_TASCAM) { 172 oxfw->midi_input_ports++; 173 oxfw->midi_output_ports++; 174 return 0; 175 } 176 177 /* Seek from Root Directory of Config ROM. */ 178 vendor = model = 0; 179 fw_csr_iterator_init(&it, fw_dev->config_rom + 5); 180 while (fw_csr_iterator_next(&it, &key, &val)) { 181 if (key == CSR_VENDOR) 182 vendor = val; 183 else if (key == CSR_MODEL) 184 model = val; 185 } 186 187 if (vendor == VENDOR_LOUD) { 188 // Mackie Onyx Satellite with base station has a quirk to report a wrong 189 // value in 'dbs' field of CIP header against its format information. 190 oxfw->quirks |= SND_OXFW_QUIRK_WRONG_DBS; 191 192 // OXFW971-based models may transfer events by blocking method. 193 if (!(oxfw->quirks & SND_OXFW_QUIRK_JUMBO_PAYLOAD)) 194 oxfw->quirks |= SND_OXFW_QUIRK_BLOCKING_TRANSMISSION; 195 } 196 197 return 0; 198 } 199 200 static int oxfw_probe(struct fw_unit *unit, const struct ieee1394_device_id *entry) 201 { 202 struct snd_card *card; 203 struct snd_oxfw *oxfw; 204 int err; 205 206 if (entry->vendor_id == VENDOR_LOUD && entry->model_id == 0 && !detect_loud_models(unit)) 207 return -ENODEV; 208 209 err = snd_card_new(&unit->device, -1, NULL, THIS_MODULE, sizeof(*oxfw), &card); 210 if (err < 0) 211 return err; 212 card->private_free = oxfw_card_free; 213 214 oxfw = card->private_data; 215 oxfw->unit = fw_unit_get(unit); 216 dev_set_drvdata(&unit->device, oxfw); 217 oxfw->card = card; 218 219 mutex_init(&oxfw->mutex); 220 spin_lock_init(&oxfw->lock); 221 init_waitqueue_head(&oxfw->hwdep_wait); 222 223 err = name_card(oxfw, entry); 224 if (err < 0) 225 goto error; 226 227 err = snd_oxfw_stream_discover(oxfw); 228 if (err < 0) 229 goto error; 230 231 err = detect_quirks(oxfw, entry); 232 if (err < 0) 233 goto error; 234 235 if (oxfw->has_output || oxfw->has_input) { 236 err = snd_oxfw_stream_init_duplex(oxfw); 237 if (err < 0) 238 goto error; 239 240 err = snd_oxfw_create_pcm(oxfw); 241 if (err < 0) 242 goto error; 243 244 snd_oxfw_proc_init(oxfw); 245 246 err = snd_oxfw_create_midi(oxfw); 247 if (err < 0) 248 goto error; 249 250 err = snd_oxfw_create_hwdep(oxfw); 251 if (err < 0) 252 goto error; 253 } 254 255 err = snd_card_register(card); 256 if (err < 0) 257 goto error; 258 259 return 0; 260 error: 261 snd_card_free(card); 262 return err; 263 } 264 265 static void oxfw_bus_reset(struct fw_unit *unit) 266 { 267 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device); 268 269 fcp_bus_reset(oxfw->unit); 270 271 if (oxfw->has_output || oxfw->has_input) { 272 mutex_lock(&oxfw->mutex); 273 snd_oxfw_stream_update_duplex(oxfw); 274 mutex_unlock(&oxfw->mutex); 275 } 276 277 if (oxfw->quirks & SND_OXFW_QUIRK_SCS_TRANSACTION) 278 snd_oxfw_scs1x_update(oxfw); 279 } 280 281 static void oxfw_remove(struct fw_unit *unit) 282 { 283 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device); 284 285 // Block till all of ALSA character devices are released. 286 snd_card_free(oxfw->card); 287 } 288 289 static const struct compat_info griffin_firewave = { 290 .driver_name = "FireWave", 291 .vendor_name = "Griffin", 292 .model_name = "FireWave", 293 }; 294 295 static const struct compat_info lacie_speakers = { 296 .driver_name = "FWSpeakers", 297 .vendor_name = "LaCie", 298 .model_name = "FireWire Speakers", 299 }; 300 301 #define OXFW_DEV_ENTRY(vendor, model, data) \ 302 { \ 303 .match_flags = IEEE1394_MATCH_VENDOR_ID | \ 304 IEEE1394_MATCH_MODEL_ID | \ 305 IEEE1394_MATCH_SPECIFIER_ID | \ 306 IEEE1394_MATCH_VERSION, \ 307 .vendor_id = vendor, \ 308 .model_id = model, \ 309 .specifier_id = SPECIFIER_1394TA, \ 310 .version = VERSION_AVC, \ 311 .driver_data = (kernel_ulong_t)data, \ 312 } 313 314 static const struct ieee1394_device_id oxfw_id_table[] = { 315 // 316 // OXFW970 devices: 317 // Initial firmware has a quirk to postpone isoc packet transmission during finishing async 318 // transaction. As a result, several isochronous cycles are skipped to transfer the packets 319 // and the audio data frames which should have been transferred during the cycles are put 320 // into packet at the first isoc cycle after the postpone. Furthermore, the value of SYT 321 // field in CIP header is not reliable as synchronization timing, 322 // 323 OXFW_DEV_ENTRY(VENDOR_GRIFFIN, 0x00f970, &griffin_firewave), 324 OXFW_DEV_ENTRY(VENDOR_LACIE, 0x00f970, &lacie_speakers), 325 // Behringer,F-Control Audio 202. The value of SYT field is not reliable at all. 326 OXFW_DEV_ENTRY(VENDOR_BEHRINGER, 0x00fc22, NULL), 327 // Loud Technologies, Tapco Link.FireWire 4x6. The value of SYT field is always 0xffff. 328 OXFW_DEV_ENTRY(VENDOR_LOUD, 0x000460, NULL), 329 // Loud Technologies, Mackie Onyx Satellite. Although revised version of firmware is 330 // installed to avoid the postpone, the value of SYT field is always 0xffff. 331 OXFW_DEV_ENTRY(VENDOR_LOUD, MODEL_SATELLITE, NULL), 332 // Miglia HarmonyAudio. Not yet identified. 333 334 // 335 // OXFW971 devices: 336 // The value of SYT field in CIP header is enough reliable. Both of blocking and non-blocking 337 // transmission methods are available. 338 // 339 // Any Mackie(Loud) models (name string/model id): 340 // Onyx-i series (former models): 0x081216 341 // Onyx 1640i: 0x001640 342 // d.2 pro/d.4 pro (built-in card): Unknown 343 // U.420: Unknown 344 // U.420d: Unknown 345 { 346 .match_flags = IEEE1394_MATCH_VENDOR_ID | 347 IEEE1394_MATCH_SPECIFIER_ID | 348 IEEE1394_MATCH_VERSION, 349 .vendor_id = VENDOR_LOUD, 350 .model_id = 0, 351 .specifier_id = SPECIFIER_1394TA, 352 .version = VERSION_AVC, 353 }, 354 // TASCAM, FireOne. 355 OXFW_DEV_ENTRY(VENDOR_TASCAM, 0x800007, NULL), 356 // Stanton, Stanton Controllers & Systems 1 Mixer (SCS.1m). 357 OXFW_DEV_ENTRY(OUI_STANTON, MODEL_SCS1M, NULL), 358 // Stanton, Stanton Controllers & Systems 1 Deck (SCS.1d). 359 OXFW_DEV_ENTRY(OUI_STANTON, 0x002000, NULL), 360 // APOGEE, duet FireWire. 361 OXFW_DEV_ENTRY(OUI_APOGEE, MODEL_DUET_FW, NULL), 362 { } 363 }; 364 MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table); 365 366 static struct fw_driver oxfw_driver = { 367 .driver = { 368 .owner = THIS_MODULE, 369 .name = KBUILD_MODNAME, 370 .bus = &fw_bus_type, 371 }, 372 .probe = oxfw_probe, 373 .update = oxfw_bus_reset, 374 .remove = oxfw_remove, 375 .id_table = oxfw_id_table, 376 }; 377 378 static int __init snd_oxfw_init(void) 379 { 380 return driver_register(&oxfw_driver.driver); 381 } 382 383 static void __exit snd_oxfw_exit(void) 384 { 385 driver_unregister(&oxfw_driver.driver); 386 } 387 388 module_init(snd_oxfw_init); 389 module_exit(snd_oxfw_exit); 390