2 * The DSP56001 Device Driver, saviour of the Free World(tm)
4 * Authors: Fredrik Noring <noring@nocrew.org>
5 * lars brinkhoff <lars@nocrew.org>
6 * Tomas Berndtsson <tomas@nocrew.org>
8 * First version May 1996
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
17 * Hmm... there must be something here :)
19 * Copyright (C) 1996,1997 Fredrik Noring, lars brinkhoff & Tomas Berndtsson
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
26 #include <linux/module.h>
27 #include <linux/slab.h> /* for kmalloc() and kfree() */
28 #include <linux/major.h>
29 #include <linux/types.h>
30 #include <linux/errno.h>
31 #include <linux/delay.h> /* guess what */
34 #include <linux/init.h>
35 #include <linux/device.h>
36 #include <linux/firmware.h>
37 #include <linux/platform_device.h>
39 #include <asm/atarihw.h>
40 #include <asm/traps.h>
41 #include <asm/uaccess.h> /* For put_user and get_user */
43 #include <asm/dsp56k.h>
46 #define DSP56K_DEV_56001 0 /* The only device so far */
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)
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
57 #define DSP56K_TRANSMIT (dsp56k_host_interface.isr & DSP56K_ISR_TXDE)
58 #define DSP56K_RECEIVE (dsp56k_host_interface.isr & DSP56K_ISR_RXDF)
60 #define handshake(count, maxio, timeout, ENABLE, f) \
64 m = min_t(unsigned long, count, maxio); \
65 for (i = 0; i < m; i++) { \
66 for (t = 0; t < timeout && !ENABLE; t++) \
73 if (m == maxio) msleep(20); \
80 for(t = 0; t < n && !DSP56K_TRANSMIT; t++) \
82 if(!DSP56K_TRANSMIT) { \
90 for(t = 0; t < n && !DSP56K_RECEIVE; t++) \
92 if(!DSP56K_RECEIVE) { \
97 static struct dsp56k_device {
100 int tx_wsize, rx_wsize;
103 static struct class *dsp56k_class;
105 static int dsp56k_reset(void)
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;
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;
124 static int dsp56k_upload(u_char __user *bin, int len)
126 struct platform_device *pdev;
127 const struct firmware *fw;
128 const char fw_name[] = "dsp56k/bootstrap.bin";
134 pdev = platform_device_register_simple("dsp56k", 0, NULL, 0);
136 printk(KERN_ERR "Failed to register device for \"%s\"\n",
140 err = request_firmware(&fw, fw_name, &pdev->dev);
141 platform_device_unregister(pdev);
143 printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
148 printk(KERN_ERR "Bogus length %d in image \"%s\"\n",
150 release_firmware(fw);
153 for (i = 0; i < fw->size; i = i + 3) {
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];
159 release_firmware(fw);
160 for (; i < 512; i++) {
162 dsp56k_host_interface.data.b[1] = 0;
163 dsp56k_host_interface.data.b[2] = 0;
164 dsp56k_host_interface.data.b[3] = 0;
167 for (i = 0; i < len; i++) {
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++);
175 dsp56k_host_interface.data.l = 3; /* Magic execute */
180 static ssize_t dsp56k_read(struct file *file, char __user *buf, size_t count,
183 struct inode *inode = file->f_path.dentry->d_inode;
184 int dev = iminor(inode) & 0x0f;
188 case DSP56K_DEV_56001:
193 /* Don't do anything if nothing is to be done */
194 if (!count) return 0;
197 switch (dsp56k.rx_wsize) {
200 handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
201 put_user(dsp56k_host_interface.data.b[3], buf+n++));
209 data = (short __user *) buf;
210 handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
211 put_user(dsp56k_host_interface.data.w[1], data+n++));
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++));
228 data = (long __user *) buf;
229 handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
230 put_user(dsp56k_host_interface.data.l, data+n++));
238 printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
243 static ssize_t dsp56k_write(struct file *file, const char __user *buf, size_t count,
246 struct inode *inode = file->f_path.dentry->d_inode;
247 int dev = iminor(inode) & 0x0f;
251 case DSP56K_DEV_56001:
255 /* Don't do anything if nothing is to be done */
256 if (!count) return 0;
259 switch (dsp56k.tx_wsize) {
262 handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
263 get_user(dsp56k_host_interface.data.b[3], buf+n++));
268 const short __user *data;
271 data = (const short __user *)buf;
272 handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
273 get_user(dsp56k_host_interface.data.w[1], data+n++));
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++));
287 const long __user *data;
290 data = (const long __user *)buf;
291 handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
292 get_user(dsp56k_host_interface.data.l, data+n++));
300 printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
305 static int dsp56k_ioctl(struct inode *inode, struct file *file,
306 unsigned int cmd, unsigned long arg)
308 int dev = iminor(inode) & 0x0f;
309 void __user *argp = (void __user *)arg;
313 case DSP56K_DEV_56001:
320 struct dsp56k_upload __user *binary = argp;
322 if(get_user(len, &binary->len) < 0)
324 if(get_user(bin, &binary->bin) < 0)
328 return -EINVAL; /* nothing to upload?!? */
330 if (len > DSP56K_MAX_BINARY_LENGTH) {
334 r = dsp56k_upload(bin, len);
341 case DSP56K_SET_TX_WSIZE:
342 if (arg > 4 || arg < 1)
344 dsp56k.tx_wsize = (int) arg;
346 case DSP56K_SET_RX_WSIZE:
347 if (arg > 4 || arg < 1)
349 dsp56k.rx_wsize = (int) arg;
351 case DSP56K_HOST_FLAGS:
353 int dir, out, status;
354 struct dsp56k_host_flags __user *hf = argp;
356 if(get_user(dir, &hf->dir) < 0)
358 if(get_user(out, &hf->out) < 0)
361 if ((dir & 0x1) && (out & 0x1))
362 dsp56k_host_interface.icr |= DSP56K_ICR_HF0;
364 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0;
365 if ((dir & 0x2) && (out & 0x2))
366 dsp56k_host_interface.icr |= DSP56K_ICR_HF1;
368 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1;
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;
376 return put_user(status, &hf->status);
378 case DSP56K_HOST_CMD:
379 if (arg > 31 || arg < 0)
381 dsp56k_host_interface.cvr = (u_char)((arg & DSP56K_CVR_HV_MASK) |
390 printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
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???
400 static unsigned int dsp56k_poll(struct file *file, poll_table *wait)
402 int dev = iminor(file->f_path.dentry->d_inode) & 0x0f;
406 case DSP56K_DEV_56001:
407 /* poll_wait(file, ???, wait); */
408 return POLLIN | POLLRDNORM | POLLOUT;
411 printk("DSP56k driver: Unknown minor device: %d\n", dev);
417 static int dsp56k_open(struct inode *inode, struct file *file)
419 int dev = iminor(inode) & 0x0f;
423 case DSP56K_DEV_56001:
425 if (test_and_set_bit(0, &dsp56k.in_use))
428 dsp56k.timeout = TIMEOUT;
429 dsp56k.maxio = MAXIO;
430 dsp56k.rx_wsize = dsp56k.tx_wsize = 4;
435 /* Zero host flags */
436 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0;
437 dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1;
448 static int dsp56k_release(struct inode *inode, struct file *file)
450 int dev = iminor(inode) & 0x0f;
454 case DSP56K_DEV_56001:
455 clear_bit(0, &dsp56k.in_use);
458 printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
465 static const struct file_operations dsp56k_fops = {
466 .owner = THIS_MODULE,
468 .write = dsp56k_write,
469 .ioctl = dsp56k_ioctl,
471 .release = dsp56k_release,
475 /****** Init and module functions ******/
477 static char banner[] __initdata = KERN_INFO "DSP56k driver installed\n";
479 static int __init dsp56k_init_driver(void)
483 if(!MACH_IS_ATARI || !ATARIHW_PRESENT(DSP56K)) {
484 printk("DSP56k driver: Hardware not present\n");
488 if(register_chrdev(DSP56K_MAJOR, "dsp56k", &dsp56k_fops)) {
489 printk("DSP56k driver: Unable to register driver\n");
492 dsp56k_class = class_create(THIS_MODULE, "dsp56k");
493 if (IS_ERR(dsp56k_class)) {
494 err = PTR_ERR(dsp56k_class);
497 device_create(dsp56k_class, NULL, MKDEV(DSP56K_MAJOR, 0), "dsp56k");
503 unregister_chrdev(DSP56K_MAJOR, "dsp56k");
507 module_init(dsp56k_init_driver);
509 static void __exit dsp56k_cleanup_driver(void)
511 device_destroy(dsp56k_class, MKDEV(DSP56K_MAJOR, 0));
512 class_destroy(dsp56k_class);
513 unregister_chrdev(DSP56K_MAJOR, "dsp56k");
515 module_exit(dsp56k_cleanup_driver);
517 MODULE_LICENSE("GPL");
518 MODULE_FIRMWARE("dsp56k/bootstrap.bin");