Loading...
1/*
2 * Parallel-port resource manager code.
3 *
4 * 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
20#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>
32
33#include <linux/spinlock.h>
34#include <linux/mutex.h>
35#include <asm/irq.h>
36
37#undef PARPORT_PARANOID
38
39#define PARPORT_DEFAULT_TIMESLICE (HZ/5)
40
41unsigned long parport_default_timeslice = PARPORT_DEFAULT_TIMESLICE;
42int parport_default_spintime = DEFAULT_SPIN_TIME;
43
44static LIST_HEAD(portlist);
45static DEFINE_SPINLOCK(parportlist_lock);
46
47/* list of all allocated ports, sorted by ->number */
48static LIST_HEAD(all_ports);
49static DEFINE_SPINLOCK(full_list_lock);
50
51static LIST_HEAD(drivers);
52
53static DEFINE_MUTEX(registration_lock);
54
55/* What you can do to a port that's gone away.. */
56static void dead_write_lines (struct parport *p, unsigned char b){}
57static unsigned char dead_read_lines (struct parport *p) { return 0; }
58static unsigned char dead_frob_lines (struct parport *p, unsigned char b,
59 unsigned char c) { return 0; }
60static void dead_onearg (struct parport *p){}
61static void dead_initstate (struct pardevice *d, struct parport_state *s) { }
62static void dead_state (struct parport *p, struct parport_state *s) { }
63static size_t dead_write (struct parport *p, const void *b, size_t l, int f)
64{ return 0; }
65static size_t dead_read (struct parport *p, void *b, size_t l, int f)
66{ return 0; }
67static struct parport_operations dead_ops = {
68 .write_data = dead_write_lines, /* data */
69 .read_data = dead_read_lines,
70
71 .write_control = dead_write_lines, /* control */
72 .read_control = dead_read_lines,
73 .frob_control = dead_frob_lines,
74
75 .read_status = dead_read_lines, /* status */
76
77 .enable_irq = dead_onearg, /* enable_irq */
78 .disable_irq = dead_onearg, /* disable_irq */
79
80 .data_forward = dead_onearg, /* data_forward */
81 .data_reverse = dead_onearg, /* data_reverse */
82
83 .init_state = dead_initstate, /* init_state */
84 .save_state = dead_state,
85 .restore_state = dead_state,
86
87 .epp_write_data = dead_write, /* epp */
88 .epp_read_data = dead_read,
89 .epp_write_addr = dead_write,
90 .epp_read_addr = dead_read,
91
92 .ecp_write_data = dead_write, /* ecp */
93 .ecp_read_data = dead_read,
94 .ecp_write_addr = dead_write,
95
96 .compat_write_data = dead_write, /* compat */
97 .nibble_read_data = dead_read, /* nibble */
98 .byte_read_data = dead_read, /* byte */
99
100 .owner = NULL,
101};
102
103/* Call attach(port) for each registered driver. */
104static void attach_driver_chain(struct parport *port)
105{
106 /* caller has exclusive registration_lock */
107 struct parport_driver *drv;
108 list_for_each_entry(drv, &drivers, list)
109 drv->attach(port);
110}
111
112/* Call detach(port) for each registered driver. */
113static void detach_driver_chain(struct parport *port)
114{
115 struct parport_driver *drv;
116 /* caller has exclusive registration_lock */
117 list_for_each_entry(drv, &drivers, list)
118 drv->detach (port);
119}
120
121/* Ask kmod for some lowlevel drivers. */
122static void get_lowlevel_driver (void)
123{
124 /* There is no actual module called this: you should set
125 * up an alias for modutils. */
126 request_module ("parport_lowlevel");
127}
128
129/**
130 * parport_register_driver - register a parallel port device driver
131 * @drv: structure describing the driver
132 *
133 * This can be called by a parallel port device driver in order
134 * to receive notifications about ports being found in the
135 * system, as well as ports no longer available.
136 *
137 * The @drv structure is allocated by the caller and must not be
138 * deallocated until after calling parport_unregister_driver().
139 *
140 * The driver's attach() function may block. The port that
141 * attach() is given will be valid for the duration of the
142 * callback, but if the driver wants to take a copy of the
143 * pointer it must call parport_get_port() to do so. Calling
144 * parport_register_device() on that port will do this for you.
145 *
146 * The driver's detach() function may block. The port that
147 * detach() is given will be valid for the duration of the
148 * callback, but if the driver wants to take a copy of the
149 * pointer it must call parport_get_port() to do so.
150 *
151 * Returns 0 on success. Currently it always succeeds.
152 **/
153
154int parport_register_driver (struct parport_driver *drv)
155{
156 struct parport *port;
157
158 if (list_empty(&portlist))
159 get_lowlevel_driver ();
160
161 mutex_lock(®istration_lock);
162 list_for_each_entry(port, &portlist, list)
163 drv->attach(port);
164 list_add(&drv->list, &drivers);
165 mutex_unlock(®istration_lock);
166
167 return 0;
168}
169
170/**
171 * parport_unregister_driver - deregister a parallel port device driver
172 * @drv: structure describing the driver that was given to
173 * parport_register_driver()
174 *
175 * This should be called by a parallel port device driver that
176 * has registered itself using parport_register_driver() when it
177 * is about to be unloaded.
178 *
179 * When it returns, the driver's attach() routine will no longer
180 * be called, and for each port that attach() was called for, the
181 * detach() routine will have been called.
182 *
183 * All the driver's attach() and detach() calls are guaranteed to have
184 * finished by the time this function returns.
185 **/
186
187void parport_unregister_driver (struct parport_driver *drv)
188{
189 struct parport *port;
190
191 mutex_lock(®istration_lock);
192 list_del_init(&drv->list);
193 list_for_each_entry(port, &portlist, list)
194 drv->detach(port);
195 mutex_unlock(®istration_lock);
196}
197
198static void free_port (struct parport *port)
199{
200 int d;
201 spin_lock(&full_list_lock);
202 list_del(&port->full_list);
203 spin_unlock(&full_list_lock);
204 for (d = 0; d < 5; d++) {
205 kfree(port->probe_info[d].class_name);
206 kfree(port->probe_info[d].mfr);
207 kfree(port->probe_info[d].model);
208 kfree(port->probe_info[d].cmdset);
209 kfree(port->probe_info[d].description);
210 }
211
212 kfree(port->name);
213 kfree(port);
214}
215
216/**
217 * parport_get_port - increment a port's reference count
218 * @port: the port
219 *
220 * This ensures that a struct parport pointer remains valid
221 * until the matching parport_put_port() call.
222 **/
223
224struct parport *parport_get_port (struct parport *port)
225{
226 atomic_inc (&port->ref_count);
227 return port;
228}
229
230/**
231 * parport_put_port - decrement a port's reference count
232 * @port: the port
233 *
234 * This should be called once for each call to parport_get_port(),
235 * once the port is no longer needed.
236 **/
237
238void parport_put_port (struct parport *port)
239{
240 if (atomic_dec_and_test (&port->ref_count))
241 /* Can destroy it now. */
242 free_port (port);
243
244 return;
245}
246
247/**
248 * parport_register_port - register a parallel port
249 * @base: base I/O address
250 * @irq: IRQ line
251 * @dma: DMA channel
252 * @ops: pointer to the port driver's port operations structure
253 *
254 * When a parallel port (lowlevel) driver finds a port that
255 * should be made available to parallel port device drivers, it
256 * should call parport_register_port(). The @base, @irq, and
257 * @dma parameters are for the convenience of port drivers, and
258 * for ports where they aren't meaningful needn't be set to
259 * anything special. They can be altered afterwards by adjusting
260 * the relevant members of the parport structure that is returned
261 * and represents the port. They should not be tampered with
262 * after calling parport_announce_port, however.
263 *
264 * If there are parallel port device drivers in the system that
265 * have registered themselves using parport_register_driver(),
266 * they are not told about the port at this time; that is done by
267 * parport_announce_port().
268 *
269 * The @ops structure is allocated by the caller, and must not be
270 * deallocated before calling parport_remove_port().
271 *
272 * If there is no memory to allocate a new parport structure,
273 * this function will return %NULL.
274 **/
275
276struct parport *parport_register_port(unsigned long base, int irq, int dma,
277 struct parport_operations *ops)
278{
279 struct list_head *l;
280 struct parport *tmp;
281 int num;
282 int device;
283 char *name;
284
285 tmp = kmalloc(sizeof(struct parport), GFP_KERNEL);
286 if (!tmp) {
287 printk(KERN_WARNING "parport: memory squeeze\n");
288 return NULL;
289 }
290
291 /* Init our structure */
292 memset(tmp, 0, sizeof(struct parport));
293 tmp->base = base;
294 tmp->irq = irq;
295 tmp->dma = dma;
296 tmp->muxport = tmp->daisy = tmp->muxsel = -1;
297 tmp->modes = 0;
298 INIT_LIST_HEAD(&tmp->list);
299 tmp->devices = tmp->cad = NULL;
300 tmp->flags = 0;
301 tmp->ops = ops;
302 tmp->physport = tmp;
303 memset (tmp->probe_info, 0, 5 * sizeof (struct parport_device_info));
304 rwlock_init(&tmp->cad_lock);
305 spin_lock_init(&tmp->waitlist_lock);
306 spin_lock_init(&tmp->pardevice_lock);
307 tmp->ieee1284.mode = IEEE1284_MODE_COMPAT;
308 tmp->ieee1284.phase = IEEE1284_PH_FWD_IDLE;
309 sema_init(&tmp->ieee1284.irq, 0);
310 tmp->spintime = parport_default_spintime;
311 atomic_set (&tmp->ref_count, 1);
312 INIT_LIST_HEAD(&tmp->full_list);
313
314 name = kmalloc(15, GFP_KERNEL);
315 if (!name) {
316 printk(KERN_ERR "parport: memory squeeze\n");
317 kfree(tmp);
318 return NULL;
319 }
320 /* Search for the lowest free parport number. */
321
322 spin_lock(&full_list_lock);
323 for (l = all_ports.next, num = 0; l != &all_ports; l = l->next, num++) {
324 struct parport *p = list_entry(l, struct parport, full_list);
325 if (p->number != num)
326 break;
327 }
328 tmp->portnum = tmp->number = num;
329 list_add_tail(&tmp->full_list, l);
330 spin_unlock(&full_list_lock);
331
332 /*
333 * Now that the portnum is known finish doing the Init.
334 */
335 sprintf(name, "parport%d", tmp->portnum = tmp->number);
336 tmp->name = name;
337
338 for (device = 0; device < 5; device++)
339 /* assume the worst */
340 tmp->probe_info[device].class = PARPORT_CLASS_LEGACY;
341
342 tmp->waithead = tmp->waittail = NULL;
343
344 return tmp;
345}
346
347/**
348 * parport_announce_port - tell device drivers about a parallel port
349 * @port: parallel port to announce
350 *
351 * After a port driver has registered a parallel port with
352 * parport_register_port, and performed any necessary
353 * initialisation or adjustments, it should call
354 * parport_announce_port() in order to notify all device drivers
355 * that have called parport_register_driver(). Their attach()
356 * functions will be called, with @port as the parameter.
357 **/
358
359void parport_announce_port (struct parport *port)
360{
361 int i;
362
363#ifdef CONFIG_PARPORT_1284
364 /* Analyse the IEEE1284.3 topology of the port. */
365 parport_daisy_init(port);
366#endif
367
368 if (!port->dev)
369 printk(KERN_WARNING "%s: fix this legacy "
370 "no-device port driver!\n",
371 port->name);
372
373 parport_proc_register(port);
374 mutex_lock(®istration_lock);
375 spin_lock_irq(&parportlist_lock);
376 list_add_tail(&port->list, &portlist);
377 for (i = 1; i < 3; i++) {
378 struct parport *slave = port->slaves[i-1];
379 if (slave)
380 list_add_tail(&slave->list, &portlist);
381 }
382 spin_unlock_irq(&parportlist_lock);
383
384 /* Let drivers know that new port(s) has arrived. */
385 attach_driver_chain (port);
386 for (i = 1; i < 3; i++) {
387 struct parport *slave = port->slaves[i-1];
388 if (slave)
389 attach_driver_chain(slave);
390 }
391 mutex_unlock(®istration_lock);
392}
393
394/**
395 * parport_remove_port - deregister a parallel port
396 * @port: parallel port to deregister
397 *
398 * When a parallel port driver is forcibly unloaded, or a
399 * parallel port becomes inaccessible, the port driver must call
400 * this function in order to deal with device drivers that still
401 * want to use it.
402 *
403 * The parport structure associated with the port has its
404 * operations structure replaced with one containing 'null'
405 * operations that return errors or just don't do anything.
406 *
407 * Any drivers that have registered themselves using
408 * parport_register_driver() are notified that the port is no
409 * longer accessible by having their detach() routines called
410 * with @port as the parameter.
411 **/
412
413void parport_remove_port(struct parport *port)
414{
415 int i;
416
417 mutex_lock(®istration_lock);
418
419 /* Spread the word. */
420 detach_driver_chain (port);
421
422#ifdef CONFIG_PARPORT_1284
423 /* Forget the IEEE1284.3 topology of the port. */
424 parport_daisy_fini(port);
425 for (i = 1; i < 3; i++) {
426 struct parport *slave = port->slaves[i-1];
427 if (!slave)
428 continue;
429 detach_driver_chain(slave);
430 parport_daisy_fini(slave);
431 }
432#endif
433
434 port->ops = &dead_ops;
435 spin_lock(&parportlist_lock);
436 list_del_init(&port->list);
437 for (i = 1; i < 3; i++) {
438 struct parport *slave = port->slaves[i-1];
439 if (slave)
440 list_del_init(&slave->list);
441 }
442 spin_unlock(&parportlist_lock);
443
444 mutex_unlock(®istration_lock);
445
446 parport_proc_unregister(port);
447
448 for (i = 1; i < 3; i++) {
449 struct parport *slave = port->slaves[i-1];
450 if (slave)
451 parport_put_port(slave);
452 }
453}
454
455/**
456 * parport_register_device - register a device on a parallel port
457 * @port: port to which the device is attached
458 * @name: a name to refer to the device
459 * @pf: preemption callback
460 * @kf: kick callback (wake-up)
461 * @irq_func: interrupt handler
462 * @flags: registration flags
463 * @handle: data for callback functions
464 *
465 * This function, called by parallel port device drivers,
466 * declares that a device is connected to a port, and tells the
467 * system all it needs to know.
468 *
469 * The @name is allocated by the caller and must not be
470 * deallocated until the caller calls @parport_unregister_device
471 * for that device.
472 *
473 * The preemption callback function, @pf, is called when this
474 * device driver has claimed access to the port but another
475 * device driver wants to use it. It is given @handle as its
476 * parameter, and should return zero if it is willing for the
477 * system to release the port to another driver on its behalf.
478 * If it wants to keep control of the port it should return
479 * non-zero, and no action will be taken. It is good manners for
480 * the driver to try to release the port at the earliest
481 * opportunity after its preemption callback rejects a preemption
482 * attempt. Note that if a preemption callback is happy for
483 * preemption to go ahead, there is no need to release the port;
484 * it is done automatically. This function may not block, as it
485 * may be called from interrupt context. If the device driver
486 * does not support preemption, @pf can be %NULL.
487 *
488 * The wake-up ("kick") callback function, @kf, is called when
489 * the port is available to be claimed for exclusive access; that
490 * is, parport_claim() is guaranteed to succeed when called from
491 * inside the wake-up callback function. If the driver wants to
492 * claim the port it should do so; otherwise, it need not take
493 * any action. This function may not block, as it may be called
494 * from interrupt context. If the device driver does not want to
495 * be explicitly invited to claim the port in this way, @kf can
496 * be %NULL.
497 *
498 * The interrupt handler, @irq_func, is called when an interrupt
499 * arrives from the parallel port. Note that if a device driver
500 * wants to use interrupts it should use parport_enable_irq(),
501 * and can also check the irq member of the parport structure
502 * representing the port.
503 *
504 * The parallel port (lowlevel) driver is the one that has called
505 * request_irq() and whose interrupt handler is called first.
506 * This handler does whatever needs to be done to the hardware to
507 * acknowledge the interrupt (for PC-style ports there is nothing
508 * special to be done). It then tells the IEEE 1284 code about
509 * the interrupt, which may involve reacting to an IEEE 1284
510 * event depending on the current IEEE 1284 phase. After this,
511 * it calls @irq_func. Needless to say, @irq_func will be called
512 * from interrupt context, and may not block.
513 *
514 * The %PARPORT_DEV_EXCL flag is for preventing port sharing, and
515 * so should only be used when sharing the port with other device
516 * drivers is impossible and would lead to incorrect behaviour.
517 * Use it sparingly! Normally, @flags will be zero.
518 *
519 * This function returns a pointer to a structure that represents
520 * the device on the port, or %NULL if there is not enough memory
521 * to allocate space for that structure.
522 **/
523
524struct pardevice *
525parport_register_device(struct parport *port, const char *name,
526 int (*pf)(void *), void (*kf)(void *),
527 void (*irq_func)(void *),
528 int flags, void *handle)
529{
530 struct pardevice *tmp;
531
532 if (port->physport->flags & PARPORT_FLAG_EXCL) {
533 /* An exclusive device is registered. */
534 printk (KERN_DEBUG "%s: no more devices allowed\n",
535 port->name);
536 return NULL;
537 }
538
539 if (flags & PARPORT_DEV_LURK) {
540 if (!pf || !kf) {
541 printk(KERN_INFO "%s: refused to register lurking device (%s) without callbacks\n", port->name, name);
542 return NULL;
543 }
544 }
545
546 /* We up our own module reference count, and that of the port
547 on which a device is to be registered, to ensure that
548 neither of us gets unloaded while we sleep in (e.g.)
549 kmalloc.
550 */
551 if (!try_module_get(port->ops->owner)) {
552 return NULL;
553 }
554
555 parport_get_port (port);
556
557 tmp = kmalloc(sizeof(struct pardevice), GFP_KERNEL);
558 if (tmp == NULL) {
559 printk(KERN_WARNING "%s: memory squeeze, couldn't register %s.\n", port->name, name);
560 goto out;
561 }
562
563 tmp->state = kmalloc(sizeof(struct parport_state), GFP_KERNEL);
564 if (tmp->state == NULL) {
565 printk(KERN_WARNING "%s: memory squeeze, couldn't register %s.\n", port->name, name);
566 goto out_free_pardevice;
567 }
568
569 tmp->name = name;
570 tmp->port = port;
571 tmp->daisy = -1;
572 tmp->preempt = pf;
573 tmp->wakeup = kf;
574 tmp->private = handle;
575 tmp->flags = flags;
576 tmp->irq_func = irq_func;
577 tmp->waiting = 0;
578 tmp->timeout = 5 * HZ;
579
580 /* Chain this onto the list */
581 tmp->prev = NULL;
582 /*
583 * This function must not run from an irq handler so we don' t need
584 * to clear irq on the local CPU. -arca
585 */
586 spin_lock(&port->physport->pardevice_lock);
587
588 if (flags & PARPORT_DEV_EXCL) {
589 if (port->physport->devices) {
590 spin_unlock (&port->physport->pardevice_lock);
591 printk (KERN_DEBUG
592 "%s: cannot grant exclusive access for "
593 "device %s\n", port->name, name);
594 goto out_free_all;
595 }
596 port->flags |= PARPORT_FLAG_EXCL;
597 }
598
599 tmp->next = port->physport->devices;
600 wmb(); /* Make sure that tmp->next is written before it's
601 added to the list; see comments marked 'no locking
602 required' */
603 if (port->physport->devices)
604 port->physport->devices->prev = tmp;
605 port->physport->devices = tmp;
606 spin_unlock(&port->physport->pardevice_lock);
607
608 init_waitqueue_head(&tmp->wait_q);
609 tmp->timeslice = parport_default_timeslice;
610 tmp->waitnext = tmp->waitprev = NULL;
611
612 /*
613 * This has to be run as last thing since init_state may need other
614 * pardevice fields. -arca
615 */
616 port->ops->init_state(tmp, tmp->state);
617 if (!test_and_set_bit(PARPORT_DEVPROC_REGISTERED, &port->devflags)) {
618 port->proc_device = tmp;
619 parport_device_proc_register(tmp);
620 }
621 return tmp;
622
623 out_free_all:
624 kfree(tmp->state);
625 out_free_pardevice:
626 kfree(tmp);
627 out:
628 parport_put_port (port);
629 module_put(port->ops->owner);
630
631 return NULL;
632}
633
634/**
635 * parport_unregister_device - deregister a device on a parallel port
636 * @dev: pointer to structure representing device
637 *
638 * This undoes the effect of parport_register_device().
639 **/
640
641void parport_unregister_device(struct pardevice *dev)
642{
643 struct parport *port;
644
645#ifdef PARPORT_PARANOID
646 if (dev == NULL) {
647 printk(KERN_ERR "parport_unregister_device: passed NULL\n");
648 return;
649 }
650#endif
651
652 port = dev->port->physport;
653
654 if (port->proc_device == dev) {
655 port->proc_device = NULL;
656 clear_bit(PARPORT_DEVPROC_REGISTERED, &port->devflags);
657 parport_device_proc_unregister(dev);
658 }
659
660 if (port->cad == dev) {
661 printk(KERN_DEBUG "%s: %s forgot to release port\n",
662 port->name, dev->name);
663 parport_release (dev);
664 }
665
666 spin_lock(&port->pardevice_lock);
667 if (dev->next)
668 dev->next->prev = dev->prev;
669 if (dev->prev)
670 dev->prev->next = dev->next;
671 else
672 port->devices = dev->next;
673
674 if (dev->flags & PARPORT_DEV_EXCL)
675 port->flags &= ~PARPORT_FLAG_EXCL;
676
677 spin_unlock(&port->pardevice_lock);
678
679 /* Make sure we haven't left any pointers around in the wait
680 * list. */
681 spin_lock_irq(&port->waitlist_lock);
682 if (dev->waitprev || dev->waitnext || port->waithead == dev) {
683 if (dev->waitprev)
684 dev->waitprev->waitnext = dev->waitnext;
685 else
686 port->waithead = dev->waitnext;
687 if (dev->waitnext)
688 dev->waitnext->waitprev = dev->waitprev;
689 else
690 port->waittail = dev->waitprev;
691 }
692 spin_unlock_irq(&port->waitlist_lock);
693
694 kfree(dev->state);
695 kfree(dev);
696
697 module_put(port->ops->owner);
698 parport_put_port (port);
699}
700
701/**
702 * parport_find_number - find a parallel port by number
703 * @number: parallel port number
704 *
705 * This returns the parallel port with the specified number, or
706 * %NULL if there is none.
707 *
708 * There is an implicit parport_get_port() done already; to throw
709 * away the reference to the port that parport_find_number()
710 * gives you, use parport_put_port().
711 */
712
713struct parport *parport_find_number (int number)
714{
715 struct parport *port, *result = NULL;
716
717 if (list_empty(&portlist))
718 get_lowlevel_driver ();
719
720 spin_lock (&parportlist_lock);
721 list_for_each_entry(port, &portlist, list) {
722 if (port->number == number) {
723 result = parport_get_port (port);
724 break;
725 }
726 }
727 spin_unlock (&parportlist_lock);
728 return result;
729}
730
731/**
732 * parport_find_base - find a parallel port by base address
733 * @base: base I/O address
734 *
735 * This returns the parallel port with the specified base
736 * address, or %NULL if there is none.
737 *
738 * There is an implicit parport_get_port() done already; to throw
739 * away the reference to the port that parport_find_base()
740 * gives you, use parport_put_port().
741 */
742
743struct parport *parport_find_base (unsigned long base)
744{
745 struct parport *port, *result = NULL;
746
747 if (list_empty(&portlist))
748 get_lowlevel_driver ();
749
750 spin_lock (&parportlist_lock);
751 list_for_each_entry(port, &portlist, list) {
752 if (port->base == base) {
753 result = parport_get_port (port);
754 break;
755 }
756 }
757 spin_unlock (&parportlist_lock);
758 return result;
759}
760
761/**
762 * parport_claim - claim access to a parallel port device
763 * @dev: pointer to structure representing a device on the port
764 *
765 * This function will not block and so can be used from interrupt
766 * context. If parport_claim() succeeds in claiming access to
767 * the port it returns zero and the port is available to use. It
768 * may fail (returning non-zero) if the port is in use by another
769 * driver and that driver is not willing to relinquish control of
770 * the port.
771 **/
772
773int parport_claim(struct pardevice *dev)
774{
775 struct pardevice *oldcad;
776 struct parport *port = dev->port->physport;
777 unsigned long flags;
778
779 if (port->cad == dev) {
780 printk(KERN_INFO "%s: %s already owner\n",
781 dev->port->name,dev->name);
782 return 0;
783 }
784
785 /* Preempt any current device */
786 write_lock_irqsave (&port->cad_lock, flags);
787 if ((oldcad = port->cad) != NULL) {
788 if (oldcad->preempt) {
789 if (oldcad->preempt(oldcad->private))
790 goto blocked;
791 port->ops->save_state(port, dev->state);
792 } else
793 goto blocked;
794
795 if (port->cad != oldcad) {
796 /* I think we'll actually deadlock rather than
797 get here, but just in case.. */
798 printk(KERN_WARNING
799 "%s: %s released port when preempted!\n",
800 port->name, oldcad->name);
801 if (port->cad)
802 goto blocked;
803 }
804 }
805
806 /* Can't fail from now on, so mark ourselves as no longer waiting. */
807 if (dev->waiting & 1) {
808 dev->waiting = 0;
809
810 /* Take ourselves out of the wait list again. */
811 spin_lock_irq (&port->waitlist_lock);
812 if (dev->waitprev)
813 dev->waitprev->waitnext = dev->waitnext;
814 else
815 port->waithead = dev->waitnext;
816 if (dev->waitnext)
817 dev->waitnext->waitprev = dev->waitprev;
818 else
819 port->waittail = dev->waitprev;
820 spin_unlock_irq (&port->waitlist_lock);
821 dev->waitprev = dev->waitnext = NULL;
822 }
823
824 /* Now we do the change of devices */
825 port->cad = dev;
826
827#ifdef CONFIG_PARPORT_1284
828 /* If it's a mux port, select it. */
829 if (dev->port->muxport >= 0) {
830 /* FIXME */
831 port->muxsel = dev->port->muxport;
832 }
833
834 /* If it's a daisy chain device, select it. */
835 if (dev->daisy >= 0) {
836 /* This could be lazier. */
837 if (!parport_daisy_select (port, dev->daisy,
838 IEEE1284_MODE_COMPAT))
839 port->daisy = dev->daisy;
840 }
841#endif /* IEEE1284.3 support */
842
843 /* Restore control registers */
844 port->ops->restore_state(port, dev->state);
845 write_unlock_irqrestore(&port->cad_lock, flags);
846 dev->time = jiffies;
847 return 0;
848
849blocked:
850 /* If this is the first time we tried to claim the port, register an
851 interest. This is only allowed for devices sleeping in
852 parport_claim_or_block(), or those with a wakeup function. */
853
854 /* The cad_lock is still held for writing here */
855 if (dev->waiting & 2 || dev->wakeup) {
856 spin_lock (&port->waitlist_lock);
857 if (test_and_set_bit(0, &dev->waiting) == 0) {
858 /* First add ourselves to the end of the wait list. */
859 dev->waitnext = NULL;
860 dev->waitprev = port->waittail;
861 if (port->waittail) {
862 port->waittail->waitnext = dev;
863 port->waittail = dev;
864 } else
865 port->waithead = port->waittail = dev;
866 }
867 spin_unlock (&port->waitlist_lock);
868 }
869 write_unlock_irqrestore (&port->cad_lock, flags);
870 return -EAGAIN;
871}
872
873/**
874 * parport_claim_or_block - claim access to a parallel port device
875 * @dev: pointer to structure representing a device on the port
876 *
877 * This behaves like parport_claim(), but will block if necessary
878 * to wait for the port to be free. A return value of 1
879 * indicates that it slept; 0 means that it succeeded without
880 * needing to sleep. A negative error code indicates failure.
881 **/
882
883int parport_claim_or_block(struct pardevice *dev)
884{
885 int r;
886
887 /* Signal to parport_claim() that we can wait even without a
888 wakeup function. */
889 dev->waiting = 2;
890
891 /* Try to claim the port. If this fails, we need to sleep. */
892 r = parport_claim(dev);
893 if (r == -EAGAIN) {
894#ifdef PARPORT_DEBUG_SHARING
895 printk(KERN_DEBUG "%s: parport_claim() returned -EAGAIN\n", dev->name);
896#endif
897 /*
898 * FIXME!!! Use the proper locking for dev->waiting,
899 * and make this use the "wait_event_interruptible()"
900 * interfaces. The cli/sti that used to be here
901 * did nothing.
902 *
903 * See also parport_release()
904 */
905
906 /* If dev->waiting is clear now, an interrupt
907 gave us the port and we would deadlock if we slept. */
908 if (dev->waiting) {
909 interruptible_sleep_on (&dev->wait_q);
910 if (signal_pending (current)) {
911 return -EINTR;
912 }
913 r = 1;
914 } else {
915 r = 0;
916#ifdef PARPORT_DEBUG_SHARING
917 printk(KERN_DEBUG "%s: didn't sleep in parport_claim_or_block()\n",
918 dev->name);
919#endif
920 }
921
922#ifdef PARPORT_DEBUG_SHARING
923 if (dev->port->physport->cad != dev)
924 printk(KERN_DEBUG "%s: exiting parport_claim_or_block "
925 "but %s owns port!\n", dev->name,
926 dev->port->physport->cad ?
927 dev->port->physport->cad->name:"nobody");
928#endif
929 }
930 dev->waiting = 0;
931 return r;
932}
933
934/**
935 * parport_release - give up access to a parallel port device
936 * @dev: pointer to structure representing parallel port device
937 *
938 * This function cannot fail, but it should not be called without
939 * the port claimed. Similarly, if the port is already claimed
940 * you should not try claiming it again.
941 **/
942
943void parport_release(struct pardevice *dev)
944{
945 struct parport *port = dev->port->physport;
946 struct pardevice *pd;
947 unsigned long flags;
948
949 /* Make sure that dev is the current device */
950 write_lock_irqsave(&port->cad_lock, flags);
951 if (port->cad != dev) {
952 write_unlock_irqrestore (&port->cad_lock, flags);
953 printk(KERN_WARNING "%s: %s tried to release parport "
954 "when not owner\n", port->name, dev->name);
955 return;
956 }
957
958#ifdef CONFIG_PARPORT_1284
959 /* If this is on a mux port, deselect it. */
960 if (dev->port->muxport >= 0) {
961 /* FIXME */
962 port->muxsel = -1;
963 }
964
965 /* If this is a daisy device, deselect it. */
966 if (dev->daisy >= 0) {
967 parport_daisy_deselect_all (port);
968 port->daisy = -1;
969 }
970#endif
971
972 port->cad = NULL;
973 write_unlock_irqrestore(&port->cad_lock, flags);
974
975 /* Save control registers */
976 port->ops->save_state(port, dev->state);
977
978 /* If anybody is waiting, find out who's been there longest and
979 then wake them up. (Note: no locking required) */
980 /* !!! LOCKING IS NEEDED HERE */
981 for (pd = port->waithead; pd; pd = pd->waitnext) {
982 if (pd->waiting & 2) { /* sleeping in claim_or_block */
983 parport_claim(pd);
984 if (waitqueue_active(&pd->wait_q))
985 wake_up_interruptible(&pd->wait_q);
986 return;
987 } else if (pd->wakeup) {
988 pd->wakeup(pd->private);
989 if (dev->port->cad) /* racy but no matter */
990 return;
991 } else {
992 printk(KERN_ERR "%s: don't know how to wake %s\n", port->name, pd->name);
993 }
994 }
995
996 /* Nobody was waiting, so walk the list to see if anyone is
997 interested in being woken up. (Note: no locking required) */
998 /* !!! LOCKING IS NEEDED HERE */
999 for (pd = port->devices; (port->cad == NULL) && pd; pd = pd->next) {
1000 if (pd->wakeup && pd != dev)
1001 pd->wakeup(pd->private);
1002 }
1003}
1004
1005irqreturn_t parport_irq_handler(int irq, void *dev_id)
1006{
1007 struct parport *port = dev_id;
1008
1009 parport_generic_irq(port);
1010
1011 return IRQ_HANDLED;
1012}
1013
1014/* Exported symbols for modules. */
1015
1016EXPORT_SYMBOL(parport_claim);
1017EXPORT_SYMBOL(parport_claim_or_block);
1018EXPORT_SYMBOL(parport_release);
1019EXPORT_SYMBOL(parport_register_port);
1020EXPORT_SYMBOL(parport_announce_port);
1021EXPORT_SYMBOL(parport_remove_port);
1022EXPORT_SYMBOL(parport_register_driver);
1023EXPORT_SYMBOL(parport_unregister_driver);
1024EXPORT_SYMBOL(parport_register_device);
1025EXPORT_SYMBOL(parport_unregister_device);
1026EXPORT_SYMBOL(parport_get_port);
1027EXPORT_SYMBOL(parport_put_port);
1028EXPORT_SYMBOL(parport_find_number);
1029EXPORT_SYMBOL(parport_find_base);
1030EXPORT_SYMBOL(parport_irq_handler);
1031
1032MODULE_LICENSE("GPL");
1/*
2 * Parallel-port resource manager code.
3 *
4 * 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
20#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/signal.h>
31#include <linux/kmod.h>
32#include <linux/device.h>
33
34#include <linux/spinlock.h>
35#include <linux/mutex.h>
36#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 DEFINE_MUTEX(registration_lock);
53
54/* What you can do to a port that's gone away.. */
55static void dead_write_lines(struct parport *p, unsigned char b){}
56static unsigned char dead_read_lines(struct parport *p) { return 0; }
57static unsigned char dead_frob_lines(struct parport *p, unsigned char b,
58 unsigned char c) { return 0; }
59static void dead_onearg(struct parport *p){}
60static void dead_initstate(struct pardevice *d, struct parport_state *s) { }
61static void dead_state(struct parport *p, struct parport_state *s) { }
62static size_t dead_write(struct parport *p, const void *b, size_t l, int f)
63{ return 0; }
64static size_t dead_read(struct parport *p, void *b, size_t l, int f)
65{ return 0; }
66static struct parport_operations dead_ops = {
67 .write_data = dead_write_lines, /* data */
68 .read_data = dead_read_lines,
69
70 .write_control = dead_write_lines, /* control */
71 .read_control = dead_read_lines,
72 .frob_control = dead_frob_lines,
73
74 .read_status = dead_read_lines, /* status */
75
76 .enable_irq = dead_onearg, /* enable_irq */
77 .disable_irq = dead_onearg, /* disable_irq */
78
79 .data_forward = dead_onearg, /* data_forward */
80 .data_reverse = dead_onearg, /* data_reverse */
81
82 .init_state = dead_initstate, /* init_state */
83 .save_state = dead_state,
84 .restore_state = dead_state,
85
86 .epp_write_data = dead_write, /* epp */
87 .epp_read_data = dead_read,
88 .epp_write_addr = dead_write,
89 .epp_read_addr = dead_read,
90
91 .ecp_write_data = dead_write, /* ecp */
92 .ecp_read_data = dead_read,
93 .ecp_write_addr = dead_write,
94
95 .compat_write_data = dead_write, /* compat */
96 .nibble_read_data = dead_read, /* nibble */
97 .byte_read_data = dead_read, /* byte */
98
99 .owner = NULL,
100};
101
102static struct device_type parport_device_type = {
103 .name = "parport",
104};
105
106static int is_parport(struct device *dev)
107{
108 return dev->type == &parport_device_type;
109}
110
111static int parport_probe(struct device *dev)
112{
113 struct parport_driver *drv;
114
115 if (is_parport(dev))
116 return -ENODEV;
117
118 drv = to_parport_driver(dev->driver);
119 if (!drv->probe) {
120 /* if driver has not defined a custom probe */
121 struct pardevice *par_dev = to_pardevice(dev);
122
123 if (strcmp(par_dev->name, drv->name))
124 return -ENODEV;
125 return 0;
126 }
127 /* if driver defined its own probe */
128 return drv->probe(to_pardevice(dev));
129}
130
131static const struct bus_type parport_bus_type = {
132 .name = "parport",
133 .probe = parport_probe,
134};
135
136int parport_bus_init(void)
137{
138 return bus_register(&parport_bus_type);
139}
140
141void parport_bus_exit(void)
142{
143 bus_unregister(&parport_bus_type);
144}
145
146/*
147 * iterates through all the drivers registered with the bus and sends the port
148 * details to the match_port callback of the driver, so that the driver can
149 * know about the new port that just registered with the bus and decide if it
150 * wants to use this new port.
151 */
152static int driver_check(struct device_driver *dev_drv, void *_port)
153{
154 struct parport *port = _port;
155 struct parport_driver *drv = to_parport_driver(dev_drv);
156
157 if (drv->match_port)
158 drv->match_port(port);
159 return 0;
160}
161
162/* Call attach(port) for each registered driver. */
163static void attach_driver_chain(struct parport *port)
164{
165 /* caller has exclusive registration_lock */
166
167 /*
168 * call the driver_check function of the drivers registered in
169 * new device model
170 */
171
172 bus_for_each_drv(&parport_bus_type, NULL, port, driver_check);
173}
174
175static int driver_detach(struct device_driver *_drv, void *_port)
176{
177 struct parport *port = _port;
178 struct parport_driver *drv = to_parport_driver(_drv);
179
180 if (drv->detach)
181 drv->detach(port);
182 return 0;
183}
184
185/* Call detach(port) for each registered driver. */
186static void detach_driver_chain(struct parport *port)
187{
188 /* caller has exclusive registration_lock */
189
190 /*
191 * call the detach function of the drivers registered in
192 * new device model
193 */
194
195 bus_for_each_drv(&parport_bus_type, NULL, port, driver_detach);
196}
197
198/* Ask kmod for some lowlevel drivers. */
199static void get_lowlevel_driver(void)
200{
201 /*
202 * There is no actual module called this: you should set
203 * up an alias for modutils.
204 */
205 request_module("parport_lowlevel");
206}
207
208/*
209 * iterates through all the devices connected to the bus and sends the device
210 * details to the match_port callback of the driver, so that the driver can
211 * know what are all the ports that are connected to the bus and choose the
212 * port to which it wants to register its device.
213 */
214static int port_check(struct device *dev, void *dev_drv)
215{
216 struct parport_driver *drv = dev_drv;
217
218 /* only send ports, do not send other devices connected to bus */
219 if (is_parport(dev))
220 drv->match_port(to_parport_dev(dev));
221 return 0;
222}
223
224/*
225 * Iterates through all the devices connected to the bus and return 1
226 * if the device is a parallel port.
227 */
228
229static int port_detect(struct device *dev, void *dev_drv)
230{
231 if (is_parport(dev))
232 return 1;
233 return 0;
234}
235
236/**
237 * __parport_register_driver - register a parallel port device driver
238 * @drv: structure describing the driver
239 * @owner: owner module of drv
240 * @mod_name: module name string
241 *
242 * This can be called by a parallel port device driver in order
243 * to receive notifications about ports being found in the
244 * system, as well as ports no longer available.
245 *
246 * If devmodel is true then the new device model is used
247 * for registration.
248 *
249 * The @drv structure is allocated by the caller and must not be
250 * deallocated until after calling parport_unregister_driver().
251 *
252 * If using the non device model:
253 * The driver's attach() function may block. The port that
254 * attach() is given will be valid for the duration of the
255 * callback, but if the driver wants to take a copy of the
256 * pointer it must call parport_get_port() to do so. Calling
257 * parport_register_device() on that port will do this for you.
258 *
259 * The driver's detach() function may block. The port that
260 * detach() is given will be valid for the duration of the
261 * callback, but if the driver wants to take a copy of the
262 * pointer it must call parport_get_port() to do so.
263 *
264 *
265 * Returns 0 on success. The non device model will always succeeds.
266 * but the new device model can fail and will return the error code.
267 **/
268
269int __parport_register_driver(struct parport_driver *drv, struct module *owner,
270 const char *mod_name)
271{
272 /* using device model */
273 int ret;
274
275 /* initialize common driver fields */
276 drv->driver.name = drv->name;
277 drv->driver.bus = &parport_bus_type;
278 drv->driver.owner = owner;
279 drv->driver.mod_name = mod_name;
280 ret = driver_register(&drv->driver);
281 if (ret)
282 return ret;
283
284 /*
285 * check if bus has any parallel port registered, if
286 * none is found then load the lowlevel driver.
287 */
288 ret = bus_for_each_dev(&parport_bus_type, NULL, NULL,
289 port_detect);
290 if (!ret)
291 get_lowlevel_driver();
292
293 mutex_lock(®istration_lock);
294 if (drv->match_port)
295 bus_for_each_dev(&parport_bus_type, NULL, drv,
296 port_check);
297 mutex_unlock(®istration_lock);
298
299 return 0;
300}
301EXPORT_SYMBOL(__parport_register_driver);
302
303static int port_detach(struct device *dev, void *_drv)
304{
305 struct parport_driver *drv = _drv;
306
307 if (is_parport(dev) && drv->detach)
308 drv->detach(to_parport_dev(dev));
309
310 return 0;
311}
312
313/**
314 * parport_unregister_driver - deregister a parallel port device driver
315 * @drv: structure describing the driver that was given to
316 * parport_register_driver()
317 *
318 * This should be called by a parallel port device driver that
319 * has registered itself using parport_register_driver() when it
320 * is about to be unloaded.
321 *
322 * When it returns, the driver's attach() routine will no longer
323 * be called, and for each port that attach() was called for, the
324 * detach() routine will have been called.
325 *
326 * All the driver's attach() and detach() calls are guaranteed to have
327 * finished by the time this function returns.
328 **/
329
330void parport_unregister_driver(struct parport_driver *drv)
331{
332 mutex_lock(®istration_lock);
333 bus_for_each_dev(&parport_bus_type, NULL, drv, port_detach);
334 driver_unregister(&drv->driver);
335 mutex_unlock(®istration_lock);
336}
337EXPORT_SYMBOL(parport_unregister_driver);
338
339static void free_port(struct device *dev)
340{
341 int d;
342 struct parport *port = to_parport_dev(dev);
343
344 spin_lock(&full_list_lock);
345 list_del(&port->full_list);
346 spin_unlock(&full_list_lock);
347 for (d = 0; d < 5; d++) {
348 kfree(port->probe_info[d].class_name);
349 kfree(port->probe_info[d].mfr);
350 kfree(port->probe_info[d].model);
351 kfree(port->probe_info[d].cmdset);
352 kfree(port->probe_info[d].description);
353 }
354
355 kfree(port);
356}
357
358/**
359 * parport_get_port - increment a port's reference count
360 * @port: the port
361 *
362 * This ensures that a struct parport pointer remains valid
363 * until the matching parport_put_port() call.
364 **/
365
366struct parport *parport_get_port(struct parport *port)
367{
368 struct device *dev = get_device(&port->bus_dev);
369
370 return to_parport_dev(dev);
371}
372EXPORT_SYMBOL(parport_get_port);
373
374void parport_del_port(struct parport *port)
375{
376 device_unregister(&port->bus_dev);
377}
378EXPORT_SYMBOL(parport_del_port);
379
380/**
381 * parport_put_port - decrement a port's reference count
382 * @port: the port
383 *
384 * This should be called once for each call to parport_get_port(),
385 * once the port is no longer needed. When the reference count reaches
386 * zero (port is no longer used), free_port is called.
387 **/
388
389void parport_put_port(struct parport *port)
390{
391 put_device(&port->bus_dev);
392}
393EXPORT_SYMBOL(parport_put_port);
394
395/**
396 * parport_register_port - register a parallel port
397 * @base: base I/O address
398 * @irq: IRQ line
399 * @dma: DMA channel
400 * @ops: pointer to the port driver's port operations structure
401 *
402 * When a parallel port (lowlevel) driver finds a port that
403 * should be made available to parallel port device drivers, it
404 * should call parport_register_port(). The @base, @irq, and
405 * @dma parameters are for the convenience of port drivers, and
406 * for ports where they aren't meaningful needn't be set to
407 * anything special. They can be altered afterwards by adjusting
408 * the relevant members of the parport structure that is returned
409 * and represents the port. They should not be tampered with
410 * after calling parport_announce_port, however.
411 *
412 * If there are parallel port device drivers in the system that
413 * have registered themselves using parport_register_driver(),
414 * they are not told about the port at this time; that is done by
415 * parport_announce_port().
416 *
417 * The @ops structure is allocated by the caller, and must not be
418 * deallocated before calling parport_remove_port().
419 *
420 * If there is no memory to allocate a new parport structure,
421 * this function will return %NULL.
422 **/
423
424struct parport *parport_register_port(unsigned long base, int irq, int dma,
425 struct parport_operations *ops)
426{
427 struct list_head *l;
428 struct parport *tmp;
429 int num;
430 int device;
431 int ret;
432
433 tmp = kzalloc(sizeof(struct parport), GFP_KERNEL);
434 if (!tmp)
435 return NULL;
436
437 /* Init our structure */
438 tmp->base = base;
439 tmp->irq = irq;
440 tmp->dma = dma;
441 tmp->muxport = tmp->daisy = tmp->muxsel = -1;
442 INIT_LIST_HEAD(&tmp->list);
443 tmp->ops = ops;
444 tmp->physport = tmp;
445 rwlock_init(&tmp->cad_lock);
446 spin_lock_init(&tmp->waitlist_lock);
447 spin_lock_init(&tmp->pardevice_lock);
448 tmp->ieee1284.mode = IEEE1284_MODE_COMPAT;
449 tmp->ieee1284.phase = IEEE1284_PH_FWD_IDLE;
450 sema_init(&tmp->ieee1284.irq, 0);
451 tmp->spintime = parport_default_spintime;
452 atomic_set(&tmp->ref_count, 1);
453
454 /* Search for the lowest free parport number. */
455
456 spin_lock(&full_list_lock);
457 num = 0;
458 list_for_each(l, &all_ports) {
459 struct parport *p = list_entry(l, struct parport, full_list);
460
461 if (p->number != num++)
462 break;
463 }
464 tmp->portnum = tmp->number = num;
465 list_add_tail(&tmp->full_list, l);
466 spin_unlock(&full_list_lock);
467
468 /*
469 * Now that the portnum is known finish doing the Init.
470 */
471 dev_set_name(&tmp->bus_dev, "parport%d", tmp->portnum);
472 tmp->bus_dev.bus = &parport_bus_type;
473 tmp->bus_dev.release = free_port;
474 tmp->bus_dev.type = &parport_device_type;
475
476 tmp->name = dev_name(&tmp->bus_dev);
477
478 for (device = 0; device < 5; device++)
479 /* assume the worst */
480 tmp->probe_info[device].class = PARPORT_CLASS_LEGACY;
481
482 ret = device_register(&tmp->bus_dev);
483 if (ret) {
484 put_device(&tmp->bus_dev);
485 return NULL;
486 }
487
488 return tmp;
489}
490EXPORT_SYMBOL(parport_register_port);
491
492/**
493 * parport_announce_port - tell device drivers about a parallel port
494 * @port: parallel port to announce
495 *
496 * After a port driver has registered a parallel port with
497 * parport_register_port, and performed any necessary
498 * initialisation or adjustments, it should call
499 * parport_announce_port() in order to notify all device drivers
500 * that have called parport_register_driver(). Their attach()
501 * functions will be called, with @port as the parameter.
502 **/
503
504void parport_announce_port(struct parport *port)
505{
506 int i;
507
508#ifdef CONFIG_PARPORT_1284
509 /* Analyse the IEEE1284.3 topology of the port. */
510 parport_daisy_init(port);
511#endif
512
513 if (!port->dev)
514 pr_warn("%s: fix this legacy no-device port driver!\n",
515 port->name);
516
517 parport_proc_register(port);
518 mutex_lock(®istration_lock);
519 spin_lock_irq(&parportlist_lock);
520 list_add_tail(&port->list, &portlist);
521 for (i = 1; i < 3; i++) {
522 struct parport *slave = port->slaves[i-1];
523 if (slave)
524 list_add_tail(&slave->list, &portlist);
525 }
526 spin_unlock_irq(&parportlist_lock);
527
528 /* Let drivers know that new port(s) has arrived. */
529 attach_driver_chain(port);
530 for (i = 1; i < 3; i++) {
531 struct parport *slave = port->slaves[i-1];
532 if (slave)
533 attach_driver_chain(slave);
534 }
535 mutex_unlock(®istration_lock);
536}
537EXPORT_SYMBOL(parport_announce_port);
538
539/**
540 * parport_remove_port - deregister a parallel port
541 * @port: parallel port to deregister
542 *
543 * When a parallel port driver is forcibly unloaded, or a
544 * parallel port becomes inaccessible, the port driver must call
545 * this function in order to deal with device drivers that still
546 * want to use it.
547 *
548 * The parport structure associated with the port has its
549 * operations structure replaced with one containing 'null'
550 * operations that return errors or just don't do anything.
551 *
552 * Any drivers that have registered themselves using
553 * parport_register_driver() are notified that the port is no
554 * longer accessible by having their detach() routines called
555 * with @port as the parameter.
556 **/
557
558void parport_remove_port(struct parport *port)
559{
560 int i;
561
562 mutex_lock(®istration_lock);
563
564 /* Spread the word. */
565 detach_driver_chain(port);
566
567#ifdef CONFIG_PARPORT_1284
568 /* Forget the IEEE1284.3 topology of the port. */
569 parport_daisy_fini(port);
570 for (i = 1; i < 3; i++) {
571 struct parport *slave = port->slaves[i-1];
572 if (!slave)
573 continue;
574 detach_driver_chain(slave);
575 parport_daisy_fini(slave);
576 }
577#endif
578
579 port->ops = &dead_ops;
580 spin_lock(&parportlist_lock);
581 list_del_init(&port->list);
582 for (i = 1; i < 3; i++) {
583 struct parport *slave = port->slaves[i-1];
584 if (slave)
585 list_del_init(&slave->list);
586 }
587 spin_unlock(&parportlist_lock);
588
589 mutex_unlock(®istration_lock);
590
591 parport_proc_unregister(port);
592
593 for (i = 1; i < 3; i++) {
594 struct parport *slave = port->slaves[i-1];
595 if (slave)
596 parport_put_port(slave);
597 }
598}
599EXPORT_SYMBOL(parport_remove_port);
600
601static void free_pardevice(struct device *dev)
602{
603 struct pardevice *par_dev = to_pardevice(dev);
604
605 kfree_const(par_dev->name);
606 kfree(par_dev);
607}
608
609/**
610 * parport_register_dev_model - register a device on a parallel port
611 * @port: port to which the device is attached
612 * @name: a name to refer to the device
613 * @par_dev_cb: struct containing callbacks
614 * @id: device number to be given to the device
615 *
616 * This function, called by parallel port device drivers,
617 * declares that a device is connected to a port, and tells the
618 * system all it needs to know.
619 *
620 * The struct pardev_cb contains pointer to callbacks. preemption
621 * callback function, @preempt, is called when this device driver
622 * has claimed access to the port but another device driver wants
623 * to use it. It is given, @private, as its parameter, and should
624 * return zero if it is willing for the system to release the port
625 * to another driver on its behalf. If it wants to keep control of
626 * the port it should return non-zero, and no action will be taken.
627 * It is good manners for the driver to try to release the port at
628 * the earliest opportunity after its preemption callback rejects a
629 * preemption attempt. Note that if a preemption callback is happy
630 * for preemption to go ahead, there is no need to release the
631 * port; it is done automatically. This function may not block, as
632 * it may be called from interrupt context. If the device driver
633 * does not support preemption, @preempt can be %NULL.
634 *
635 * The wake-up ("kick") callback function, @wakeup, is called when
636 * the port is available to be claimed for exclusive access; that
637 * is, parport_claim() is guaranteed to succeed when called from
638 * inside the wake-up callback function. If the driver wants to
639 * claim the port it should do so; otherwise, it need not take
640 * any action. This function may not block, as it may be called
641 * from interrupt context. If the device driver does not want to
642 * be explicitly invited to claim the port in this way, @wakeup can
643 * be %NULL.
644 *
645 * The interrupt handler, @irq_func, is called when an interrupt
646 * arrives from the parallel port. Note that if a device driver
647 * wants to use interrupts it should use parport_enable_irq(),
648 * and can also check the irq member of the parport structure
649 * representing the port.
650 *
651 * The parallel port (lowlevel) driver is the one that has called
652 * request_irq() and whose interrupt handler is called first.
653 * This handler does whatever needs to be done to the hardware to
654 * acknowledge the interrupt (for PC-style ports there is nothing
655 * special to be done). It then tells the IEEE 1284 code about
656 * the interrupt, which may involve reacting to an IEEE 1284
657 * event depending on the current IEEE 1284 phase. After this,
658 * it calls @irq_func. Needless to say, @irq_func will be called
659 * from interrupt context, and may not block.
660 *
661 * The %PARPORT_DEV_EXCL flag is for preventing port sharing, and
662 * so should only be used when sharing the port with other device
663 * drivers is impossible and would lead to incorrect behaviour.
664 * Use it sparingly! Normally, @flags will be zero.
665 *
666 * This function returns a pointer to a structure that represents
667 * the device on the port, or %NULL if there is not enough memory
668 * to allocate space for that structure.
669 **/
670
671struct pardevice *
672parport_register_dev_model(struct parport *port, const char *name,
673 const struct pardev_cb *par_dev_cb, int id)
674{
675 struct pardevice *par_dev;
676 const char *devname;
677 int ret;
678
679 if (port->physport->flags & PARPORT_FLAG_EXCL) {
680 /* An exclusive device is registered. */
681 pr_err("%s: no more devices allowed\n", port->name);
682 return NULL;
683 }
684
685 if (par_dev_cb->flags & PARPORT_DEV_LURK) {
686 if (!par_dev_cb->preempt || !par_dev_cb->wakeup) {
687 pr_info("%s: refused to register lurking device (%s) without callbacks\n",
688 port->name, name);
689 return NULL;
690 }
691 }
692
693 if (par_dev_cb->flags & PARPORT_DEV_EXCL) {
694 if (port->physport->devices) {
695 /*
696 * If a device is already registered and this new
697 * device wants exclusive access, then no need to
698 * continue as we can not grant exclusive access to
699 * this device.
700 */
701 pr_err("%s: cannot grant exclusive access for device %s\n",
702 port->name, name);
703 return NULL;
704 }
705 }
706
707 if (!try_module_get(port->ops->owner))
708 return NULL;
709
710 parport_get_port(port);
711
712 par_dev = kzalloc(sizeof(*par_dev), GFP_KERNEL);
713 if (!par_dev)
714 goto err_put_port;
715
716 par_dev->state = kzalloc(sizeof(*par_dev->state), GFP_KERNEL);
717 if (!par_dev->state)
718 goto err_put_par_dev;
719
720 devname = kstrdup_const(name, GFP_KERNEL);
721 if (!devname)
722 goto err_free_par_dev;
723
724 par_dev->name = devname;
725 par_dev->port = port;
726 par_dev->daisy = -1;
727 par_dev->preempt = par_dev_cb->preempt;
728 par_dev->wakeup = par_dev_cb->wakeup;
729 par_dev->private = par_dev_cb->private;
730 par_dev->flags = par_dev_cb->flags;
731 par_dev->irq_func = par_dev_cb->irq_func;
732 par_dev->waiting = 0;
733 par_dev->timeout = 5 * HZ;
734
735 par_dev->dev.parent = &port->bus_dev;
736 par_dev->dev.bus = &parport_bus_type;
737 ret = dev_set_name(&par_dev->dev, "%s.%d", devname, id);
738 if (ret)
739 goto err_free_devname;
740 par_dev->dev.release = free_pardevice;
741 par_dev->devmodel = true;
742 ret = device_register(&par_dev->dev);
743 if (ret) {
744 kfree(par_dev->state);
745 put_device(&par_dev->dev);
746 goto err_put_port;
747 }
748
749 /* Chain this onto the list */
750 par_dev->prev = NULL;
751 /*
752 * This function must not run from an irq handler so we don' t need
753 * to clear irq on the local CPU. -arca
754 */
755 spin_lock(&port->physport->pardevice_lock);
756
757 if (par_dev_cb->flags & PARPORT_DEV_EXCL) {
758 if (port->physport->devices) {
759 spin_unlock(&port->physport->pardevice_lock);
760 pr_debug("%s: cannot grant exclusive access for device %s\n",
761 port->name, name);
762 kfree(par_dev->state);
763 device_unregister(&par_dev->dev);
764 goto err_put_port;
765 }
766 port->flags |= PARPORT_FLAG_EXCL;
767 }
768
769 par_dev->next = port->physport->devices;
770 wmb(); /*
771 * Make sure that tmp->next is written before it's
772 * added to the list; see comments marked 'no locking
773 * required'
774 */
775 if (port->physport->devices)
776 port->physport->devices->prev = par_dev;
777 port->physport->devices = par_dev;
778 spin_unlock(&port->physport->pardevice_lock);
779
780 init_waitqueue_head(&par_dev->wait_q);
781 par_dev->timeslice = parport_default_timeslice;
782 par_dev->waitnext = NULL;
783 par_dev->waitprev = NULL;
784
785 /*
786 * This has to be run as last thing since init_state may need other
787 * pardevice fields. -arca
788 */
789 port->ops->init_state(par_dev, par_dev->state);
790 if (!test_and_set_bit(PARPORT_DEVPROC_REGISTERED, &port->devflags)) {
791 port->proc_device = par_dev;
792 parport_device_proc_register(par_dev);
793 }
794
795 return par_dev;
796
797err_free_devname:
798 kfree_const(devname);
799err_free_par_dev:
800 kfree(par_dev->state);
801err_put_par_dev:
802 if (!par_dev->devmodel)
803 kfree(par_dev);
804err_put_port:
805 parport_put_port(port);
806 module_put(port->ops->owner);
807
808 return NULL;
809}
810EXPORT_SYMBOL(parport_register_dev_model);
811
812/**
813 * parport_unregister_device - deregister a device on a parallel port
814 * @dev: pointer to structure representing device
815 *
816 * This undoes the effect of parport_register_device().
817 **/
818
819void parport_unregister_device(struct pardevice *dev)
820{
821 struct parport *port;
822
823#ifdef PARPORT_PARANOID
824 if (!dev) {
825 pr_err("%s: passed NULL\n", __func__);
826 return;
827 }
828#endif
829
830 port = dev->port->physport;
831
832 if (port->proc_device == dev) {
833 port->proc_device = NULL;
834 clear_bit(PARPORT_DEVPROC_REGISTERED, &port->devflags);
835 parport_device_proc_unregister(dev);
836 }
837
838 if (port->cad == dev) {
839 printk(KERN_DEBUG "%s: %s forgot to release port\n",
840 port->name, dev->name);
841 parport_release(dev);
842 }
843
844 spin_lock(&port->pardevice_lock);
845 if (dev->next)
846 dev->next->prev = dev->prev;
847 if (dev->prev)
848 dev->prev->next = dev->next;
849 else
850 port->devices = dev->next;
851
852 if (dev->flags & PARPORT_DEV_EXCL)
853 port->flags &= ~PARPORT_FLAG_EXCL;
854
855 spin_unlock(&port->pardevice_lock);
856
857 /*
858 * Make sure we haven't left any pointers around in the wait
859 * list.
860 */
861 spin_lock_irq(&port->waitlist_lock);
862 if (dev->waitprev || dev->waitnext || port->waithead == dev) {
863 if (dev->waitprev)
864 dev->waitprev->waitnext = dev->waitnext;
865 else
866 port->waithead = dev->waitnext;
867 if (dev->waitnext)
868 dev->waitnext->waitprev = dev->waitprev;
869 else
870 port->waittail = dev->waitprev;
871 }
872 spin_unlock_irq(&port->waitlist_lock);
873
874 kfree(dev->state);
875 device_unregister(&dev->dev);
876
877 module_put(port->ops->owner);
878 parport_put_port(port);
879}
880EXPORT_SYMBOL(parport_unregister_device);
881
882/**
883 * parport_find_number - find a parallel port by number
884 * @number: parallel port number
885 *
886 * This returns the parallel port with the specified number, or
887 * %NULL if there is none.
888 *
889 * There is an implicit parport_get_port() done already; to throw
890 * away the reference to the port that parport_find_number()
891 * gives you, use parport_put_port().
892 */
893
894struct parport *parport_find_number(int number)
895{
896 struct parport *port, *result = NULL;
897
898 if (list_empty(&portlist))
899 get_lowlevel_driver();
900
901 spin_lock(&parportlist_lock);
902 list_for_each_entry(port, &portlist, list) {
903 if (port->number == number) {
904 result = parport_get_port(port);
905 break;
906 }
907 }
908 spin_unlock(&parportlist_lock);
909 return result;
910}
911EXPORT_SYMBOL(parport_find_number);
912
913/**
914 * parport_find_base - find a parallel port by base address
915 * @base: base I/O address
916 *
917 * This returns the parallel port with the specified base
918 * address, or %NULL if there is none.
919 *
920 * There is an implicit parport_get_port() done already; to throw
921 * away the reference to the port that parport_find_base()
922 * gives you, use parport_put_port().
923 */
924
925struct parport *parport_find_base(unsigned long base)
926{
927 struct parport *port, *result = NULL;
928
929 if (list_empty(&portlist))
930 get_lowlevel_driver();
931
932 spin_lock(&parportlist_lock);
933 list_for_each_entry(port, &portlist, list) {
934 if (port->base == base) {
935 result = parport_get_port(port);
936 break;
937 }
938 }
939 spin_unlock(&parportlist_lock);
940 return result;
941}
942EXPORT_SYMBOL(parport_find_base);
943
944/**
945 * parport_claim - claim access to a parallel port device
946 * @dev: pointer to structure representing a device on the port
947 *
948 * This function will not block and so can be used from interrupt
949 * context. If parport_claim() succeeds in claiming access to
950 * the port it returns zero and the port is available to use. It
951 * may fail (returning non-zero) if the port is in use by another
952 * driver and that driver is not willing to relinquish control of
953 * the port.
954 **/
955
956int parport_claim(struct pardevice *dev)
957{
958 struct pardevice *oldcad;
959 struct parport *port = dev->port->physport;
960 unsigned long flags;
961
962 if (port->cad == dev) {
963 pr_info("%s: %s already owner\n", dev->port->name, dev->name);
964 return 0;
965 }
966
967 /* Preempt any current device */
968 write_lock_irqsave(&port->cad_lock, flags);
969 oldcad = port->cad;
970 if (oldcad) {
971 if (oldcad->preempt) {
972 if (oldcad->preempt(oldcad->private))
973 goto blocked;
974 port->ops->save_state(port, dev->state);
975 } else
976 goto blocked;
977
978 if (port->cad != oldcad) {
979 /*
980 * I think we'll actually deadlock rather than
981 * get here, but just in case..
982 */
983 pr_warn("%s: %s released port when preempted!\n",
984 port->name, oldcad->name);
985 if (port->cad)
986 goto blocked;
987 }
988 }
989
990 /* Can't fail from now on, so mark ourselves as no longer waiting. */
991 if (dev->waiting & 1) {
992 dev->waiting = 0;
993
994 /* Take ourselves out of the wait list again. */
995 spin_lock_irq(&port->waitlist_lock);
996 if (dev->waitprev)
997 dev->waitprev->waitnext = dev->waitnext;
998 else
999 port->waithead = dev->waitnext;
1000 if (dev->waitnext)
1001 dev->waitnext->waitprev = dev->waitprev;
1002 else
1003 port->waittail = dev->waitprev;
1004 spin_unlock_irq(&port->waitlist_lock);
1005 dev->waitprev = dev->waitnext = NULL;
1006 }
1007
1008 /* Now we do the change of devices */
1009 port->cad = dev;
1010
1011#ifdef CONFIG_PARPORT_1284
1012 /* If it's a mux port, select it. */
1013 if (dev->port->muxport >= 0) {
1014 /* FIXME */
1015 port->muxsel = dev->port->muxport;
1016 }
1017
1018 /* If it's a daisy chain device, select it. */
1019 if (dev->daisy >= 0) {
1020 /* This could be lazier. */
1021 if (!parport_daisy_select(port, dev->daisy,
1022 IEEE1284_MODE_COMPAT))
1023 port->daisy = dev->daisy;
1024 }
1025#endif /* IEEE1284.3 support */
1026
1027 /* Restore control registers */
1028 port->ops->restore_state(port, dev->state);
1029 write_unlock_irqrestore(&port->cad_lock, flags);
1030 dev->time = jiffies;
1031 return 0;
1032
1033blocked:
1034 /*
1035 * If this is the first time we tried to claim the port, register an
1036 * interest. This is only allowed for devices sleeping in
1037 * parport_claim_or_block(), or those with a wakeup function.
1038 */
1039
1040 /* The cad_lock is still held for writing here */
1041 if (dev->waiting & 2 || dev->wakeup) {
1042 spin_lock(&port->waitlist_lock);
1043 if (test_and_set_bit(0, &dev->waiting) == 0) {
1044 /* First add ourselves to the end of the wait list. */
1045 dev->waitnext = NULL;
1046 dev->waitprev = port->waittail;
1047 if (port->waittail) {
1048 port->waittail->waitnext = dev;
1049 port->waittail = dev;
1050 } else
1051 port->waithead = port->waittail = dev;
1052 }
1053 spin_unlock(&port->waitlist_lock);
1054 }
1055 write_unlock_irqrestore(&port->cad_lock, flags);
1056 return -EAGAIN;
1057}
1058EXPORT_SYMBOL(parport_claim);
1059
1060/**
1061 * parport_claim_or_block - claim access to a parallel port device
1062 * @dev: pointer to structure representing a device on the port
1063 *
1064 * This behaves like parport_claim(), but will block if necessary
1065 * to wait for the port to be free. A return value of 1
1066 * indicates that it slept; 0 means that it succeeded without
1067 * needing to sleep. A negative error code indicates failure.
1068 **/
1069
1070int parport_claim_or_block(struct pardevice *dev)
1071{
1072 int r;
1073
1074 /*
1075 * Signal to parport_claim() that we can wait even without a
1076 * wakeup function.
1077 */
1078 dev->waiting = 2;
1079
1080 /* Try to claim the port. If this fails, we need to sleep. */
1081 r = parport_claim(dev);
1082 if (r == -EAGAIN) {
1083#ifdef PARPORT_DEBUG_SHARING
1084 printk(KERN_DEBUG "%s: parport_claim() returned -EAGAIN\n",
1085 dev->name);
1086#endif
1087 /*
1088 * FIXME!!! Use the proper locking for dev->waiting,
1089 * and make this use the "wait_event_interruptible()"
1090 * interfaces. The cli/sti that used to be here
1091 * did nothing.
1092 *
1093 * See also parport_release()
1094 */
1095
1096 /*
1097 * If dev->waiting is clear now, an interrupt
1098 * gave us the port and we would deadlock if we slept.
1099 */
1100 if (dev->waiting) {
1101 wait_event_interruptible(dev->wait_q,
1102 !dev->waiting);
1103 if (signal_pending(current))
1104 return -EINTR;
1105 r = 1;
1106 } else {
1107 r = 0;
1108#ifdef PARPORT_DEBUG_SHARING
1109 printk(KERN_DEBUG "%s: didn't sleep in parport_claim_or_block()\n",
1110 dev->name);
1111#endif
1112 }
1113
1114#ifdef PARPORT_DEBUG_SHARING
1115 if (dev->port->physport->cad != dev)
1116 printk(KERN_DEBUG "%s: exiting parport_claim_or_block but %s owns port!\n",
1117 dev->name, dev->port->physport->cad ?
1118 dev->port->physport->cad->name : "nobody");
1119#endif
1120 }
1121 dev->waiting = 0;
1122 return r;
1123}
1124EXPORT_SYMBOL(parport_claim_or_block);
1125
1126/**
1127 * parport_release - give up access to a parallel port device
1128 * @dev: pointer to structure representing parallel port device
1129 *
1130 * This function cannot fail, but it should not be called without
1131 * the port claimed. Similarly, if the port is already claimed
1132 * you should not try claiming it again.
1133 **/
1134
1135void parport_release(struct pardevice *dev)
1136{
1137 struct parport *port = dev->port->physport;
1138 struct pardevice *pd;
1139 unsigned long flags;
1140
1141 /* Make sure that dev is the current device */
1142 write_lock_irqsave(&port->cad_lock, flags);
1143 if (port->cad != dev) {
1144 write_unlock_irqrestore(&port->cad_lock, flags);
1145 pr_warn("%s: %s tried to release parport when not owner\n",
1146 port->name, dev->name);
1147 return;
1148 }
1149
1150#ifdef CONFIG_PARPORT_1284
1151 /* If this is on a mux port, deselect it. */
1152 if (dev->port->muxport >= 0) {
1153 /* FIXME */
1154 port->muxsel = -1;
1155 }
1156
1157 /* If this is a daisy device, deselect it. */
1158 if (dev->daisy >= 0) {
1159 parport_daisy_deselect_all(port);
1160 port->daisy = -1;
1161 }
1162#endif
1163
1164 port->cad = NULL;
1165 write_unlock_irqrestore(&port->cad_lock, flags);
1166
1167 /* Save control registers */
1168 port->ops->save_state(port, dev->state);
1169
1170 /*
1171 * If anybody is waiting, find out who's been there longest and
1172 * then wake them up. (Note: no locking required)
1173 */
1174 /* !!! LOCKING IS NEEDED HERE */
1175 for (pd = port->waithead; pd; pd = pd->waitnext) {
1176 if (pd->waiting & 2) { /* sleeping in claim_or_block */
1177 parport_claim(pd);
1178 if (waitqueue_active(&pd->wait_q))
1179 wake_up_interruptible(&pd->wait_q);
1180 return;
1181 } else if (pd->wakeup) {
1182 pd->wakeup(pd->private);
1183 if (dev->port->cad) /* racy but no matter */
1184 return;
1185 } else {
1186 pr_err("%s: don't know how to wake %s\n",
1187 port->name, pd->name);
1188 }
1189 }
1190
1191 /*
1192 * Nobody was waiting, so walk the list to see if anyone is
1193 * interested in being woken up. (Note: no locking required)
1194 */
1195 /* !!! LOCKING IS NEEDED HERE */
1196 for (pd = port->devices; !port->cad && pd; pd = pd->next) {
1197 if (pd->wakeup && pd != dev)
1198 pd->wakeup(pd->private);
1199 }
1200}
1201EXPORT_SYMBOL(parport_release);
1202
1203irqreturn_t parport_irq_handler(int irq, void *dev_id)
1204{
1205 struct parport *port = dev_id;
1206
1207 parport_generic_irq(port);
1208
1209 return IRQ_HANDLED;
1210}
1211EXPORT_SYMBOL(parport_irq_handler);
1212
1213MODULE_DESCRIPTION("Parallel-port resource manager");
1214MODULE_LICENSE("GPL");