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.
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.
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
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;
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 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 dev_dbg(&pdev->dev, "registered pardevice\n");
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_set_timeout(struct pardevice *pdev, long tv_sec, int tv_usec)
333 if ((tv_sec < 0) || (tv_usec < 0))
336 to_jiffies = usecs_to_jiffies(tv_usec);
337 to_jiffies += tv_sec * HZ;
341 pdev->timeout = to_jiffies;
345 static int pp_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
347 unsigned int minor = iminor(file_inode(file));
348 struct pp_struct *pp = file->private_data;
349 struct parport *port;
350 void __user *argp = (void __user *)arg;
352 /* First handle the cases that don't take arguments. */
356 struct ieee1284_info *info;
359 if (pp->flags & PP_CLAIMED) {
360 dev_dbg(&pp->pdev->dev, "you've already got it!\n");
364 /* Deferred device registration. */
366 int err = register_device(minor, pp);
372 ret = parport_claim_or_block(pp->pdev);
376 pp->flags |= PP_CLAIMED;
378 /* For interrupt-reporting to work, we need to be
379 * informed of each interrupt. */
382 /* We may need to fix up the state machine. */
383 info = &pp->pdev->port->ieee1284;
384 pp->saved_state.mode = info->mode;
385 pp->saved_state.phase = info->phase;
386 info->mode = pp->state.mode;
387 info->phase = pp->state.phase;
388 pp->default_inactivity = parport_set_timeout(pp->pdev, 0);
389 parport_set_timeout(pp->pdev, pp->default_inactivity);
395 dev_dbg(&pp->pdev->dev,
396 "too late for PPEXCL; already registered\n");
397 if (pp->flags & PP_EXCL)
398 /* But it's not really an error. */
400 /* There's no chance of making the driver happy. */
404 /* Just remember to register the device exclusively
405 * when we finally do the registration. */
406 pp->flags |= PP_EXCL;
412 if (copy_from_user(&mode, argp, sizeof(mode)))
414 /* FIXME: validate mode */
415 pp->state.mode = mode;
416 pp->state.phase = init_phase(mode);
418 if (pp->flags & PP_CLAIMED) {
419 pp->pdev->port->ieee1284.mode = mode;
420 pp->pdev->port->ieee1284.phase = pp->state.phase;
429 if (pp->flags & PP_CLAIMED)
430 mode = pp->pdev->port->ieee1284.mode;
432 mode = pp->state.mode;
434 if (copy_to_user(argp, &mode, sizeof(mode)))
442 if (copy_from_user(&phase, argp, sizeof(phase)))
445 /* FIXME: validate phase */
446 pp->state.phase = phase;
448 if (pp->flags & PP_CLAIMED)
449 pp->pdev->port->ieee1284.phase = phase;
457 if (pp->flags & PP_CLAIMED)
458 phase = pp->pdev->port->ieee1284.phase;
460 phase = pp->state.phase;
461 if (copy_to_user(argp, &phase, sizeof(phase)))
469 port = parport_find_number(minor);
474 parport_put_port(port);
475 if (copy_to_user(argp, &modes, sizeof(modes)))
483 if (copy_from_user(&uflags, argp, sizeof(uflags)))
485 pp->flags &= ~PP_FLAGMASK;
486 pp->flags |= (uflags & PP_FLAGMASK);
493 uflags = pp->flags & PP_FLAGMASK;
494 if (copy_to_user(argp, &uflags, sizeof(uflags)))
500 /* Everything else requires the port to be claimed, so check
502 if ((pp->flags & PP_CLAIMED) == 0) {
503 pr_debug(CHRDEV "%x: claim the port first\n", minor);
507 port = pp->pdev->port;
509 struct ieee1284_info *info;
515 struct timespec64 ts;
519 reg = parport_read_status(port);
520 if (copy_to_user(argp, ®, sizeof(reg)))
524 reg = parport_read_data(port);
525 if (copy_to_user(argp, ®, sizeof(reg)))
529 reg = parport_read_control(port);
530 if (copy_to_user(argp, ®, sizeof(reg)))
534 parport_yield_blocking(pp->pdev);
538 /* Save the state machine's state. */
539 info = &pp->pdev->port->ieee1284;
540 pp->state.mode = info->mode;
541 pp->state.phase = info->phase;
542 info->mode = pp->saved_state.mode;
543 info->phase = pp->saved_state.phase;
544 parport_release(pp->pdev);
545 pp->flags &= ~PP_CLAIMED;
549 if (copy_from_user(®, argp, sizeof(reg)))
551 parport_write_control(port, reg);
555 if (copy_from_user(®, argp, sizeof(reg)))
557 parport_write_data(port, reg);
561 if (copy_from_user(&mask, argp,
564 if (copy_from_user(®, 1 + (unsigned char __user *) arg,
567 parport_frob_control(port, mask, reg);
571 if (copy_from_user(&mode, argp, sizeof(mode)))
574 port->ops->data_reverse(port);
576 port->ops->data_forward(port);
580 if (copy_from_user(&mode, argp, sizeof(mode)))
582 switch ((ret = parport_negotiate(port, mode))) {
584 case -1: /* handshake failed, peripheral not IEEE 1284 */
587 case 1: /* handshake succeeded, peripheral rejected mode */
595 if (copy_from_user(®, argp, sizeof(reg)))
598 /* Remember what to set the control lines to, for next
599 * time we get an interrupt. */
605 ret = atomic_read(&pp->irqc);
606 if (copy_to_user(argp, &ret, sizeof(ret)))
608 atomic_sub(ret, &pp->irqc);
612 if (copy_from_user(time32, argp, sizeof(time32)))
615 return pp_set_timeout(pp->pdev, time32[0], time32[1]);
618 if (copy_from_user(time64, argp, sizeof(time64)))
621 return pp_set_timeout(pp->pdev, time64[0], time64[1]);
624 jiffies_to_timespec64(pp->pdev->timeout, &ts);
625 time32[0] = ts.tv_sec;
626 time32[1] = ts.tv_nsec / NSEC_PER_USEC;
627 if ((time32[0] < 0) || (time32[1] < 0))
630 if (copy_to_user(argp, time32, sizeof(time32)))
636 jiffies_to_timespec64(pp->pdev->timeout, &ts);
637 time64[0] = ts.tv_sec;
638 time64[1] = ts.tv_nsec / NSEC_PER_USEC;
639 if ((time64[0] < 0) || (time64[1] < 0))
642 if (copy_to_user(argp, time64, sizeof(time64)))
648 dev_dbg(&pp->pdev->dev, "What? (cmd=0x%x)\n", cmd);
652 /* Keep the compiler happy */
656 static long pp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
660 mutex_lock(&pp_do_mutex);
661 ret = pp_do_ioctl(file, cmd, arg);
662 mutex_unlock(&pp_do_mutex);
667 static long pp_compat_ioctl(struct file *file, unsigned int cmd,
670 return pp_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
674 static int pp_open(struct inode *inode, struct file *file)
676 unsigned int minor = iminor(inode);
677 struct pp_struct *pp;
679 if (minor >= PARPORT_MAX)
682 pp = kmalloc(sizeof(struct pp_struct), GFP_KERNEL);
686 pp->state.mode = IEEE1284_MODE_COMPAT;
687 pp->state.phase = init_phase(pp->state.mode);
690 atomic_set(&pp->irqc, 0);
691 init_waitqueue_head(&pp->irq_wait);
693 /* Defer the actual device registration until the first claim.
694 * That way, we know whether or not the driver wants to have
695 * exclusive access to the port (PPEXCL).
698 file->private_data = pp;
703 static int pp_release(struct inode *inode, struct file *file)
705 unsigned int minor = iminor(inode);
706 struct pp_struct *pp = file->private_data;
710 if (!(pp->flags & PP_CLAIMED) && pp->pdev &&
711 (pp->state.mode != IEEE1284_MODE_COMPAT)) {
712 struct ieee1284_info *info;
714 /* parport released, but not in compatibility mode */
715 parport_claim_or_block(pp->pdev);
716 pp->flags |= PP_CLAIMED;
717 info = &pp->pdev->port->ieee1284;
718 pp->saved_state.mode = info->mode;
719 pp->saved_state.phase = info->phase;
720 info->mode = pp->state.mode;
721 info->phase = pp->state.phase;
723 } else if ((pp->flags & PP_CLAIMED) && pp->pdev &&
724 (pp->pdev->port->ieee1284.mode != IEEE1284_MODE_COMPAT)) {
728 parport_negotiate(pp->pdev->port, IEEE1284_MODE_COMPAT);
729 dev_dbg(&pp->pdev->dev,
730 "negotiated back to compatibility mode because user-space forgot\n");
733 if (pp->flags & PP_CLAIMED) {
734 struct ieee1284_info *info;
736 info = &pp->pdev->port->ieee1284;
737 pp->state.mode = info->mode;
738 pp->state.phase = info->phase;
739 info->mode = pp->saved_state.mode;
740 info->phase = pp->saved_state.phase;
741 parport_release(pp->pdev);
742 if (compat_negot != 1) {
743 pr_debug(CHRDEV "%x: released pardevice "
744 "because user-space forgot\n", minor);
749 const char *name = pp->pdev->name;
751 parport_unregister_device(pp->pdev);
754 pr_debug(CHRDEV "%x: unregistered pardevice\n", minor);
762 /* No kernel lock held - fine */
763 static unsigned int pp_poll(struct file *file, poll_table *wait)
765 struct pp_struct *pp = file->private_data;
766 unsigned int mask = 0;
768 poll_wait(file, &pp->irq_wait, wait);
769 if (atomic_read(&pp->irqc))
770 mask |= POLLIN | POLLRDNORM;
775 static struct class *ppdev_class;
777 static const struct file_operations pp_fops = {
778 .owner = THIS_MODULE,
783 .unlocked_ioctl = pp_ioctl,
785 .compat_ioctl = pp_compat_ioctl,
788 .release = pp_release,
791 static void pp_attach(struct parport *port)
793 device_create(ppdev_class, port->dev, MKDEV(PP_MAJOR, port->number),
794 NULL, "parport%d", port->number);
797 static void pp_detach(struct parport *port)
799 device_destroy(ppdev_class, MKDEV(PP_MAJOR, port->number));
802 static struct parport_driver pp_driver = {
808 static int __init ppdev_init(void)
812 if (register_chrdev(PP_MAJOR, CHRDEV, &pp_fops)) {
813 printk(KERN_WARNING CHRDEV ": unable to get major %d\n",
817 ppdev_class = class_create(THIS_MODULE, CHRDEV);
818 if (IS_ERR(ppdev_class)) {
819 err = PTR_ERR(ppdev_class);
822 err = parport_register_driver(&pp_driver);
824 printk(KERN_WARNING CHRDEV ": unable to register with parport\n");
828 printk(KERN_INFO PP_VERSION "\n");
832 class_destroy(ppdev_class);
834 unregister_chrdev(PP_MAJOR, CHRDEV);
839 static void __exit ppdev_cleanup(void)
841 /* Clean up all parport stuff */
842 parport_unregister_driver(&pp_driver);
843 class_destroy(ppdev_class);
844 unregister_chrdev(PP_MAJOR, CHRDEV);
847 module_init(ppdev_init);
848 module_exit(ppdev_cleanup);
850 MODULE_LICENSE("GPL");
851 MODULE_ALIAS_CHARDEV_MAJOR(PP_MAJOR);