blob: 8a1b28a10ef0af184e4ff4e03e9eaaf4783f97ca [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/major.h>
28#include <linux/types.h>
29#include <linux/errno.h>
30#include <linux/delay.h> /* guess what */
31#include <linux/fs.h>
32#include <linux/mm.h>
33#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/device.h>
Jonathan Corbet65f37b72008-05-16 13:57:31 -060035#include <linux/smp_lock.h>
Jaswinder Singh7f127d52008-07-05 15:28:30 +053036#include <linux/firmware.h>
37#include <linux/platform_device.h>
Alan Cox236b8752008-07-25 01:48:17 -070038#include <linux/uaccess.h> /* For put_user and get_user */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#include <asm/atarihw.h>
41#include <asm/traps.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070097static struct dsp56k_device {
Al Viro64b33612007-10-14 19:35:20 +010098 unsigned long in_use;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 long maxio, timeout;
100 int tx_wsize, rx_wsize;
101} dsp56k;
102
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800103static struct class *dsp56k_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105static 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
Al Virod85f6892006-01-12 01:06:31 -0800124static int dsp56k_upload(u_char __user *bin, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
Jaswinder Singh7f127d52008-07-05 15:28:30 +0530126 struct platform_device *pdev;
127 const struct firmware *fw;
128 const char fw_name[] = "dsp56k/bootstrap.bin";
129 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 int i;
Jaswinder Singh7f127d52008-07-05 15:28:30 +0530131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 dsp56k_reset();
Jaswinder Singh7f127d52008-07-05 15:28:30 +0530133
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 }
Jaswinder Singh7f127d52008-07-05 15:28:30 +0530140 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) {
154 /* tx_wait(10); */
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];
158 }
159 release_firmware(fw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 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
Al Virod85f6892006-01-12 01:06:31 -0800180static ssize_t dsp56k_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 loff_t *ppos)
182{
Josef Sipeka7113a92006-12-08 02:36:55 -0800183 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 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 {
Al Virod85f6892006-01-12 01:06:31 -0800206 short __user *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208 count /= 2;
Al Virod85f6892006-01-12 01:06:31 -0800209 data = (short __user *) buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 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 {
Al Virod85f6892006-01-12 01:06:31 -0800225 long __user *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227 count /= 4;
Al Virod85f6892006-01-12 01:06:31 -0800228 data = (long __user *) buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 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
Al Virod85f6892006-01-12 01:06:31 -0800243static ssize_t dsp56k_write(struct file *file, const char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 loff_t *ppos)
245{
Josef Sipeka7113a92006-12-08 02:36:55 -0800246 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 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 {
Al Virod85f6892006-01-12 01:06:31 -0800268 const short __user *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270 count /= 2;
Al Virod85f6892006-01-12 01:06:31 -0800271 data = (const short __user *)buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 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 {
Al Virod85f6892006-01-12 01:06:31 -0800287 const long __user *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 count /= 4;
Al Virod85f6892006-01-12 01:06:31 -0800290 data = (const long __user *)buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 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
Alan Cox236b8752008-07-25 01:48:17 -0700305static long dsp56k_ioctl(struct file *file, unsigned int cmd,
Geert Uytterhoeven689796a2008-07-26 17:15:05 +0200306 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307{
Geert Uytterhoeven689796a2008-07-26 17:15:05 +0200308 int dev = iminor(file->f_path.dentry->d_inode) & 0x0f;
Al Virod85f6892006-01-12 01:06:31 -0800309 void __user *argp = (void __user *)arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 switch(dev)
312 {
313 case DSP56K_DEV_56001:
314
315 switch(cmd) {
316 case DSP56K_UPLOAD:
317 {
Al Virod85f6892006-01-12 01:06:31 -0800318 char __user *bin;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 int r, len;
Al Virod85f6892006-01-12 01:06:31 -0800320 struct dsp56k_upload __user *binary = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
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 }
Alan Cox236b8752008-07-25 01:48:17 -0700333 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 r = dsp56k_upload(bin, len);
Alan Cox236b8752008-07-25 01:48:17 -0700335 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 if (r < 0) {
337 return r;
338 }
339
340 break;
341 }
342 case DSP56K_SET_TX_WSIZE:
343 if (arg > 4 || arg < 1)
344 return -EINVAL;
Alan Cox236b8752008-07-25 01:48:17 -0700345 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 dsp56k.tx_wsize = (int) arg;
Alan Cox236b8752008-07-25 01:48:17 -0700347 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 break;
349 case DSP56K_SET_RX_WSIZE:
350 if (arg > 4 || arg < 1)
351 return -EINVAL;
Alan Cox236b8752008-07-25 01:48:17 -0700352 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 dsp56k.rx_wsize = (int) arg;
Alan Cox236b8752008-07-25 01:48:17 -0700354 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 break;
356 case DSP56K_HOST_FLAGS:
357 {
358 int dir, out, status;
Al Virod85f6892006-01-12 01:06:31 -0800359 struct dsp56k_host_flags __user *hf = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
361 if(get_user(dir, &hf->dir) < 0)
362 return -EFAULT;
363 if(get_user(out, &hf->out) < 0)
364 return -EFAULT;
365
Alan Cox236b8752008-07-25 01:48:17 -0700366 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 if ((dir & 0x1) && (out & 0x1))
368 dsp56k_host_interface.icr |= DSP56K_ICR_HF0;
369 else if (dir & 0x1)
370 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0;
371 if ((dir & 0x2) && (out & 0x2))
372 dsp56k_host_interface.icr |= DSP56K_ICR_HF1;
373 else if (dir & 0x2)
374 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1;
375
376 status = 0;
377 if (dsp56k_host_interface.icr & DSP56K_ICR_HF0) status |= 0x1;
378 if (dsp56k_host_interface.icr & DSP56K_ICR_HF1) status |= 0x2;
379 if (dsp56k_host_interface.isr & DSP56K_ISR_HF2) status |= 0x4;
380 if (dsp56k_host_interface.isr & DSP56K_ISR_HF3) status |= 0x8;
Alan Cox236b8752008-07-25 01:48:17 -0700381 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 return put_user(status, &hf->status);
383 }
384 case DSP56K_HOST_CMD:
385 if (arg > 31 || arg < 0)
386 return -EINVAL;
Alan Cox236b8752008-07-25 01:48:17 -0700387 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 dsp56k_host_interface.cvr = (u_char)((arg & DSP56K_CVR_HV_MASK) |
389 DSP56K_CVR_HC);
Alan Cox236b8752008-07-25 01:48:17 -0700390 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 break;
392 default:
393 return -EINVAL;
394 }
395 return 0;
396
397 default:
398 printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
399 return -ENXIO;
400 }
401}
402
403/* As of 2.1.26 this should be dsp56k_poll,
404 * but how do I then check device minor number?
405 * Do I need this function at all???
406 */
407#if 0
408static unsigned int dsp56k_poll(struct file *file, poll_table *wait)
409{
Josef Sipeka7113a92006-12-08 02:36:55 -0800410 int dev = iminor(file->f_path.dentry->d_inode) & 0x0f;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412 switch(dev)
413 {
414 case DSP56K_DEV_56001:
415 /* poll_wait(file, ???, wait); */
416 return POLLIN | POLLRDNORM | POLLOUT;
417
418 default:
419 printk("DSP56k driver: Unknown minor device: %d\n", dev);
420 return 0;
421 }
422}
423#endif
424
425static int dsp56k_open(struct inode *inode, struct file *file)
426{
427 int dev = iminor(inode) & 0x0f;
Jonathan Corbet65f37b72008-05-16 13:57:31 -0600428 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Jonathan Corbet65f37b72008-05-16 13:57:31 -0600430 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 switch(dev)
432 {
433 case DSP56K_DEV_56001:
434
Jonathan Corbet65f37b72008-05-16 13:57:31 -0600435 if (test_and_set_bit(0, &dsp56k.in_use)) {
436 ret = -EBUSY;
437 goto out;
438 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
440 dsp56k.timeout = TIMEOUT;
441 dsp56k.maxio = MAXIO;
442 dsp56k.rx_wsize = dsp56k.tx_wsize = 4;
443
444 DSP56K_TX_INT_OFF;
445 DSP56K_RX_INT_OFF;
446
447 /* Zero host flags */
448 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0;
449 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1;
450
451 break;
452
453 default:
Jonathan Corbet65f37b72008-05-16 13:57:31 -0600454 ret = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 }
Jonathan Corbet65f37b72008-05-16 13:57:31 -0600456out:
457 unlock_kernel();
458 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459}
460
461static int dsp56k_release(struct inode *inode, struct file *file)
462{
463 int dev = iminor(inode) & 0x0f;
464
465 switch(dev)
466 {
467 case DSP56K_DEV_56001:
468 clear_bit(0, &dsp56k.in_use);
469 break;
470 default:
471 printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
472 return -ENXIO;
473 }
474
475 return 0;
476}
477
Arjan van de Ven62322d22006-07-03 00:24:21 -0700478static const struct file_operations dsp56k_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 .owner = THIS_MODULE,
480 .read = dsp56k_read,
481 .write = dsp56k_write,
Alan Cox236b8752008-07-25 01:48:17 -0700482 .unlocked_ioctl = dsp56k_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 .open = dsp56k_open,
484 .release = dsp56k_release,
485};
486
487
488/****** Init and module functions ******/
489
490static char banner[] __initdata = KERN_INFO "DSP56k driver installed\n";
491
492static int __init dsp56k_init_driver(void)
493{
494 int err = 0;
495
496 if(!MACH_IS_ATARI || !ATARIHW_PRESENT(DSP56K)) {
497 printk("DSP56k driver: Hardware not present\n");
498 return -ENODEV;
499 }
500
501 if(register_chrdev(DSP56K_MAJOR, "dsp56k", &dsp56k_fops)) {
502 printk("DSP56k driver: Unable to register driver\n");
503 return -ENODEV;
504 }
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800505 dsp56k_class = class_create(THIS_MODULE, "dsp56k");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 if (IS_ERR(dsp56k_class)) {
507 err = PTR_ERR(dsp56k_class);
508 goto out_chrdev;
509 }
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -0700510 device_create(dsp56k_class, NULL, MKDEV(DSP56K_MAJOR, 0), NULL,
511 "dsp56k");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 printk(banner);
514 goto out;
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516out_chrdev:
517 unregister_chrdev(DSP56K_MAJOR, "dsp56k");
518out:
519 return err;
520}
521module_init(dsp56k_init_driver);
522
523static void __exit dsp56k_cleanup_driver(void)
524{
tonyj@suse.de07c015e2007-08-07 22:28:44 -0700525 device_destroy(dsp56k_class, MKDEV(DSP56K_MAJOR, 0));
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800526 class_destroy(dsp56k_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 unregister_chrdev(DSP56K_MAJOR, "dsp56k");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528}
529module_exit(dsp56k_cleanup_driver);
530
531MODULE_LICENSE("GPL");
Jaswinder Singh7f127d52008-07-05 15:28:30 +0530532MODULE_FIRMWARE("dsp56k/bootstrap.bin");