blob: 840c73063a6a48715e2923bb36b23e020b17c5e1 [file] [log] [blame]
Adrian Bunk612de102008-10-15 22:04:33 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Parallel-port resource manager code.
Sudip Mukherjee657e24d2015-10-28 14:41:31 +05303 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Authors: David Campbell <campbell@tirian.che.curtin.edu.au>
5 * Tim Waugh <tim@cyberelk.demon.co.uk>
6 * Jose Renau <renau@acm.org>
7 * Philip Blundell <philb@gnu.org>
8 * Andrea Arcangeli
9 *
10 * based on work by Grant Guenther <grant@torque.net>
11 * and Philip Blundell
12 *
13 * Any part of this program may be used in documents licensed under
14 * the GNU Free Documentation License, Version 1.1 or any later version
15 * published by the Free Software Foundation.
16 */
17
18#undef PARPORT_DEBUG_SHARING /* undef for production */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/module.h>
21#include <linux/string.h>
22#include <linux/threads.h>
23#include <linux/parport.h>
24#include <linux/delay.h>
25#include <linux/errno.h>
26#include <linux/interrupt.h>
27#include <linux/ioport.h>
28#include <linux/kernel.h>
29#include <linux/slab.h>
30#include <linux/sched.h>
31#include <linux/kmod.h>
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +053032#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34#include <linux/spinlock.h>
Ingo Molnar14cc3e22006-03-26 01:37:14 -080035#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/irq.h>
37
38#undef PARPORT_PARANOID
39
40#define PARPORT_DEFAULT_TIMESLICE (HZ/5)
41
42unsigned long parport_default_timeslice = PARPORT_DEFAULT_TIMESLICE;
43int parport_default_spintime = DEFAULT_SPIN_TIME;
44
45static LIST_HEAD(portlist);
46static DEFINE_SPINLOCK(parportlist_lock);
47
48/* list of all allocated ports, sorted by ->number */
49static LIST_HEAD(all_ports);
50static DEFINE_SPINLOCK(full_list_lock);
51
52static LIST_HEAD(drivers);
53
Ingo Molnar14cc3e22006-03-26 01:37:14 -080054static DEFINE_MUTEX(registration_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/* What you can do to a port that's gone away.. */
57static void dead_write_lines (struct parport *p, unsigned char b){}
58static unsigned char dead_read_lines (struct parport *p) { return 0; }
59static unsigned char dead_frob_lines (struct parport *p, unsigned char b,
60 unsigned char c) { return 0; }
61static void dead_onearg (struct parport *p){}
62static void dead_initstate (struct pardevice *d, struct parport_state *s) { }
63static void dead_state (struct parport *p, struct parport_state *s) { }
64static size_t dead_write (struct parport *p, const void *b, size_t l, int f)
65{ return 0; }
66static size_t dead_read (struct parport *p, void *b, size_t l, int f)
67{ return 0; }
68static struct parport_operations dead_ops = {
69 .write_data = dead_write_lines, /* data */
70 .read_data = dead_read_lines,
71
72 .write_control = dead_write_lines, /* control */
73 .read_control = dead_read_lines,
74 .frob_control = dead_frob_lines,
75
76 .read_status = dead_read_lines, /* status */
77
78 .enable_irq = dead_onearg, /* enable_irq */
79 .disable_irq = dead_onearg, /* disable_irq */
80
81 .data_forward = dead_onearg, /* data_forward */
82 .data_reverse = dead_onearg, /* data_reverse */
83
84 .init_state = dead_initstate, /* init_state */
85 .save_state = dead_state,
86 .restore_state = dead_state,
87
88 .epp_write_data = dead_write, /* epp */
89 .epp_read_data = dead_read,
90 .epp_write_addr = dead_write,
91 .epp_read_addr = dead_read,
92
93 .ecp_write_data = dead_write, /* ecp */
94 .ecp_read_data = dead_read,
95 .ecp_write_addr = dead_write,
Sudip Mukherjee657e24d2015-10-28 14:41:31 +053096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 .compat_write_data = dead_write, /* compat */
98 .nibble_read_data = dead_read, /* nibble */
99 .byte_read_data = dead_read, /* byte */
100
101 .owner = NULL,
102};
103
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530104static struct device_type parport_device_type = {
105 .name = "parport",
106};
107
108static int is_parport(struct device *dev)
109{
110 return dev->type == &parport_device_type;
111}
112
113static int parport_probe(struct device *dev)
114{
115 struct parport_driver *drv;
116
117 if (is_parport(dev))
118 return -ENODEV;
119
120 drv = to_parport_driver(dev->driver);
121 if (!drv->probe) {
122 /* if driver has not defined a custom probe */
123 struct pardevice *par_dev = to_pardevice(dev);
124
125 if (strcmp(par_dev->name, drv->name))
126 return -ENODEV;
127 return 0;
128 }
129 /* if driver defined its own probe */
130 return drv->probe(to_pardevice(dev));
131}
132
133static struct bus_type parport_bus_type = {
134 .name = "parport",
135 .probe = parport_probe,
136};
137
138int parport_bus_init(void)
139{
140 return bus_register(&parport_bus_type);
141}
142
143void parport_bus_exit(void)
144{
145 bus_unregister(&parport_bus_type);
146}
147
148/*
149 * iterates through all the drivers registered with the bus and sends the port
150 * details to the match_port callback of the driver, so that the driver can
Geliang Tange9527362015-10-28 14:41:30 +0530151 * know about the new port that just registered with the bus and decide if it
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530152 * wants to use this new port.
153 */
154static int driver_check(struct device_driver *dev_drv, void *_port)
155{
156 struct parport *port = _port;
157 struct parport_driver *drv = to_parport_driver(dev_drv);
158
159 if (drv->match_port)
160 drv->match_port(port);
161 return 0;
162}
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164/* Call attach(port) for each registered driver. */
165static void attach_driver_chain(struct parport *port)
166{
167 /* caller has exclusive registration_lock */
168 struct parport_driver *drv;
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 list_for_each_entry(drv, &drivers, list)
171 drv->attach(port);
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530172
173 /*
174 * call the driver_check function of the drivers registered in
175 * new device model
176 */
177
178 bus_for_each_drv(&parport_bus_type, NULL, port, driver_check);
179}
180
181static int driver_detach(struct device_driver *_drv, void *_port)
182{
183 struct parport *port = _port;
184 struct parport_driver *drv = to_parport_driver(_drv);
185
186 if (drv->detach)
187 drv->detach(port);
188 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189}
190
191/* Call detach(port) for each registered driver. */
192static void detach_driver_chain(struct parport *port)
193{
194 struct parport_driver *drv;
195 /* caller has exclusive registration_lock */
196 list_for_each_entry(drv, &drivers, list)
197 drv->detach (port);
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530198
199 /*
200 * call the detach function of the drivers registered in
201 * new device model
202 */
203
204 bus_for_each_drv(&parport_bus_type, NULL, port, driver_detach);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205}
206
207/* Ask kmod for some lowlevel drivers. */
208static void get_lowlevel_driver (void)
209{
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +0530210 /*
211 * There is no actual module called this: you should set
212 * up an alias for modutils.
213 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 request_module ("parport_lowlevel");
215}
216
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530217/*
218 * iterates through all the devices connected to the bus and sends the device
219 * details to the match_port callback of the driver, so that the driver can
220 * know what are all the ports that are connected to the bus and choose the
221 * port to which it wants to register its device.
222 */
223static int port_check(struct device *dev, void *dev_drv)
224{
225 struct parport_driver *drv = dev_drv;
226
227 /* only send ports, do not send other devices connected to bus */
228 if (is_parport(dev))
229 drv->match_port(to_parport_dev(dev));
230 return 0;
231}
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233/**
234 * parport_register_driver - register a parallel port device driver
235 * @drv: structure describing the driver
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530236 * @owner: owner module of drv
237 * @mod_name: module name string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 *
239 * This can be called by a parallel port device driver in order
240 * to receive notifications about ports being found in the
241 * system, as well as ports no longer available.
242 *
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530243 * If devmodel is true then the new device model is used
244 * for registration.
245 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 * The @drv structure is allocated by the caller and must not be
247 * deallocated until after calling parport_unregister_driver().
248 *
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530249 * If using the non device model:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 * The driver's attach() function may block. The port that
251 * attach() is given will be valid for the duration of the
252 * callback, but if the driver wants to take a copy of the
253 * pointer it must call parport_get_port() to do so. Calling
254 * parport_register_device() on that port will do this for you.
255 *
256 * The driver's detach() function may block. The port that
257 * detach() is given will be valid for the duration of the
258 * callback, but if the driver wants to take a copy of the
259 * pointer it must call parport_get_port() to do so.
260 *
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530261 *
262 * Returns 0 on success. The non device model will always succeeds.
263 * but the new device model can fail and will return the error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 **/
265
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530266int __parport_register_driver(struct parport_driver *drv, struct module *owner,
267 const char *mod_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 if (list_empty(&portlist))
270 get_lowlevel_driver ();
271
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530272 if (drv->devmodel) {
273 /* using device model */
274 int ret;
275
276 /* initialize common driver fields */
277 drv->driver.name = drv->name;
278 drv->driver.bus = &parport_bus_type;
279 drv->driver.owner = owner;
280 drv->driver.mod_name = mod_name;
281 ret = driver_register(&drv->driver);
282 if (ret)
283 return ret;
284
285 mutex_lock(&registration_lock);
286 if (drv->match_port)
287 bus_for_each_dev(&parport_bus_type, NULL, drv,
288 port_check);
289 mutex_unlock(&registration_lock);
290 } else {
291 struct parport *port;
292
293 drv->devmodel = false;
294
295 mutex_lock(&registration_lock);
296 list_for_each_entry(port, &portlist, list)
297 drv->attach(port);
298 list_add(&drv->list, &drivers);
299 mutex_unlock(&registration_lock);
300 }
301
302 return 0;
303}
304EXPORT_SYMBOL(__parport_register_driver);
305
306static int port_detach(struct device *dev, void *_drv)
307{
308 struct parport_driver *drv = _drv;
309
310 if (is_parport(dev) && drv->detach)
311 drv->detach(to_parport_dev(dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313 return 0;
314}
315
316/**
317 * parport_unregister_driver - deregister a parallel port device driver
318 * @drv: structure describing the driver that was given to
319 * parport_register_driver()
320 *
321 * This should be called by a parallel port device driver that
322 * has registered itself using parport_register_driver() when it
323 * is about to be unloaded.
324 *
325 * When it returns, the driver's attach() routine will no longer
326 * be called, and for each port that attach() was called for, the
327 * detach() routine will have been called.
328 *
329 * All the driver's attach() and detach() calls are guaranteed to have
330 * finished by the time this function returns.
331 **/
332
333void parport_unregister_driver (struct parport_driver *drv)
334{
335 struct parport *port;
336
Ingo Molnar14cc3e22006-03-26 01:37:14 -0800337 mutex_lock(&registration_lock);
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530338 if (drv->devmodel) {
339 bus_for_each_dev(&parport_bus_type, NULL, drv, port_detach);
340 driver_unregister(&drv->driver);
341 } else {
342 list_del_init(&drv->list);
343 list_for_each_entry(port, &portlist, list)
344 drv->detach(port);
345 }
Ingo Molnar14cc3e22006-03-26 01:37:14 -0800346 mutex_unlock(&registration_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530348EXPORT_SYMBOL(parport_unregister_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530350static void free_port(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351{
352 int d;
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530353 struct parport *port = to_parport_dev(dev);
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 spin_lock(&full_list_lock);
356 list_del(&port->full_list);
357 spin_unlock(&full_list_lock);
358 for (d = 0; d < 5; d++) {
Jesper Juhl6044ec82005-11-07 01:01:32 -0800359 kfree(port->probe_info[d].class_name);
360 kfree(port->probe_info[d].mfr);
361 kfree(port->probe_info[d].model);
362 kfree(port->probe_info[d].cmdset);
363 kfree(port->probe_info[d].description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 }
365
366 kfree(port->name);
367 kfree(port);
368}
369
370/**
371 * parport_get_port - increment a port's reference count
372 * @port: the port
373 *
Randy Dunlap7d469722006-06-25 05:49:29 -0700374 * This ensures that a struct parport pointer remains valid
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 * until the matching parport_put_port() call.
376 **/
377
378struct parport *parport_get_port (struct parport *port)
379{
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530380 struct device *dev = get_device(&port->bus_dev);
381
382 return to_parport_dev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530384EXPORT_SYMBOL(parport_get_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530386void parport_del_port(struct parport *port)
387{
388 device_unregister(&port->bus_dev);
389}
390EXPORT_SYMBOL(parport_del_port);
391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392/**
393 * parport_put_port - decrement a port's reference count
394 * @port: the port
395 *
396 * This should be called once for each call to parport_get_port(),
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530397 * once the port is no longer needed. When the reference count reaches
398 * zero (port is no longer used), free_port is called.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 **/
400
401void parport_put_port (struct parport *port)
402{
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530403 put_device(&port->bus_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530405EXPORT_SYMBOL(parport_put_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407/**
408 * parport_register_port - register a parallel port
409 * @base: base I/O address
410 * @irq: IRQ line
411 * @dma: DMA channel
412 * @ops: pointer to the port driver's port operations structure
413 *
414 * When a parallel port (lowlevel) driver finds a port that
415 * should be made available to parallel port device drivers, it
416 * should call parport_register_port(). The @base, @irq, and
417 * @dma parameters are for the convenience of port drivers, and
418 * for ports where they aren't meaningful needn't be set to
419 * anything special. They can be altered afterwards by adjusting
420 * the relevant members of the parport structure that is returned
421 * and represents the port. They should not be tampered with
422 * after calling parport_announce_port, however.
423 *
424 * If there are parallel port device drivers in the system that
425 * have registered themselves using parport_register_driver(),
426 * they are not told about the port at this time; that is done by
427 * parport_announce_port().
428 *
429 * The @ops structure is allocated by the caller, and must not be
430 * deallocated before calling parport_remove_port().
431 *
432 * If there is no memory to allocate a new parport structure,
433 * this function will return %NULL.
434 **/
435
436struct parport *parport_register_port(unsigned long base, int irq, int dma,
437 struct parport_operations *ops)
438{
439 struct list_head *l;
440 struct parport *tmp;
441 int num;
442 int device;
443 char *name;
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530444 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Alexandru Gheorghiuc32df4e2013-07-03 15:09:09 -0700446 tmp = kzalloc(sizeof(struct parport), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 if (!tmp) {
448 printk(KERN_WARNING "parport: memory squeeze\n");
449 return NULL;
450 }
451
452 /* Init our structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 tmp->base = base;
454 tmp->irq = irq;
455 tmp->dma = dma;
456 tmp->muxport = tmp->daisy = tmp->muxsel = -1;
457 tmp->modes = 0;
458 INIT_LIST_HEAD(&tmp->list);
459 tmp->devices = tmp->cad = NULL;
460 tmp->flags = 0;
461 tmp->ops = ops;
462 tmp->physport = tmp;
463 memset (tmp->probe_info, 0, 5 * sizeof (struct parport_device_info));
464 rwlock_init(&tmp->cad_lock);
465 spin_lock_init(&tmp->waitlist_lock);
466 spin_lock_init(&tmp->pardevice_lock);
467 tmp->ieee1284.mode = IEEE1284_MODE_COMPAT;
468 tmp->ieee1284.phase = IEEE1284_PH_FWD_IDLE;
Thomas Gleixnera529f152010-09-07 14:32:34 +0000469 sema_init(&tmp->ieee1284.irq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 tmp->spintime = parport_default_spintime;
471 atomic_set (&tmp->ref_count, 1);
472 INIT_LIST_HEAD(&tmp->full_list);
473
474 name = kmalloc(15, GFP_KERNEL);
475 if (!name) {
476 printk(KERN_ERR "parport: memory squeeze\n");
477 kfree(tmp);
478 return NULL;
479 }
480 /* Search for the lowest free parport number. */
481
482 spin_lock(&full_list_lock);
483 for (l = all_ports.next, num = 0; l != &all_ports; l = l->next, num++) {
484 struct parport *p = list_entry(l, struct parport, full_list);
485 if (p->number != num)
486 break;
487 }
488 tmp->portnum = tmp->number = num;
489 list_add_tail(&tmp->full_list, l);
490 spin_unlock(&full_list_lock);
491
492 /*
493 * Now that the portnum is known finish doing the Init.
494 */
495 sprintf(name, "parport%d", tmp->portnum = tmp->number);
496 tmp->name = name;
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530497 tmp->bus_dev.bus = &parport_bus_type;
498 tmp->bus_dev.release = free_port;
499 dev_set_name(&tmp->bus_dev, name);
500 tmp->bus_dev.type = &parport_device_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
502 for (device = 0; device < 5; device++)
503 /* assume the worst */
504 tmp->probe_info[device].class = PARPORT_CLASS_LEGACY;
505
506 tmp->waithead = tmp->waittail = NULL;
507
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530508 ret = device_register(&tmp->bus_dev);
509 if (ret) {
510 put_device(&tmp->bus_dev);
511 return NULL;
512 }
513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 return tmp;
515}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530516EXPORT_SYMBOL(parport_register_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518/**
519 * parport_announce_port - tell device drivers about a parallel port
520 * @port: parallel port to announce
521 *
522 * After a port driver has registered a parallel port with
523 * parport_register_port, and performed any necessary
524 * initialisation or adjustments, it should call
525 * parport_announce_port() in order to notify all device drivers
526 * that have called parport_register_driver(). Their attach()
527 * functions will be called, with @port as the parameter.
528 **/
529
530void parport_announce_port (struct parport *port)
531{
532 int i;
533
534#ifdef CONFIG_PARPORT_1284
535 /* Analyse the IEEE1284.3 topology of the port. */
536 parport_daisy_init(port);
537#endif
538
David Brownellc15a3832007-05-08 00:27:35 -0700539 if (!port->dev)
540 printk(KERN_WARNING "%s: fix this legacy "
541 "no-device port driver!\n",
542 port->name);
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 parport_proc_register(port);
Ingo Molnar14cc3e22006-03-26 01:37:14 -0800545 mutex_lock(&registration_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 spin_lock_irq(&parportlist_lock);
547 list_add_tail(&port->list, &portlist);
548 for (i = 1; i < 3; i++) {
549 struct parport *slave = port->slaves[i-1];
550 if (slave)
551 list_add_tail(&slave->list, &portlist);
552 }
553 spin_unlock_irq(&parportlist_lock);
554
555 /* Let drivers know that new port(s) has arrived. */
556 attach_driver_chain (port);
557 for (i = 1; i < 3; i++) {
558 struct parport *slave = port->slaves[i-1];
559 if (slave)
560 attach_driver_chain(slave);
561 }
Ingo Molnar14cc3e22006-03-26 01:37:14 -0800562 mutex_unlock(&registration_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530564EXPORT_SYMBOL(parport_announce_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566/**
567 * parport_remove_port - deregister a parallel port
568 * @port: parallel port to deregister
569 *
570 * When a parallel port driver is forcibly unloaded, or a
571 * parallel port becomes inaccessible, the port driver must call
572 * this function in order to deal with device drivers that still
573 * want to use it.
574 *
575 * The parport structure associated with the port has its
576 * operations structure replaced with one containing 'null'
577 * operations that return errors or just don't do anything.
578 *
579 * Any drivers that have registered themselves using
580 * parport_register_driver() are notified that the port is no
581 * longer accessible by having their detach() routines called
582 * with @port as the parameter.
583 **/
584
585void parport_remove_port(struct parport *port)
586{
587 int i;
588
Ingo Molnar14cc3e22006-03-26 01:37:14 -0800589 mutex_lock(&registration_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
591 /* Spread the word. */
592 detach_driver_chain (port);
593
594#ifdef CONFIG_PARPORT_1284
595 /* Forget the IEEE1284.3 topology of the port. */
596 parport_daisy_fini(port);
597 for (i = 1; i < 3; i++) {
598 struct parport *slave = port->slaves[i-1];
599 if (!slave)
600 continue;
601 detach_driver_chain(slave);
602 parport_daisy_fini(slave);
603 }
604#endif
605
606 port->ops = &dead_ops;
607 spin_lock(&parportlist_lock);
608 list_del_init(&port->list);
609 for (i = 1; i < 3; i++) {
610 struct parport *slave = port->slaves[i-1];
611 if (slave)
612 list_del_init(&slave->list);
613 }
614 spin_unlock(&parportlist_lock);
615
Ingo Molnar14cc3e22006-03-26 01:37:14 -0800616 mutex_unlock(&registration_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
618 parport_proc_unregister(port);
619
620 for (i = 1; i < 3; i++) {
621 struct parport *slave = port->slaves[i-1];
622 if (slave)
623 parport_put_port(slave);
624 }
625}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530626EXPORT_SYMBOL(parport_remove_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
628/**
629 * parport_register_device - register a device on a parallel port
630 * @port: port to which the device is attached
631 * @name: a name to refer to the device
632 * @pf: preemption callback
633 * @kf: kick callback (wake-up)
634 * @irq_func: interrupt handler
635 * @flags: registration flags
636 * @handle: data for callback functions
637 *
638 * This function, called by parallel port device drivers,
639 * declares that a device is connected to a port, and tells the
640 * system all it needs to know.
641 *
642 * The @name is allocated by the caller and must not be
643 * deallocated until the caller calls @parport_unregister_device
644 * for that device.
645 *
646 * The preemption callback function, @pf, is called when this
647 * device driver has claimed access to the port but another
648 * device driver wants to use it. It is given @handle as its
649 * parameter, and should return zero if it is willing for the
650 * system to release the port to another driver on its behalf.
651 * If it wants to keep control of the port it should return
652 * non-zero, and no action will be taken. It is good manners for
653 * the driver to try to release the port at the earliest
654 * opportunity after its preemption callback rejects a preemption
655 * attempt. Note that if a preemption callback is happy for
656 * preemption to go ahead, there is no need to release the port;
657 * it is done automatically. This function may not block, as it
658 * may be called from interrupt context. If the device driver
659 * does not support preemption, @pf can be %NULL.
660 *
661 * The wake-up ("kick") callback function, @kf, is called when
662 * the port is available to be claimed for exclusive access; that
663 * is, parport_claim() is guaranteed to succeed when called from
664 * inside the wake-up callback function. If the driver wants to
665 * claim the port it should do so; otherwise, it need not take
666 * any action. This function may not block, as it may be called
667 * from interrupt context. If the device driver does not want to
668 * be explicitly invited to claim the port in this way, @kf can
669 * be %NULL.
670 *
671 * The interrupt handler, @irq_func, is called when an interrupt
672 * arrives from the parallel port. Note that if a device driver
673 * wants to use interrupts it should use parport_enable_irq(),
674 * and can also check the irq member of the parport structure
675 * representing the port.
676 *
677 * The parallel port (lowlevel) driver is the one that has called
678 * request_irq() and whose interrupt handler is called first.
679 * This handler does whatever needs to be done to the hardware to
680 * acknowledge the interrupt (for PC-style ports there is nothing
681 * special to be done). It then tells the IEEE 1284 code about
682 * the interrupt, which may involve reacting to an IEEE 1284
683 * event depending on the current IEEE 1284 phase. After this,
684 * it calls @irq_func. Needless to say, @irq_func will be called
685 * from interrupt context, and may not block.
686 *
687 * The %PARPORT_DEV_EXCL flag is for preventing port sharing, and
688 * so should only be used when sharing the port with other device
689 * drivers is impossible and would lead to incorrect behaviour.
690 * Use it sparingly! Normally, @flags will be zero.
691 *
692 * This function returns a pointer to a structure that represents
693 * the device on the port, or %NULL if there is not enough memory
694 * to allocate space for that structure.
695 **/
696
697struct pardevice *
698parport_register_device(struct parport *port, const char *name,
699 int (*pf)(void *), void (*kf)(void *),
Sudip Mukherjee657e24d2015-10-28 14:41:31 +0530700 void (*irq_func)(void *),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 int flags, void *handle)
702{
703 struct pardevice *tmp;
704
705 if (port->physport->flags & PARPORT_FLAG_EXCL) {
706 /* An exclusive device is registered. */
707 printk (KERN_DEBUG "%s: no more devices allowed\n",
708 port->name);
709 return NULL;
710 }
711
712 if (flags & PARPORT_DEV_LURK) {
713 if (!pf || !kf) {
714 printk(KERN_INFO "%s: refused to register lurking device (%s) without callbacks\n", port->name, name);
715 return NULL;
716 }
717 }
718
Sudip Mukherjee50566ac82015-06-12 15:20:20 +0530719 if (flags & PARPORT_DEV_EXCL) {
720 if (port->physport->devices) {
721 /*
722 * If a device is already registered and this new
723 * device wants exclusive access, then no need to
724 * continue as we can not grant exclusive access to
725 * this device.
726 */
727 pr_err("%s: cannot grant exclusive access for device %s\n",
728 port->name, name);
729 return NULL;
730 }
731 }
732
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +0530733 /*
734 * We up our own module reference count, and that of the port
735 * on which a device is to be registered, to ensure that
736 * neither of us gets unloaded while we sleep in (e.g.)
737 * kmalloc.
738 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 if (!try_module_get(port->ops->owner)) {
740 return NULL;
741 }
Sudip Mukherjee657e24d2015-10-28 14:41:31 +0530742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 parport_get_port (port);
744
745 tmp = kmalloc(sizeof(struct pardevice), GFP_KERNEL);
746 if (tmp == NULL) {
747 printk(KERN_WARNING "%s: memory squeeze, couldn't register %s.\n", port->name, name);
748 goto out;
749 }
750
751 tmp->state = kmalloc(sizeof(struct parport_state), GFP_KERNEL);
752 if (tmp->state == NULL) {
753 printk(KERN_WARNING "%s: memory squeeze, couldn't register %s.\n", port->name, name);
754 goto out_free_pardevice;
755 }
756
757 tmp->name = name;
758 tmp->port = port;
759 tmp->daisy = -1;
760 tmp->preempt = pf;
761 tmp->wakeup = kf;
762 tmp->private = handle;
763 tmp->flags = flags;
764 tmp->irq_func = irq_func;
765 tmp->waiting = 0;
766 tmp->timeout = 5 * HZ;
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530767 tmp->devmodel = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
769 /* Chain this onto the list */
770 tmp->prev = NULL;
771 /*
772 * This function must not run from an irq handler so we don' t need
773 * to clear irq on the local CPU. -arca
774 */
775 spin_lock(&port->physport->pardevice_lock);
776
777 if (flags & PARPORT_DEV_EXCL) {
778 if (port->physport->devices) {
779 spin_unlock (&port->physport->pardevice_lock);
780 printk (KERN_DEBUG
781 "%s: cannot grant exclusive access for "
782 "device %s\n", port->name, name);
783 goto out_free_all;
784 }
785 port->flags |= PARPORT_FLAG_EXCL;
786 }
787
788 tmp->next = port->physport->devices;
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +0530789 wmb(); /*
790 * Make sure that tmp->next is written before it's
791 * added to the list; see comments marked 'no locking
792 * required'
793 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 if (port->physport->devices)
795 port->physport->devices->prev = tmp;
796 port->physport->devices = tmp;
797 spin_unlock(&port->physport->pardevice_lock);
798
799 init_waitqueue_head(&tmp->wait_q);
800 tmp->timeslice = parport_default_timeslice;
801 tmp->waitnext = tmp->waitprev = NULL;
802
803 /*
804 * This has to be run as last thing since init_state may need other
805 * pardevice fields. -arca
806 */
807 port->ops->init_state(tmp, tmp->state);
Alan Cox05ad7092009-06-02 16:58:10 +0100808 if (!test_and_set_bit(PARPORT_DEVPROC_REGISTERED, &port->devflags)) {
809 port->proc_device = tmp;
810 parport_device_proc_register(tmp);
811 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return tmp;
813
814 out_free_all:
Jesper Juhl6044ec82005-11-07 01:01:32 -0800815 kfree(tmp->state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 out_free_pardevice:
Jesper Juhl6044ec82005-11-07 01:01:32 -0800817 kfree(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 out:
819 parport_put_port (port);
820 module_put(port->ops->owner);
821
822 return NULL;
823}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +0530824EXPORT_SYMBOL(parport_register_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530826static void free_pardevice(struct device *dev)
827{
828 struct pardevice *par_dev = to_pardevice(dev);
829
830 kfree(par_dev->name);
831 kfree(par_dev);
832}
833
834struct pardevice *
835parport_register_dev_model(struct parport *port, const char *name,
836 const struct pardev_cb *par_dev_cb, int id)
837{
838 struct pardevice *par_dev;
839 int ret;
840 char *devname;
841
842 if (port->physport->flags & PARPORT_FLAG_EXCL) {
843 /* An exclusive device is registered. */
844 pr_err("%s: no more devices allowed\n", port->name);
845 return NULL;
846 }
847
848 if (par_dev_cb->flags & PARPORT_DEV_LURK) {
849 if (!par_dev_cb->preempt || !par_dev_cb->wakeup) {
850 pr_info("%s: refused to register lurking device (%s) without callbacks\n",
851 port->name, name);
852 return NULL;
853 }
854 }
855
Sudip Mukherjee50566ac82015-06-12 15:20:20 +0530856 if (par_dev_cb->flags & PARPORT_DEV_EXCL) {
857 if (port->physport->devices) {
858 /*
859 * If a device is already registered and this new
860 * device wants exclusive access, then no need to
861 * continue as we can not grant exclusive access to
862 * this device.
863 */
864 pr_err("%s: cannot grant exclusive access for device %s\n",
865 port->name, name);
866 return NULL;
867 }
868 }
869
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530870 if (!try_module_get(port->ops->owner))
871 return NULL;
872
873 parport_get_port(port);
874
875 par_dev = kzalloc(sizeof(*par_dev), GFP_KERNEL);
876 if (!par_dev)
877 goto err_put_port;
878
879 par_dev->state = kzalloc(sizeof(*par_dev->state), GFP_KERNEL);
880 if (!par_dev->state)
881 goto err_put_par_dev;
882
883 devname = kstrdup(name, GFP_KERNEL);
884 if (!devname)
885 goto err_free_par_dev;
886
887 par_dev->name = devname;
888 par_dev->port = port;
889 par_dev->daisy = -1;
890 par_dev->preempt = par_dev_cb->preempt;
891 par_dev->wakeup = par_dev_cb->wakeup;
892 par_dev->private = par_dev_cb->private;
893 par_dev->flags = par_dev_cb->flags;
894 par_dev->irq_func = par_dev_cb->irq_func;
895 par_dev->waiting = 0;
896 par_dev->timeout = 5 * HZ;
897
898 par_dev->dev.parent = &port->bus_dev;
899 par_dev->dev.bus = &parport_bus_type;
900 ret = dev_set_name(&par_dev->dev, "%s.%d", devname, id);
901 if (ret)
902 goto err_free_devname;
903 par_dev->dev.release = free_pardevice;
904 par_dev->devmodel = true;
905 ret = device_register(&par_dev->dev);
Sudip Mukherjee68d35c72015-06-15 20:05:51 +0530906 if (ret) {
907 put_device(&par_dev->dev);
908 goto err_put_port;
909 }
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530910
911 /* Chain this onto the list */
912 par_dev->prev = NULL;
913 /*
914 * This function must not run from an irq handler so we don' t need
915 * to clear irq on the local CPU. -arca
916 */
917 spin_lock(&port->physport->pardevice_lock);
918
919 if (par_dev_cb->flags & PARPORT_DEV_EXCL) {
920 if (port->physport->devices) {
921 spin_unlock(&port->physport->pardevice_lock);
922 pr_debug("%s: cannot grant exclusive access for device %s\n",
923 port->name, name);
Sudip Mukherjeecabea692015-06-15 20:05:49 +0530924 device_unregister(&par_dev->dev);
925 goto err_put_port;
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530926 }
927 port->flags |= PARPORT_FLAG_EXCL;
928 }
929
930 par_dev->next = port->physport->devices;
931 wmb(); /*
932 * Make sure that tmp->next is written before it's
933 * added to the list; see comments marked 'no locking
934 * required'
935 */
936 if (port->physport->devices)
937 port->physport->devices->prev = par_dev;
938 port->physport->devices = par_dev;
939 spin_unlock(&port->physport->pardevice_lock);
940
941 init_waitqueue_head(&par_dev->wait_q);
942 par_dev->timeslice = parport_default_timeslice;
943 par_dev->waitnext = NULL;
944 par_dev->waitprev = NULL;
945
946 /*
947 * This has to be run as last thing since init_state may need other
948 * pardevice fields. -arca
949 */
950 port->ops->init_state(par_dev, par_dev->state);
951 port->proc_device = par_dev;
952 parport_device_proc_register(par_dev);
953
954 return par_dev;
955
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +0530956err_free_devname:
957 kfree(devname);
958err_free_par_dev:
959 kfree(par_dev->state);
960err_put_par_dev:
961 if (!par_dev->devmodel)
962 kfree(par_dev);
963err_put_port:
964 parport_put_port(port);
965 module_put(port->ops->owner);
966
967 return NULL;
968}
969EXPORT_SYMBOL(parport_register_dev_model);
970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971/**
972 * parport_unregister_device - deregister a device on a parallel port
973 * @dev: pointer to structure representing device
974 *
975 * This undoes the effect of parport_register_device().
976 **/
977
978void parport_unregister_device(struct pardevice *dev)
979{
980 struct parport *port;
981
982#ifdef PARPORT_PARANOID
983 if (dev == NULL) {
984 printk(KERN_ERR "parport_unregister_device: passed NULL\n");
985 return;
986 }
987#endif
988
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 port = dev->port->physport;
990
Alan Cox05ad7092009-06-02 16:58:10 +0100991 if (port->proc_device == dev) {
992 port->proc_device = NULL;
993 clear_bit(PARPORT_DEVPROC_REGISTERED, &port->devflags);
994 parport_device_proc_unregister(dev);
995 }
996
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 if (port->cad == dev) {
998 printk(KERN_DEBUG "%s: %s forgot to release port\n",
999 port->name, dev->name);
1000 parport_release (dev);
1001 }
1002
1003 spin_lock(&port->pardevice_lock);
1004 if (dev->next)
1005 dev->next->prev = dev->prev;
1006 if (dev->prev)
1007 dev->prev->next = dev->next;
1008 else
1009 port->devices = dev->next;
1010
1011 if (dev->flags & PARPORT_DEV_EXCL)
1012 port->flags &= ~PARPORT_FLAG_EXCL;
1013
1014 spin_unlock(&port->pardevice_lock);
1015
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301016 /*
1017 * Make sure we haven't left any pointers around in the wait
1018 * list.
1019 */
Alexander Gordeevcbeb4b72011-01-25 15:07:16 -08001020 spin_lock_irq(&port->waitlist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 if (dev->waitprev || dev->waitnext || port->waithead == dev) {
1022 if (dev->waitprev)
1023 dev->waitprev->waitnext = dev->waitnext;
1024 else
1025 port->waithead = dev->waitnext;
1026 if (dev->waitnext)
1027 dev->waitnext->waitprev = dev->waitprev;
1028 else
1029 port->waittail = dev->waitprev;
1030 }
Alexander Gordeevcbeb4b72011-01-25 15:07:16 -08001031 spin_unlock_irq(&port->waitlist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
1033 kfree(dev->state);
Sudip Mukherjee6fa45a22015-05-20 20:56:57 +05301034 if (dev->devmodel)
1035 device_unregister(&dev->dev);
1036 else
1037 kfree(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
1039 module_put(port->ops->owner);
1040 parport_put_port (port);
1041}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +05301042EXPORT_SYMBOL(parport_unregister_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
1044/**
1045 * parport_find_number - find a parallel port by number
1046 * @number: parallel port number
1047 *
1048 * This returns the parallel port with the specified number, or
1049 * %NULL if there is none.
1050 *
1051 * There is an implicit parport_get_port() done already; to throw
1052 * away the reference to the port that parport_find_number()
1053 * gives you, use parport_put_port().
1054 */
1055
1056struct parport *parport_find_number (int number)
1057{
1058 struct parport *port, *result = NULL;
1059
1060 if (list_empty(&portlist))
1061 get_lowlevel_driver ();
1062
1063 spin_lock (&parportlist_lock);
1064 list_for_each_entry(port, &portlist, list) {
1065 if (port->number == number) {
1066 result = parport_get_port (port);
1067 break;
1068 }
1069 }
1070 spin_unlock (&parportlist_lock);
1071 return result;
1072}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +05301073EXPORT_SYMBOL(parport_find_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
1075/**
1076 * parport_find_base - find a parallel port by base address
1077 * @base: base I/O address
1078 *
1079 * This returns the parallel port with the specified base
1080 * address, or %NULL if there is none.
1081 *
1082 * There is an implicit parport_get_port() done already; to throw
1083 * away the reference to the port that parport_find_base()
1084 * gives you, use parport_put_port().
1085 */
1086
1087struct parport *parport_find_base (unsigned long base)
1088{
1089 struct parport *port, *result = NULL;
1090
1091 if (list_empty(&portlist))
1092 get_lowlevel_driver ();
1093
1094 spin_lock (&parportlist_lock);
1095 list_for_each_entry(port, &portlist, list) {
1096 if (port->base == base) {
1097 result = parport_get_port (port);
1098 break;
1099 }
1100 }
1101 spin_unlock (&parportlist_lock);
1102 return result;
1103}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +05301104EXPORT_SYMBOL(parport_find_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
1106/**
1107 * parport_claim - claim access to a parallel port device
1108 * @dev: pointer to structure representing a device on the port
1109 *
1110 * This function will not block and so can be used from interrupt
1111 * context. If parport_claim() succeeds in claiming access to
1112 * the port it returns zero and the port is available to use. It
1113 * may fail (returning non-zero) if the port is in use by another
1114 * driver and that driver is not willing to relinquish control of
1115 * the port.
1116 **/
1117
1118int parport_claim(struct pardevice *dev)
1119{
1120 struct pardevice *oldcad;
1121 struct parport *port = dev->port->physport;
1122 unsigned long flags;
1123
1124 if (port->cad == dev) {
1125 printk(KERN_INFO "%s: %s already owner\n",
1126 dev->port->name,dev->name);
1127 return 0;
1128 }
1129
1130 /* Preempt any current device */
1131 write_lock_irqsave (&port->cad_lock, flags);
1132 if ((oldcad = port->cad) != NULL) {
1133 if (oldcad->preempt) {
1134 if (oldcad->preempt(oldcad->private))
1135 goto blocked;
1136 port->ops->save_state(port, dev->state);
1137 } else
1138 goto blocked;
1139
1140 if (port->cad != oldcad) {
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301141 /*
1142 * I think we'll actually deadlock rather than
1143 * get here, but just in case..
1144 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 printk(KERN_WARNING
1146 "%s: %s released port when preempted!\n",
1147 port->name, oldcad->name);
1148 if (port->cad)
1149 goto blocked;
1150 }
1151 }
1152
1153 /* Can't fail from now on, so mark ourselves as no longer waiting. */
1154 if (dev->waiting & 1) {
1155 dev->waiting = 0;
1156
1157 /* Take ourselves out of the wait list again. */
1158 spin_lock_irq (&port->waitlist_lock);
1159 if (dev->waitprev)
1160 dev->waitprev->waitnext = dev->waitnext;
1161 else
1162 port->waithead = dev->waitnext;
1163 if (dev->waitnext)
1164 dev->waitnext->waitprev = dev->waitprev;
1165 else
1166 port->waittail = dev->waitprev;
1167 spin_unlock_irq (&port->waitlist_lock);
1168 dev->waitprev = dev->waitnext = NULL;
1169 }
1170
1171 /* Now we do the change of devices */
1172 port->cad = dev;
1173
1174#ifdef CONFIG_PARPORT_1284
1175 /* If it's a mux port, select it. */
1176 if (dev->port->muxport >= 0) {
1177 /* FIXME */
1178 port->muxsel = dev->port->muxport;
1179 }
1180
1181 /* If it's a daisy chain device, select it. */
1182 if (dev->daisy >= 0) {
1183 /* This could be lazier. */
1184 if (!parport_daisy_select (port, dev->daisy,
1185 IEEE1284_MODE_COMPAT))
1186 port->daisy = dev->daisy;
1187 }
1188#endif /* IEEE1284.3 support */
1189
1190 /* Restore control registers */
1191 port->ops->restore_state(port, dev->state);
1192 write_unlock_irqrestore(&port->cad_lock, flags);
1193 dev->time = jiffies;
1194 return 0;
1195
1196blocked:
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301197 /*
1198 * If this is the first time we tried to claim the port, register an
1199 * interest. This is only allowed for devices sleeping in
1200 * parport_claim_or_block(), or those with a wakeup function.
1201 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
1203 /* The cad_lock is still held for writing here */
1204 if (dev->waiting & 2 || dev->wakeup) {
1205 spin_lock (&port->waitlist_lock);
1206 if (test_and_set_bit(0, &dev->waiting) == 0) {
1207 /* First add ourselves to the end of the wait list. */
1208 dev->waitnext = NULL;
1209 dev->waitprev = port->waittail;
1210 if (port->waittail) {
1211 port->waittail->waitnext = dev;
1212 port->waittail = dev;
1213 } else
1214 port->waithead = port->waittail = dev;
1215 }
1216 spin_unlock (&port->waitlist_lock);
1217 }
1218 write_unlock_irqrestore (&port->cad_lock, flags);
1219 return -EAGAIN;
1220}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +05301221EXPORT_SYMBOL(parport_claim);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
1223/**
1224 * parport_claim_or_block - claim access to a parallel port device
1225 * @dev: pointer to structure representing a device on the port
1226 *
1227 * This behaves like parport_claim(), but will block if necessary
1228 * to wait for the port to be free. A return value of 1
1229 * indicates that it slept; 0 means that it succeeded without
1230 * needing to sleep. A negative error code indicates failure.
1231 **/
1232
1233int parport_claim_or_block(struct pardevice *dev)
1234{
1235 int r;
1236
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301237 /*
1238 * Signal to parport_claim() that we can wait even without a
1239 * wakeup function.
1240 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 dev->waiting = 2;
1242
1243 /* Try to claim the port. If this fails, we need to sleep. */
1244 r = parport_claim(dev);
1245 if (r == -EAGAIN) {
1246#ifdef PARPORT_DEBUG_SHARING
1247 printk(KERN_DEBUG "%s: parport_claim() returned -EAGAIN\n", dev->name);
1248#endif
1249 /*
1250 * FIXME!!! Use the proper locking for dev->waiting,
1251 * and make this use the "wait_event_interruptible()"
1252 * interfaces. The cli/sti that used to be here
1253 * did nothing.
1254 *
1255 * See also parport_release()
1256 */
1257
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301258 /*
1259 * If dev->waiting is clear now, an interrupt
1260 * gave us the port and we would deadlock if we slept.
1261 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 if (dev->waiting) {
Arnd Bergmann76ae0532014-02-26 12:01:49 +01001263 wait_event_interruptible(dev->wait_q,
1264 !dev->waiting);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 if (signal_pending (current)) {
1266 return -EINTR;
1267 }
1268 r = 1;
1269 } else {
1270 r = 0;
1271#ifdef PARPORT_DEBUG_SHARING
1272 printk(KERN_DEBUG "%s: didn't sleep in parport_claim_or_block()\n",
1273 dev->name);
1274#endif
1275 }
1276
1277#ifdef PARPORT_DEBUG_SHARING
1278 if (dev->port->physport->cad != dev)
1279 printk(KERN_DEBUG "%s: exiting parport_claim_or_block "
1280 "but %s owns port!\n", dev->name,
1281 dev->port->physport->cad ?
1282 dev->port->physport->cad->name:"nobody");
1283#endif
1284 }
1285 dev->waiting = 0;
1286 return r;
1287}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +05301288EXPORT_SYMBOL(parport_claim_or_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290/**
1291 * parport_release - give up access to a parallel port device
1292 * @dev: pointer to structure representing parallel port device
1293 *
1294 * This function cannot fail, but it should not be called without
1295 * the port claimed. Similarly, if the port is already claimed
1296 * you should not try claiming it again.
1297 **/
1298
1299void parport_release(struct pardevice *dev)
1300{
1301 struct parport *port = dev->port->physport;
1302 struct pardevice *pd;
1303 unsigned long flags;
1304
1305 /* Make sure that dev is the current device */
1306 write_lock_irqsave(&port->cad_lock, flags);
1307 if (port->cad != dev) {
1308 write_unlock_irqrestore (&port->cad_lock, flags);
1309 printk(KERN_WARNING "%s: %s tried to release parport "
1310 "when not owner\n", port->name, dev->name);
1311 return;
1312 }
1313
1314#ifdef CONFIG_PARPORT_1284
1315 /* If this is on a mux port, deselect it. */
1316 if (dev->port->muxport >= 0) {
1317 /* FIXME */
1318 port->muxsel = -1;
1319 }
1320
1321 /* If this is a daisy device, deselect it. */
1322 if (dev->daisy >= 0) {
1323 parport_daisy_deselect_all (port);
1324 port->daisy = -1;
1325 }
1326#endif
1327
1328 port->cad = NULL;
1329 write_unlock_irqrestore(&port->cad_lock, flags);
1330
1331 /* Save control registers */
1332 port->ops->save_state(port, dev->state);
1333
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301334 /*
1335 * If anybody is waiting, find out who's been there longest and
1336 * then wake them up. (Note: no locking required)
1337 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 /* !!! LOCKING IS NEEDED HERE */
1339 for (pd = port->waithead; pd; pd = pd->waitnext) {
1340 if (pd->waiting & 2) { /* sleeping in claim_or_block */
1341 parport_claim(pd);
1342 if (waitqueue_active(&pd->wait_q))
1343 wake_up_interruptible(&pd->wait_q);
1344 return;
1345 } else if (pd->wakeup) {
1346 pd->wakeup(pd->private);
1347 if (dev->port->cad) /* racy but no matter */
1348 return;
1349 } else {
1350 printk(KERN_ERR "%s: don't know how to wake %s\n", port->name, pd->name);
1351 }
1352 }
1353
Sudip Mukherjee7b7a0a32015-10-28 14:41:33 +05301354 /*
1355 * Nobody was waiting, so walk the list to see if anyone is
1356 * interested in being woken up. (Note: no locking required)
1357 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 /* !!! LOCKING IS NEEDED HERE */
1359 for (pd = port->devices; (port->cad == NULL) && pd; pd = pd->next) {
1360 if (pd->wakeup && pd != dev)
1361 pd->wakeup(pd->private);
1362 }
1363}
Sudip Mukherjee27c6db22015-10-28 14:41:32 +05301364EXPORT_SYMBOL(parport_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
Jeff Garzik3f2e40d2007-10-19 01:42:14 -04001366irqreturn_t parport_irq_handler(int irq, void *dev_id)
1367{
1368 struct parport *port = dev_id;
1369
Jeff Garzikf230d102007-10-19 01:56:02 -04001370 parport_generic_irq(port);
Jeff Garzik3f2e40d2007-10-19 01:42:14 -04001371
1372 return IRQ_HANDLED;
1373}
Jeff Garzik3f2e40d2007-10-19 01:42:14 -04001374EXPORT_SYMBOL(parport_irq_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
1376MODULE_LICENSE("GPL");