1 | // SPDX-License-Identifier: GPL-2.0-only |
2 | /* |
3 | * tascam.c - a part of driver for TASCAM FireWire series |
4 | * |
5 | * Copyright (c) 2015 Takashi Sakamoto |
6 | */ |
7 | |
8 | #include "tascam.h" |
9 | |
10 | MODULE_DESCRIPTION("TASCAM FireWire series Driver" ); |
11 | MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>" ); |
12 | MODULE_LICENSE("GPL" ); |
13 | |
14 | static const struct snd_tscm_spec model_specs[] = { |
15 | { |
16 | .name = "FW-1884" , |
17 | .has_adat = true, |
18 | .has_spdif = true, |
19 | .pcm_capture_analog_channels = 8, |
20 | .pcm_playback_analog_channels = 8, |
21 | .midi_capture_ports = 4, |
22 | .midi_playback_ports = 4, |
23 | }, |
24 | { |
25 | .name = "FW-1082" , |
26 | .has_adat = false, |
27 | .has_spdif = true, |
28 | .pcm_capture_analog_channels = 8, |
29 | .pcm_playback_analog_channels = 2, |
30 | .midi_capture_ports = 2, |
31 | .midi_playback_ports = 2, |
32 | }, |
33 | { |
34 | .name = "FW-1804" , |
35 | .has_adat = true, |
36 | .has_spdif = true, |
37 | .pcm_capture_analog_channels = 8, |
38 | .pcm_playback_analog_channels = 2, |
39 | .midi_capture_ports = 2, |
40 | .midi_playback_ports = 4, |
41 | }, |
42 | }; |
43 | |
44 | static int identify_model(struct snd_tscm *tscm) |
45 | { |
46 | struct fw_device *fw_dev = fw_parent_device(tscm->unit); |
47 | const u32 *config_rom = fw_dev->config_rom; |
48 | char model[9]; |
49 | unsigned int i; |
50 | u8 c; |
51 | |
52 | if (fw_dev->config_rom_length < 30) { |
53 | dev_err(&tscm->unit->device, |
54 | "Configuration ROM is too short.\n" ); |
55 | return -ENODEV; |
56 | } |
57 | |
58 | /* Pick up model name from certain addresses. */ |
59 | for (i = 0; i < 8; i++) { |
60 | c = config_rom[28 + i / 4] >> (24 - 8 * (i % 4)); |
61 | if (c == '\0') |
62 | break; |
63 | model[i] = c; |
64 | } |
65 | model[i] = '\0'; |
66 | |
67 | for (i = 0; i < ARRAY_SIZE(model_specs); i++) { |
68 | if (strcmp(model, model_specs[i].name) == 0) { |
69 | tscm->spec = &model_specs[i]; |
70 | break; |
71 | } |
72 | } |
73 | if (tscm->spec == NULL) |
74 | return -ENODEV; |
75 | |
76 | strcpy(p: tscm->card->driver, q: "FW-TASCAM" ); |
77 | strcpy(p: tscm->card->shortname, q: model); |
78 | strcpy(p: tscm->card->mixername, q: model); |
79 | snprintf(buf: tscm->card->longname, size: sizeof(tscm->card->longname), |
80 | fmt: "TASCAM %s, GUID %08x%08x at %s, S%d" , model, |
81 | fw_dev->config_rom[3], fw_dev->config_rom[4], |
82 | dev_name(dev: &tscm->unit->device), 100 << fw_dev->max_speed); |
83 | |
84 | return 0; |
85 | } |
86 | |
87 | static void tscm_card_free(struct snd_card *card) |
88 | { |
89 | struct snd_tscm *tscm = card->private_data; |
90 | |
91 | snd_tscm_transaction_unregister(tscm); |
92 | snd_tscm_stream_destroy_duplex(tscm); |
93 | |
94 | mutex_destroy(lock: &tscm->mutex); |
95 | fw_unit_put(unit: tscm->unit); |
96 | } |
97 | |
98 | static int snd_tscm_probe(struct fw_unit *unit, |
99 | const struct ieee1394_device_id *entry) |
100 | { |
101 | struct snd_card *card; |
102 | struct snd_tscm *tscm; |
103 | int err; |
104 | |
105 | err = snd_card_new(parent: &unit->device, idx: -1, NULL, THIS_MODULE, extra_size: sizeof(*tscm), card_ret: &card); |
106 | if (err < 0) |
107 | return err; |
108 | card->private_free = tscm_card_free; |
109 | |
110 | tscm = card->private_data; |
111 | tscm->unit = fw_unit_get(unit); |
112 | dev_set_drvdata(dev: &unit->device, data: tscm); |
113 | tscm->card = card; |
114 | |
115 | mutex_init(&tscm->mutex); |
116 | spin_lock_init(&tscm->lock); |
117 | init_waitqueue_head(&tscm->hwdep_wait); |
118 | |
119 | err = identify_model(tscm); |
120 | if (err < 0) |
121 | goto error; |
122 | |
123 | err = snd_tscm_transaction_register(tscm); |
124 | if (err < 0) |
125 | goto error; |
126 | |
127 | err = snd_tscm_stream_init_duplex(tscm); |
128 | if (err < 0) |
129 | goto error; |
130 | |
131 | snd_tscm_proc_init(tscm); |
132 | |
133 | err = snd_tscm_create_pcm_devices(tscm); |
134 | if (err < 0) |
135 | goto error; |
136 | |
137 | err = snd_tscm_create_midi_devices(tscm); |
138 | if (err < 0) |
139 | goto error; |
140 | |
141 | err = snd_tscm_create_hwdep_device(tscm); |
142 | if (err < 0) |
143 | goto error; |
144 | |
145 | err = snd_card_register(card); |
146 | if (err < 0) |
147 | goto error; |
148 | |
149 | return 0; |
150 | error: |
151 | snd_card_free(card); |
152 | return err; |
153 | } |
154 | |
155 | static void snd_tscm_update(struct fw_unit *unit) |
156 | { |
157 | struct snd_tscm *tscm = dev_get_drvdata(dev: &unit->device); |
158 | |
159 | snd_tscm_transaction_reregister(tscm); |
160 | |
161 | mutex_lock(&tscm->mutex); |
162 | snd_tscm_stream_update_duplex(tscm); |
163 | mutex_unlock(lock: &tscm->mutex); |
164 | } |
165 | |
166 | static void snd_tscm_remove(struct fw_unit *unit) |
167 | { |
168 | struct snd_tscm *tscm = dev_get_drvdata(dev: &unit->device); |
169 | |
170 | // Block till all of ALSA character devices are released. |
171 | snd_card_free(card: tscm->card); |
172 | } |
173 | |
174 | static const struct ieee1394_device_id snd_tscm_id_table[] = { |
175 | // Tascam, FW-1884. |
176 | { |
177 | .match_flags = IEEE1394_MATCH_VENDOR_ID | |
178 | IEEE1394_MATCH_SPECIFIER_ID | |
179 | IEEE1394_MATCH_VERSION, |
180 | .vendor_id = 0x00022e, |
181 | .specifier_id = 0x00022e, |
182 | .version = 0x800000, |
183 | }, |
184 | // Tascam, FE-8 (.version = 0x800001) |
185 | // This kernel module doesn't support FE-8 because the most of features |
186 | // can be implemented in userspace without any specific support of this |
187 | // module. |
188 | // |
189 | // .version = 0x800002 is unknown. |
190 | // |
191 | // Tascam, FW-1082. |
192 | { |
193 | .match_flags = IEEE1394_MATCH_VENDOR_ID | |
194 | IEEE1394_MATCH_SPECIFIER_ID | |
195 | IEEE1394_MATCH_VERSION, |
196 | .vendor_id = 0x00022e, |
197 | .specifier_id = 0x00022e, |
198 | .version = 0x800003, |
199 | }, |
200 | // Tascam, FW-1804. |
201 | { |
202 | .match_flags = IEEE1394_MATCH_VENDOR_ID | |
203 | IEEE1394_MATCH_SPECIFIER_ID | |
204 | IEEE1394_MATCH_VERSION, |
205 | .vendor_id = 0x00022e, |
206 | .specifier_id = 0x00022e, |
207 | .version = 0x800004, |
208 | }, |
209 | {} |
210 | }; |
211 | MODULE_DEVICE_TABLE(ieee1394, snd_tscm_id_table); |
212 | |
213 | static struct fw_driver tscm_driver = { |
214 | .driver = { |
215 | .owner = THIS_MODULE, |
216 | .name = KBUILD_MODNAME, |
217 | .bus = &fw_bus_type, |
218 | }, |
219 | .probe = snd_tscm_probe, |
220 | .update = snd_tscm_update, |
221 | .remove = snd_tscm_remove, |
222 | .id_table = snd_tscm_id_table, |
223 | }; |
224 | |
225 | static int __init snd_tscm_init(void) |
226 | { |
227 | return driver_register(drv: &tscm_driver.driver); |
228 | } |
229 | |
230 | static void __exit snd_tscm_exit(void) |
231 | { |
232 | driver_unregister(drv: &tscm_driver.driver); |
233 | } |
234 | |
235 | module_init(snd_tscm_init); |
236 | module_exit(snd_tscm_exit); |
237 | |