2 * oxfw.c - a part of driver for OXFW970/971 based devices
4 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
5 * Licensed under the terms of the GNU General Public License, version 2.
10 #define OXFORD_FIRMWARE_ID_ADDRESS (CSR_REGISTER_BASE + 0x50000)
11 /* 0x970?vvvv or 0x971?vvvv, where vvvv = firmware version */
13 #define OXFORD_HARDWARE_ID_ADDRESS (CSR_REGISTER_BASE + 0x90020)
14 #define OXFORD_HARDWARE_ID_OXFW970 0x39443841
15 #define OXFORD_HARDWARE_ID_OXFW971 0x39373100
17 #define VENDOR_LOUD 0x000ff2
18 #define VENDOR_GRIFFIN 0x001292
19 #define VENDOR_BEHRINGER 0x001564
20 #define VENDOR_LACIE 0x00d04b
22 #define SPECIFIER_1394TA 0x00a02d
23 #define VERSION_AVC 0x010001
25 MODULE_DESCRIPTION("Oxford Semiconductor FW970/971 driver");
26 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
27 MODULE_LICENSE("GPL v2");
28 MODULE_ALIAS("snd-firewire-speakers");
30 static bool detect_loud_models(struct fw_unit *unit)
32 const char *const models[] = {
36 "Mackie Onyx Satellite",
37 "Tapco LINK.firewire 4x6",
43 err = fw_csr_string(unit->directory, CSR_MODEL,
44 model, sizeof(model));
48 for (i = 0; i < ARRAY_SIZE(models); i++) {
49 if (strcmp(models[i], model) == 0)
53 return (i < ARRAY_SIZE(models));
56 static int name_card(struct snd_oxfw *oxfw)
58 struct fw_device *fw_dev = fw_parent_device(oxfw->unit);
61 const char *d, *v, *m;
65 /* get vendor name from root directory */
66 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
67 vendor, sizeof(vendor));
71 /* get model name from unit directory */
72 err = fw_csr_string(oxfw->unit->directory, CSR_MODEL,
73 model, sizeof(model));
77 err = snd_fw_transaction(oxfw->unit, TCODE_READ_QUADLET_REQUEST,
78 OXFORD_FIRMWARE_ID_ADDRESS, &firmware, 4, 0);
81 be32_to_cpus(&firmware);
83 /* to apply card definitions */
84 if (oxfw->device_info) {
85 d = oxfw->device_info->driver_name;
86 v = oxfw->device_info->vendor_name;
87 m = oxfw->device_info->model_name;
94 strcpy(oxfw->card->driver, d);
95 strcpy(oxfw->card->mixername, m);
96 strcpy(oxfw->card->shortname, m);
98 snprintf(oxfw->card->longname, sizeof(oxfw->card->longname),
99 "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d",
100 v, m, firmware >> 20, firmware & 0xffff,
101 fw_dev->config_rom[3], fw_dev->config_rom[4],
102 dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed);
107 static void oxfw_card_free(struct snd_card *card)
109 struct snd_oxfw *oxfw = card->private_data;
112 for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) {
113 kfree(oxfw->tx_stream_formats[i]);
114 kfree(oxfw->rx_stream_formats[i]);
117 mutex_destroy(&oxfw->mutex);
120 static int oxfw_probe(struct fw_unit *unit,
121 const struct ieee1394_device_id *id)
123 struct snd_card *card;
124 struct snd_oxfw *oxfw;
127 if ((id->vendor_id == VENDOR_LOUD) && !detect_loud_models(unit))
130 err = snd_card_new(&unit->device, -1, NULL, THIS_MODULE,
131 sizeof(*oxfw), &card);
135 card->private_free = oxfw_card_free;
136 oxfw = card->private_data;
138 mutex_init(&oxfw->mutex);
140 oxfw->device_info = (const struct device_info *)id->driver_data;
141 spin_lock_init(&oxfw->lock);
143 err = snd_oxfw_stream_discover(oxfw);
147 err = name_card(oxfw);
151 err = snd_oxfw_create_pcm(oxfw);
155 if (oxfw->device_info) {
156 err = snd_oxfw_create_mixer(oxfw);
161 snd_oxfw_proc_init(oxfw);
163 err = snd_oxfw_create_midi(oxfw);
167 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->rx_stream);
170 if (oxfw->has_output) {
171 err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->tx_stream);
176 err = snd_card_register(card);
178 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream);
179 if (oxfw->has_output)
180 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream);
183 dev_set_drvdata(&unit->device, oxfw);
191 static void oxfw_bus_reset(struct fw_unit *unit)
193 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
195 fcp_bus_reset(oxfw->unit);
197 mutex_lock(&oxfw->mutex);
199 snd_oxfw_stream_update_simplex(oxfw, &oxfw->rx_stream);
200 if (oxfw->has_output)
201 snd_oxfw_stream_update_simplex(oxfw, &oxfw->tx_stream);
203 mutex_unlock(&oxfw->mutex);
206 static void oxfw_remove(struct fw_unit *unit)
208 struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device);
210 snd_card_disconnect(oxfw->card);
212 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream);
213 if (oxfw->has_output)
214 snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream);
216 snd_card_free_when_closed(oxfw->card);
219 static const struct device_info griffin_firewave = {
220 .driver_name = "FireWave",
221 .vendor_name = "Griffin",
222 .model_name = "FireWave",
225 .volume_fb_id = 0x02,
228 static const struct device_info lacie_speakers = {
229 .driver_name = "FWSpeakers",
230 .vendor_name = "LaCie",
231 .model_name = "FireWire Speakers",
234 .volume_fb_id = 0x01,
237 static const struct ieee1394_device_id oxfw_id_table[] = {
239 .match_flags = IEEE1394_MATCH_VENDOR_ID |
240 IEEE1394_MATCH_MODEL_ID |
241 IEEE1394_MATCH_SPECIFIER_ID |
242 IEEE1394_MATCH_VERSION,
243 .vendor_id = VENDOR_GRIFFIN,
244 .model_id = 0x00f970,
245 .specifier_id = SPECIFIER_1394TA,
246 .version = VERSION_AVC,
247 .driver_data = (kernel_ulong_t)&griffin_firewave,
250 .match_flags = IEEE1394_MATCH_VENDOR_ID |
251 IEEE1394_MATCH_MODEL_ID |
252 IEEE1394_MATCH_SPECIFIER_ID |
253 IEEE1394_MATCH_VERSION,
254 .vendor_id = VENDOR_LACIE,
255 .model_id = 0x00f970,
256 .specifier_id = SPECIFIER_1394TA,
257 .version = VERSION_AVC,
258 .driver_data = (kernel_ulong_t)&lacie_speakers,
260 /* Behringer,F-Control Audio 202 */
262 .match_flags = IEEE1394_MATCH_VENDOR_ID |
263 IEEE1394_MATCH_MODEL_ID,
264 .vendor_id = VENDOR_BEHRINGER,
265 .model_id = 0x00fc22,
268 * Any Mackie(Loud) models (name string/model id):
269 * Onyx-i series (former models): 0x081216
270 * Mackie Onyx Satellite: 0x00200f
271 * Tapco LINK.firewire 4x6: 0x000460
278 .match_flags = IEEE1394_MATCH_VENDOR_ID |
279 IEEE1394_MATCH_SPECIFIER_ID |
280 IEEE1394_MATCH_VERSION,
281 .vendor_id = VENDOR_LOUD,
282 .specifier_id = SPECIFIER_1394TA,
283 .version = VERSION_AVC,
287 MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table);
289 static struct fw_driver oxfw_driver = {
291 .owner = THIS_MODULE,
292 .name = KBUILD_MODNAME,
296 .update = oxfw_bus_reset,
297 .remove = oxfw_remove,
298 .id_table = oxfw_id_table,
301 static int __init snd_oxfw_init(void)
303 return driver_register(&oxfw_driver.driver);
306 static void __exit snd_oxfw_exit(void)
308 driver_unregister(&oxfw_driver.driver);
311 module_init(snd_oxfw_init);
312 module_exit(snd_oxfw_exit);