Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * The DSP56001 Device Driver, saviour of the Free World(tm) | |
3 | * | |
4 | * Authors: Fredrik Noring <noring@nocrew.org> | |
5 | * lars brinkhoff <lars@nocrew.org> | |
6 | * Tomas Berndtsson <tomas@nocrew.org> | |
7 | * | |
8 | * First version May 1996 | |
9 | * | |
10 | * History: | |
11 | * 97-01-29 Tomas Berndtsson, | |
12 | * Integrated with Linux 2.1.21 kernel sources. | |
13 | * 97-02-15 Tomas Berndtsson, | |
14 | * Fixed for kernel 2.1.26 | |
15 | * | |
16 | * BUGS: | |
17 | * Hmm... there must be something here :) | |
18 | * | |
19 | * Copyright (C) 1996,1997 Fredrik Noring, lars brinkhoff & Tomas Berndtsson | |
20 | * | |
21 | * This file is subject to the terms and conditions of the GNU General Public | |
22 | * License. See the file COPYING in the main directory of this archive | |
23 | * for more details. | |
24 | */ | |
25 | ||
26 | #include <linux/module.h> | |
27 | #include <linux/slab.h> /* for kmalloc() and kfree() */ | |
1da177e4 LT |
28 | #include <linux/major.h> |
29 | #include <linux/types.h> | |
30 | #include <linux/errno.h> | |
31 | #include <linux/delay.h> /* guess what */ | |
32 | #include <linux/fs.h> | |
33 | #include <linux/mm.h> | |
34 | #include <linux/init.h> | |
1da177e4 | 35 | #include <linux/device.h> |
7f127d5e JS |
36 | #include <linux/firmware.h> |
37 | #include <linux/platform_device.h> | |
1da177e4 LT |
38 | |
39 | #include <asm/atarihw.h> | |
40 | #include <asm/traps.h> | |
41 | #include <asm/uaccess.h> /* For put_user and get_user */ | |
42 | ||
43 | #include <asm/dsp56k.h> | |
44 | ||
45 | /* minor devices */ | |
46 | #define DSP56K_DEV_56001 0 /* The only device so far */ | |
47 | ||
48 | #define TIMEOUT 10 /* Host port timeout in number of tries */ | |
49 | #define MAXIO 2048 /* Maximum number of words before sleep */ | |
50 | #define DSP56K_MAX_BINARY_LENGTH (3*64*1024) | |
51 | ||
52 | #define DSP56K_TX_INT_ON dsp56k_host_interface.icr |= DSP56K_ICR_TREQ | |
53 | #define DSP56K_RX_INT_ON dsp56k_host_interface.icr |= DSP56K_ICR_RREQ | |
54 | #define DSP56K_TX_INT_OFF dsp56k_host_interface.icr &= ~DSP56K_ICR_TREQ | |
55 | #define DSP56K_RX_INT_OFF dsp56k_host_interface.icr &= ~DSP56K_ICR_RREQ | |
56 | ||
57 | #define DSP56K_TRANSMIT (dsp56k_host_interface.isr & DSP56K_ISR_TXDE) | |
58 | #define DSP56K_RECEIVE (dsp56k_host_interface.isr & DSP56K_ISR_RXDF) | |
59 | ||
60 | #define handshake(count, maxio, timeout, ENABLE, f) \ | |
61 | { \ | |
62 | long i, t, m; \ | |
63 | while (count > 0) { \ | |
64 | m = min_t(unsigned long, count, maxio); \ | |
65 | for (i = 0; i < m; i++) { \ | |
66 | for (t = 0; t < timeout && !ENABLE; t++) \ | |
67 | msleep(20); \ | |
68 | if(!ENABLE) \ | |
69 | return -EIO; \ | |
70 | f; \ | |
71 | } \ | |
72 | count -= m; \ | |
73 | if (m == maxio) msleep(20); \ | |
74 | } \ | |
75 | } | |
76 | ||
77 | #define tx_wait(n) \ | |
78 | { \ | |
79 | int t; \ | |
80 | for(t = 0; t < n && !DSP56K_TRANSMIT; t++) \ | |
81 | msleep(10); \ | |
82 | if(!DSP56K_TRANSMIT) { \ | |
83 | return -EIO; \ | |
84 | } \ | |
85 | } | |
86 | ||
87 | #define rx_wait(n) \ | |
88 | { \ | |
89 | int t; \ | |
90 | for(t = 0; t < n && !DSP56K_RECEIVE; t++) \ | |
91 | msleep(10); \ | |
92 | if(!DSP56K_RECEIVE) { \ | |
93 | return -EIO; \ | |
94 | } \ | |
95 | } | |
96 | ||
1da177e4 | 97 | static struct dsp56k_device { |
64b33619 | 98 | unsigned long in_use; |
1da177e4 LT |
99 | long maxio, timeout; |
100 | int tx_wsize, rx_wsize; | |
101 | } dsp56k; | |
102 | ||
ca8eca68 | 103 | static struct class *dsp56k_class; |
1da177e4 LT |
104 | |
105 | static int dsp56k_reset(void) | |
106 | { | |
107 | u_char status; | |
108 | ||
109 | /* Power down the DSP */ | |
110 | sound_ym.rd_data_reg_sel = 14; | |
111 | status = sound_ym.rd_data_reg_sel & 0xef; | |
112 | sound_ym.wd_data = status; | |
113 | sound_ym.wd_data = status | 0x10; | |
114 | ||
115 | udelay(10); | |
116 | ||
117 | /* Power up the DSP */ | |
118 | sound_ym.rd_data_reg_sel = 14; | |
119 | sound_ym.wd_data = sound_ym.rd_data_reg_sel & 0xef; | |
120 | ||
121 | return 0; | |
122 | } | |
123 | ||
d85f6891 | 124 | static int dsp56k_upload(u_char __user *bin, int len) |
1da177e4 | 125 | { |
7f127d5e JS |
126 | struct platform_device *pdev; |
127 | const struct firmware *fw; | |
128 | const char fw_name[] = "dsp56k/bootstrap.bin"; | |
129 | int err; | |
1da177e4 | 130 | int i; |
7f127d5e | 131 | |
1da177e4 | 132 | dsp56k_reset(); |
7f127d5e JS |
133 | |
134 | pdev = platform_device_register_simple("dsp56k", 0, NULL, 0); | |
135 | if (IS_ERR(pdev)) { | |
136 | printk(KERN_ERR "Failed to register device for \"%s\"\n", | |
137 | fw_name); | |
138 | return -EINVAL; | |
139 | } | |
140 | err = request_firmware(&fw, fw_name, &pdev->dev); | |
141 | platform_device_unregister(pdev); | |
142 | if (err) { | |
143 | printk(KERN_ERR "Failed to load image \"%s\" err %d\n", | |
144 | fw_name, err); | |
145 | return err; | |
146 | } | |
147 | if (fw->size % 3) { | |
148 | printk(KERN_ERR "Bogus length %d in image \"%s\"\n", | |
149 | fw->size, fw_name); | |
150 | release_firmware(fw); | |
151 | return -EINVAL; | |
152 | } | |
153 | for (i = 0; i < fw->size; i = i + 3) { | |
1da177e4 | 154 | /* tx_wait(10); */ |
7f127d5e JS |
155 | dsp56k_host_interface.data.b[1] = fw->data[i]; |
156 | dsp56k_host_interface.data.b[2] = fw->data[i + 1]; | |
157 | dsp56k_host_interface.data.b[3] = fw->data[i + 2]; | |
1da177e4 | 158 | } |
7f127d5e | 159 | release_firmware(fw); |
1da177e4 LT |
160 | for (; i < 512; i++) { |
161 | /* tx_wait(10); */ | |
162 | dsp56k_host_interface.data.b[1] = 0; | |
163 | dsp56k_host_interface.data.b[2] = 0; | |
164 | dsp56k_host_interface.data.b[3] = 0; | |
165 | } | |
166 | ||
167 | for (i = 0; i < len; i++) { | |
168 | tx_wait(10); | |
169 | get_user(dsp56k_host_interface.data.b[1], bin++); | |
170 | get_user(dsp56k_host_interface.data.b[2], bin++); | |
171 | get_user(dsp56k_host_interface.data.b[3], bin++); | |
172 | } | |
173 | ||
174 | tx_wait(10); | |
175 | dsp56k_host_interface.data.l = 3; /* Magic execute */ | |
176 | ||
177 | return 0; | |
178 | } | |
179 | ||
d85f6891 | 180 | static ssize_t dsp56k_read(struct file *file, char __user *buf, size_t count, |
1da177e4 LT |
181 | loff_t *ppos) |
182 | { | |
a7113a96 | 183 | struct inode *inode = file->f_path.dentry->d_inode; |
1da177e4 LT |
184 | int dev = iminor(inode) & 0x0f; |
185 | ||
186 | switch(dev) | |
187 | { | |
188 | case DSP56K_DEV_56001: | |
189 | { | |
190 | ||
191 | long n; | |
192 | ||
193 | /* Don't do anything if nothing is to be done */ | |
194 | if (!count) return 0; | |
195 | ||
196 | n = 0; | |
197 | switch (dsp56k.rx_wsize) { | |
198 | case 1: /* 8 bit */ | |
199 | { | |
200 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE, | |
201 | put_user(dsp56k_host_interface.data.b[3], buf+n++)); | |
202 | return n; | |
203 | } | |
204 | case 2: /* 16 bit */ | |
205 | { | |
d85f6891 | 206 | short __user *data; |
1da177e4 LT |
207 | |
208 | count /= 2; | |
d85f6891 | 209 | data = (short __user *) buf; |
1da177e4 LT |
210 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE, |
211 | put_user(dsp56k_host_interface.data.w[1], data+n++)); | |
212 | return 2*n; | |
213 | } | |
214 | case 3: /* 24 bit */ | |
215 | { | |
216 | count /= 3; | |
217 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE, | |
218 | put_user(dsp56k_host_interface.data.b[1], buf+n++); | |
219 | put_user(dsp56k_host_interface.data.b[2], buf+n++); | |
220 | put_user(dsp56k_host_interface.data.b[3], buf+n++)); | |
221 | return 3*n; | |
222 | } | |
223 | case 4: /* 32 bit */ | |
224 | { | |
d85f6891 | 225 | long __user *data; |
1da177e4 LT |
226 | |
227 | count /= 4; | |
d85f6891 | 228 | data = (long __user *) buf; |
1da177e4 LT |
229 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE, |
230 | put_user(dsp56k_host_interface.data.l, data+n++)); | |
231 | return 4*n; | |
232 | } | |
233 | } | |
234 | return -EFAULT; | |
235 | } | |
236 | ||
237 | default: | |
238 | printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev); | |
239 | return -ENXIO; | |
240 | } | |
241 | } | |
242 | ||
d85f6891 | 243 | static ssize_t dsp56k_write(struct file *file, const char __user *buf, size_t count, |
1da177e4 LT |
244 | loff_t *ppos) |
245 | { | |
a7113a96 | 246 | struct inode *inode = file->f_path.dentry->d_inode; |
1da177e4 LT |
247 | int dev = iminor(inode) & 0x0f; |
248 | ||
249 | switch(dev) | |
250 | { | |
251 | case DSP56K_DEV_56001: | |
252 | { | |
253 | long n; | |
254 | ||
255 | /* Don't do anything if nothing is to be done */ | |
256 | if (!count) return 0; | |
257 | ||
258 | n = 0; | |
259 | switch (dsp56k.tx_wsize) { | |
260 | case 1: /* 8 bit */ | |
261 | { | |
262 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT, | |
263 | get_user(dsp56k_host_interface.data.b[3], buf+n++)); | |
264 | return n; | |
265 | } | |
266 | case 2: /* 16 bit */ | |
267 | { | |
d85f6891 | 268 | const short __user *data; |
1da177e4 LT |
269 | |
270 | count /= 2; | |
d85f6891 | 271 | data = (const short __user *)buf; |
1da177e4 LT |
272 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT, |
273 | get_user(dsp56k_host_interface.data.w[1], data+n++)); | |
274 | return 2*n; | |
275 | } | |
276 | case 3: /* 24 bit */ | |
277 | { | |
278 | count /= 3; | |
279 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT, | |
280 | get_user(dsp56k_host_interface.data.b[1], buf+n++); | |
281 | get_user(dsp56k_host_interface.data.b[2], buf+n++); | |
282 | get_user(dsp56k_host_interface.data.b[3], buf+n++)); | |
283 | return 3*n; | |
284 | } | |
285 | case 4: /* 32 bit */ | |
286 | { | |
d85f6891 | 287 | const long __user *data; |
1da177e4 LT |
288 | |
289 | count /= 4; | |
d85f6891 | 290 | data = (const long __user *)buf; |
1da177e4 LT |
291 | handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT, |
292 | get_user(dsp56k_host_interface.data.l, data+n++)); | |
293 | return 4*n; | |
294 | } | |
295 | } | |
296 | ||
297 | return -EFAULT; | |
298 | } | |
299 | default: | |
300 | printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev); | |
301 | return -ENXIO; | |
302 | } | |
303 | } | |
304 | ||
305 | static int dsp56k_ioctl(struct inode *inode, struct file *file, | |
306 | unsigned int cmd, unsigned long arg) | |
307 | { | |
308 | int dev = iminor(inode) & 0x0f; | |
d85f6891 | 309 | void __user *argp = (void __user *)arg; |
1da177e4 LT |
310 | |
311 | switch(dev) | |
312 | { | |
313 | case DSP56K_DEV_56001: | |
314 | ||
315 | switch(cmd) { | |
316 | case DSP56K_UPLOAD: | |
317 | { | |
d85f6891 | 318 | char __user *bin; |
1da177e4 | 319 | int r, len; |
d85f6891 | 320 | struct dsp56k_upload __user *binary = argp; |
1da177e4 LT |
321 | |
322 | if(get_user(len, &binary->len) < 0) | |
323 | return -EFAULT; | |
324 | if(get_user(bin, &binary->bin) < 0) | |
325 | return -EFAULT; | |
326 | ||
327 | if (len == 0) { | |
328 | return -EINVAL; /* nothing to upload?!? */ | |
329 | } | |
330 | if (len > DSP56K_MAX_BINARY_LENGTH) { | |
331 | return -EINVAL; | |
332 | } | |
333 | ||
334 | r = dsp56k_upload(bin, len); | |
335 | if (r < 0) { | |
336 | return r; | |
337 | } | |
338 | ||
339 | break; | |
340 | } | |
341 | case DSP56K_SET_TX_WSIZE: | |
342 | if (arg > 4 || arg < 1) | |
343 | return -EINVAL; | |
344 | dsp56k.tx_wsize = (int) arg; | |
345 | break; | |
346 | case DSP56K_SET_RX_WSIZE: | |
347 | if (arg > 4 || arg < 1) | |
348 | return -EINVAL; | |
349 | dsp56k.rx_wsize = (int) arg; | |
350 | break; | |
351 | case DSP56K_HOST_FLAGS: | |
352 | { | |
353 | int dir, out, status; | |
d85f6891 | 354 | struct dsp56k_host_flags __user *hf = argp; |
1da177e4 LT |
355 | |
356 | if(get_user(dir, &hf->dir) < 0) | |
357 | return -EFAULT; | |
358 | if(get_user(out, &hf->out) < 0) | |
359 | return -EFAULT; | |
360 | ||
361 | if ((dir & 0x1) && (out & 0x1)) | |
362 | dsp56k_host_interface.icr |= DSP56K_ICR_HF0; | |
363 | else if (dir & 0x1) | |
364 | dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0; | |
365 | if ((dir & 0x2) && (out & 0x2)) | |
366 | dsp56k_host_interface.icr |= DSP56K_ICR_HF1; | |
367 | else if (dir & 0x2) | |
368 | dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1; | |
369 | ||
370 | status = 0; | |
371 | if (dsp56k_host_interface.icr & DSP56K_ICR_HF0) status |= 0x1; | |
372 | if (dsp56k_host_interface.icr & DSP56K_ICR_HF1) status |= 0x2; | |
373 | if (dsp56k_host_interface.isr & DSP56K_ISR_HF2) status |= 0x4; | |
374 | if (dsp56k_host_interface.isr & DSP56K_ISR_HF3) status |= 0x8; | |
375 | ||
376 | return put_user(status, &hf->status); | |
377 | } | |
378 | case DSP56K_HOST_CMD: | |
379 | if (arg > 31 || arg < 0) | |
380 | return -EINVAL; | |
381 | dsp56k_host_interface.cvr = (u_char)((arg & DSP56K_CVR_HV_MASK) | | |
382 | DSP56K_CVR_HC); | |
383 | break; | |
384 | default: | |
385 | return -EINVAL; | |
386 | } | |
387 | return 0; | |
388 | ||
389 | default: | |
390 | printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev); | |
391 | return -ENXIO; | |
392 | } | |
393 | } | |
394 | ||
395 | /* As of 2.1.26 this should be dsp56k_poll, | |
396 | * but how do I then check device minor number? | |
397 | * Do I need this function at all??? | |
398 | */ | |
399 | #if 0 | |
400 | static unsigned int dsp56k_poll(struct file *file, poll_table *wait) | |
401 | { | |
a7113a96 | 402 | int dev = iminor(file->f_path.dentry->d_inode) & 0x0f; |
1da177e4 LT |
403 | |
404 | switch(dev) | |
405 | { | |
406 | case DSP56K_DEV_56001: | |
407 | /* poll_wait(file, ???, wait); */ | |
408 | return POLLIN | POLLRDNORM | POLLOUT; | |
409 | ||
410 | default: | |
411 | printk("DSP56k driver: Unknown minor device: %d\n", dev); | |
412 | return 0; | |
413 | } | |
414 | } | |
415 | #endif | |
416 | ||
417 | static int dsp56k_open(struct inode *inode, struct file *file) | |
418 | { | |
419 | int dev = iminor(inode) & 0x0f; | |
420 | ||
421 | switch(dev) | |
422 | { | |
423 | case DSP56K_DEV_56001: | |
424 | ||
425 | if (test_and_set_bit(0, &dsp56k.in_use)) | |
426 | return -EBUSY; | |
427 | ||
428 | dsp56k.timeout = TIMEOUT; | |
429 | dsp56k.maxio = MAXIO; | |
430 | dsp56k.rx_wsize = dsp56k.tx_wsize = 4; | |
431 | ||
432 | DSP56K_TX_INT_OFF; | |
433 | DSP56K_RX_INT_OFF; | |
434 | ||
435 | /* Zero host flags */ | |
436 | dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0; | |
437 | dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1; | |
438 | ||
439 | break; | |
440 | ||
441 | default: | |
442 | return -ENODEV; | |
443 | } | |
444 | ||
445 | return 0; | |
446 | } | |
447 | ||
448 | static int dsp56k_release(struct inode *inode, struct file *file) | |
449 | { | |
450 | int dev = iminor(inode) & 0x0f; | |
451 | ||
452 | switch(dev) | |
453 | { | |
454 | case DSP56K_DEV_56001: | |
455 | clear_bit(0, &dsp56k.in_use); | |
456 | break; | |
457 | default: | |
458 | printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev); | |
459 | return -ENXIO; | |
460 | } | |
461 | ||
462 | return 0; | |
463 | } | |
464 | ||
62322d25 | 465 | static const struct file_operations dsp56k_fops = { |
1da177e4 LT |
466 | .owner = THIS_MODULE, |
467 | .read = dsp56k_read, | |
468 | .write = dsp56k_write, | |
469 | .ioctl = dsp56k_ioctl, | |
470 | .open = dsp56k_open, | |
471 | .release = dsp56k_release, | |
472 | }; | |
473 | ||
474 | ||
475 | /****** Init and module functions ******/ | |
476 | ||
477 | static char banner[] __initdata = KERN_INFO "DSP56k driver installed\n"; | |
478 | ||
479 | static int __init dsp56k_init_driver(void) | |
480 | { | |
481 | int err = 0; | |
482 | ||
483 | if(!MACH_IS_ATARI || !ATARIHW_PRESENT(DSP56K)) { | |
484 | printk("DSP56k driver: Hardware not present\n"); | |
485 | return -ENODEV; | |
486 | } | |
487 | ||
488 | if(register_chrdev(DSP56K_MAJOR, "dsp56k", &dsp56k_fops)) { | |
489 | printk("DSP56k driver: Unable to register driver\n"); | |
490 | return -ENODEV; | |
491 | } | |
ca8eca68 | 492 | dsp56k_class = class_create(THIS_MODULE, "dsp56k"); |
1da177e4 LT |
493 | if (IS_ERR(dsp56k_class)) { |
494 | err = PTR_ERR(dsp56k_class); | |
495 | goto out_chrdev; | |
496 | } | |
07c015e7 | 497 | device_create(dsp56k_class, NULL, MKDEV(DSP56K_MAJOR, 0), "dsp56k"); |
1da177e4 | 498 | |
1da177e4 LT |
499 | printk(banner); |
500 | goto out; | |
501 | ||
1da177e4 LT |
502 | out_chrdev: |
503 | unregister_chrdev(DSP56K_MAJOR, "dsp56k"); | |
504 | out: | |
505 | return err; | |
506 | } | |
507 | module_init(dsp56k_init_driver); | |
508 | ||
509 | static void __exit dsp56k_cleanup_driver(void) | |
510 | { | |
07c015e7 | 511 | device_destroy(dsp56k_class, MKDEV(DSP56K_MAJOR, 0)); |
ca8eca68 | 512 | class_destroy(dsp56k_class); |
1da177e4 | 513 | unregister_chrdev(DSP56K_MAJOR, "dsp56k"); |
1da177e4 LT |
514 | } |
515 | module_exit(dsp56k_cleanup_driver); | |
516 | ||
517 | MODULE_LICENSE("GPL"); | |
7f127d5e | 518 | MODULE_FIRMWARE("dsp56k/bootstrap.bin"); |