2 * linux/drivers/char/ppdev.c
4 * This is the code behind /dev/parport* -- it allows a user-space
5 * application to use the parport subsystem.
7 * Copyright (C) 1998-2000, 2002 Tim Waugh <tim@cyberelk.net>
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
14 * A /dev/parportx device node represents an arbitrary device
15 * on port 'x'. The following operations are possible:
17 * open do nothing, set up default IEEE 1284 protocol to be COMPAT
18 * close release port and unregister device (if necessary)
20 * EXCL register device exclusively (may fail)
21 * CLAIM (register device first time) parport_claim_or_block
22 * RELEASE parport_release
23 * SETMODE set the IEEE 1284 protocol to use for read/write
24 * SETPHASE set the IEEE 1284 phase of a particular mode. Not to be
25 * confused with ioctl(fd, SETPHASER, &stun). ;-)
26 * DATADIR data_forward / data_reverse
29 * WCONTROL write_control
30 * RCONTROL read_control
31 * FCONTROL frob_control
33 * NEGOT parport_negotiate
34 * YIELD parport_yield_blocking
35 * WCTLONIRQ on interrupt, set control lines
36 * CLRIRQ clear (and return) interrupt count
37 * SETTIME sets device timeout (struct timeval)
38 * GETTIME gets device timeout (struct timeval)
39 * GETMODES gets hardware supported modes (unsigned int)
40 * GETMODE gets the current IEEE1284 mode
41 * GETPHASE gets the current IEEE1284 phase
42 * GETFLAGS gets current (user-visible) flags
43 * SETFLAGS sets current (user-visible) flags
44 * read/write read or write in current IEEE 1284 protocol
45 * select wait for interrupt (in readfds)
48 * Added SETTIME/GETTIME ioctl, Fred Barnes, 1999.
50 * Arnaldo Carvalho de Melo <acme@conectiva.com.br> 2000/08/25
51 * - On error, copy_from_user and copy_to_user do not return -EFAULT,
52 * They return the positive number of bytes *not* copied due to address
55 * Added GETMODES/GETMODE/GETPHASE ioctls, Fred Barnes <frmb2@ukc.ac.uk>, 03/01/2001.
56 * Added GETFLAGS/SETFLAGS ioctls, Fred Barnes, 04/2001
59 #include <linux/module.h>
60 #include <linux/init.h>
61 #include <linux/sched.h>
62 #include <linux/device.h>
63 #include <linux/ioctl.h>
64 #include <linux/parport.h>
65 #include <linux/ctype.h>
66 #include <linux/poll.h>
67 #include <linux/major.h>
68 #include <linux/ppdev.h>
69 #include <linux/smp_lock.h>
70 #include <linux/uaccess.h>
72 #define PP_VERSION "ppdev: user-space parallel port driver"
73 #define CHRDEV "ppdev"
76 struct pardevice
* pdev
;
77 wait_queue_head_t irq_wait
;
82 struct ieee1284_info state
;
83 struct ieee1284_info saved_state
;
84 long default_inactivity
;
87 /* pp_struct.flags bitfields */
88 #define PP_CLAIMED (1<<0)
89 #define PP_EXCL (1<<1)
92 #define PP_INTERRUPT_TIMEOUT (10 * HZ) /* 10s */
93 #define PP_BUFFER_SIZE 1024
94 #define PARDEVICE_MAX 8
96 /* ROUND_UP macro from fs/select.c */
97 #define ROUND_UP(x,y) (((x)+(y)-1)/(y))
99 static inline void pp_enable_irq (struct pp_struct
*pp
)
101 struct parport
*port
= pp
->pdev
->port
;
102 port
->ops
->enable_irq (port
);
105 static ssize_t
pp_read (struct file
* file
, char __user
* buf
, size_t count
,
108 unsigned int minor
= iminor(file
->f_path
.dentry
->d_inode
);
109 struct pp_struct
*pp
= file
->private_data
;
111 ssize_t bytes_read
= 0;
112 struct parport
*pport
;
115 if (!(pp
->flags
& PP_CLAIMED
)) {
116 /* Don't have the port claimed */
117 pr_debug(CHRDEV
"%x: claim the port first\n", minor
);
125 kbuffer
= kmalloc(min_t(size_t, count
, PP_BUFFER_SIZE
), GFP_KERNEL
);
129 pport
= pp
->pdev
->port
;
130 mode
= pport
->ieee1284
.mode
& ~(IEEE1284_DEVICEID
| IEEE1284_ADDR
);
132 parport_set_timeout (pp
->pdev
,
133 (file
->f_flags
& O_NONBLOCK
) ?
134 PARPORT_INACTIVITY_O_NONBLOCK
:
135 pp
->default_inactivity
);
137 while (bytes_read
== 0) {
138 ssize_t need
= min_t(unsigned long, count
, PP_BUFFER_SIZE
);
140 if (mode
== IEEE1284_MODE_EPP
) {
141 /* various specials for EPP mode */
143 size_t (*fn
)(struct parport
*, void *, size_t, int);
145 if (pp
->flags
& PP_W91284PIC
) {
146 flags
|= PARPORT_W91284PIC
;
148 if (pp
->flags
& PP_FASTREAD
) {
149 flags
|= PARPORT_EPP_FAST
;
151 if (pport
->ieee1284
.mode
& IEEE1284_ADDR
) {
152 fn
= pport
->ops
->epp_read_addr
;
154 fn
= pport
->ops
->epp_read_data
;
156 bytes_read
= (*fn
)(pport
, kbuffer
, need
, flags
);
158 bytes_read
= parport_read (pport
, kbuffer
, need
);
164 if (file
->f_flags
& O_NONBLOCK
) {
165 bytes_read
= -EAGAIN
;
169 if (signal_pending (current
)) {
170 bytes_read
= -ERESTARTSYS
;
177 parport_set_timeout (pp
->pdev
, pp
->default_inactivity
);
179 if (bytes_read
> 0 && copy_to_user (buf
, kbuffer
, bytes_read
))
180 bytes_read
= -EFAULT
;
187 static ssize_t
pp_write (struct file
* file
, const char __user
* buf
,
188 size_t count
, loff_t
* ppos
)
190 unsigned int minor
= iminor(file
->f_path
.dentry
->d_inode
);
191 struct pp_struct
*pp
= file
->private_data
;
193 ssize_t bytes_written
= 0;
196 struct parport
*pport
;
198 if (!(pp
->flags
& PP_CLAIMED
)) {
199 /* Don't have the port claimed */
200 pr_debug(CHRDEV
"%x: claim the port first\n", minor
);
204 kbuffer
= kmalloc(min_t(size_t, count
, PP_BUFFER_SIZE
), GFP_KERNEL
);
208 pport
= pp
->pdev
->port
;
209 mode
= pport
->ieee1284
.mode
& ~(IEEE1284_DEVICEID
| IEEE1284_ADDR
);
211 parport_set_timeout (pp
->pdev
,
212 (file
->f_flags
& O_NONBLOCK
) ?
213 PARPORT_INACTIVITY_O_NONBLOCK
:
214 pp
->default_inactivity
);
216 while (bytes_written
< count
) {
217 ssize_t n
= min_t(unsigned long, count
- bytes_written
, PP_BUFFER_SIZE
);
219 if (copy_from_user (kbuffer
, buf
+ bytes_written
, n
)) {
220 bytes_written
= -EFAULT
;
224 if ((pp
->flags
& PP_FASTWRITE
) && (mode
== IEEE1284_MODE_EPP
)) {
225 /* do a fast EPP write */
226 if (pport
->ieee1284
.mode
& IEEE1284_ADDR
) {
227 wrote
= pport
->ops
->epp_write_addr (pport
,
228 kbuffer
, n
, PARPORT_EPP_FAST
);
230 wrote
= pport
->ops
->epp_write_data (pport
,
231 kbuffer
, n
, PARPORT_EPP_FAST
);
234 wrote
= parport_write (pp
->pdev
->port
, kbuffer
, n
);
238 if (!bytes_written
) {
239 bytes_written
= wrote
;
244 bytes_written
+= wrote
;
246 if (file
->f_flags
& O_NONBLOCK
) {
248 bytes_written
= -EAGAIN
;
252 if (signal_pending (current
)) {
253 if (!bytes_written
) {
254 bytes_written
= -EINTR
;
262 parport_set_timeout (pp
->pdev
, pp
->default_inactivity
);
266 return bytes_written
;
269 static void pp_irq (void *private)
271 struct pp_struct
*pp
= private;
273 if (pp
->irqresponse
) {
274 parport_write_control (pp
->pdev
->port
, pp
->irqctl
);
278 atomic_inc (&pp
->irqc
);
279 wake_up_interruptible (&pp
->irq_wait
);
282 static int register_device (int minor
, struct pp_struct
*pp
)
284 struct parport
*port
;
285 struct pardevice
* pdev
= NULL
;
289 name
= kmalloc (strlen (CHRDEV
) + 3, GFP_KERNEL
);
293 sprintf (name
, CHRDEV
"%x", minor
);
295 port
= parport_find_number (minor
);
297 printk (KERN_WARNING
"%s: no associated port!\n", name
);
302 fl
= (pp
->flags
& PP_EXCL
) ? PARPORT_FLAG_EXCL
: 0;
303 pdev
= parport_register_device (port
, name
, NULL
,
304 NULL
, pp_irq
, fl
, pp
);
305 parport_put_port (port
);
308 printk (KERN_WARNING
"%s: failed to register device!\n", name
);
314 pr_debug("%s: registered pardevice\n", name
);
318 static enum ieee1284_phase
init_phase (int mode
)
320 switch (mode
& ~(IEEE1284_DEVICEID
322 case IEEE1284_MODE_NIBBLE
:
323 case IEEE1284_MODE_BYTE
:
324 return IEEE1284_PH_REV_IDLE
;
326 return IEEE1284_PH_FWD_IDLE
;
329 static int pp_do_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
331 unsigned int minor
= iminor(file
->f_path
.dentry
->d_inode
);
332 struct pp_struct
*pp
= file
->private_data
;
333 struct parport
* port
;
334 void __user
*argp
= (void __user
*)arg
;
336 /* First handle the cases that don't take arguments. */
340 struct ieee1284_info
*info
;
343 if (pp
->flags
& PP_CLAIMED
) {
344 pr_debug(CHRDEV
"%x: you've already got it!\n", minor
);
348 /* Deferred device registration. */
350 int err
= register_device (minor
, pp
);
356 ret
= parport_claim_or_block (pp
->pdev
);
360 pp
->flags
|= PP_CLAIMED
;
362 /* For interrupt-reporting to work, we need to be
363 * informed of each interrupt. */
366 /* We may need to fix up the state machine. */
367 info
= &pp
->pdev
->port
->ieee1284
;
368 pp
->saved_state
.mode
= info
->mode
;
369 pp
->saved_state
.phase
= info
->phase
;
370 info
->mode
= pp
->state
.mode
;
371 info
->phase
= pp
->state
.phase
;
372 pp
->default_inactivity
= parport_set_timeout (pp
->pdev
, 0);
373 parport_set_timeout (pp
->pdev
, pp
->default_inactivity
);
379 pr_debug(CHRDEV
"%x: too late for PPEXCL; "
380 "already registered\n", minor
);
381 if (pp
->flags
& PP_EXCL
)
382 /* But it's not really an error. */
384 /* There's no chance of making the driver happy. */
388 /* Just remember to register the device exclusively
389 * when we finally do the registration. */
390 pp
->flags
|= PP_EXCL
;
395 if (copy_from_user (&mode
, argp
, sizeof (mode
)))
397 /* FIXME: validate mode */
398 pp
->state
.mode
= mode
;
399 pp
->state
.phase
= init_phase (mode
);
401 if (pp
->flags
& PP_CLAIMED
) {
402 pp
->pdev
->port
->ieee1284
.mode
= mode
;
403 pp
->pdev
->port
->ieee1284
.phase
= pp
->state
.phase
;
412 if (pp
->flags
& PP_CLAIMED
) {
413 mode
= pp
->pdev
->port
->ieee1284
.mode
;
415 mode
= pp
->state
.mode
;
417 if (copy_to_user (argp
, &mode
, sizeof (mode
))) {
425 if (copy_from_user (&phase
, argp
, sizeof (phase
))) {
428 /* FIXME: validate phase */
429 pp
->state
.phase
= phase
;
431 if (pp
->flags
& PP_CLAIMED
) {
432 pp
->pdev
->port
->ieee1284
.phase
= phase
;
441 if (pp
->flags
& PP_CLAIMED
) {
442 phase
= pp
->pdev
->port
->ieee1284
.phase
;
444 phase
= pp
->state
.phase
;
446 if (copy_to_user (argp
, &phase
, sizeof (phase
))) {
455 port
= parport_find_number (minor
);
460 if (copy_to_user (argp
, &modes
, sizeof (modes
))) {
469 if (copy_from_user (&uflags
, argp
, sizeof (uflags
))) {
472 pp
->flags
&= ~PP_FLAGMASK
;
473 pp
->flags
|= (uflags
& PP_FLAGMASK
);
480 uflags
= pp
->flags
& PP_FLAGMASK
;
481 if (copy_to_user (argp
, &uflags
, sizeof (uflags
))) {
488 /* Everything else requires the port to be claimed, so check
490 if ((pp
->flags
& PP_CLAIMED
) == 0) {
491 pr_debug(CHRDEV
"%x: claim the port first\n", minor
);
495 port
= pp
->pdev
->port
;
497 struct ieee1284_info
*info
;
502 struct timeval par_timeout
;
506 reg
= parport_read_status (port
);
507 if (copy_to_user (argp
, ®
, sizeof (reg
)))
511 reg
= parport_read_data (port
);
512 if (copy_to_user (argp
, ®
, sizeof (reg
)))
516 reg
= parport_read_control (port
);
517 if (copy_to_user (argp
, ®
, sizeof (reg
)))
521 parport_yield_blocking (pp
->pdev
);
525 /* Save the state machine's state. */
526 info
= &pp
->pdev
->port
->ieee1284
;
527 pp
->state
.mode
= info
->mode
;
528 pp
->state
.phase
= info
->phase
;
529 info
->mode
= pp
->saved_state
.mode
;
530 info
->phase
= pp
->saved_state
.phase
;
531 parport_release (pp
->pdev
);
532 pp
->flags
&= ~PP_CLAIMED
;
536 if (copy_from_user (®
, argp
, sizeof (reg
)))
538 parport_write_control (port
, reg
);
542 if (copy_from_user (®
, argp
, sizeof (reg
)))
544 parport_write_data (port
, reg
);
548 if (copy_from_user (&mask
, argp
,
551 if (copy_from_user (®
, 1 + (unsigned char __user
*) arg
,
554 parport_frob_control (port
, mask
, reg
);
558 if (copy_from_user (&mode
, argp
, sizeof (mode
)))
561 port
->ops
->data_reverse (port
);
563 port
->ops
->data_forward (port
);
567 if (copy_from_user (&mode
, argp
, sizeof (mode
)))
569 switch ((ret
= parport_negotiate (port
, mode
))) {
571 case -1: /* handshake failed, peripheral not IEEE 1284 */
574 case 1: /* handshake succeeded, peripheral rejected mode */
582 if (copy_from_user (®
, argp
, sizeof (reg
)))
585 /* Remember what to set the control lines to, for next
586 * time we get an interrupt. */
592 ret
= atomic_read (&pp
->irqc
);
593 if (copy_to_user (argp
, &ret
, sizeof (ret
)))
595 atomic_sub (ret
, &pp
->irqc
);
599 if (copy_from_user (&par_timeout
, argp
, sizeof(struct timeval
))) {
602 /* Convert to jiffies, place in pp->pdev->timeout */
603 if ((par_timeout
.tv_sec
< 0) || (par_timeout
.tv_usec
< 0)) {
606 to_jiffies
= ROUND_UP(par_timeout
.tv_usec
, 1000000/HZ
);
607 to_jiffies
+= par_timeout
.tv_sec
* (long)HZ
;
608 if (to_jiffies
<= 0) {
611 pp
->pdev
->timeout
= to_jiffies
;
615 to_jiffies
= pp
->pdev
->timeout
;
616 par_timeout
.tv_sec
= to_jiffies
/ HZ
;
617 par_timeout
.tv_usec
= (to_jiffies
% (long)HZ
) * (1000000/HZ
);
618 if (copy_to_user (argp
, &par_timeout
, sizeof(struct timeval
)))
623 pr_debug(CHRDEV
"%x: What? (cmd=0x%x)\n", minor
, cmd
);
627 /* Keep the compiler happy */
631 static long pp_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
635 ret
= pp_do_ioctl(file
, cmd
, arg
);
640 static int pp_open (struct inode
* inode
, struct file
* file
)
642 unsigned int minor
= iminor(inode
);
643 struct pp_struct
*pp
;
646 if (minor
>= PARPORT_MAX
)
649 pp
= kmalloc (sizeof (struct pp_struct
), GFP_KERNEL
);
653 pp
->state
.mode
= IEEE1284_MODE_COMPAT
;
654 pp
->state
.phase
= init_phase (pp
->state
.mode
);
657 atomic_set (&pp
->irqc
, 0);
658 init_waitqueue_head (&pp
->irq_wait
);
660 /* Defer the actual device registration until the first claim.
661 * That way, we know whether or not the driver wants to have
662 * exclusive access to the port (PPEXCL).
665 file
->private_data
= pp
;
670 static int pp_release (struct inode
* inode
, struct file
* file
)
672 unsigned int minor
= iminor(inode
);
673 struct pp_struct
*pp
= file
->private_data
;
677 if (!(pp
->flags
& PP_CLAIMED
) && pp
->pdev
&&
678 (pp
->state
.mode
!= IEEE1284_MODE_COMPAT
)) {
679 struct ieee1284_info
*info
;
681 /* parport released, but not in compatibility mode */
682 parport_claim_or_block (pp
->pdev
);
683 pp
->flags
|= PP_CLAIMED
;
684 info
= &pp
->pdev
->port
->ieee1284
;
685 pp
->saved_state
.mode
= info
->mode
;
686 pp
->saved_state
.phase
= info
->phase
;
687 info
->mode
= pp
->state
.mode
;
688 info
->phase
= pp
->state
.phase
;
690 } else if ((pp
->flags
& PP_CLAIMED
) && pp
->pdev
&&
691 (pp
->pdev
->port
->ieee1284
.mode
!= IEEE1284_MODE_COMPAT
)) {
695 parport_negotiate (pp
->pdev
->port
, IEEE1284_MODE_COMPAT
);
696 pr_debug(CHRDEV
"%x: negotiated back to compatibility "
697 "mode because user-space forgot\n", minor
);
700 if (pp
->flags
& PP_CLAIMED
) {
701 struct ieee1284_info
*info
;
703 info
= &pp
->pdev
->port
->ieee1284
;
704 pp
->state
.mode
= info
->mode
;
705 pp
->state
.phase
= info
->phase
;
706 info
->mode
= pp
->saved_state
.mode
;
707 info
->phase
= pp
->saved_state
.phase
;
708 parport_release (pp
->pdev
);
709 if (compat_negot
!= 1) {
710 pr_debug(CHRDEV
"%x: released pardevice "
711 "because user-space forgot\n", minor
);
716 const char *name
= pp
->pdev
->name
;
717 parport_unregister_device (pp
->pdev
);
720 pr_debug(CHRDEV
"%x: unregistered pardevice\n", minor
);
728 /* No kernel lock held - fine */
729 static unsigned int pp_poll (struct file
* file
, poll_table
* wait
)
731 struct pp_struct
*pp
= file
->private_data
;
732 unsigned int mask
= 0;
734 poll_wait (file
, &pp
->irq_wait
, wait
);
735 if (atomic_read (&pp
->irqc
))
736 mask
|= POLLIN
| POLLRDNORM
;
741 static struct class *ppdev_class
;
743 static const struct file_operations pp_fops
= {
744 .owner
= THIS_MODULE
,
749 .unlocked_ioctl
= pp_ioctl
,
751 .release
= pp_release
,
754 static void pp_attach(struct parport
*port
)
756 device_create(ppdev_class
, port
->dev
, MKDEV(PP_MAJOR
, port
->number
),
757 NULL
, "parport%d", port
->number
);
760 static void pp_detach(struct parport
*port
)
762 device_destroy(ppdev_class
, MKDEV(PP_MAJOR
, port
->number
));
765 static struct parport_driver pp_driver
= {
771 static int __init
ppdev_init (void)
775 if (register_chrdev (PP_MAJOR
, CHRDEV
, &pp_fops
)) {
776 printk (KERN_WARNING CHRDEV
": unable to get major %d\n",
780 ppdev_class
= class_create(THIS_MODULE
, CHRDEV
);
781 if (IS_ERR(ppdev_class
)) {
782 err
= PTR_ERR(ppdev_class
);
785 if (parport_register_driver(&pp_driver
)) {
786 printk (KERN_WARNING CHRDEV
": unable to register with parport\n");
790 printk (KERN_INFO PP_VERSION
"\n");
794 class_destroy(ppdev_class
);
796 unregister_chrdev(PP_MAJOR
, CHRDEV
);
801 static void __exit
ppdev_cleanup (void)
803 /* Clean up all parport stuff */
804 parport_unregister_driver(&pp_driver
);
805 class_destroy(ppdev_class
);
806 unregister_chrdev (PP_MAJOR
, CHRDEV
);
809 module_init(ppdev_init
);
810 module_exit(ppdev_cleanup
);
812 MODULE_LICENSE("GPL");
813 MODULE_ALIAS_CHARDEV_MAJOR(PP_MAJOR
);