blob: 39dedb775d5fe605c5b64c34cc007bf255b0b4f7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/ppdev.c
3 *
4 * This is the code behind /dev/parport* -- it allows a user-space
5 * application to use the parport subsystem.
6 *
7 * Copyright (C) 1998-2000, 2002 Tim Waugh <tim@cyberelk.net>
8 *
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.
13 *
14 * A /dev/parportx device node represents an arbitrary device
15 * on port 'x'. The following operations are possible:
16 *
17 * open do nothing, set up default IEEE 1284 protocol to be COMPAT
18 * close release port and unregister device (if necessary)
19 * ioctl
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
27 * WDATA write_data
28 * RDATA read_data
29 * WCONTROL write_control
30 * RCONTROL read_control
31 * FCONTROL frob_control
32 * RSTATUS read_status
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)
46 *
47 * Changes:
48 * Added SETTIME/GETTIME ioctl, Fred Barnes, 1999.
49 *
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
53 * space errors.
54 *
55 * Added GETMODES/GETMODE/GETPHASE ioctls, Fred Barnes <frmb2@ukc.ac.uk>, 03/01/2001.
56 * Added GETFLAGS/SETFLAGS ioctls, Fred Barnes, 04/2001
57 */
58
59#include <linux/module.h>
60#include <linux/init.h>
61#include <linux/sched.h>
62#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#include <linux/ioctl.h>
64#include <linux/parport.h>
65#include <linux/ctype.h>
66#include <linux/poll.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090067#include <linux/slab.h>
Rene Hermane6a67842006-03-25 03:07:13 -080068#include <linux/major.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <linux/ppdev.h>
Arnd Bergmann613655f2010-06-02 14:28:52 +020070#include <linux/mutex.h>
Alan Cox6d535d32008-07-25 01:48:16 -070071#include <linux/uaccess.h>
Bamvor Jian Zhang17a35962016-01-08 15:50:49 +080072#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74#define PP_VERSION "ppdev: user-space parallel port driver"
75#define CHRDEV "ppdev"
76
77struct pp_struct {
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +053078 struct pardevice *pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 wait_queue_head_t irq_wait;
80 atomic_t irqc;
81 unsigned int flags;
82 int irqresponse;
83 unsigned char irqctl;
84 struct ieee1284_info state;
85 struct ieee1284_info saved_state;
86 long default_inactivity;
87};
88
89/* pp_struct.flags bitfields */
90#define PP_CLAIMED (1<<0)
91#define PP_EXCL (1<<1)
92
93/* Other constants */
94#define PP_INTERRUPT_TIMEOUT (10 * HZ) /* 10s */
95#define PP_BUFFER_SIZE 1024
96#define PARDEVICE_MAX 8
97
98/* ROUND_UP macro from fs/select.c */
99#define ROUND_UP(x,y) (((x)+(y)-1)/(y))
100
Arnd Bergmann613655f2010-06-02 14:28:52 +0200101static DEFINE_MUTEX(pp_do_mutex);
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800102
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])
108
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530109static inline void pp_enable_irq(struct pp_struct *pp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
111 struct parport *port = pp->pdev->port;
Sudip Mukherjee27f3b8a2016-02-12 18:33:41 +0530112
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530113 port->ops->enable_irq(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114}
115
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530116static ssize_t pp_read(struct file *file, char __user *buf, size_t count,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530117 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
Al Viro496ad9a2013-01-23 17:07:38 -0500119 unsigned int minor = iminor(file_inode(file));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 struct pp_struct *pp = file->private_data;
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530121 char *kbuffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 ssize_t bytes_read = 0;
123 struct parport *pport;
124 int mode;
125
126 if (!(pp->flags & PP_CLAIMED)) {
127 /* Don't have the port claimed */
Michael Buesch81fc4012009-06-17 16:27:49 -0700128 pr_debug(CHRDEV "%x: claim the port first\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 return -EINVAL;
130 }
131
132 /* Trivial case. */
133 if (count == 0)
134 return 0;
135
136 kbuffer = kmalloc(min_t(size_t, count, PP_BUFFER_SIZE), GFP_KERNEL);
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530137 if (!kbuffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 pport = pp->pdev->port;
140 mode = pport->ieee1284.mode & ~(IEEE1284_DEVICEID | IEEE1284_ADDR);
141
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530142 parport_set_timeout(pp->pdev,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530143 (file->f_flags & O_NONBLOCK) ?
144 PARPORT_INACTIVITY_O_NONBLOCK :
145 pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147 while (bytes_read == 0) {
148 ssize_t need = min_t(unsigned long, count, PP_BUFFER_SIZE);
149
150 if (mode == IEEE1284_MODE_EPP) {
151 /* various specials for EPP mode */
152 int flags = 0;
153 size_t (*fn)(struct parport *, void *, size_t, int);
154
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530155 if (pp->flags & PP_W91284PIC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 flags |= PARPORT_W91284PIC;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530157 if (pp->flags & PP_FASTREAD)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 flags |= PARPORT_EPP_FAST;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530159 if (pport->ieee1284.mode & IEEE1284_ADDR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 fn = pport->ops->epp_read_addr;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530161 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 fn = pport->ops->epp_read_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 bytes_read = (*fn)(pport, kbuffer, need, flags);
164 } else {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530165 bytes_read = parport_read(pport, kbuffer, need);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 }
167
168 if (bytes_read != 0)
169 break;
170
171 if (file->f_flags & O_NONBLOCK) {
172 bytes_read = -EAGAIN;
173 break;
174 }
175
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530176 if (signal_pending(current)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 bytes_read = -ERESTARTSYS;
178 break;
179 }
180
181 cond_resched();
182 }
183
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530184 parport_set_timeout(pp->pdev, pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530186 if (bytes_read > 0 && copy_to_user(buf, kbuffer, bytes_read))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 bytes_read = -EFAULT;
188
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530189 kfree(kbuffer);
190 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return bytes_read;
192}
193
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530194static ssize_t pp_write(struct file *file, const char __user *buf,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530195 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
Al Viro496ad9a2013-01-23 17:07:38 -0500197 unsigned int minor = iminor(file_inode(file));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 struct pp_struct *pp = file->private_data;
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530199 char *kbuffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 ssize_t bytes_written = 0;
201 ssize_t wrote;
202 int mode;
203 struct parport *pport;
204
205 if (!(pp->flags & PP_CLAIMED)) {
206 /* Don't have the port claimed */
Michael Buesch81fc4012009-06-17 16:27:49 -0700207 pr_debug(CHRDEV "%x: claim the port first\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 return -EINVAL;
209 }
210
211 kbuffer = kmalloc(min_t(size_t, count, PP_BUFFER_SIZE), GFP_KERNEL);
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530212 if (!kbuffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 return -ENOMEM;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 pport = pp->pdev->port;
216 mode = pport->ieee1284.mode & ~(IEEE1284_DEVICEID | IEEE1284_ADDR);
217
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530218 parport_set_timeout(pp->pdev,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530219 (file->f_flags & O_NONBLOCK) ?
220 PARPORT_INACTIVITY_O_NONBLOCK :
221 pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 while (bytes_written < count) {
224 ssize_t n = min_t(unsigned long, count - bytes_written, PP_BUFFER_SIZE);
225
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530226 if (copy_from_user(kbuffer, buf + bytes_written, n)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 bytes_written = -EFAULT;
228 break;
229 }
230
231 if ((pp->flags & PP_FASTWRITE) && (mode == IEEE1284_MODE_EPP)) {
232 /* do a fast EPP write */
233 if (pport->ieee1284.mode & IEEE1284_ADDR) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530234 wrote = pport->ops->epp_write_addr(pport,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 kbuffer, n, PARPORT_EPP_FAST);
236 } else {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530237 wrote = pport->ops->epp_write_data(pport,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 kbuffer, n, PARPORT_EPP_FAST);
239 }
240 } else {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530241 wrote = parport_write(pp->pdev->port, kbuffer, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 }
243
244 if (wrote <= 0) {
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530245 if (!bytes_written)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 bytes_written = wrote;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 break;
248 }
249
250 bytes_written += wrote;
251
252 if (file->f_flags & O_NONBLOCK) {
253 if (!bytes_written)
254 bytes_written = -EAGAIN;
255 break;
256 }
257
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530258 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 cond_resched();
262 }
263
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530264 parport_set_timeout(pp->pdev, pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530266 kfree(kbuffer);
267 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return bytes_written;
269}
270
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530271static void pp_irq(void *private)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272{
Jeff Garzik5712cb32007-10-19 02:54:26 -0400273 struct pp_struct *pp = private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275 if (pp->irqresponse) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530276 parport_write_control(pp->pdev->port, pp->irqctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 pp->irqresponse = 0;
278 }
279
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530280 atomic_inc(&pp->irqc);
281 wake_up_interruptible(&pp->irq_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530284static int register_device(int minor, struct pp_struct *pp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
286 struct parport *port;
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530287 struct pardevice *pdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 char *name;
289 int fl;
290
Julia Lawall87575432010-05-26 14:43:55 -0700291 name = kasprintf(GFP_KERNEL, CHRDEV "%x", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 if (name == NULL)
293 return -ENOMEM;
294
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530295 port = parport_find_number(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (!port) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530297 printk(KERN_WARNING "%s: no associated port!\n", name);
298 kfree(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 return -ENXIO;
300 }
301
302 fl = (pp->flags & PP_EXCL) ? PARPORT_FLAG_EXCL : 0;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530303 pdev = parport_register_device(port, name, NULL,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530304 NULL, pp_irq, fl, pp);
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530305 parport_put_port(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307 if (!pdev) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530308 printk(KERN_WARNING "%s: failed to register device!\n", name);
309 kfree(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 return -ENXIO;
311 }
312
313 pp->pdev = pdev;
Michael Buesch81fc4012009-06-17 16:27:49 -0700314 pr_debug("%s: registered pardevice\n", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return 0;
316}
317
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530318static enum ieee1284_phase init_phase(int mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319{
320 switch (mode & ~(IEEE1284_DEVICEID
321 | IEEE1284_ADDR)) {
322 case IEEE1284_MODE_NIBBLE:
323 case IEEE1284_MODE_BYTE:
324 return IEEE1284_PH_REV_IDLE;
325 }
326 return IEEE1284_PH_FWD_IDLE;
327}
328
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800329static int pp_set_timeout(struct pardevice *pdev, long tv_sec, int tv_usec)
330{
331 long to_jiffies;
332
333 if ((tv_sec < 0) || (tv_usec < 0))
334 return -EINVAL;
335
336 to_jiffies = usecs_to_jiffies(tv_usec);
337 to_jiffies += tv_sec * HZ;
338 if (to_jiffies <= 0)
339 return -EINVAL;
340
341 pdev->timeout = to_jiffies;
342 return 0;
343}
344
Alan Cox6d535d32008-07-25 01:48:16 -0700345static int pp_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
Al Viro496ad9a2013-01-23 17:07:38 -0500347 unsigned int minor = iminor(file_inode(file));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 struct pp_struct *pp = file->private_data;
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530349 struct parport *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 void __user *argp = (void __user *)arg;
351
352 /* First handle the cases that don't take arguments. */
353 switch (cmd) {
354 case PPCLAIM:
355 {
356 struct ieee1284_info *info;
357 int ret;
358
359 if (pp->flags & PP_CLAIMED) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700360 pr_debug(CHRDEV "%x: you've already got it!\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 return -EINVAL;
362 }
363
364 /* Deferred device registration. */
365 if (!pp->pdev) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530366 int err = register_device(minor, pp);
Sudip Mukherjee27f3b8a2016-02-12 18:33:41 +0530367
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530368 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 }
371
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530372 ret = parport_claim_or_block(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 if (ret < 0)
374 return ret;
375
376 pp->flags |= PP_CLAIMED;
377
378 /* For interrupt-reporting to work, we need to be
379 * informed of each interrupt. */
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530380 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
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;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530388 pp->default_inactivity = parport_set_timeout(pp->pdev, 0);
389 parport_set_timeout(pp->pdev, pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 return 0;
392 }
393 case PPEXCL:
394 if (pp->pdev) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700395 pr_debug(CHRDEV "%x: too late for PPEXCL; "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 "already registered\n", minor);
397 if (pp->flags & PP_EXCL)
398 /* But it's not really an error. */
399 return 0;
400 /* There's no chance of making the driver happy. */
401 return -EINVAL;
402 }
403
404 /* Just remember to register the device exclusively
405 * when we finally do the registration. */
406 pp->flags |= PP_EXCL;
407 return 0;
408 case PPSETMODE:
409 {
410 int mode;
Sudip Mukherjee27f3b8a2016-02-12 18:33:41 +0530411
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530412 if (copy_from_user(&mode, argp, sizeof(mode)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 return -EFAULT;
414 /* FIXME: validate mode */
415 pp->state.mode = mode;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530416 pp->state.phase = init_phase(mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
418 if (pp->flags & PP_CLAIMED) {
419 pp->pdev->port->ieee1284.mode = mode;
420 pp->pdev->port->ieee1284.phase = pp->state.phase;
421 }
422
423 return 0;
424 }
425 case PPGETMODE:
426 {
427 int mode;
428
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530429 if (pp->flags & PP_CLAIMED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 mode = pp->pdev->port->ieee1284.mode;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530431 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 mode = pp->state.mode;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530433
434 if (copy_to_user(argp, &mode, sizeof(mode)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 return 0;
437 }
438 case PPSETPHASE:
439 {
440 int phase;
Sudip Mukherjee27f3b8a2016-02-12 18:33:41 +0530441
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530442 if (copy_from_user(&phase, argp, sizeof(phase)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 return -EFAULT;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 /* FIXME: validate phase */
446 pp->state.phase = phase;
447
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530448 if (pp->flags & PP_CLAIMED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 pp->pdev->port->ieee1284.phase = phase;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451 return 0;
452 }
453 case PPGETPHASE:
454 {
455 int phase;
456
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530457 if (pp->flags & PP_CLAIMED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 phase = pp->pdev->port->ieee1284.phase;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530459 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 phase = pp->state.phase;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530461 if (copy_to_user(argp, &phase, sizeof(phase)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 return 0;
464 }
465 case PPGETMODES:
466 {
467 unsigned int modes;
468
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530469 port = parport_find_number(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 if (!port)
471 return -ENODEV;
472
473 modes = port->modes;
Julia Lawalld98808a2011-05-26 16:25:59 -0700474 parport_put_port(port);
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530475 if (copy_to_user(argp, &modes, sizeof(modes)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 return 0;
478 }
479 case PPSETFLAGS:
480 {
481 int uflags;
482
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530483 if (copy_from_user(&uflags, argp, sizeof(uflags)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 pp->flags &= ~PP_FLAGMASK;
486 pp->flags |= (uflags & PP_FLAGMASK);
487 return 0;
488 }
489 case PPGETFLAGS:
490 {
491 int uflags;
492
493 uflags = pp->flags & PP_FLAGMASK;
Sudip Mukherjee83e80602016-02-12 18:33:42 +0530494 if (copy_to_user(argp, &uflags, sizeof(uflags)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 return 0;
497 }
498 } /* end switch() */
499
500 /* Everything else requires the port to be claimed, so check
501 * that now. */
502 if ((pp->flags & PP_CLAIMED) == 0) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700503 pr_debug(CHRDEV "%x: claim the port first\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 return -EINVAL;
505 }
506
507 port = pp->pdev->port;
508 switch (cmd) {
509 struct ieee1284_info *info;
510 unsigned char reg;
511 unsigned char mask;
512 int mode;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800513 s32 time32[2];
514 s64 time64[2];
515 struct timespec64 ts;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518 case PPRSTATUS:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530519 reg = parport_read_status(port);
520 if (copy_to_user(argp, &reg, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 return -EFAULT;
522 return 0;
523 case PPRDATA:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530524 reg = parport_read_data(port);
525 if (copy_to_user(argp, &reg, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 return -EFAULT;
527 return 0;
528 case PPRCONTROL:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530529 reg = parport_read_control(port);
530 if (copy_to_user(argp, &reg, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 return -EFAULT;
532 return 0;
533 case PPYIELD:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530534 parport_yield_blocking(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 return 0;
536
537 case PPRELEASE:
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;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530544 parport_release(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 pp->flags &= ~PP_CLAIMED;
546 return 0;
547
548 case PPWCONTROL:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530549 if (copy_from_user(&reg, argp, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530551 parport_write_control(port, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 return 0;
553
554 case PPWDATA:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530555 if (copy_from_user(&reg, argp, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530557 parport_write_data(port, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 return 0;
559
560 case PPFCONTROL:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530561 if (copy_from_user(&mask, argp,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530562 sizeof(mask)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530564 if (copy_from_user(&reg, 1 + (unsigned char __user *) arg,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530565 sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530567 parport_frob_control(port, mask, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 return 0;
569
570 case PPDATADIR:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530571 if (copy_from_user(&mode, argp, sizeof(mode)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 return -EFAULT;
573 if (mode)
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530574 port->ops->data_reverse(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 else
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530576 port->ops->data_forward(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return 0;
578
579 case PPNEGOT:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530580 if (copy_from_user(&mode, argp, sizeof(mode)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530582 switch ((ret = parport_negotiate(port, mode))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 case 0: break;
584 case -1: /* handshake failed, peripheral not IEEE 1284 */
585 ret = -EIO;
586 break;
587 case 1: /* handshake succeeded, peripheral rejected mode */
588 ret = -ENXIO;
589 break;
590 }
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530591 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 return ret;
593
594 case PPWCTLONIRQ:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530595 if (copy_from_user(&reg, argp, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 return -EFAULT;
597
598 /* Remember what to set the control lines to, for next
599 * time we get an interrupt. */
600 pp->irqctl = reg;
601 pp->irqresponse = 1;
602 return 0;
603
604 case PPCLRIRQ:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530605 ret = atomic_read(&pp->irqc);
606 if (copy_to_user(argp, &ret, sizeof(ret)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530608 atomic_sub(ret, &pp->irqc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 return 0;
610
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800611 case PPSETTIME32:
612 if (copy_from_user(time32, argp, sizeof(time32)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 return -EFAULT;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800614
615 return pp_set_timeout(pp->pdev, time32[0], time32[1]);
616
617 case PPSETTIME64:
618 if (copy_from_user(time64, argp, sizeof(time64)))
619 return -EFAULT;
620
621 return pp_set_timeout(pp->pdev, time64[0], time64[1]);
622
623 case PPGETTIME32:
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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 return -EINVAL;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800629
630 if (copy_to_user(argp, time32, sizeof(time32)))
631 return -EFAULT;
632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 return 0;
634
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800635 case PPGETTIME64:
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))
640 return -EINVAL;
641
642 if (copy_to_user(argp, time64, sizeof(time64)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 return -EFAULT;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 return 0;
646
647 default:
Michael Buesch81fc4012009-06-17 16:27:49 -0700648 pr_debug(CHRDEV "%x: What? (cmd=0x%x)\n", minor, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 return -EINVAL;
650 }
651
652 /* Keep the compiler happy */
653 return 0;
654}
655
Alan Cox6d535d32008-07-25 01:48:16 -0700656static long pp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
657{
658 long ret;
Sudip Mukherjee27f3b8a2016-02-12 18:33:41 +0530659
Arnd Bergmann613655f2010-06-02 14:28:52 +0200660 mutex_lock(&pp_do_mutex);
Alan Cox6d535d32008-07-25 01:48:16 -0700661 ret = pp_do_ioctl(file, cmd, arg);
Arnd Bergmann613655f2010-06-02 14:28:52 +0200662 mutex_unlock(&pp_do_mutex);
Alan Cox6d535d32008-07-25 01:48:16 -0700663 return ret;
664}
665
Bamvor Jian Zhang17a35962016-01-08 15:50:49 +0800666#ifdef CONFIG_COMPAT
667static long pp_compat_ioctl(struct file *file, unsigned int cmd,
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530668 unsigned long arg)
Bamvor Jian Zhang17a35962016-01-08 15:50:49 +0800669{
670 return pp_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
671}
672#endif
673
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530674static int pp_open(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
676 unsigned int minor = iminor(inode);
677 struct pp_struct *pp;
678
679 if (minor >= PARPORT_MAX)
680 return -ENXIO;
681
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530682 pp = kmalloc(sizeof(struct pp_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 if (!pp)
684 return -ENOMEM;
685
686 pp->state.mode = IEEE1284_MODE_COMPAT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530687 pp->state.phase = init_phase(pp->state.mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 pp->flags = 0;
689 pp->irqresponse = 0;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530690 atomic_set(&pp->irqc, 0);
691 init_waitqueue_head(&pp->irq_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
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).
696 */
697 pp->pdev = NULL;
698 file->private_data = pp;
699
700 return 0;
701}
702
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530703static int pp_release(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
705 unsigned int minor = iminor(inode);
706 struct pp_struct *pp = file->private_data;
707 int compat_negot;
708
709 compat_negot = 0;
710 if (!(pp->flags & PP_CLAIMED) && pp->pdev &&
711 (pp->state.mode != IEEE1284_MODE_COMPAT)) {
712 struct ieee1284_info *info;
713
714 /* parport released, but not in compatibility mode */
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530715 parport_claim_or_block(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 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;
722 compat_negot = 1;
723 } else if ((pp->flags & PP_CLAIMED) && pp->pdev &&
724 (pp->pdev->port->ieee1284.mode != IEEE1284_MODE_COMPAT)) {
725 compat_negot = 2;
726 }
727 if (compat_negot) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530728 parport_negotiate(pp->pdev->port, IEEE1284_MODE_COMPAT);
Michael Buesch81fc4012009-06-17 16:27:49 -0700729 pr_debug(CHRDEV "%x: negotiated back to compatibility "
730 "mode because user-space forgot\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 }
732
733 if (pp->flags & PP_CLAIMED) {
734 struct ieee1284_info *info;
735
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;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530741 parport_release(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 if (compat_negot != 1) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700743 pr_debug(CHRDEV "%x: released pardevice "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 "because user-space forgot\n", minor);
745 }
746 }
747
748 if (pp->pdev) {
749 const char *name = pp->pdev->name;
Sudip Mukherjee27f3b8a2016-02-12 18:33:41 +0530750
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530751 parport_unregister_device(pp->pdev);
752 kfree(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 pp->pdev = NULL;
Michael Buesch81fc4012009-06-17 16:27:49 -0700754 pr_debug(CHRDEV "%x: unregistered pardevice\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 }
756
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530757 kfree(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
759 return 0;
760}
761
762/* No kernel lock held - fine */
Sudip Mukherjeed85c1a22016-02-12 18:33:40 +0530763static unsigned int pp_poll(struct file *file, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764{
765 struct pp_struct *pp = file->private_data;
766 unsigned int mask = 0;
767
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530768 poll_wait(file, &pp->irq_wait, wait);
769 if (atomic_read(&pp->irqc))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 mask |= POLLIN | POLLRDNORM;
771
772 return mask;
773}
774
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800775static struct class *ppdev_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Arjan van de Ven62322d22006-07-03 00:24:21 -0700777static const struct file_operations pp_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 .owner = THIS_MODULE,
779 .llseek = no_llseek,
780 .read = pp_read,
781 .write = pp_write,
782 .poll = pp_poll,
Alan Cox6d535d32008-07-25 01:48:16 -0700783 .unlocked_ioctl = pp_ioctl,
Bamvor Jian Zhang17a35962016-01-08 15:50:49 +0800784#ifdef CONFIG_COMPAT
785 .compat_ioctl = pp_compat_ioctl,
786#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 .open = pp_open,
788 .release = pp_release,
789};
790
791static void pp_attach(struct parport *port)
792{
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -0700793 device_create(ppdev_class, port->dev, MKDEV(PP_MAJOR, port->number),
794 NULL, "parport%d", port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795}
796
797static void pp_detach(struct parport *port)
798{
Greg Kroah-Hartman04880ed2006-09-12 17:00:10 +0200799 device_destroy(ppdev_class, MKDEV(PP_MAJOR, port->number));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
802static struct parport_driver pp_driver = {
803 .name = CHRDEV,
804 .attach = pp_attach,
805 .detach = pp_detach,
806};
807
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530808static int __init ppdev_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
Greg Kroah-Hartman8ab5e4c2005-06-20 21:15:16 -0700810 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530812 if (register_chrdev(PP_MAJOR, CHRDEV, &pp_fops)) {
813 printk(KERN_WARNING CHRDEV ": unable to get major %d\n",
Sudip Mukherjeea7c71c02016-02-12 18:33:43 +0530814 PP_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 return -EIO;
816 }
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800817 ppdev_class = class_create(THIS_MODULE, CHRDEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 if (IS_ERR(ppdev_class)) {
819 err = PTR_ERR(ppdev_class);
820 goto out_chrdev;
821 }
Alexey Khoroshilov9a32bb32012-09-02 00:31:58 +0400822 err = parport_register_driver(&pp_driver);
823 if (err < 0) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530824 printk(KERN_WARNING CHRDEV ": unable to register with parport\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 goto out_class;
826 }
827
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530828 printk(KERN_INFO PP_VERSION "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 goto out;
830
831out_class:
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800832 class_destroy(ppdev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833out_chrdev:
834 unregister_chrdev(PP_MAJOR, CHRDEV);
835out:
836 return err;
837}
838
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530839static void __exit ppdev_cleanup(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 /* Clean up all parport stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 parport_unregister_driver(&pp_driver);
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800843 class_destroy(ppdev_class);
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530844 unregister_chrdev(PP_MAJOR, CHRDEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846
847module_init(ppdev_init);
848module_exit(ppdev_cleanup);
849
850MODULE_LICENSE("GPL");
851MODULE_ALIAS_CHARDEV_MAJOR(PP_MAJOR);