Commit | Line | Data |
---|---|---|
31ef9134 | 1 | /* |
8832c5a7 | 2 | * oxfw.c - a part of driver for OXFW970/971 based devices |
31ef9134 CL |
3 | * |
4 | * Copyright (c) Clemens Ladisch <clemens@ladisch.de> | |
5 | * Licensed under the terms of the GNU General Public License, version 2. | |
6 | */ | |
7 | ||
e2786ca6 | 8 | #include "oxfw.h" |
31ef9134 CL |
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 | ||
ec4dba50 | 17 | #define VENDOR_LOUD 0x000ff2 |
31ef9134 | 18 | #define VENDOR_GRIFFIN 0x001292 |
ec4dba50 | 19 | #define VENDOR_BEHRINGER 0x001564 |
31ef9134 | 20 | #define VENDOR_LACIE 0x00d04b |
759a2f40 | 21 | #define VENDOR_TASCAM 0x00022e |
31ef9134 | 22 | |
13f3a46d TS |
23 | #define MODEL_SATELLITE 0x00200f |
24 | ||
31ef9134 CL |
25 | #define SPECIFIER_1394TA 0x00a02d |
26 | #define VERSION_AVC 0x010001 | |
27 | ||
8832c5a7 | 28 | MODULE_DESCRIPTION("Oxford Semiconductor FW970/971 driver"); |
31ef9134 CL |
29 | MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>"); |
30 | MODULE_LICENSE("GPL v2"); | |
8832c5a7 | 31 | MODULE_ALIAS("snd-firewire-speakers"); |
31ef9134 | 32 | |
ec4dba50 TS |
33 | static bool detect_loud_models(struct fw_unit *unit) |
34 | { | |
35 | const char *const models[] = { | |
36 | "Onyxi", | |
37 | "Onyx-i", | |
38 | "d.Pro", | |
39 | "Mackie Onyx Satellite", | |
40 | "Tapco LINK.firewire 4x6", | |
41 | "U.420"}; | |
42 | char model[32]; | |
43 | unsigned int i; | |
44 | int err; | |
45 | ||
46 | err = fw_csr_string(unit->directory, CSR_MODEL, | |
47 | model, sizeof(model)); | |
48 | if (err < 0) | |
0d3aba30 | 49 | return false; |
ec4dba50 TS |
50 | |
51 | for (i = 0; i < ARRAY_SIZE(models); i++) { | |
52 | if (strcmp(models[i], model) == 0) | |
53 | break; | |
54 | } | |
55 | ||
56 | return (i < ARRAY_SIZE(models)); | |
57 | } | |
58 | ||
fec7b753 | 59 | static int name_card(struct snd_oxfw *oxfw) |
31ef9134 | 60 | { |
fec7b753 | 61 | struct fw_device *fw_dev = fw_parent_device(oxfw->unit); |
ec4dba50 TS |
62 | char vendor[24]; |
63 | char model[32]; | |
fec7b753 TS |
64 | const char *d, *v, *m; |
65 | u32 firmware; | |
31ef9134 CL |
66 | int err; |
67 | ||
ec4dba50 TS |
68 | /* get vendor name from root directory */ |
69 | err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR, | |
70 | vendor, sizeof(vendor)); | |
71 | if (err < 0) | |
72 | goto end; | |
73 | ||
74 | /* get model name from unit directory */ | |
75 | err = fw_csr_string(oxfw->unit->directory, CSR_MODEL, | |
76 | model, sizeof(model)); | |
77 | if (err < 0) | |
78 | goto end; | |
79 | ||
fec7b753 TS |
80 | err = snd_fw_transaction(oxfw->unit, TCODE_READ_QUADLET_REQUEST, |
81 | OXFORD_FIRMWARE_ID_ADDRESS, &firmware, 4, 0); | |
82 | if (err < 0) | |
83 | goto end; | |
84 | be32_to_cpus(&firmware); | |
85 | ||
ec4dba50 TS |
86 | /* to apply card definitions */ |
87 | if (oxfw->device_info) { | |
88 | d = oxfw->device_info->driver_name; | |
89 | v = oxfw->device_info->vendor_name; | |
90 | m = oxfw->device_info->model_name; | |
91 | } else { | |
92 | d = "OXFW"; | |
93 | v = vendor; | |
94 | m = model; | |
95 | } | |
fec7b753 TS |
96 | |
97 | strcpy(oxfw->card->driver, d); | |
98 | strcpy(oxfw->card->mixername, m); | |
99 | strcpy(oxfw->card->shortname, m); | |
100 | ||
101 | snprintf(oxfw->card->longname, sizeof(oxfw->card->longname), | |
102 | "%s %s (OXFW%x %04x), GUID %08x%08x at %s, S%d", | |
103 | v, m, firmware >> 20, firmware & 0xffff, | |
104 | fw_dev->config_rom[3], fw_dev->config_rom[4], | |
105 | dev_name(&oxfw->unit->device), 100 << fw_dev->max_speed); | |
106 | end: | |
107 | return err; | |
31ef9134 CL |
108 | } |
109 | ||
12ed7192 TS |
110 | /* |
111 | * This module releases the FireWire unit data after all ALSA character devices | |
112 | * are released by applications. This is for releasing stream data or finishing | |
113 | * transactions safely. Thus at returning from .remove(), this module still keep | |
114 | * references for the unit. | |
115 | */ | |
8832c5a7 | 116 | static void oxfw_card_free(struct snd_card *card) |
31ef9134 | 117 | { |
8832c5a7 | 118 | struct snd_oxfw *oxfw = card->private_data; |
5cd1d3f4 TS |
119 | unsigned int i; |
120 | ||
dec84316 TS |
121 | snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream); |
122 | if (oxfw->has_output) | |
123 | snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream); | |
124 | ||
12ed7192 TS |
125 | fw_unit_put(oxfw->unit); |
126 | ||
b0ac0009 TS |
127 | for (i = 0; i < SND_OXFW_STREAM_FORMAT_ENTRIES; i++) { |
128 | kfree(oxfw->tx_stream_formats[i]); | |
5cd1d3f4 | 129 | kfree(oxfw->rx_stream_formats[i]); |
b0ac0009 | 130 | } |
31ef9134 | 131 | |
8832c5a7 | 132 | mutex_destroy(&oxfw->mutex); |
31ef9134 CL |
133 | } |
134 | ||
13f3a46d TS |
135 | static void detect_quirks(struct snd_oxfw *oxfw) |
136 | { | |
137 | struct fw_device *fw_dev = fw_parent_device(oxfw->unit); | |
138 | struct fw_csr_iterator it; | |
139 | int key, val; | |
140 | int vendor, model; | |
141 | ||
142 | /* Seek from Root Directory of Config ROM. */ | |
143 | vendor = model = 0; | |
144 | fw_csr_iterator_init(&it, fw_dev->config_rom + 5); | |
145 | while (fw_csr_iterator_next(&it, &key, &val)) { | |
146 | if (key == CSR_VENDOR) | |
147 | vendor = val; | |
148 | else if (key == CSR_MODEL) | |
149 | model = val; | |
150 | } | |
151 | ||
152 | /* | |
153 | * Mackie Onyx Satellite with base station has a quirk to report a wrong | |
154 | * value in 'dbs' field of CIP header against its format information. | |
155 | */ | |
156 | if (vendor == VENDOR_LOUD && model == MODEL_SATELLITE) | |
157 | oxfw->wrong_dbs = true; | |
759a2f40 TS |
158 | |
159 | /* | |
160 | * TASCAM FireOne has physical control and requires a pair of additional | |
161 | * MIDI ports. | |
162 | */ | |
163 | if (vendor == VENDOR_TASCAM) { | |
164 | oxfw->midi_input_ports++; | |
165 | oxfw->midi_output_ports++; | |
166 | } | |
13f3a46d TS |
167 | } |
168 | ||
8832c5a7 | 169 | static int oxfw_probe(struct fw_unit *unit, |
94a87157 | 170 | const struct ieee1394_device_id *id) |
31ef9134 | 171 | { |
31ef9134 | 172 | struct snd_card *card; |
8832c5a7 | 173 | struct snd_oxfw *oxfw; |
31ef9134 CL |
174 | int err; |
175 | ||
ec4dba50 TS |
176 | if ((id->vendor_id == VENDOR_LOUD) && !detect_loud_models(unit)) |
177 | return -ENODEV; | |
178 | ||
06b45f00 | 179 | err = snd_card_new(&unit->device, -1, NULL, THIS_MODULE, |
8832c5a7 | 180 | sizeof(*oxfw), &card); |
31ef9134 CL |
181 | if (err < 0) |
182 | return err; | |
31ef9134 | 183 | |
e2786ca6 | 184 | card->private_free = oxfw_card_free; |
8832c5a7 TS |
185 | oxfw = card->private_data; |
186 | oxfw->card = card; | |
187 | mutex_init(&oxfw->mutex); | |
12ed7192 | 188 | oxfw->unit = fw_unit_get(unit); |
8832c5a7 | 189 | oxfw->device_info = (const struct device_info *)id->driver_data; |
05588d34 | 190 | spin_lock_init(&oxfw->lock); |
8985f4ac | 191 | init_waitqueue_head(&oxfw->hwdep_wait); |
31ef9134 | 192 | |
5cd1d3f4 TS |
193 | err = snd_oxfw_stream_discover(oxfw); |
194 | if (err < 0) | |
195 | goto error; | |
196 | ||
13f3a46d TS |
197 | detect_quirks(oxfw); |
198 | ||
fec7b753 TS |
199 | err = name_card(oxfw); |
200 | if (err < 0) | |
201 | goto error; | |
31ef9134 | 202 | |
3713d93a | 203 | err = snd_oxfw_create_pcm(oxfw); |
31ef9134 CL |
204 | if (err < 0) |
205 | goto error; | |
206 | ||
ec4dba50 | 207 | if (oxfw->device_info) { |
29aa09ac | 208 | err = snd_oxfw_add_spkr(oxfw); |
ec4dba50 TS |
209 | if (err < 0) |
210 | goto error; | |
211 | } | |
31ef9134 | 212 | |
3c96101f TS |
213 | snd_oxfw_proc_init(oxfw); |
214 | ||
05588d34 TS |
215 | err = snd_oxfw_create_midi(oxfw); |
216 | if (err < 0) | |
217 | goto error; | |
218 | ||
8985f4ac TS |
219 | err = snd_oxfw_create_hwdep(oxfw); |
220 | if (err < 0) | |
221 | goto error; | |
222 | ||
b0ac0009 | 223 | err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->rx_stream); |
31ef9134 CL |
224 | if (err < 0) |
225 | goto error; | |
b0ac0009 TS |
226 | if (oxfw->has_output) { |
227 | err = snd_oxfw_stream_init_simplex(oxfw, &oxfw->tx_stream); | |
228 | if (err < 0) | |
229 | goto error; | |
230 | } | |
31ef9134 | 231 | |
e2786ca6 TS |
232 | err = snd_card_register(card); |
233 | if (err < 0) { | |
b0ac0009 TS |
234 | snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->rx_stream); |
235 | if (oxfw->has_output) | |
236 | snd_oxfw_stream_destroy_simplex(oxfw, &oxfw->tx_stream); | |
e2786ca6 TS |
237 | goto error; |
238 | } | |
8832c5a7 | 239 | dev_set_drvdata(&unit->device, oxfw); |
31ef9134 CL |
240 | |
241 | return 0; | |
31ef9134 CL |
242 | error: |
243 | snd_card_free(card); | |
244 | return err; | |
245 | } | |
246 | ||
8832c5a7 | 247 | static void oxfw_bus_reset(struct fw_unit *unit) |
31ef9134 | 248 | { |
8832c5a7 | 249 | struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device); |
31ef9134 | 250 | |
8832c5a7 | 251 | fcp_bus_reset(oxfw->unit); |
31ef9134 | 252 | |
e2786ca6 | 253 | mutex_lock(&oxfw->mutex); |
b0ac0009 TS |
254 | |
255 | snd_oxfw_stream_update_simplex(oxfw, &oxfw->rx_stream); | |
256 | if (oxfw->has_output) | |
257 | snd_oxfw_stream_update_simplex(oxfw, &oxfw->tx_stream); | |
258 | ||
e2786ca6 | 259 | mutex_unlock(&oxfw->mutex); |
31ef9134 CL |
260 | } |
261 | ||
8832c5a7 | 262 | static void oxfw_remove(struct fw_unit *unit) |
94a87157 | 263 | { |
8832c5a7 | 264 | struct snd_oxfw *oxfw = dev_get_drvdata(&unit->device); |
94a87157 | 265 | |
12ed7192 | 266 | /* No need to wait for releasing card object in this context. */ |
8832c5a7 | 267 | snd_card_free_when_closed(oxfw->card); |
94a87157 SR |
268 | } |
269 | ||
270 | static const struct device_info griffin_firewave = { | |
271 | .driver_name = "FireWave", | |
fec7b753 TS |
272 | .vendor_name = "Griffin", |
273 | .model_name = "FireWave", | |
94a87157 SR |
274 | .mixer_channels = 6, |
275 | .mute_fb_id = 0x01, | |
276 | .volume_fb_id = 0x02, | |
277 | }; | |
278 | ||
279 | static const struct device_info lacie_speakers = { | |
280 | .driver_name = "FWSpeakers", | |
fec7b753 TS |
281 | .vendor_name = "LaCie", |
282 | .model_name = "FireWire Speakers", | |
94a87157 SR |
283 | .mixer_channels = 1, |
284 | .mute_fb_id = 0x01, | |
285 | .volume_fb_id = 0x01, | |
286 | }; | |
287 | ||
8832c5a7 | 288 | static const struct ieee1394_device_id oxfw_id_table[] = { |
31ef9134 CL |
289 | { |
290 | .match_flags = IEEE1394_MATCH_VENDOR_ID | | |
291 | IEEE1394_MATCH_MODEL_ID | | |
292 | IEEE1394_MATCH_SPECIFIER_ID | | |
293 | IEEE1394_MATCH_VERSION, | |
294 | .vendor_id = VENDOR_GRIFFIN, | |
295 | .model_id = 0x00f970, | |
296 | .specifier_id = SPECIFIER_1394TA, | |
297 | .version = VERSION_AVC, | |
94a87157 | 298 | .driver_data = (kernel_ulong_t)&griffin_firewave, |
31ef9134 CL |
299 | }, |
300 | { | |
301 | .match_flags = IEEE1394_MATCH_VENDOR_ID | | |
302 | IEEE1394_MATCH_MODEL_ID | | |
303 | IEEE1394_MATCH_SPECIFIER_ID | | |
304 | IEEE1394_MATCH_VERSION, | |
305 | .vendor_id = VENDOR_LACIE, | |
306 | .model_id = 0x00f970, | |
307 | .specifier_id = SPECIFIER_1394TA, | |
308 | .version = VERSION_AVC, | |
94a87157 | 309 | .driver_data = (kernel_ulong_t)&lacie_speakers, |
31ef9134 | 310 | }, |
ec4dba50 TS |
311 | /* Behringer,F-Control Audio 202 */ |
312 | { | |
313 | .match_flags = IEEE1394_MATCH_VENDOR_ID | | |
314 | IEEE1394_MATCH_MODEL_ID, | |
315 | .vendor_id = VENDOR_BEHRINGER, | |
316 | .model_id = 0x00fc22, | |
317 | }, | |
318 | /* | |
319 | * Any Mackie(Loud) models (name string/model id): | |
320 | * Onyx-i series (former models): 0x081216 | |
321 | * Mackie Onyx Satellite: 0x00200f | |
322 | * Tapco LINK.firewire 4x6: 0x000460 | |
323 | * d.2 pro: Unknown | |
324 | * d.4 pro: Unknown | |
325 | * U.420: Unknown | |
326 | * U.420d: Unknown | |
327 | */ | |
328 | { | |
329 | .match_flags = IEEE1394_MATCH_VENDOR_ID | | |
330 | IEEE1394_MATCH_SPECIFIER_ID | | |
331 | IEEE1394_MATCH_VERSION, | |
332 | .vendor_id = VENDOR_LOUD, | |
333 | .specifier_id = SPECIFIER_1394TA, | |
334 | .version = VERSION_AVC, | |
335 | }, | |
759a2f40 TS |
336 | /* TASCAM, FireOne */ |
337 | { | |
338 | .match_flags = IEEE1394_MATCH_VENDOR_ID | | |
339 | IEEE1394_MATCH_MODEL_ID, | |
340 | .vendor_id = VENDOR_TASCAM, | |
341 | .model_id = 0x800007, | |
342 | }, | |
31ef9134 CL |
343 | { } |
344 | }; | |
8832c5a7 | 345 | MODULE_DEVICE_TABLE(ieee1394, oxfw_id_table); |
31ef9134 | 346 | |
8832c5a7 | 347 | static struct fw_driver oxfw_driver = { |
31ef9134 CL |
348 | .driver = { |
349 | .owner = THIS_MODULE, | |
350 | .name = KBUILD_MODNAME, | |
351 | .bus = &fw_bus_type, | |
31ef9134 | 352 | }, |
8832c5a7 TS |
353 | .probe = oxfw_probe, |
354 | .update = oxfw_bus_reset, | |
355 | .remove = oxfw_remove, | |
356 | .id_table = oxfw_id_table, | |
31ef9134 CL |
357 | }; |
358 | ||
8832c5a7 | 359 | static int __init snd_oxfw_init(void) |
31ef9134 | 360 | { |
8832c5a7 | 361 | return driver_register(&oxfw_driver.driver); |
31ef9134 CL |
362 | } |
363 | ||
8832c5a7 | 364 | static void __exit snd_oxfw_exit(void) |
31ef9134 | 365 | { |
8832c5a7 | 366 | driver_unregister(&oxfw_driver.driver); |
31ef9134 CL |
367 | } |
368 | ||
8832c5a7 TS |
369 | module_init(snd_oxfw_init); |
370 | module_exit(snd_oxfw_exit); |