blob: 80ab757de8d3120f057bc29b107d56b835cbe434 [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 {
78 struct pardevice * pdev;
79 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 Mukherjee783ea442016-02-12 18:33:39 +0530112 port->ops->enable_irq(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113}
114
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530115static ssize_t pp_read(struct file * file, char __user * buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 loff_t * ppos)
117{
Al Viro496ad9a2013-01-23 17:07:38 -0500118 unsigned int minor = iminor(file_inode(file));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 struct pp_struct *pp = file->private_data;
120 char * kbuffer;
121 ssize_t bytes_read = 0;
122 struct parport *pport;
123 int mode;
124
125 if (!(pp->flags & PP_CLAIMED)) {
126 /* Don't have the port claimed */
Michael Buesch81fc4012009-06-17 16:27:49 -0700127 pr_debug(CHRDEV "%x: claim the port first\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 return -EINVAL;
129 }
130
131 /* Trivial case. */
132 if (count == 0)
133 return 0;
134
135 kbuffer = kmalloc(min_t(size_t, count, PP_BUFFER_SIZE), GFP_KERNEL);
136 if (!kbuffer) {
137 return -ENOMEM;
138 }
139 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,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 (file->f_flags & O_NONBLOCK) ?
144 PARPORT_INACTIVITY_O_NONBLOCK :
145 pp->default_inactivity);
146
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
155 if (pp->flags & PP_W91284PIC) {
156 flags |= PARPORT_W91284PIC;
157 }
158 if (pp->flags & PP_FASTREAD) {
159 flags |= PARPORT_EPP_FAST;
160 }
161 if (pport->ieee1284.mode & IEEE1284_ADDR) {
162 fn = pport->ops->epp_read_addr;
163 } else {
164 fn = pport->ops->epp_read_data;
165 }
166 bytes_read = (*fn)(pport, kbuffer, need, flags);
167 } else {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530168 bytes_read = parport_read(pport, kbuffer, need);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 }
170
171 if (bytes_read != 0)
172 break;
173
174 if (file->f_flags & O_NONBLOCK) {
175 bytes_read = -EAGAIN;
176 break;
177 }
178
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530179 if (signal_pending(current)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 bytes_read = -ERESTARTSYS;
181 break;
182 }
183
184 cond_resched();
185 }
186
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530187 parport_set_timeout(pp->pdev, pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530189 if (bytes_read > 0 && copy_to_user(buf, kbuffer, bytes_read))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 bytes_read = -EFAULT;
191
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530192 kfree(kbuffer);
193 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 return bytes_read;
195}
196
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530197static ssize_t pp_write(struct file * file, const char __user * buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 size_t count, loff_t * ppos)
199{
Al Viro496ad9a2013-01-23 17:07:38 -0500200 unsigned int minor = iminor(file_inode(file));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 struct pp_struct *pp = file->private_data;
202 char * kbuffer;
203 ssize_t bytes_written = 0;
204 ssize_t wrote;
205 int mode;
206 struct parport *pport;
207
208 if (!(pp->flags & PP_CLAIMED)) {
209 /* Don't have the port claimed */
Michael Buesch81fc4012009-06-17 16:27:49 -0700210 pr_debug(CHRDEV "%x: claim the port first\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 return -EINVAL;
212 }
213
214 kbuffer = kmalloc(min_t(size_t, count, PP_BUFFER_SIZE), GFP_KERNEL);
215 if (!kbuffer) {
216 return -ENOMEM;
217 }
218 pport = pp->pdev->port;
219 mode = pport->ieee1284.mode & ~(IEEE1284_DEVICEID | IEEE1284_ADDR);
220
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530221 parport_set_timeout(pp->pdev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 (file->f_flags & O_NONBLOCK) ?
223 PARPORT_INACTIVITY_O_NONBLOCK :
224 pp->default_inactivity);
225
226 while (bytes_written < count) {
227 ssize_t n = min_t(unsigned long, count - bytes_written, PP_BUFFER_SIZE);
228
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530229 if (copy_from_user(kbuffer, buf + bytes_written, n)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 bytes_written = -EFAULT;
231 break;
232 }
233
234 if ((pp->flags & PP_FASTWRITE) && (mode == IEEE1284_MODE_EPP)) {
235 /* do a fast EPP write */
236 if (pport->ieee1284.mode & IEEE1284_ADDR) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530237 wrote = pport->ops->epp_write_addr(pport,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 kbuffer, n, PARPORT_EPP_FAST);
239 } else {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530240 wrote = pport->ops->epp_write_data(pport,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 kbuffer, n, PARPORT_EPP_FAST);
242 }
243 } else {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530244 wrote = parport_write(pp->pdev->port, kbuffer, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 }
246
247 if (wrote <= 0) {
248 if (!bytes_written) {
249 bytes_written = wrote;
250 }
251 break;
252 }
253
254 bytes_written += wrote;
255
256 if (file->f_flags & O_NONBLOCK) {
257 if (!bytes_written)
258 bytes_written = -EAGAIN;
259 break;
260 }
261
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530262 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
265 cond_resched();
266 }
267
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530268 parport_set_timeout(pp->pdev, pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530270 kfree(kbuffer);
271 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 return bytes_written;
273}
274
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530275static void pp_irq(void *private)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276{
Jeff Garzik5712cb32007-10-19 02:54:26 -0400277 struct pp_struct *pp = private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279 if (pp->irqresponse) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530280 parport_write_control(pp->pdev->port, pp->irqctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 pp->irqresponse = 0;
282 }
283
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530284 atomic_inc(&pp->irqc);
285 wake_up_interruptible(&pp->irq_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286}
287
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530288static int register_device(int minor, struct pp_struct *pp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
290 struct parport *port;
291 struct pardevice * pdev = NULL;
292 char *name;
293 int fl;
294
Julia Lawall87575432010-05-26 14:43:55 -0700295 name = kasprintf(GFP_KERNEL, CHRDEV "%x", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (name == NULL)
297 return -ENOMEM;
298
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530299 port = parport_find_number(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 if (!port) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530301 printk(KERN_WARNING "%s: no associated port!\n", name);
302 kfree(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 return -ENXIO;
304 }
305
306 fl = (pp->flags & PP_EXCL) ? PARPORT_FLAG_EXCL : 0;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530307 pdev = parport_register_device(port, name, NULL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 NULL, pp_irq, fl, pp);
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530309 parport_put_port(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 if (!pdev) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530312 printk(KERN_WARNING "%s: failed to register device!\n", name);
313 kfree(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 return -ENXIO;
315 }
316
317 pp->pdev = pdev;
Michael Buesch81fc4012009-06-17 16:27:49 -0700318 pr_debug("%s: registered pardevice\n", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 return 0;
320}
321
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530322static enum ieee1284_phase init_phase(int mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
324 switch (mode & ~(IEEE1284_DEVICEID
325 | IEEE1284_ADDR)) {
326 case IEEE1284_MODE_NIBBLE:
327 case IEEE1284_MODE_BYTE:
328 return IEEE1284_PH_REV_IDLE;
329 }
330 return IEEE1284_PH_FWD_IDLE;
331}
332
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800333static int pp_set_timeout(struct pardevice *pdev, long tv_sec, int tv_usec)
334{
335 long to_jiffies;
336
337 if ((tv_sec < 0) || (tv_usec < 0))
338 return -EINVAL;
339
340 to_jiffies = usecs_to_jiffies(tv_usec);
341 to_jiffies += tv_sec * HZ;
342 if (to_jiffies <= 0)
343 return -EINVAL;
344
345 pdev->timeout = to_jiffies;
346 return 0;
347}
348
Alan Cox6d535d32008-07-25 01:48:16 -0700349static int pp_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350{
Al Viro496ad9a2013-01-23 17:07:38 -0500351 unsigned int minor = iminor(file_inode(file));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 struct pp_struct *pp = file->private_data;
353 struct parport * port;
354 void __user *argp = (void __user *)arg;
355
356 /* First handle the cases that don't take arguments. */
357 switch (cmd) {
358 case PPCLAIM:
359 {
360 struct ieee1284_info *info;
361 int ret;
362
363 if (pp->flags & PP_CLAIMED) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700364 pr_debug(CHRDEV "%x: you've already got it!\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 return -EINVAL;
366 }
367
368 /* Deferred device registration. */
369 if (!pp->pdev) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530370 int err = register_device(minor, pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 if (err) {
372 return err;
373 }
374 }
375
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530376 ret = parport_claim_or_block(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 if (ret < 0)
378 return ret;
379
380 pp->flags |= PP_CLAIMED;
381
382 /* For interrupt-reporting to work, we need to be
383 * informed of each interrupt. */
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530384 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386 /* We may need to fix up the state machine. */
387 info = &pp->pdev->port->ieee1284;
388 pp->saved_state.mode = info->mode;
389 pp->saved_state.phase = info->phase;
390 info->mode = pp->state.mode;
391 info->phase = pp->state.phase;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530392 pp->default_inactivity = parport_set_timeout(pp->pdev, 0);
393 parport_set_timeout(pp->pdev, pp->default_inactivity);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 return 0;
396 }
397 case PPEXCL:
398 if (pp->pdev) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700399 pr_debug(CHRDEV "%x: too late for PPEXCL; "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 "already registered\n", minor);
401 if (pp->flags & PP_EXCL)
402 /* But it's not really an error. */
403 return 0;
404 /* There's no chance of making the driver happy. */
405 return -EINVAL;
406 }
407
408 /* Just remember to register the device exclusively
409 * when we finally do the registration. */
410 pp->flags |= PP_EXCL;
411 return 0;
412 case PPSETMODE:
413 {
414 int mode;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530415 if (copy_from_user(&mode, argp, sizeof(mode)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 return -EFAULT;
417 /* FIXME: validate mode */
418 pp->state.mode = mode;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530419 pp->state.phase = init_phase(mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421 if (pp->flags & PP_CLAIMED) {
422 pp->pdev->port->ieee1284.mode = mode;
423 pp->pdev->port->ieee1284.phase = pp->state.phase;
424 }
425
426 return 0;
427 }
428 case PPGETMODE:
429 {
430 int mode;
431
432 if (pp->flags & PP_CLAIMED) {
433 mode = pp->pdev->port->ieee1284.mode;
434 } else {
435 mode = pp->state.mode;
436 }
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530437 if (copy_to_user(argp, &mode, sizeof(mode))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return -EFAULT;
439 }
440 return 0;
441 }
442 case PPSETPHASE:
443 {
444 int phase;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530445 if (copy_from_user(&phase, argp, sizeof(phase))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return -EFAULT;
447 }
448 /* FIXME: validate phase */
449 pp->state.phase = phase;
450
451 if (pp->flags & PP_CLAIMED) {
452 pp->pdev->port->ieee1284.phase = phase;
453 }
454
455 return 0;
456 }
457 case PPGETPHASE:
458 {
459 int phase;
460
461 if (pp->flags & PP_CLAIMED) {
462 phase = pp->pdev->port->ieee1284.phase;
463 } else {
464 phase = pp->state.phase;
465 }
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530466 if (copy_to_user(argp, &phase, sizeof(phase))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 return -EFAULT;
468 }
469 return 0;
470 }
471 case PPGETMODES:
472 {
473 unsigned int modes;
474
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530475 port = parport_find_number(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 if (!port)
477 return -ENODEV;
478
479 modes = port->modes;
Julia Lawalld98808a2011-05-26 16:25:59 -0700480 parport_put_port(port);
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530481 if (copy_to_user(argp, &modes, sizeof(modes))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 return -EFAULT;
483 }
484 return 0;
485 }
486 case PPSETFLAGS:
487 {
488 int uflags;
489
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530490 if (copy_from_user(&uflags, argp, sizeof(uflags))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 return -EFAULT;
492 }
493 pp->flags &= ~PP_FLAGMASK;
494 pp->flags |= (uflags & PP_FLAGMASK);
495 return 0;
496 }
497 case PPGETFLAGS:
498 {
499 int uflags;
500
501 uflags = pp->flags & PP_FLAGMASK;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530502 if (copy_to_user(argp, &uflags, sizeof(uflags))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 return -EFAULT;
504 }
505 return 0;
506 }
507 } /* end switch() */
508
509 /* Everything else requires the port to be claimed, so check
510 * that now. */
511 if ((pp->flags & PP_CLAIMED) == 0) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700512 pr_debug(CHRDEV "%x: claim the port first\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 return -EINVAL;
514 }
515
516 port = pp->pdev->port;
517 switch (cmd) {
518 struct ieee1284_info *info;
519 unsigned char reg;
520 unsigned char mask;
521 int mode;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800522 s32 time32[2];
523 s64 time64[2];
524 struct timespec64 ts;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527 case PPRSTATUS:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530528 reg = parport_read_status(port);
529 if (copy_to_user(argp, &reg, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 return -EFAULT;
531 return 0;
532 case PPRDATA:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530533 reg = parport_read_data(port);
534 if (copy_to_user(argp, &reg, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 return -EFAULT;
536 return 0;
537 case PPRCONTROL:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530538 reg = parport_read_control(port);
539 if (copy_to_user(argp, &reg, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 return -EFAULT;
541 return 0;
542 case PPYIELD:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530543 parport_yield_blocking(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 return 0;
545
546 case PPRELEASE:
547 /* Save the state machine's state. */
548 info = &pp->pdev->port->ieee1284;
549 pp->state.mode = info->mode;
550 pp->state.phase = info->phase;
551 info->mode = pp->saved_state.mode;
552 info->phase = pp->saved_state.phase;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530553 parport_release(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 pp->flags &= ~PP_CLAIMED;
555 return 0;
556
557 case PPWCONTROL:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530558 if (copy_from_user(&reg, argp, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530560 parport_write_control(port, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 return 0;
562
563 case PPWDATA:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530564 if (copy_from_user(&reg, argp, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530566 parport_write_data(port, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 return 0;
568
569 case PPFCONTROL:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530570 if (copy_from_user(&mask, argp,
571 sizeof(mask)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530573 if (copy_from_user(&reg, 1 + (unsigned char __user *) arg,
574 sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530576 parport_frob_control(port, mask, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return 0;
578
579 case PPDATADIR:
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;
582 if (mode)
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530583 port->ops->data_reverse(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 else
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530585 port->ops->data_forward(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 return 0;
587
588 case PPNEGOT:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530589 if (copy_from_user(&mode, argp, sizeof(mode)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530591 switch ((ret = parport_negotiate(port, mode))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 case 0: break;
593 case -1: /* handshake failed, peripheral not IEEE 1284 */
594 ret = -EIO;
595 break;
596 case 1: /* handshake succeeded, peripheral rejected mode */
597 ret = -ENXIO;
598 break;
599 }
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530600 pp_enable_irq(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 return ret;
602
603 case PPWCTLONIRQ:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530604 if (copy_from_user(&reg, argp, sizeof(reg)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 return -EFAULT;
606
607 /* Remember what to set the control lines to, for next
608 * time we get an interrupt. */
609 pp->irqctl = reg;
610 pp->irqresponse = 1;
611 return 0;
612
613 case PPCLRIRQ:
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530614 ret = atomic_read(&pp->irqc);
615 if (copy_to_user(argp, &ret, sizeof(ret)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 return -EFAULT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530617 atomic_sub(ret, &pp->irqc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 return 0;
619
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800620 case PPSETTIME32:
621 if (copy_from_user(time32, argp, sizeof(time32)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return -EFAULT;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800623
624 return pp_set_timeout(pp->pdev, time32[0], time32[1]);
625
626 case PPSETTIME64:
627 if (copy_from_user(time64, argp, sizeof(time64)))
628 return -EFAULT;
629
630 return pp_set_timeout(pp->pdev, time64[0], time64[1]);
631
632 case PPGETTIME32:
633 jiffies_to_timespec64(pp->pdev->timeout, &ts);
634 time32[0] = ts.tv_sec;
635 time32[1] = ts.tv_nsec / NSEC_PER_USEC;
636 if ((time32[0] < 0) || (time32[1] < 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 return -EINVAL;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800638
639 if (copy_to_user(argp, time32, sizeof(time32)))
640 return -EFAULT;
641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 return 0;
643
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800644 case PPGETTIME64:
645 jiffies_to_timespec64(pp->pdev->timeout, &ts);
646 time64[0] = ts.tv_sec;
647 time64[1] = ts.tv_nsec / NSEC_PER_USEC;
648 if ((time64[0] < 0) || (time64[1] < 0))
649 return -EINVAL;
650
651 if (copy_to_user(argp, time64, sizeof(time64)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return -EFAULT;
Bamvor Jian Zhang3b9ab372016-01-08 15:50:48 +0800653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 return 0;
655
656 default:
Michael Buesch81fc4012009-06-17 16:27:49 -0700657 pr_debug(CHRDEV "%x: What? (cmd=0x%x)\n", minor, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 return -EINVAL;
659 }
660
661 /* Keep the compiler happy */
662 return 0;
663}
664
Alan Cox6d535d32008-07-25 01:48:16 -0700665static long pp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
666{
667 long ret;
Arnd Bergmann613655f2010-06-02 14:28:52 +0200668 mutex_lock(&pp_do_mutex);
Alan Cox6d535d32008-07-25 01:48:16 -0700669 ret = pp_do_ioctl(file, cmd, arg);
Arnd Bergmann613655f2010-06-02 14:28:52 +0200670 mutex_unlock(&pp_do_mutex);
Alan Cox6d535d32008-07-25 01:48:16 -0700671 return ret;
672}
673
Bamvor Jian Zhang17a35962016-01-08 15:50:49 +0800674#ifdef CONFIG_COMPAT
675static long pp_compat_ioctl(struct file *file, unsigned int cmd,
676 unsigned long arg)
677{
678 return pp_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
679}
680#endif
681
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530682static int pp_open(struct inode * inode, struct file * file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
684 unsigned int minor = iminor(inode);
685 struct pp_struct *pp;
686
687 if (minor >= PARPORT_MAX)
688 return -ENXIO;
689
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530690 pp = kmalloc(sizeof(struct pp_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 if (!pp)
692 return -ENOMEM;
693
694 pp->state.mode = IEEE1284_MODE_COMPAT;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530695 pp->state.phase = init_phase(pp->state.mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 pp->flags = 0;
697 pp->irqresponse = 0;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530698 atomic_set(&pp->irqc, 0);
699 init_waitqueue_head(&pp->irq_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
701 /* Defer the actual device registration until the first claim.
702 * That way, we know whether or not the driver wants to have
703 * exclusive access to the port (PPEXCL).
704 */
705 pp->pdev = NULL;
706 file->private_data = pp;
707
708 return 0;
709}
710
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530711static int pp_release(struct inode * inode, struct file * file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
713 unsigned int minor = iminor(inode);
714 struct pp_struct *pp = file->private_data;
715 int compat_negot;
716
717 compat_negot = 0;
718 if (!(pp->flags & PP_CLAIMED) && pp->pdev &&
719 (pp->state.mode != IEEE1284_MODE_COMPAT)) {
720 struct ieee1284_info *info;
721
722 /* parport released, but not in compatibility mode */
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530723 parport_claim_or_block(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 pp->flags |= PP_CLAIMED;
725 info = &pp->pdev->port->ieee1284;
726 pp->saved_state.mode = info->mode;
727 pp->saved_state.phase = info->phase;
728 info->mode = pp->state.mode;
729 info->phase = pp->state.phase;
730 compat_negot = 1;
731 } else if ((pp->flags & PP_CLAIMED) && pp->pdev &&
732 (pp->pdev->port->ieee1284.mode != IEEE1284_MODE_COMPAT)) {
733 compat_negot = 2;
734 }
735 if (compat_negot) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530736 parport_negotiate(pp->pdev->port, IEEE1284_MODE_COMPAT);
Michael Buesch81fc4012009-06-17 16:27:49 -0700737 pr_debug(CHRDEV "%x: negotiated back to compatibility "
738 "mode because user-space forgot\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 }
740
741 if (pp->flags & PP_CLAIMED) {
742 struct ieee1284_info *info;
743
744 info = &pp->pdev->port->ieee1284;
745 pp->state.mode = info->mode;
746 pp->state.phase = info->phase;
747 info->mode = pp->saved_state.mode;
748 info->phase = pp->saved_state.phase;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530749 parport_release(pp->pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 if (compat_negot != 1) {
Michael Buesch81fc4012009-06-17 16:27:49 -0700751 pr_debug(CHRDEV "%x: released pardevice "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 "because user-space forgot\n", minor);
753 }
754 }
755
756 if (pp->pdev) {
757 const char *name = pp->pdev->name;
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530758 parport_unregister_device(pp->pdev);
759 kfree(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 pp->pdev = NULL;
Michael Buesch81fc4012009-06-17 16:27:49 -0700761 pr_debug(CHRDEV "%x: unregistered pardevice\n", minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 }
763
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530764 kfree(pp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
766 return 0;
767}
768
769/* No kernel lock held - fine */
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530770static unsigned int pp_poll(struct file * file, poll_table * wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
772 struct pp_struct *pp = file->private_data;
773 unsigned int mask = 0;
774
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530775 poll_wait(file, &pp->irq_wait, wait);
776 if (atomic_read(&pp->irqc))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 mask |= POLLIN | POLLRDNORM;
778
779 return mask;
780}
781
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800782static struct class *ppdev_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Arjan van de Ven62322d22006-07-03 00:24:21 -0700784static const struct file_operations pp_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 .owner = THIS_MODULE,
786 .llseek = no_llseek,
787 .read = pp_read,
788 .write = pp_write,
789 .poll = pp_poll,
Alan Cox6d535d32008-07-25 01:48:16 -0700790 .unlocked_ioctl = pp_ioctl,
Bamvor Jian Zhang17a35962016-01-08 15:50:49 +0800791#ifdef CONFIG_COMPAT
792 .compat_ioctl = pp_compat_ioctl,
793#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 .open = pp_open,
795 .release = pp_release,
796};
797
798static void pp_attach(struct parport *port)
799{
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -0700800 device_create(ppdev_class, port->dev, MKDEV(PP_MAJOR, port->number),
801 NULL, "parport%d", port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802}
803
804static void pp_detach(struct parport *port)
805{
Greg Kroah-Hartman04880ed2006-09-12 17:00:10 +0200806 device_destroy(ppdev_class, MKDEV(PP_MAJOR, port->number));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
809static struct parport_driver pp_driver = {
810 .name = CHRDEV,
811 .attach = pp_attach,
812 .detach = pp_detach,
813};
814
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530815static int __init ppdev_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Greg Kroah-Hartman8ab5e4c2005-06-20 21:15:16 -0700817 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530819 if (register_chrdev(PP_MAJOR, CHRDEV, &pp_fops)) {
820 printk(KERN_WARNING CHRDEV ": unable to get major %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 PP_MAJOR);
822 return -EIO;
823 }
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800824 ppdev_class = class_create(THIS_MODULE, CHRDEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 if (IS_ERR(ppdev_class)) {
826 err = PTR_ERR(ppdev_class);
827 goto out_chrdev;
828 }
Alexey Khoroshilov9a32bb32012-09-02 00:31:58 +0400829 err = parport_register_driver(&pp_driver);
830 if (err < 0) {
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530831 printk(KERN_WARNING CHRDEV ": unable to register with parport\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 goto out_class;
833 }
834
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530835 printk(KERN_INFO PP_VERSION "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 goto out;
837
838out_class:
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800839 class_destroy(ppdev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840out_chrdev:
841 unregister_chrdev(PP_MAJOR, CHRDEV);
842out:
843 return err;
844}
845
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530846static void __exit ppdev_cleanup(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 /* Clean up all parport stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 parport_unregister_driver(&pp_driver);
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800850 class_destroy(ppdev_class);
Sudip Mukherjee783ea442016-02-12 18:33:39 +0530851 unregister_chrdev(PP_MAJOR, CHRDEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
854module_init(ppdev_init);
855module_exit(ppdev_cleanup);
856
857MODULE_LICENSE("GPL");
858MODULE_ALIAS_CHARDEV_MAJOR(PP_MAJOR);