3 * mwavedd.c -- mwave device driver
6 * Written By: Mike Sullivan IBM Corporation
8 * Copyright (C) 1999 IBM Corporation
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
21 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
22 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
23 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
24 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
25 * solely responsible for determining the appropriateness of using and
26 * distributing the Program and assumes all risks associated with its
27 * exercise of rights under this Agreement, including but not limited to
28 * the risks and costs of program errors, damage to or loss of data,
29 * programs or equipment, and unavailability or interruption of operations.
31 * DISCLAIMER OF LIABILITY
32 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
33 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
35 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
38 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
40 * You should have received a copy of the GNU General Public License
41 * along with this program; if not, write to the Free Software
42 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
45 * 10/23/2000 - Alpha Release
46 * First release to the public
49 #include <linux/module.h>
50 #include <linux/kernel.h>
52 #include <linux/init.h>
53 #include <linux/major.h>
54 #include <linux/miscdevice.h>
55 #include <linux/device.h>
56 #include <linux/serial.h>
57 #include <linux/sched.h>
58 #include <linux/spinlock.h>
59 #include <linux/smp_lock.h>
60 #include <linux/delay.h>
61 #include <linux/serial_8250.h>
67 MODULE_DESCRIPTION("3780i Advanced Communications Processor (Mwave) driver");
68 MODULE_AUTHOR("Mike Sullivan and Paul Schroeder");
69 MODULE_LICENSE("GPL");
72 * These parameters support the setting of MWave resources. Note that no
73 * checks are made against other devices (ie. superio) for conflicts.
74 * We'll depend on users using the tpctl utility to do that for now
77 int mwave_3780i_irq
= 0;
78 int mwave_3780i_io
= 0;
79 int mwave_uart_irq
= 0;
80 int mwave_uart_io
= 0;
81 module_param(mwave_debug
, int, 0);
82 module_param(mwave_3780i_irq
, int, 0);
83 module_param(mwave_3780i_io
, int, 0);
84 module_param(mwave_uart_irq
, int, 0);
85 module_param(mwave_uart_io
, int, 0);
87 static int mwave_open(struct inode
*inode
, struct file
*file
);
88 static int mwave_close(struct inode
*inode
, struct file
*file
);
89 static long mwave_ioctl(struct file
*filp
, unsigned int iocmd
,
92 MWAVE_DEVICE_DATA mwave_s_mdd
;
94 static int mwave_open(struct inode
*inode
, struct file
*file
)
96 unsigned int retval
= 0;
99 "mwavedd::mwave_open, entry inode %p file %p\n",
101 PRINTK_2(TRACE_MWAVE
,
102 "mwavedd::mwave_open, exit return retval %x\n", retval
);
108 static int mwave_close(struct inode
*inode
, struct file
*file
)
110 unsigned int retval
= 0;
112 PRINTK_3(TRACE_MWAVE
,
113 "mwavedd::mwave_close, entry inode %p file %p\n",
116 PRINTK_2(TRACE_MWAVE
, "mwavedd::mwave_close, exit retval %x\n",
122 static long mwave_ioctl(struct file
*file
, unsigned int iocmd
,
125 unsigned int retval
= 0;
126 pMWAVE_DEVICE_DATA pDrvData
= &mwave_s_mdd
;
127 void __user
*arg
= (void __user
*)ioarg
;
129 PRINTK_4(TRACE_MWAVE
,
130 "mwavedd::mwave_ioctl, entry file %p cmd %x arg %x\n",
131 file
, iocmd
, (int) ioarg
);
136 PRINTK_1(TRACE_MWAVE
,
137 "mwavedd::mwave_ioctl, IOCTL_MW_RESET"
138 " calling tp3780I_ResetDSP\n");
140 retval
= tp3780I_ResetDSP(&pDrvData
->rBDData
);
142 PRINTK_2(TRACE_MWAVE
,
143 "mwavedd::mwave_ioctl, IOCTL_MW_RESET"
144 " retval %x from tp3780I_ResetDSP\n",
149 PRINTK_1(TRACE_MWAVE
,
150 "mwavedd::mwave_ioctl, IOCTL_MW_RUN"
151 " calling tp3780I_StartDSP\n");
153 retval
= tp3780I_StartDSP(&pDrvData
->rBDData
);
155 PRINTK_2(TRACE_MWAVE
,
156 "mwavedd::mwave_ioctl, IOCTL_MW_RUN"
157 " retval %x from tp3780I_StartDSP\n",
161 case IOCTL_MW_DSP_ABILITIES
: {
162 MW_ABILITIES rAbilities
;
164 PRINTK_1(TRACE_MWAVE
,
165 "mwavedd::mwave_ioctl,"
166 " IOCTL_MW_DSP_ABILITIES calling"
167 " tp3780I_QueryAbilities\n");
169 retval
= tp3780I_QueryAbilities(&pDrvData
->rBDData
,
172 PRINTK_2(TRACE_MWAVE
,
173 "mwavedd::mwave_ioctl, IOCTL_MW_DSP_ABILITIES"
174 " retval %x from tp3780I_QueryAbilities\n",
177 if( copy_to_user(arg
, &rAbilities
,
178 sizeof(MW_ABILITIES
)) )
181 PRINTK_2(TRACE_MWAVE
,
182 "mwavedd::mwave_ioctl, IOCTL_MW_DSP_ABILITIES"
188 case IOCTL_MW_READ_DATA
:
189 case IOCTL_MW_READCLEAR_DATA
: {
190 MW_READWRITE rReadData
;
191 unsigned short __user
*pusBuffer
= NULL
;
193 if( copy_from_user(&rReadData
, arg
,
194 sizeof(MW_READWRITE
)) )
196 pusBuffer
= (unsigned short __user
*) (rReadData
.pBuf
);
198 PRINTK_4(TRACE_MWAVE
,
199 "mwavedd::mwave_ioctl IOCTL_MW_READ_DATA,"
200 " size %lx, ioarg %lx pusBuffer %p\n",
201 rReadData
.ulDataLength
, ioarg
, pusBuffer
);
203 retval
= tp3780I_ReadWriteDspDStore(&pDrvData
->rBDData
,
206 rReadData
.ulDataLength
,
207 rReadData
.usDspAddress
);
212 case IOCTL_MW_READ_INST
: {
213 MW_READWRITE rReadData
;
214 unsigned short __user
*pusBuffer
= NULL
;
216 if( copy_from_user(&rReadData
, arg
,
217 sizeof(MW_READWRITE
)) )
219 pusBuffer
= (unsigned short __user
*) (rReadData
.pBuf
);
221 PRINTK_4(TRACE_MWAVE
,
222 "mwavedd::mwave_ioctl IOCTL_MW_READ_INST,"
223 " size %lx, ioarg %lx pusBuffer %p\n",
224 rReadData
.ulDataLength
/ 2, ioarg
,
227 retval
= tp3780I_ReadWriteDspDStore(&pDrvData
->rBDData
,
229 rReadData
.ulDataLength
/ 2,
230 rReadData
.usDspAddress
);
235 case IOCTL_MW_WRITE_DATA
: {
236 MW_READWRITE rWriteData
;
237 unsigned short __user
*pusBuffer
= NULL
;
239 if( copy_from_user(&rWriteData
, arg
,
240 sizeof(MW_READWRITE
)) )
242 pusBuffer
= (unsigned short __user
*) (rWriteData
.pBuf
);
244 PRINTK_4(TRACE_MWAVE
,
245 "mwavedd::mwave_ioctl IOCTL_MW_WRITE_DATA,"
246 " size %lx, ioarg %lx pusBuffer %p\n",
247 rWriteData
.ulDataLength
, ioarg
,
250 retval
= tp3780I_ReadWriteDspDStore(&pDrvData
->rBDData
,
252 rWriteData
.ulDataLength
,
253 rWriteData
.usDspAddress
);
258 case IOCTL_MW_WRITE_INST
: {
259 MW_READWRITE rWriteData
;
260 unsigned short __user
*pusBuffer
= NULL
;
262 if( copy_from_user(&rWriteData
, arg
,
263 sizeof(MW_READWRITE
)) )
265 pusBuffer
= (unsigned short __user
*)(rWriteData
.pBuf
);
267 PRINTK_4(TRACE_MWAVE
,
268 "mwavedd::mwave_ioctl IOCTL_MW_WRITE_INST,"
269 " size %lx, ioarg %lx pusBuffer %p\n",
270 rWriteData
.ulDataLength
, ioarg
,
273 retval
= tp3780I_ReadWriteDspIStore(&pDrvData
->rBDData
,
275 rWriteData
.ulDataLength
,
276 rWriteData
.usDspAddress
);
281 case IOCTL_MW_REGISTER_IPC
: {
282 unsigned int ipcnum
= (unsigned int) ioarg
;
284 if (ipcnum
>= ARRAY_SIZE(pDrvData
->IPCs
)) {
285 PRINTK_ERROR(KERN_ERR_MWAVE
286 "mwavedd::mwave_ioctl:"
287 " IOCTL_MW_REGISTER_IPC:"
288 " Error: Invalid ipcnum %x\n",
292 PRINTK_3(TRACE_MWAVE
,
293 "mwavedd::mwave_ioctl IOCTL_MW_REGISTER_IPC"
294 " ipcnum %x entry usIntCount %x\n",
296 pDrvData
->IPCs
[ipcnum
].usIntCount
);
299 pDrvData
->IPCs
[ipcnum
].bIsHere
= FALSE
;
300 pDrvData
->IPCs
[ipcnum
].bIsEnabled
= TRUE
;
303 PRINTK_2(TRACE_MWAVE
,
304 "mwavedd::mwave_ioctl IOCTL_MW_REGISTER_IPC"
310 case IOCTL_MW_GET_IPC
: {
311 unsigned int ipcnum
= (unsigned int) ioarg
;
313 if (ipcnum
>= ARRAY_SIZE(pDrvData
->IPCs
)) {
314 PRINTK_ERROR(KERN_ERR_MWAVE
315 "mwavedd::mwave_ioctl:"
316 " IOCTL_MW_GET_IPC: Error:"
317 " Invalid ipcnum %x\n", ipcnum
);
320 PRINTK_3(TRACE_MWAVE
,
321 "mwavedd::mwave_ioctl IOCTL_MW_GET_IPC"
322 " ipcnum %x, usIntCount %x\n",
324 pDrvData
->IPCs
[ipcnum
].usIntCount
);
327 if (pDrvData
->IPCs
[ipcnum
].bIsEnabled
== TRUE
) {
328 DECLARE_WAITQUEUE(wait
, current
);
330 PRINTK_2(TRACE_MWAVE
,
331 "mwavedd::mwave_ioctl, thread for"
332 " ipc %x going to sleep\n",
334 add_wait_queue(&pDrvData
->IPCs
[ipcnum
].ipc_wait_queue
, &wait
);
335 pDrvData
->IPCs
[ipcnum
].bIsHere
= TRUE
;
336 set_current_state(TASK_INTERRUPTIBLE
);
337 /* check whether an event was signalled by */
338 /* the interrupt handler while we were gone */
339 if (pDrvData
->IPCs
[ipcnum
].usIntCount
== 1) { /* first int has occurred (race condition) */
340 pDrvData
->IPCs
[ipcnum
].usIntCount
= 2; /* first int has been handled */
341 PRINTK_2(TRACE_MWAVE
,
342 "mwavedd::mwave_ioctl"
343 " IOCTL_MW_GET_IPC ipcnum %x"
344 " handling first int\n",
346 } else { /* either 1st int has not yet occurred, or we have already handled the first int */
348 if (pDrvData
->IPCs
[ipcnum
].usIntCount
== 1) {
349 pDrvData
->IPCs
[ipcnum
].usIntCount
= 2;
351 PRINTK_2(TRACE_MWAVE
,
352 "mwavedd::mwave_ioctl"
353 " IOCTL_MW_GET_IPC ipcnum %x"
354 " woke up and returning to"
358 pDrvData
->IPCs
[ipcnum
].bIsHere
= FALSE
;
359 remove_wait_queue(&pDrvData
->IPCs
[ipcnum
].ipc_wait_queue
, &wait
);
360 set_current_state(TASK_RUNNING
);
361 PRINTK_2(TRACE_MWAVE
,
362 "mwavedd::mwave_ioctl IOCTL_MW_GET_IPC,"
363 " returning thread for ipc %x"
371 case IOCTL_MW_UNREGISTER_IPC
: {
372 unsigned int ipcnum
= (unsigned int) ioarg
;
374 PRINTK_2(TRACE_MWAVE
,
375 "mwavedd::mwave_ioctl IOCTL_MW_UNREGISTER_IPC"
378 if (ipcnum
>= ARRAY_SIZE(pDrvData
->IPCs
)) {
379 PRINTK_ERROR(KERN_ERR_MWAVE
380 "mwavedd::mwave_ioctl:"
381 " IOCTL_MW_UNREGISTER_IPC:"
382 " Error: Invalid ipcnum %x\n",
387 if (pDrvData
->IPCs
[ipcnum
].bIsEnabled
== TRUE
) {
388 pDrvData
->IPCs
[ipcnum
].bIsEnabled
= FALSE
;
389 if (pDrvData
->IPCs
[ipcnum
].bIsHere
== TRUE
) {
390 wake_up_interruptible(&pDrvData
->IPCs
[ipcnum
].ipc_wait_queue
);
402 PRINTK_2(TRACE_MWAVE
, "mwavedd::mwave_ioctl, exit retval %x\n", retval
);
408 static ssize_t
mwave_read(struct file
*file
, char __user
*buf
, size_t count
,
411 PRINTK_5(TRACE_MWAVE
,
412 "mwavedd::mwave_read entry file %p, buf %p, count %zx ppos %p\n",
413 file
, buf
, count
, ppos
);
419 static ssize_t
mwave_write(struct file
*file
, const char __user
*buf
,
420 size_t count
, loff_t
* ppos
)
422 PRINTK_5(TRACE_MWAVE
,
423 "mwavedd::mwave_write entry file %p, buf %p,"
424 " count %zx ppos %p\n",
425 file
, buf
, count
, ppos
);
431 static int register_serial_portandirq(unsigned int port
, int irq
)
433 struct uart_port uart
;
443 PRINTK_ERROR(KERN_ERR_MWAVE
444 "mwavedd::register_serial_portandirq:"
445 " Error: Illegal port %x\n", port
);
458 PRINTK_ERROR(KERN_ERR_MWAVE
459 "mwavedd::register_serial_portandirq:"
460 " Error: Illegal irq %x\n", irq
);
465 memset(&uart
, 0, sizeof(struct uart_port
));
467 uart
.uartclk
= 1843200;
470 uart
.iotype
= UPIO_PORT
;
471 uart
.flags
= UPF_SHARE_IRQ
;
472 return serial8250_register_port(&uart
);
476 static const struct file_operations mwave_fops
= {
477 .owner
= THIS_MODULE
,
479 .write
= mwave_write
,
480 .unlocked_ioctl
= mwave_ioctl
,
482 .release
= mwave_close
486 static struct miscdevice mwave_misc_dev
= { MWAVE_MINOR
, "mwave", &mwave_fops
};
488 #if 0 /* totally b0rked */
490 * sysfs support <paulsch@us.ibm.com>
493 struct device mwave_device
;
495 /* Prevent code redundancy, create a macro for mwave_show_* functions. */
496 #define mwave_show_function(attr_name, format_string, field) \
497 static ssize_t mwave_show_##attr_name(struct device *dev, struct device_attribute *attr, char *buf) \
499 DSP_3780I_CONFIG_SETTINGS *pSettings = \
500 &mwave_s_mdd.rBDData.rDspSettings; \
501 return sprintf(buf, format_string, pSettings->field); \
504 /* All of our attributes are read attributes. */
505 #define mwave_dev_rd_attr(attr_name, format_string, field) \
506 mwave_show_function(attr_name, format_string, field) \
507 static DEVICE_ATTR(attr_name, S_IRUGO, mwave_show_##attr_name, NULL)
509 mwave_dev_rd_attr (3780i_dma
, "%i\n", usDspDma
);
510 mwave_dev_rd_attr (3780i_irq
, "%i\n", usDspIrq
);
511 mwave_dev_rd_attr (3780i_io
, "%#.4x\n", usDspBaseIO
);
512 mwave_dev_rd_attr (uart_irq
, "%i\n", usUartIrq
);
513 mwave_dev_rd_attr (uart_io
, "%#.4x\n", usUartBaseIO
);
515 static struct device_attribute
* const mwave_dev_attrs
[] = {
525 * mwave_init is called on module load
527 * mwave_exit is called on module unload
528 * mwave_exit is also used to clean up after an aborted mwave_init
530 static void mwave_exit(void)
532 pMWAVE_DEVICE_DATA pDrvData
= &mwave_s_mdd
;
534 PRINTK_1(TRACE_MWAVE
, "mwavedd::mwave_exit entry\n");
537 for (i
= 0; i
< pDrvData
->nr_registered_attrs
; i
++)
538 device_remove_file(&mwave_device
, mwave_dev_attrs
[i
]);
539 pDrvData
->nr_registered_attrs
= 0;
541 if (pDrvData
->device_registered
) {
542 device_unregister(&mwave_device
);
543 pDrvData
->device_registered
= FALSE
;
547 if ( pDrvData
->sLine
>= 0 ) {
548 serial8250_unregister_port(pDrvData
->sLine
);
550 if (pDrvData
->bMwaveDevRegistered
) {
551 misc_deregister(&mwave_misc_dev
);
553 if (pDrvData
->bDSPEnabled
) {
554 tp3780I_DisableDSP(&pDrvData
->rBDData
);
556 if (pDrvData
->bResourcesClaimed
) {
557 tp3780I_ReleaseResources(&pDrvData
->rBDData
);
559 if (pDrvData
->bBDInitialized
) {
560 tp3780I_Cleanup(&pDrvData
->rBDData
);
563 PRINTK_1(TRACE_MWAVE
, "mwavedd::mwave_exit exit\n");
566 module_exit(mwave_exit
);
568 static int __init
mwave_init(void)
572 pMWAVE_DEVICE_DATA pDrvData
= &mwave_s_mdd
;
574 PRINTK_1(TRACE_MWAVE
, "mwavedd::mwave_init entry\n");
576 memset(&mwave_s_mdd
, 0, sizeof(MWAVE_DEVICE_DATA
));
578 pDrvData
->bBDInitialized
= FALSE
;
579 pDrvData
->bResourcesClaimed
= FALSE
;
580 pDrvData
->bDSPEnabled
= FALSE
;
581 pDrvData
->bDSPReset
= FALSE
;
582 pDrvData
->bMwaveDevRegistered
= FALSE
;
583 pDrvData
->sLine
= -1;
585 for (i
= 0; i
< ARRAY_SIZE(pDrvData
->IPCs
); i
++) {
586 pDrvData
->IPCs
[i
].bIsEnabled
= FALSE
;
587 pDrvData
->IPCs
[i
].bIsHere
= FALSE
;
588 pDrvData
->IPCs
[i
].usIntCount
= 0; /* no ints received yet */
589 init_waitqueue_head(&pDrvData
->IPCs
[i
].ipc_wait_queue
);
592 retval
= tp3780I_InitializeBoardData(&pDrvData
->rBDData
);
593 PRINTK_2(TRACE_MWAVE
,
594 "mwavedd::mwave_init, return from tp3780I_InitializeBoardData"
598 PRINTK_ERROR(KERN_ERR_MWAVE
599 "mwavedd::mwave_init: Error:"
600 " Failed to initialize board data\n");
603 pDrvData
->bBDInitialized
= TRUE
;
605 retval
= tp3780I_CalcResources(&pDrvData
->rBDData
);
606 PRINTK_2(TRACE_MWAVE
,
607 "mwavedd::mwave_init, return from tp3780I_CalcResources"
611 PRINTK_ERROR(KERN_ERR_MWAVE
612 "mwavedd:mwave_init: Error:"
613 " Failed to calculate resources\n");
617 retval
= tp3780I_ClaimResources(&pDrvData
->rBDData
);
618 PRINTK_2(TRACE_MWAVE
,
619 "mwavedd::mwave_init, return from tp3780I_ClaimResources"
623 PRINTK_ERROR(KERN_ERR_MWAVE
624 "mwavedd:mwave_init: Error:"
625 " Failed to claim resources\n");
628 pDrvData
->bResourcesClaimed
= TRUE
;
630 retval
= tp3780I_EnableDSP(&pDrvData
->rBDData
);
631 PRINTK_2(TRACE_MWAVE
,
632 "mwavedd::mwave_init, return from tp3780I_EnableDSP"
636 PRINTK_ERROR(KERN_ERR_MWAVE
637 "mwavedd:mwave_init: Error:"
638 " Failed to enable DSP\n");
641 pDrvData
->bDSPEnabled
= TRUE
;
643 if (misc_register(&mwave_misc_dev
) < 0) {
644 PRINTK_ERROR(KERN_ERR_MWAVE
645 "mwavedd:mwave_init: Error:"
646 " Failed to register misc device\n");
649 pDrvData
->bMwaveDevRegistered
= TRUE
;
651 pDrvData
->sLine
= register_serial_portandirq(
652 pDrvData
->rBDData
.rDspSettings
.usUartBaseIO
,
653 pDrvData
->rBDData
.rDspSettings
.usUartIrq
655 if (pDrvData
->sLine
< 0) {
656 PRINTK_ERROR(KERN_ERR_MWAVE
657 "mwavedd:mwave_init: Error:"
658 " Failed to register serial driver\n");
661 /* uart is registered */
665 memset(&mwave_device
, 0, sizeof (struct device
));
666 dev_set_name(&mwave_device
, "mwave");
668 if (device_register(&mwave_device
))
670 pDrvData
->device_registered
= TRUE
;
671 for (i
= 0; i
< ARRAY_SIZE(mwave_dev_attrs
); i
++) {
672 if(device_create_file(&mwave_device
, mwave_dev_attrs
[i
])) {
673 PRINTK_ERROR(KERN_ERR_MWAVE
674 "mwavedd:mwave_init: Error:"
675 " Failed to create sysfs file %s\n",
676 mwave_dev_attrs
[i
]->attr
.name
);
679 pDrvData
->nr_registered_attrs
++;
687 PRINTK_ERROR(KERN_ERR_MWAVE
688 "mwavedd::mwave_init: Error:"
689 " Failed to initialize\n");
690 mwave_exit(); /* clean up */
695 module_init(mwave_init
);