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/slab.h>
68 #include <linux/major.h>
69 #include <linux/ppdev.h>
70 #include <linux/mutex.h>
71 #include <linux/uaccess.h>
72 #include <linux/compat.h>
74 #define PP_VERSION "ppdev: user-space parallel port driver"
75 #define CHRDEV "ppdev"
78 struct pardevice
*pdev
;
79 wait_queue_head_t irq_wait
;
84 struct ieee1284_info state
;
85 struct ieee1284_info saved_state
;
86 long default_inactivity
;
89 /* pp_struct.flags bitfields */
90 #define PP_CLAIMED (1<<0)
91 #define PP_EXCL (1<<1)
94 #define PP_INTERRUPT_TIMEOUT (10 * HZ) /* 10s */
95 #define PP_BUFFER_SIZE 1024
96 #define PARDEVICE_MAX 8
98 /* ROUND_UP macro from fs/select.c */
99 #define ROUND_UP(x,y) (((x)+(y)-1)/(y))
101 static DEFINE_MUTEX(pp_do_mutex
);
103 /* define fixed sized ioctl cmd for y2038 migration */
104 #define PPGETTIME32 _IOR(PP_IOCTL, 0x95, s32[2])
105 #define PPSETTIME32 _IOW(PP_IOCTL, 0x96, s32[2])
106 #define PPGETTIME64 _IOR(PP_IOCTL, 0x95, s64[2])
107 #define PPSETTIME64 _IOW(PP_IOCTL, 0x96, s64[2])
109 static inline void pp_enable_irq(struct pp_struct
*pp
)
111 struct parport
*port
= pp
->pdev
->port
;
113 port
->ops
->enable_irq(port
);
116 static ssize_t
pp_read(struct file
*file
, char __user
*buf
, size_t count
,
119 unsigned int minor
= iminor(file_inode(file
));
120 struct pp_struct
*pp
= file
->private_data
;
122 ssize_t bytes_read
= 0;
123 struct parport
*pport
;
126 if (!(pp
->flags
& PP_CLAIMED
)) {
127 /* Don't have the port claimed */
128 pr_debug(CHRDEV
"%x: claim the port first\n", minor
);
136 kbuffer
= kmalloc(min_t(size_t, count
, PP_BUFFER_SIZE
), GFP_KERNEL
);
139 pport
= pp
->pdev
->port
;
140 mode
= pport
->ieee1284
.mode
& ~(IEEE1284_DEVICEID
| IEEE1284_ADDR
);
142 parport_set_timeout(pp
->pdev
,
143 (file
->f_flags
& O_NONBLOCK
) ?
144 PARPORT_INACTIVITY_O_NONBLOCK
:
145 pp
->default_inactivity
);
147 while (bytes_read
== 0) {
148 ssize_t need
= min_t(unsigned long, count
, PP_BUFFER_SIZE
);
150 if (mode
== IEEE1284_MODE_EPP
) {
151 /* various specials for EPP mode */
153 size_t (*fn
)(struct parport
*, void *, size_t, int);
155 if (pp
->flags
& PP_W91284PIC
)
156 flags
|= PARPORT_W91284PIC
;
157 if (pp
->flags
& PP_FASTREAD
)
158 flags
|= PARPORT_EPP_FAST
;
159 if (pport
->ieee1284
.mode
& IEEE1284_ADDR
)
160 fn
= pport
->ops
->epp_read_addr
;
162 fn
= pport
->ops
->epp_read_data
;
163 bytes_read
= (*fn
)(pport
, kbuffer
, need
, flags
);
165 bytes_read
= parport_read(pport
, kbuffer
, need
);
171 if (file
->f_flags
& O_NONBLOCK
) {
172 bytes_read
= -EAGAIN
;
176 if (signal_pending(current
)) {
177 bytes_read
= -ERESTARTSYS
;
184 parport_set_timeout(pp
->pdev
, pp
->default_inactivity
);
186 if (bytes_read
> 0 && copy_to_user(buf
, kbuffer
, bytes_read
))
187 bytes_read
= -EFAULT
;
194 static ssize_t
pp_write(struct file
*file
, const char __user
*buf
,
195 size_t count
, loff_t
*ppos
)
197 unsigned int minor
= iminor(file_inode(file
));
198 struct pp_struct
*pp
= file
->private_data
;
200 ssize_t bytes_written
= 0;
203 struct parport
*pport
;
205 if (!(pp
->flags
& PP_CLAIMED
)) {
206 /* Don't have the port claimed */
207 pr_debug(CHRDEV
"%x: claim the port first\n", minor
);
211 kbuffer
= kmalloc(min_t(size_t, count
, PP_BUFFER_SIZE
), GFP_KERNEL
);
215 pport
= pp
->pdev
->port
;
216 mode
= pport
->ieee1284
.mode
& ~(IEEE1284_DEVICEID
| IEEE1284_ADDR
);
218 parport_set_timeout(pp
->pdev
,
219 (file
->f_flags
& O_NONBLOCK
) ?
220 PARPORT_INACTIVITY_O_NONBLOCK
:
221 pp
->default_inactivity
);
223 while (bytes_written
< count
) {
224 ssize_t n
= min_t(unsigned long, count
- bytes_written
, PP_BUFFER_SIZE
);
226 if (copy_from_user(kbuffer
, buf
+ bytes_written
, n
)) {
227 bytes_written
= -EFAULT
;
231 if ((pp
->flags
& PP_FASTWRITE
) && (mode
== IEEE1284_MODE_EPP
)) {
232 /* do a fast EPP write */
233 if (pport
->ieee1284
.mode
& IEEE1284_ADDR
) {
234 wrote
= pport
->ops
->epp_write_addr(pport
,
235 kbuffer
, n
, PARPORT_EPP_FAST
);
237 wrote
= pport
->ops
->epp_write_data(pport
,
238 kbuffer
, n
, PARPORT_EPP_FAST
);
241 wrote
= parport_write(pp
->pdev
->port
, kbuffer
, n
);
246 bytes_written
= wrote
;
250 bytes_written
+= wrote
;
252 if (file
->f_flags
& O_NONBLOCK
) {
254 bytes_written
= -EAGAIN
;
258 if (signal_pending(current
))
264 parport_set_timeout(pp
->pdev
, pp
->default_inactivity
);
268 return bytes_written
;
271 static void pp_irq(void *private)
273 struct pp_struct
*pp
= private;
275 if (pp
->irqresponse
) {
276 parport_write_control(pp
->pdev
->port
, pp
->irqctl
);
280 atomic_inc(&pp
->irqc
);
281 wake_up_interruptible(&pp
->irq_wait
);
284 static int register_device(int minor
, struct pp_struct
*pp
)
286 struct parport
*port
;
287 struct pardevice
*pdev
= NULL
;
289 struct pardev_cb ppdev_cb
;
291 name
= kasprintf(GFP_KERNEL
, CHRDEV
"%x", minor
);
295 port
= parport_find_number(minor
);
297 printk(KERN_WARNING
"%s: no associated port!\n", name
);
302 memset(&ppdev_cb
, 0, sizeof(ppdev_cb
));
303 ppdev_cb
.irq_func
= pp_irq
;
304 ppdev_cb
.flags
= (pp
->flags
& PP_EXCL
) ? PARPORT_FLAG_EXCL
: 0;
305 ppdev_cb
.private = pp
;
306 pdev
= parport_register_dev_model(port
, name
, &ppdev_cb
, minor
);
307 parport_put_port(port
);
310 printk(KERN_WARNING
"%s: failed to register device!\n", name
);
316 dev_dbg(&pdev
->dev
, "registered pardevice\n");
320 static enum ieee1284_phase
init_phase(int mode
)
322 switch (mode
& ~(IEEE1284_DEVICEID
324 case IEEE1284_MODE_NIBBLE
:
325 case IEEE1284_MODE_BYTE
:
326 return IEEE1284_PH_REV_IDLE
;
328 return IEEE1284_PH_FWD_IDLE
;
331 static int pp_set_timeout(struct pardevice
*pdev
, long tv_sec
, int tv_usec
)
335 if ((tv_sec
< 0) || (tv_usec
< 0))
338 to_jiffies
= usecs_to_jiffies(tv_usec
);
339 to_jiffies
+= tv_sec
* HZ
;
343 pdev
->timeout
= to_jiffies
;
347 static int pp_do_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
349 unsigned int minor
= iminor(file_inode(file
));
350 struct pp_struct
*pp
= file
->private_data
;
351 struct parport
*port
;
352 void __user
*argp
= (void __user
*)arg
;
354 /* First handle the cases that don't take arguments. */
358 struct ieee1284_info
*info
;
361 if (pp
->flags
& PP_CLAIMED
) {
362 dev_dbg(&pp
->pdev
->dev
, "you've already got it!\n");
366 /* Deferred device registration. */
368 int err
= register_device(minor
, pp
);
374 ret
= parport_claim_or_block(pp
->pdev
);
378 pp
->flags
|= PP_CLAIMED
;
380 /* For interrupt-reporting to work, we need to be
381 * informed of each interrupt. */
384 /* We may need to fix up the state machine. */
385 info
= &pp
->pdev
->port
->ieee1284
;
386 pp
->saved_state
.mode
= info
->mode
;
387 pp
->saved_state
.phase
= info
->phase
;
388 info
->mode
= pp
->state
.mode
;
389 info
->phase
= pp
->state
.phase
;
390 pp
->default_inactivity
= parport_set_timeout(pp
->pdev
, 0);
391 parport_set_timeout(pp
->pdev
, pp
->default_inactivity
);
397 dev_dbg(&pp
->pdev
->dev
,
398 "too late for PPEXCL; already registered\n");
399 if (pp
->flags
& PP_EXCL
)
400 /* But it's not really an error. */
402 /* There's no chance of making the driver happy. */
406 /* Just remember to register the device exclusively
407 * when we finally do the registration. */
408 pp
->flags
|= PP_EXCL
;
414 if (copy_from_user(&mode
, argp
, sizeof(mode
)))
416 /* FIXME: validate mode */
417 pp
->state
.mode
= mode
;
418 pp
->state
.phase
= init_phase(mode
);
420 if (pp
->flags
& PP_CLAIMED
) {
421 pp
->pdev
->port
->ieee1284
.mode
= mode
;
422 pp
->pdev
->port
->ieee1284
.phase
= pp
->state
.phase
;
431 if (pp
->flags
& PP_CLAIMED
)
432 mode
= pp
->pdev
->port
->ieee1284
.mode
;
434 mode
= pp
->state
.mode
;
436 if (copy_to_user(argp
, &mode
, sizeof(mode
)))
444 if (copy_from_user(&phase
, argp
, sizeof(phase
)))
447 /* FIXME: validate phase */
448 pp
->state
.phase
= phase
;
450 if (pp
->flags
& PP_CLAIMED
)
451 pp
->pdev
->port
->ieee1284
.phase
= phase
;
459 if (pp
->flags
& PP_CLAIMED
)
460 phase
= pp
->pdev
->port
->ieee1284
.phase
;
462 phase
= pp
->state
.phase
;
463 if (copy_to_user(argp
, &phase
, sizeof(phase
)))
471 port
= parport_find_number(minor
);
476 parport_put_port(port
);
477 if (copy_to_user(argp
, &modes
, sizeof(modes
)))
485 if (copy_from_user(&uflags
, argp
, sizeof(uflags
)))
487 pp
->flags
&= ~PP_FLAGMASK
;
488 pp
->flags
|= (uflags
& PP_FLAGMASK
);
495 uflags
= pp
->flags
& PP_FLAGMASK
;
496 if (copy_to_user(argp
, &uflags
, sizeof(uflags
)))
502 /* Everything else requires the port to be claimed, so check
504 if ((pp
->flags
& PP_CLAIMED
) == 0) {
505 pr_debug(CHRDEV
"%x: claim the port first\n", minor
);
509 port
= pp
->pdev
->port
;
511 struct ieee1284_info
*info
;
517 struct timespec64 ts
;
521 reg
= parport_read_status(port
);
522 if (copy_to_user(argp
, ®
, sizeof(reg
)))
526 reg
= parport_read_data(port
);
527 if (copy_to_user(argp
, ®
, sizeof(reg
)))
531 reg
= parport_read_control(port
);
532 if (copy_to_user(argp
, ®
, sizeof(reg
)))
536 parport_yield_blocking(pp
->pdev
);
540 /* Save the state machine's state. */
541 info
= &pp
->pdev
->port
->ieee1284
;
542 pp
->state
.mode
= info
->mode
;
543 pp
->state
.phase
= info
->phase
;
544 info
->mode
= pp
->saved_state
.mode
;
545 info
->phase
= pp
->saved_state
.phase
;
546 parport_release(pp
->pdev
);
547 pp
->flags
&= ~PP_CLAIMED
;
551 if (copy_from_user(®
, argp
, sizeof(reg
)))
553 parport_write_control(port
, reg
);
557 if (copy_from_user(®
, argp
, sizeof(reg
)))
559 parport_write_data(port
, reg
);
563 if (copy_from_user(&mask
, argp
,
566 if (copy_from_user(®
, 1 + (unsigned char __user
*) arg
,
569 parport_frob_control(port
, mask
, reg
);
573 if (copy_from_user(&mode
, argp
, sizeof(mode
)))
576 port
->ops
->data_reverse(port
);
578 port
->ops
->data_forward(port
);
582 if (copy_from_user(&mode
, argp
, sizeof(mode
)))
584 switch ((ret
= parport_negotiate(port
, mode
))) {
586 case -1: /* handshake failed, peripheral not IEEE 1284 */
589 case 1: /* handshake succeeded, peripheral rejected mode */
597 if (copy_from_user(®
, argp
, sizeof(reg
)))
600 /* Remember what to set the control lines to, for next
601 * time we get an interrupt. */
607 ret
= atomic_read(&pp
->irqc
);
608 if (copy_to_user(argp
, &ret
, sizeof(ret
)))
610 atomic_sub(ret
, &pp
->irqc
);
614 if (copy_from_user(time32
, argp
, sizeof(time32
)))
617 return pp_set_timeout(pp
->pdev
, time32
[0], time32
[1]);
620 if (copy_from_user(time64
, argp
, sizeof(time64
)))
623 return pp_set_timeout(pp
->pdev
, time64
[0], time64
[1]);
626 jiffies_to_timespec64(pp
->pdev
->timeout
, &ts
);
627 time32
[0] = ts
.tv_sec
;
628 time32
[1] = ts
.tv_nsec
/ NSEC_PER_USEC
;
629 if ((time32
[0] < 0) || (time32
[1] < 0))
632 if (copy_to_user(argp
, time32
, sizeof(time32
)))
638 jiffies_to_timespec64(pp
->pdev
->timeout
, &ts
);
639 time64
[0] = ts
.tv_sec
;
640 time64
[1] = ts
.tv_nsec
/ NSEC_PER_USEC
;
641 if ((time64
[0] < 0) || (time64
[1] < 0))
644 if (copy_to_user(argp
, time64
, sizeof(time64
)))
650 dev_dbg(&pp
->pdev
->dev
, "What? (cmd=0x%x)\n", cmd
);
654 /* Keep the compiler happy */
658 static long pp_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
662 mutex_lock(&pp_do_mutex
);
663 ret
= pp_do_ioctl(file
, cmd
, arg
);
664 mutex_unlock(&pp_do_mutex
);
669 static long pp_compat_ioctl(struct file
*file
, unsigned int cmd
,
672 return pp_ioctl(file
, cmd
, (unsigned long)compat_ptr(arg
));
676 static int pp_open(struct inode
*inode
, struct file
*file
)
678 unsigned int minor
= iminor(inode
);
679 struct pp_struct
*pp
;
681 if (minor
>= PARPORT_MAX
)
684 pp
= kmalloc(sizeof(struct pp_struct
), GFP_KERNEL
);
688 pp
->state
.mode
= IEEE1284_MODE_COMPAT
;
689 pp
->state
.phase
= init_phase(pp
->state
.mode
);
692 atomic_set(&pp
->irqc
, 0);
693 init_waitqueue_head(&pp
->irq_wait
);
695 /* Defer the actual device registration until the first claim.
696 * That way, we know whether or not the driver wants to have
697 * exclusive access to the port (PPEXCL).
700 file
->private_data
= pp
;
705 static int pp_release(struct inode
*inode
, struct file
*file
)
707 unsigned int minor
= iminor(inode
);
708 struct pp_struct
*pp
= file
->private_data
;
712 if (!(pp
->flags
& PP_CLAIMED
) && pp
->pdev
&&
713 (pp
->state
.mode
!= IEEE1284_MODE_COMPAT
)) {
714 struct ieee1284_info
*info
;
716 /* parport released, but not in compatibility mode */
717 parport_claim_or_block(pp
->pdev
);
718 pp
->flags
|= PP_CLAIMED
;
719 info
= &pp
->pdev
->port
->ieee1284
;
720 pp
->saved_state
.mode
= info
->mode
;
721 pp
->saved_state
.phase
= info
->phase
;
722 info
->mode
= pp
->state
.mode
;
723 info
->phase
= pp
->state
.phase
;
725 } else if ((pp
->flags
& PP_CLAIMED
) && pp
->pdev
&&
726 (pp
->pdev
->port
->ieee1284
.mode
!= IEEE1284_MODE_COMPAT
)) {
730 parport_negotiate(pp
->pdev
->port
, IEEE1284_MODE_COMPAT
);
731 dev_dbg(&pp
->pdev
->dev
,
732 "negotiated back to compatibility mode because user-space forgot\n");
735 if (pp
->flags
& PP_CLAIMED
) {
736 struct ieee1284_info
*info
;
738 info
= &pp
->pdev
->port
->ieee1284
;
739 pp
->state
.mode
= info
->mode
;
740 pp
->state
.phase
= info
->phase
;
741 info
->mode
= pp
->saved_state
.mode
;
742 info
->phase
= pp
->saved_state
.phase
;
743 parport_release(pp
->pdev
);
744 if (compat_negot
!= 1) {
745 pr_debug(CHRDEV
"%x: released pardevice "
746 "because user-space forgot\n", minor
);
751 const char *name
= pp
->pdev
->name
;
753 parport_unregister_device(pp
->pdev
);
756 pr_debug(CHRDEV
"%x: unregistered pardevice\n", minor
);
764 /* No kernel lock held - fine */
765 static unsigned int pp_poll(struct file
*file
, poll_table
*wait
)
767 struct pp_struct
*pp
= file
->private_data
;
768 unsigned int mask
= 0;
770 poll_wait(file
, &pp
->irq_wait
, wait
);
771 if (atomic_read(&pp
->irqc
))
772 mask
|= POLLIN
| POLLRDNORM
;
777 static struct class *ppdev_class
;
779 static const struct file_operations pp_fops
= {
780 .owner
= THIS_MODULE
,
785 .unlocked_ioctl
= pp_ioctl
,
787 .compat_ioctl
= pp_compat_ioctl
,
790 .release
= pp_release
,
793 static void pp_attach(struct parport
*port
)
795 device_create(ppdev_class
, port
->dev
, MKDEV(PP_MAJOR
, port
->number
),
796 NULL
, "parport%d", port
->number
);
799 static void pp_detach(struct parport
*port
)
801 device_destroy(ppdev_class
, MKDEV(PP_MAJOR
, port
->number
));
804 static int pp_probe(struct pardevice
*par_dev
)
806 struct device_driver
*drv
= par_dev
->dev
.driver
;
807 int len
= strlen(drv
->name
);
809 if (strncmp(par_dev
->name
, drv
->name
, len
))
815 static struct parport_driver pp_driver
= {
818 .match_port
= pp_attach
,
823 static int __init
ppdev_init(void)
827 if (register_chrdev(PP_MAJOR
, CHRDEV
, &pp_fops
)) {
828 printk(KERN_WARNING CHRDEV
": unable to get major %d\n",
832 ppdev_class
= class_create(THIS_MODULE
, CHRDEV
);
833 if (IS_ERR(ppdev_class
)) {
834 err
= PTR_ERR(ppdev_class
);
837 err
= parport_register_driver(&pp_driver
);
839 printk(KERN_WARNING CHRDEV
": unable to register with parport\n");
843 printk(KERN_INFO PP_VERSION
"\n");
847 class_destroy(ppdev_class
);
849 unregister_chrdev(PP_MAJOR
, CHRDEV
);
854 static void __exit
ppdev_cleanup(void)
856 /* Clean up all parport stuff */
857 parport_unregister_driver(&pp_driver
);
858 class_destroy(ppdev_class
);
859 unregister_chrdev(PP_MAJOR
, CHRDEV
);
862 module_init(ppdev_init
);
863 module_exit(ppdev_cleanup
);
865 MODULE_LICENSE("GPL");
866 MODULE_ALIAS_CHARDEV_MAJOR(PP_MAJOR
);