Commit | Line | Data |
---|---|---|
fd6f4b0d TS |
1 | /* |
2 | * bebob.c - a part of driver for BeBoB based devices | |
3 | * | |
4 | * Copyright (c) 2013-2014 Takashi Sakamoto | |
5 | * | |
6 | * Licensed under the terms of the GNU General Public License, version 2. | |
7 | */ | |
8 | ||
9 | /* | |
10 | * BeBoB is 'BridgeCo enhanced Breakout Box'. This is installed to firewire | |
11 | * devices with DM1000/DM1100/DM1500 chipset. It gives common way for host | |
12 | * system to handle BeBoB based devices. | |
13 | */ | |
14 | ||
15 | #include "bebob.h" | |
16 | ||
17 | MODULE_DESCRIPTION("BridgeCo BeBoB driver"); | |
18 | MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>"); | |
19 | MODULE_LICENSE("GPL v2"); | |
20 | ||
21 | static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; | |
22 | static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; | |
23 | static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; | |
24 | ||
25 | module_param_array(index, int, NULL, 0444); | |
26 | MODULE_PARM_DESC(index, "card index"); | |
27 | module_param_array(id, charp, NULL, 0444); | |
28 | MODULE_PARM_DESC(id, "ID string"); | |
29 | module_param_array(enable, bool, NULL, 0444); | |
30 | MODULE_PARM_DESC(enable, "enable BeBoB sound card"); | |
31 | ||
32 | static DEFINE_MUTEX(devices_mutex); | |
33 | static DECLARE_BITMAP(devices_used, SNDRV_CARDS); | |
34 | ||
35 | /* Offsets from information register. */ | |
36 | #define INFO_OFFSET_GUID 0x10 | |
37 | #define INFO_OFFSET_HW_MODEL_ID 0x18 | |
38 | #define INFO_OFFSET_HW_MODEL_REVISION 0x1c | |
39 | ||
40 | #define VEN_EDIROL 0x000040ab | |
41 | #define VEN_PRESONUS 0x00000a92 | |
42 | #define VEN_BRIDGECO 0x000007f5 | |
43 | #define VEN_MACKIE 0x0000000f | |
44 | #define VEN_STANTON 0x00001260 | |
45 | #define VEN_TASCAM 0x0000022e | |
46 | #define VEN_BEHRINGER 0x00001564 | |
47 | #define VEN_APOGEE 0x000003db | |
48 | #define VEN_ESI 0x00000f1b | |
49 | #define VEN_ACOUSTIC 0x00000002 | |
50 | #define VEN_CME 0x0000000a | |
51 | #define VEN_PHONIC 0x00001496 | |
52 | #define VEN_LYNX 0x000019e5 | |
53 | #define VEN_ICON 0x00001a9e | |
54 | #define VEN_PRISMSOUND 0x00001198 | |
326b9cac | 55 | #define VEN_TERRATEC 0x00000aac |
8ac98a35 | 56 | #define VEN_YAMAHA 0x0000a0de |
25784ec2 TS |
57 | #define VEN_FOCUSRITE 0x0000130e |
58 | ||
59 | #define MODEL_FOCUSRITE_SAFFIRE_BOTH 0x00000000 | |
fd6f4b0d TS |
60 | |
61 | static int | |
62 | name_device(struct snd_bebob *bebob, unsigned int vendor_id) | |
63 | { | |
64 | struct fw_device *fw_dev = fw_parent_device(bebob->unit); | |
65 | char vendor[24] = {0}; | |
66 | char model[32] = {0}; | |
67 | u32 id; | |
68 | u32 data[2] = {0}; | |
69 | u32 revision; | |
70 | int err; | |
71 | ||
72 | /* get vendor name from root directory */ | |
73 | err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR, | |
74 | vendor, sizeof(vendor)); | |
75 | if (err < 0) | |
76 | goto end; | |
77 | ||
78 | /* get model name from unit directory */ | |
79 | err = fw_csr_string(bebob->unit->directory, CSR_MODEL, | |
80 | model, sizeof(model)); | |
81 | if (err < 0) | |
82 | goto end; | |
83 | ||
84 | /* get hardware id */ | |
85 | err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID, | |
86 | &id); | |
87 | if (err < 0) | |
88 | goto end; | |
89 | ||
90 | /* get hardware revision */ | |
91 | err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION, | |
92 | &revision); | |
93 | if (err < 0) | |
94 | goto end; | |
95 | ||
96 | /* get GUID */ | |
97 | err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID, | |
98 | data, sizeof(data)); | |
99 | if (err < 0) | |
100 | goto end; | |
101 | ||
102 | strcpy(bebob->card->driver, "BeBoB"); | |
103 | strcpy(bebob->card->shortname, model); | |
104 | strcpy(bebob->card->mixername, model); | |
105 | snprintf(bebob->card->longname, sizeof(bebob->card->longname), | |
106 | "%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d", | |
107 | vendor, model, id, revision, | |
108 | data[0], data[1], dev_name(&bebob->unit->device), | |
109 | 100 << fw_dev->max_speed); | |
110 | end: | |
111 | return err; | |
112 | } | |
113 | ||
114 | static void | |
115 | bebob_card_free(struct snd_card *card) | |
116 | { | |
117 | struct snd_bebob *bebob = card->private_data; | |
118 | ||
119 | if (bebob->card_index >= 0) { | |
120 | mutex_lock(&devices_mutex); | |
121 | clear_bit(bebob->card_index, devices_used); | |
122 | mutex_unlock(&devices_mutex); | |
123 | } | |
124 | ||
125 | mutex_destroy(&bebob->mutex); | |
126 | } | |
127 | ||
25784ec2 TS |
128 | static const struct snd_bebob_spec * |
129 | get_saffire_spec(struct fw_unit *unit) | |
130 | { | |
131 | char name[24] = {0}; | |
132 | ||
133 | if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0) | |
134 | return NULL; | |
135 | ||
136 | if (strcmp(name, "SaffireLE") == 0) | |
137 | return &saffire_le_spec; | |
138 | else | |
139 | return &saffire_spec; | |
140 | } | |
141 | ||
fd6f4b0d TS |
142 | static int |
143 | bebob_probe(struct fw_unit *unit, | |
144 | const struct ieee1394_device_id *entry) | |
145 | { | |
146 | struct snd_card *card; | |
147 | struct snd_bebob *bebob; | |
1fc9522a | 148 | const struct snd_bebob_spec *spec; |
fd6f4b0d TS |
149 | unsigned int card_index; |
150 | int err; | |
151 | ||
152 | mutex_lock(&devices_mutex); | |
153 | ||
154 | for (card_index = 0; card_index < SNDRV_CARDS; card_index++) { | |
155 | if (!test_bit(card_index, devices_used) && enable[card_index]) | |
156 | break; | |
157 | } | |
158 | if (card_index >= SNDRV_CARDS) { | |
159 | err = -ENOENT; | |
160 | goto end; | |
161 | } | |
162 | ||
25784ec2 TS |
163 | if ((entry->vendor_id == VEN_FOCUSRITE) && |
164 | (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH)) | |
165 | spec = get_saffire_spec(unit); | |
166 | else | |
167 | spec = (const struct snd_bebob_spec *)entry->driver_data; | |
1fc9522a TS |
168 | if (spec == NULL) { |
169 | err = -ENOSYS; | |
170 | goto end; | |
171 | } | |
172 | ||
fd6f4b0d TS |
173 | err = snd_card_new(&unit->device, index[card_index], id[card_index], |
174 | THIS_MODULE, sizeof(struct snd_bebob), &card); | |
175 | if (err < 0) | |
176 | goto end; | |
177 | bebob = card->private_data; | |
178 | bebob->card_index = card_index; | |
179 | set_bit(card_index, devices_used); | |
180 | card->private_free = bebob_card_free; | |
181 | ||
182 | bebob->card = card; | |
183 | bebob->unit = unit; | |
1fc9522a | 184 | bebob->spec = spec; |
fd6f4b0d TS |
185 | mutex_init(&bebob->mutex); |
186 | spin_lock_init(&bebob->lock); | |
618eabea | 187 | init_waitqueue_head(&bebob->hwdep_wait); |
fd6f4b0d TS |
188 | |
189 | err = name_device(bebob, entry->vendor_id); | |
190 | if (err < 0) | |
191 | goto error; | |
192 | ||
eb7b3a05 | 193 | err = snd_bebob_stream_discover(bebob); |
fd6f4b0d TS |
194 | if (err < 0) |
195 | goto error; | |
eb7b3a05 | 196 | |
ad9697ba TS |
197 | snd_bebob_proc_init(bebob); |
198 | ||
248b7802 TS |
199 | if ((bebob->midi_input_ports > 0) || |
200 | (bebob->midi_output_ports > 0)) { | |
201 | err = snd_bebob_create_midi_devices(bebob); | |
202 | if (err < 0) | |
203 | goto error; | |
204 | } | |
205 | ||
fbbebd2c TS |
206 | err = snd_bebob_create_pcm_devices(bebob); |
207 | if (err < 0) | |
208 | goto error; | |
209 | ||
618eabea TS |
210 | err = snd_bebob_create_hwdep_device(bebob); |
211 | if (err < 0) | |
212 | goto error; | |
213 | ||
eb7b3a05 TS |
214 | err = snd_bebob_stream_init_duplex(bebob); |
215 | if (err < 0) | |
216 | goto error; | |
217 | ||
218 | err = snd_card_register(card); | |
219 | if (err < 0) { | |
220 | snd_bebob_stream_destroy_duplex(bebob); | |
221 | goto error; | |
222 | } | |
223 | ||
fd6f4b0d TS |
224 | dev_set_drvdata(&unit->device, bebob); |
225 | end: | |
226 | mutex_unlock(&devices_mutex); | |
227 | return err; | |
228 | error: | |
229 | mutex_unlock(&devices_mutex); | |
230 | snd_card_free(card); | |
231 | return err; | |
232 | } | |
233 | ||
234 | static void | |
235 | bebob_update(struct fw_unit *unit) | |
236 | { | |
237 | struct snd_bebob *bebob = dev_get_drvdata(&unit->device); | |
238 | fcp_bus_reset(bebob->unit); | |
eb7b3a05 | 239 | snd_bebob_stream_update_duplex(bebob); |
fd6f4b0d TS |
240 | } |
241 | ||
242 | static void bebob_remove(struct fw_unit *unit) | |
243 | { | |
244 | struct snd_bebob *bebob = dev_get_drvdata(&unit->device); | |
eb7b3a05 | 245 | snd_bebob_stream_destroy_duplex(bebob); |
fd6f4b0d TS |
246 | snd_card_disconnect(bebob->card); |
247 | snd_card_free_when_closed(bebob->card); | |
248 | } | |
249 | ||
1fc9522a TS |
250 | struct snd_bebob_rate_spec normal_rate_spec = { |
251 | .get = &snd_bebob_stream_get_rate, | |
252 | .set = &snd_bebob_stream_set_rate | |
253 | }; | |
254 | static const struct snd_bebob_spec spec_normal = { | |
255 | .clock = NULL, | |
256 | .rate = &normal_rate_spec, | |
257 | .meter = NULL | |
258 | }; | |
259 | ||
fd6f4b0d TS |
260 | static const struct ieee1394_device_id bebob_id_table[] = { |
261 | /* Edirol, FA-66 */ | |
1fc9522a | 262 | SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal), |
fd6f4b0d | 263 | /* Edirol, FA-101 */ |
1fc9522a | 264 | SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal), |
fd6f4b0d | 265 | /* Presonus, FIREBOX */ |
1fc9522a | 266 | SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal), |
fd6f4b0d | 267 | /* PreSonus, FIREPOD/FP10 */ |
1fc9522a | 268 | SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal), |
fd6f4b0d | 269 | /* PreSonus, Inspire1394 */ |
1fc9522a | 270 | SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal), |
fd6f4b0d | 271 | /* BridgeCo, RDAudio1 */ |
1fc9522a | 272 | SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal), |
fd6f4b0d | 273 | /* BridgeCo, Audio5 */ |
1fc9522a | 274 | SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal), |
fd6f4b0d | 275 | /* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */ |
1fc9522a | 276 | SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065, &spec_normal), |
fd6f4b0d | 277 | /* Mackie, d.2 (Firewire Option) */ |
1fc9522a | 278 | SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067, &spec_normal), |
fd6f4b0d | 279 | /* Stanton, ScratchAmp */ |
1fc9522a | 280 | SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal), |
fd6f4b0d | 281 | /* Tascam, IF-FW DM */ |
1fc9522a | 282 | SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal), |
fd6f4b0d | 283 | /* Behringer, XENIX UFX 1204 */ |
1fc9522a | 284 | SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal), |
fd6f4b0d | 285 | /* Behringer, XENIX UFX 1604 */ |
1fc9522a | 286 | SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal), |
fd6f4b0d | 287 | /* Behringer, Digital Mixer X32 series (X-UF Card) */ |
1fc9522a | 288 | SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal), |
fd6f4b0d TS |
289 | /* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */ |
290 | /* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */ | |
1fc9522a | 291 | SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal), |
fd6f4b0d | 292 | /* Apogee Electronics, Ensemble */ |
1fc9522a | 293 | SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee, &spec_normal), |
fd6f4b0d | 294 | /* ESI, Quatafire610 */ |
1fc9522a | 295 | SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal), |
fd6f4b0d | 296 | /* AcousticReality, eARMasterOne */ |
1fc9522a | 297 | SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal), |
fd6f4b0d | 298 | /* CME, MatrixKFW */ |
1fc9522a | 299 | SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal), |
fd6f4b0d | 300 | /* Phonic, Helix Board 12 MkII */ |
1fc9522a | 301 | SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal), |
fd6f4b0d | 302 | /* Phonic, Helix Board 18 MkII */ |
1fc9522a | 303 | SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal), |
fd6f4b0d | 304 | /* Phonic, Helix Board 24 MkII */ |
1fc9522a | 305 | SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal), |
fd6f4b0d | 306 | /* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */ |
1fc9522a | 307 | SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal), |
fd6f4b0d | 308 | /* Lynx, Aurora 8/16 (LT-FW) */ |
1fc9522a | 309 | SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal), |
fd6f4b0d | 310 | /* ICON, FireXon */ |
1fc9522a | 311 | SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal), |
fd6f4b0d | 312 | /* PrismSound, Orpheus */ |
1fc9522a | 313 | SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal), |
fd6f4b0d | 314 | /* PrismSound, ADA-8XR */ |
1fc9522a | 315 | SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal), |
326b9cac TS |
316 | /* TerraTec Electronic GmbH, PHASE 88 Rack FW */ |
317 | SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec), | |
318 | /* TerraTec Electronic GmbH, PHASE 24 FW */ | |
319 | SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &phase24_series_spec), | |
320 | /* TerraTec Electronic GmbH, Phase X24 FW */ | |
321 | SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &phase24_series_spec), | |
322 | /* TerraTec Electronic GmbH, EWS MIC2/MIC8 */ | |
323 | SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal), | |
324 | /* Terratec Electronic GmbH, Aureon 7.1 Firewire */ | |
325 | SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal), | |
8ac98a35 TS |
326 | /* Yamaha, GO44 */ |
327 | SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_go_spec), | |
328 | /* YAMAHA, GO46 */ | |
329 | SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_go_spec), | |
25784ec2 TS |
330 | /* Focusrite, SaffirePro 26 I/O */ |
331 | SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec), | |
332 | /* Focusrite, SaffirePro 10 I/O */ | |
333 | SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000006, &saffirepro_10_spec), | |
334 | /* Focusrite, Saffire(no label and LE) */ | |
335 | SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH, | |
336 | &saffire_spec), | |
fd6f4b0d TS |
337 | /* IDs are unknown but able to be supported */ |
338 | /* Apogee, Mini-ME Firewire */ | |
339 | /* Apogee, Mini-DAC Firewire */ | |
340 | /* Behringer, F-Control Audio 1616 */ | |
341 | /* Behringer, F-Control Audio 610 */ | |
342 | /* Cakawalk, Sonar Power Studio 66 */ | |
343 | /* CME, UF400e */ | |
344 | /* ESI, Quotafire XL */ | |
345 | /* Infrasonic, DewX */ | |
346 | /* Infrasonic, Windy6 */ | |
347 | /* Mackie, Digital X Bus x.200 */ | |
348 | /* Mackie, Digital X Bus x.400 */ | |
349 | /* Phonic, HB 12 */ | |
350 | /* Phonic, HB 24 */ | |
351 | /* Phonic, HB 18 */ | |
352 | /* Phonic, FireFly 202 */ | |
353 | /* Phonic, FireFly 302 */ | |
354 | /* Rolf Spuler, Firewire Guitar */ | |
355 | {} | |
356 | }; | |
357 | MODULE_DEVICE_TABLE(ieee1394, bebob_id_table); | |
358 | ||
359 | static struct fw_driver bebob_driver = { | |
360 | .driver = { | |
361 | .owner = THIS_MODULE, | |
362 | .name = "snd-bebob", | |
363 | .bus = &fw_bus_type, | |
364 | }, | |
365 | .probe = bebob_probe, | |
366 | .update = bebob_update, | |
367 | .remove = bebob_remove, | |
368 | .id_table = bebob_id_table, | |
369 | }; | |
370 | ||
371 | static int __init | |
372 | snd_bebob_init(void) | |
373 | { | |
374 | return driver_register(&bebob_driver.driver); | |
375 | } | |
376 | ||
377 | static void __exit | |
378 | snd_bebob_exit(void) | |
379 | { | |
380 | driver_unregister(&bebob_driver.driver); | |
381 | mutex_destroy(&devices_mutex); | |
382 | } | |
383 | ||
384 | module_init(snd_bebob_init); | |
385 | module_exit(snd_bebob_exit); |