dsp56k.c 12.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/*
 * The DSP56001 Device Driver, saviour of the Free World(tm)
 *
 * Authors: Fredrik Noring   <noring@nocrew.org>
 *          lars brinkhoff   <lars@nocrew.org>
 *          Tomas Berndtsson <tomas@nocrew.org>
 *
 * First version May 1996
 *
 * History:
 *  97-01-29   Tomas Berndtsson,
 *               Integrated with Linux 2.1.21 kernel sources.
 *  97-02-15   Tomas Berndtsson,
 *               Fixed for kernel 2.1.26
 *
 * BUGS:
 *  Hmm... there must be something here :)
 *
 * Copyright (C) 1996,1997 Fredrik Noring, lars brinkhoff & Tomas Berndtsson
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file COPYING in the main directory of this archive
 * for more details.
 */

#include <linux/module.h>
#include <linux/major.h>
#include <linux/types.h>
#include <linux/errno.h>
#include <linux/delay.h>	/* guess what */
#include <linux/fs.h>
#include <linux/mm.h>
#include <linux/init.h>
#include <linux/device.h>
35
#include <linux/mutex.h>
36 37
#include <linux/firmware.h>
#include <linux/platform_device.h>
Alan Cox's avatar
Alan Cox committed
38
#include <linux/uaccess.h>	/* For put_user and get_user */
Linus Torvalds's avatar
Linus Torvalds committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

#include <asm/atarihw.h>
#include <asm/traps.h>

#include <asm/dsp56k.h>

/* minor devices */
#define DSP56K_DEV_56001        0    /* The only device so far */

#define TIMEOUT    10   /* Host port timeout in number of tries */
#define MAXIO    2048   /* Maximum number of words before sleep */
#define DSP56K_MAX_BINARY_LENGTH (3*64*1024)

#define DSP56K_TX_INT_ON	dsp56k_host_interface.icr |=  DSP56K_ICR_TREQ
#define DSP56K_RX_INT_ON	dsp56k_host_interface.icr |=  DSP56K_ICR_RREQ
#define DSP56K_TX_INT_OFF	dsp56k_host_interface.icr &= ~DSP56K_ICR_TREQ
#define DSP56K_RX_INT_OFF	dsp56k_host_interface.icr &= ~DSP56K_ICR_RREQ

#define DSP56K_TRANSMIT		(dsp56k_host_interface.isr & DSP56K_ISR_TXDE)
#define DSP56K_RECEIVE		(dsp56k_host_interface.isr & DSP56K_ISR_RXDF)

#define handshake(count, maxio, timeout, ENABLE, f) \
{ \
	long i, t, m; \
	while (count > 0) { \
		m = min_t(unsigned long, count, maxio); \
		for (i = 0; i < m; i++) { \
			for (t = 0; t < timeout && !ENABLE; t++) \
				msleep(20); \
			if(!ENABLE) \
				return -EIO; \
			f; \
		} \
		count -= m; \
		if (m == maxio) msleep(20); \
	} \
}

#define tx_wait(n) \
{ \
	int t; \
	for(t = 0; t < n && !DSP56K_TRANSMIT; t++) \
		msleep(10); \
	if(!DSP56K_TRANSMIT) { \
		return -EIO; \
	} \
}

#define rx_wait(n) \
{ \
	int t; \
	for(t = 0; t < n && !DSP56K_RECEIVE; t++) \
		msleep(10); \
	if(!DSP56K_RECEIVE) { \
		return -EIO; \
	} \
}

97
static DEFINE_MUTEX(dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
98
static struct dsp56k_device {
99
	unsigned long in_use;
Linus Torvalds's avatar
Linus Torvalds committed
100 101 102 103
	long maxio, timeout;
	int tx_wsize, rx_wsize;
} dsp56k;

104
static struct class *dsp56k_class;
Linus Torvalds's avatar
Linus Torvalds committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

static int dsp56k_reset(void)
{
	u_char status;
	
	/* Power down the DSP */
	sound_ym.rd_data_reg_sel = 14;
	status = sound_ym.rd_data_reg_sel & 0xef;
	sound_ym.wd_data = status;
	sound_ym.wd_data = status | 0x10;
  
	udelay(10);
  
	/* Power up the DSP */
	sound_ym.rd_data_reg_sel = 14;
	sound_ym.wd_data = sound_ym.rd_data_reg_sel & 0xef;

	return 0;
}

125
static int dsp56k_upload(u_char __user *bin, int len)
Linus Torvalds's avatar
Linus Torvalds committed
126
{
127 128 129 130
	struct platform_device *pdev;
	const struct firmware *fw;
	const char fw_name[] = "dsp56k/bootstrap.bin";
	int err;
Linus Torvalds's avatar
Linus Torvalds committed
131
	int i;
132

Linus Torvalds's avatar
Linus Torvalds committed
133
	dsp56k_reset();
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

	pdev = platform_device_register_simple("dsp56k", 0, NULL, 0);
	if (IS_ERR(pdev)) {
		printk(KERN_ERR "Failed to register device for \"%s\"\n",
		       fw_name);
		return -EINVAL;
	}
	err = request_firmware(&fw, fw_name, &pdev->dev);
	platform_device_unregister(pdev);
	if (err) {
		printk(KERN_ERR "Failed to load image \"%s\" err %d\n",
		       fw_name, err);
		return err;
	}
	if (fw->size % 3) {
		printk(KERN_ERR "Bogus length %d in image \"%s\"\n",
		       fw->size, fw_name);
		release_firmware(fw);
		return -EINVAL;
	}
	for (i = 0; i < fw->size; i = i + 3) {
Linus Torvalds's avatar
Linus Torvalds committed
155
		/* tx_wait(10); */
156 157 158
		dsp56k_host_interface.data.b[1] = fw->data[i];
		dsp56k_host_interface.data.b[2] = fw->data[i + 1];
		dsp56k_host_interface.data.b[3] = fw->data[i + 2];
Linus Torvalds's avatar
Linus Torvalds committed
159
	}
160
	release_firmware(fw);
Linus Torvalds's avatar
Linus Torvalds committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
	for (; i < 512; i++) {
		/* tx_wait(10); */
		dsp56k_host_interface.data.b[1] = 0;
		dsp56k_host_interface.data.b[2] = 0;
		dsp56k_host_interface.data.b[3] = 0;
	}
  
	for (i = 0; i < len; i++) {
		tx_wait(10);
		get_user(dsp56k_host_interface.data.b[1], bin++);
		get_user(dsp56k_host_interface.data.b[2], bin++);
		get_user(dsp56k_host_interface.data.b[3], bin++);
	}

	tx_wait(10);
	dsp56k_host_interface.data.l = 3;    /* Magic execute */

	return 0;
}

181
static ssize_t dsp56k_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds's avatar
Linus Torvalds committed
182 183
			   loff_t *ppos)
{
Al Viro's avatar
Al Viro committed
184
	struct inode *inode = file_inode(file);
Linus Torvalds's avatar
Linus Torvalds committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
	int dev = iminor(inode) & 0x0f;

	switch(dev)
	{
	case DSP56K_DEV_56001:
	{

		long n;

		/* Don't do anything if nothing is to be done */
		if (!count) return 0;

		n = 0;
		switch (dsp56k.rx_wsize) {
		case 1:  /* 8 bit */
		{
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
				  put_user(dsp56k_host_interface.data.b[3], buf+n++));
			return n;
		}
		case 2:  /* 16 bit */
		{
207
			short __user *data;
Linus Torvalds's avatar
Linus Torvalds committed
208 209

			count /= 2;
210
			data = (short __user *) buf;
Linus Torvalds's avatar
Linus Torvalds committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
				  put_user(dsp56k_host_interface.data.w[1], data+n++));
			return 2*n;
		}
		case 3:  /* 24 bit */
		{
			count /= 3;
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
				  put_user(dsp56k_host_interface.data.b[1], buf+n++);
				  put_user(dsp56k_host_interface.data.b[2], buf+n++);
				  put_user(dsp56k_host_interface.data.b[3], buf+n++));
			return 3*n;
		}
		case 4:  /* 32 bit */
		{
226
			long __user *data;
Linus Torvalds's avatar
Linus Torvalds committed
227 228

			count /= 4;
229
			data = (long __user *) buf;
Linus Torvalds's avatar
Linus Torvalds committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_RECEIVE,
				  put_user(dsp56k_host_interface.data.l, data+n++));
			return 4*n;
		}
		}
		return -EFAULT;
	}

	default:
		printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
		return -ENXIO;
	}
}

244
static ssize_t dsp56k_write(struct file *file, const char __user *buf, size_t count,
Linus Torvalds's avatar
Linus Torvalds committed
245 246
			    loff_t *ppos)
{
Al Viro's avatar
Al Viro committed
247
	struct inode *inode = file_inode(file);
Linus Torvalds's avatar
Linus Torvalds committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
	int dev = iminor(inode) & 0x0f;

	switch(dev)
	{
	case DSP56K_DEV_56001:
	{
		long n;

		/* Don't do anything if nothing is to be done */
		if (!count) return 0;

		n = 0;
		switch (dsp56k.tx_wsize) {
		case 1:  /* 8 bit */
		{
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
				  get_user(dsp56k_host_interface.data.b[3], buf+n++));
			return n;
		}
		case 2:  /* 16 bit */
		{
269
			const short __user *data;
Linus Torvalds's avatar
Linus Torvalds committed
270 271

			count /= 2;
272
			data = (const short __user *)buf;
Linus Torvalds's avatar
Linus Torvalds committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
				  get_user(dsp56k_host_interface.data.w[1], data+n++));
			return 2*n;
		}
		case 3:  /* 24 bit */
		{
			count /= 3;
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
				  get_user(dsp56k_host_interface.data.b[1], buf+n++);
				  get_user(dsp56k_host_interface.data.b[2], buf+n++);
				  get_user(dsp56k_host_interface.data.b[3], buf+n++));
			return 3*n;
		}
		case 4:  /* 32 bit */
		{
288
			const long __user *data;
Linus Torvalds's avatar
Linus Torvalds committed
289 290

			count /= 4;
291
			data = (const long __user *)buf;
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305
			handshake(count, dsp56k.maxio, dsp56k.timeout, DSP56K_TRANSMIT,
				  get_user(dsp56k_host_interface.data.l, data+n++));
			return 4*n;
		}
		}

		return -EFAULT;
	}
	default:
		printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
		return -ENXIO;
	}
}

Alan Cox's avatar
Alan Cox committed
306
static long dsp56k_ioctl(struct file *file, unsigned int cmd,
307
			 unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
308
{
Al Viro's avatar
Al Viro committed
309
	int dev = iminor(file_inode(file)) & 0x0f;
310
	void __user *argp = (void __user *)arg;
Linus Torvalds's avatar
Linus Torvalds committed
311 312 313 314 315 316 317 318

	switch(dev)
	{
	case DSP56K_DEV_56001:

		switch(cmd) {
		case DSP56K_UPLOAD:
		{
319
			char __user *bin;
Linus Torvalds's avatar
Linus Torvalds committed
320
			int r, len;
321
			struct dsp56k_upload __user *binary = argp;
Linus Torvalds's avatar
Linus Torvalds committed
322 323 324 325 326 327
    
			if(get_user(len, &binary->len) < 0)
				return -EFAULT;
			if(get_user(bin, &binary->bin) < 0)
				return -EFAULT;
		
328
			if (len <= 0) {
Linus Torvalds's avatar
Linus Torvalds committed
329 330 331 332 333
				return -EINVAL;      /* nothing to upload?!? */
			}
			if (len > DSP56K_MAX_BINARY_LENGTH) {
				return -EINVAL;
			}
334
			mutex_lock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
335
			r = dsp56k_upload(bin, len);
336
			mutex_unlock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
337 338 339 340 341 342 343 344 345
			if (r < 0) {
				return r;
			}
    
			break;
		}
		case DSP56K_SET_TX_WSIZE:
			if (arg > 4 || arg < 1)
				return -EINVAL;
346
			mutex_lock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
347
			dsp56k.tx_wsize = (int) arg;
348
			mutex_unlock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
349 350 351 352
			break;
		case DSP56K_SET_RX_WSIZE:
			if (arg > 4 || arg < 1)
				return -EINVAL;
353
			mutex_lock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
354
			dsp56k.rx_wsize = (int) arg;
355
			mutex_unlock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
356 357 358 359
			break;
		case DSP56K_HOST_FLAGS:
		{
			int dir, out, status;
360
			struct dsp56k_host_flags __user *hf = argp;
Linus Torvalds's avatar
Linus Torvalds committed
361 362 363 364 365 366
    
			if(get_user(dir, &hf->dir) < 0)
				return -EFAULT;
			if(get_user(out, &hf->out) < 0)
				return -EFAULT;

367
			mutex_lock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381
			if ((dir & 0x1) && (out & 0x1))
				dsp56k_host_interface.icr |= DSP56K_ICR_HF0;
			else if (dir & 0x1)
				dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0;
			if ((dir & 0x2) && (out & 0x2))
				dsp56k_host_interface.icr |= DSP56K_ICR_HF1;
			else if (dir & 0x2)
				dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1;

			status = 0;
			if (dsp56k_host_interface.icr & DSP56K_ICR_HF0) status |= 0x1;
			if (dsp56k_host_interface.icr & DSP56K_ICR_HF1) status |= 0x2;
			if (dsp56k_host_interface.isr & DSP56K_ISR_HF2) status |= 0x4;
			if (dsp56k_host_interface.isr & DSP56K_ISR_HF3) status |= 0x8;
382
			mutex_unlock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
383 384 385
			return put_user(status, &hf->status);
		}
		case DSP56K_HOST_CMD:
386
			if (arg > 31)
Linus Torvalds's avatar
Linus Torvalds committed
387
				return -EINVAL;
388
			mutex_lock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
389 390
			dsp56k_host_interface.cvr = (u_char)((arg & DSP56K_CVR_HV_MASK) |
							     DSP56K_CVR_HC);
391
			mutex_unlock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
			break;
		default:
			return -EINVAL;
		}
		return 0;

	default:
		printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
		return -ENXIO;
	}
}

/* As of 2.1.26 this should be dsp56k_poll,
 * but how do I then check device minor number?
 * Do I need this function at all???
 */
#if 0
static unsigned int dsp56k_poll(struct file *file, poll_table *wait)
{
Al Viro's avatar
Al Viro committed
411
	int dev = iminor(file_inode(file)) & 0x0f;
Linus Torvalds's avatar
Linus Torvalds committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428

	switch(dev)
	{
	case DSP56K_DEV_56001:
		/* poll_wait(file, ???, wait); */
		return POLLIN | POLLRDNORM | POLLOUT;

	default:
		printk("DSP56k driver: Unknown minor device: %d\n", dev);
		return 0;
	}
}
#endif

static int dsp56k_open(struct inode *inode, struct file *file)
{
	int dev = iminor(inode) & 0x0f;
Jonathan Corbet's avatar
Jonathan Corbet committed
429
	int ret = 0;
Linus Torvalds's avatar
Linus Torvalds committed
430

431
	mutex_lock(&dsp56k_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
432 433 434 435
	switch(dev)
	{
	case DSP56K_DEV_56001:

Jonathan Corbet's avatar
Jonathan Corbet committed
436 437 438 439
		if (test_and_set_bit(0, &dsp56k.in_use)) {
			ret = -EBUSY;
			goto out;
		}
Linus Torvalds's avatar
Linus Torvalds committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454

		dsp56k.timeout = TIMEOUT;
		dsp56k.maxio = MAXIO;
		dsp56k.rx_wsize = dsp56k.tx_wsize = 4; 

		DSP56K_TX_INT_OFF;
		DSP56K_RX_INT_OFF;

		/* Zero host flags */
		dsp56k_host_interface.icr &= ~DSP56K_ICR_HF0;
		dsp56k_host_interface.icr &= ~DSP56K_ICR_HF1;

		break;

	default:
Jonathan Corbet's avatar
Jonathan Corbet committed
455
		ret = -ENODEV;
Linus Torvalds's avatar
Linus Torvalds committed
456
	}
Jonathan Corbet's avatar
Jonathan Corbet committed
457
out:
458
	mutex_unlock(&dsp56k_mutex);
Jonathan Corbet's avatar
Jonathan Corbet committed
459
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
}

static int dsp56k_release(struct inode *inode, struct file *file)
{
	int dev = iminor(inode) & 0x0f;

	switch(dev)
	{
	case DSP56K_DEV_56001:
		clear_bit(0, &dsp56k.in_use);
		break;
	default:
		printk(KERN_ERR "DSP56k driver: Unknown minor device: %d\n", dev);
		return -ENXIO;
	}

	return 0;
}

479
static const struct file_operations dsp56k_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
480 481 482
	.owner		= THIS_MODULE,
	.read		= dsp56k_read,
	.write		= dsp56k_write,
Alan Cox's avatar
Alan Cox committed
483
	.unlocked_ioctl	= dsp56k_ioctl,
Linus Torvalds's avatar
Linus Torvalds committed
484 485
	.open		= dsp56k_open,
	.release	= dsp56k_release,
486
	.llseek		= noop_llseek,
Linus Torvalds's avatar
Linus Torvalds committed
487 488 489 490 491
};


/****** Init and module functions ******/

492
static const char banner[] __initconst = KERN_INFO "DSP56k driver installed\n";
Linus Torvalds's avatar
Linus Torvalds committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506

static int __init dsp56k_init_driver(void)
{
	int err = 0;

	if(!MACH_IS_ATARI || !ATARIHW_PRESENT(DSP56K)) {
		printk("DSP56k driver: Hardware not present\n");
		return -ENODEV;
	}

	if(register_chrdev(DSP56K_MAJOR, "dsp56k", &dsp56k_fops)) {
		printk("DSP56k driver: Unable to register driver\n");
		return -ENODEV;
	}
507
	dsp56k_class = class_create(THIS_MODULE, "dsp56k");
Linus Torvalds's avatar
Linus Torvalds committed
508 509 510 511
	if (IS_ERR(dsp56k_class)) {
		err = PTR_ERR(dsp56k_class);
		goto out_chrdev;
	}
512 513
	device_create(dsp56k_class, NULL, MKDEV(DSP56K_MAJOR, 0), NULL,
		      "dsp56k");
Linus Torvalds's avatar
Linus Torvalds committed
514 515 516 517 518 519 520 521 522 523 524 525 526

	printk(banner);
	goto out;

out_chrdev:
	unregister_chrdev(DSP56K_MAJOR, "dsp56k");
out:
	return err;
}
module_init(dsp56k_init_driver);

static void __exit dsp56k_cleanup_driver(void)
{
527
	device_destroy(dsp56k_class, MKDEV(DSP56K_MAJOR, 0));
528
	class_destroy(dsp56k_class);
Linus Torvalds's avatar
Linus Torvalds committed
529 530 531 532 533
	unregister_chrdev(DSP56K_MAJOR, "dsp56k");
}
module_exit(dsp56k_cleanup_driver);

MODULE_LICENSE("GPL");
534
MODULE_FIRMWARE("dsp56k/bootstrap.bin");