2 * Device driver for the Apple Desktop Bus
3 * and the /dev/adb device on macintoshes.
5 * Copyright (C) 1996 Paul Mackerras.
7 * Modified to declare controllers as structures, added
8 * client notification of bus reset and handles PowerBook
9 * sleep, by Benjamin Herrenschmidt.
13 * - /sys/bus/adb to list the devices and infos
14 * - more /dev/adb to allow userland to receive the
15 * flow of auto-polling datas from a given device.
16 * - move bus probe to a kernel thread
19 #include <linux/types.h>
20 #include <linux/errno.h>
21 #include <linux/kernel.h>
22 #include <linux/slab.h>
23 #include <linux/module.h>
26 #include <linux/sched.h>
27 #include <linux/adb.h>
28 #include <linux/cuda.h>
29 #include <linux/pmu.h>
30 #include <linux/notifier.h>
31 #include <linux/wait.h>
32 #include <linux/init.h>
33 #include <linux/delay.h>
34 #include <linux/spinlock.h>
35 #include <linux/completion.h>
36 #include <linux/device.h>
37 #include <linux/kthread.h>
38 #include <linux/platform_device.h>
39 #include <linux/mutex.h>
41 #include <asm/uaccess.h>
44 #include <asm/machdep.h>
48 EXPORT_SYMBOL(adb_client_list
);
50 extern struct adb_driver via_macii_driver
;
51 extern struct adb_driver via_maciisi_driver
;
52 extern struct adb_driver via_cuda_driver
;
53 extern struct adb_driver adb_iop_driver
;
54 extern struct adb_driver via_pmu_driver
;
55 extern struct adb_driver macio_adb_driver
;
57 static DEFINE_MUTEX(adb_mutex
);
58 static struct adb_driver
*adb_driver_list
[] = {
59 #ifdef CONFIG_ADB_MACII
62 #ifdef CONFIG_ADB_MACIISI
65 #ifdef CONFIG_ADB_CUDA
71 #if defined(CONFIG_ADB_PMU) || defined(CONFIG_ADB_PMU68K)
74 #ifdef CONFIG_ADB_MACIO
80 static struct class *adb_dev_class
;
82 static struct adb_driver
*adb_controller
;
83 BLOCKING_NOTIFIER_HEAD(adb_client_list
);
84 static int adb_got_sleep
;
85 static int adb_inited
;
86 static DEFINE_SEMAPHORE(adb_probe_mutex
);
87 static int sleepy_trackpad
;
88 static int autopoll_devs
;
91 static int adb_scan_bus(void);
92 static int do_adb_reset_bus(void);
93 static void adbdev_init(void);
94 static int try_handler_change(int, int);
96 static struct adb_handler
{
97 void (*handler
)(unsigned char *, int, int);
104 * The adb_handler_mutex mutex protects all accesses to the original_address
105 * and handler_id fields of adb_handler[i] for all i, and changes to the
107 * Accesses to the handler field are protected by the adb_handler_lock
108 * rwlock. It is held across all calls to any handler, so that by the
109 * time adb_unregister returns, we know that the old handler isn't being
112 static DEFINE_MUTEX(adb_handler_mutex
);
113 static DEFINE_RWLOCK(adb_handler_lock
);
116 static void printADBreply(struct adb_request
*req
)
120 printk("adb reply (%d)", req
->reply_len
);
121 for(i
= 0; i
< req
->reply_len
; i
++)
122 printk(" %x", req
->reply
[i
]);
128 static int adb_scan_bus(void)
130 int i
, highFree
=0, noMovement
;
132 struct adb_request req
;
134 /* assumes adb_handler[] is all zeroes at this point */
135 for (i
= 1; i
< 16; i
++) {
136 /* see if there is anything at address i */
137 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
139 if (req
.reply_len
> 1)
140 /* one or more devices at this address */
141 adb_handler
[i
].original_address
= i
;
142 else if (i
> highFree
)
146 /* Note we reset noMovement to 0 each time we move a device */
147 for (noMovement
= 1; noMovement
< 2 && highFree
> 0; noMovement
++) {
148 for (i
= 1; i
< 16; i
++) {
149 if (adb_handler
[i
].original_address
== 0)
152 * Send a "talk register 3" command to address i
153 * to provoke a collision if there is more than
154 * one device at this address.
156 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
159 * Move the device(s) which didn't detect a
160 * collision to address `highFree'. Hopefully
161 * this only moves one device.
163 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
164 (i
<< 4) | 0xb, (highFree
| 0x60), 0xfe);
166 * See if anybody actually moved. This is suggested
169 * http://developer.apple.com/technotes/hw/hw_01.html
171 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
172 (highFree
<< 4) | 0xf);
173 if (req
.reply_len
<= 1) continue;
175 * Test whether there are any device(s) left
178 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
180 if (req
.reply_len
> 1) {
182 * There are still one or more devices
183 * left at address i. Register the one(s)
184 * we moved to `highFree', and find a new
185 * value for highFree.
187 adb_handler
[highFree
].original_address
=
188 adb_handler
[i
].original_address
;
189 while (highFree
> 0 &&
190 adb_handler
[highFree
].original_address
)
199 * No devices left at address i; move the
200 * one(s) we moved to `highFree' back to i.
202 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
203 (highFree
<< 4) | 0xb,
209 /* Now fill in the handler_id field of the adb_handler entries. */
210 printk(KERN_DEBUG
"adb devices:");
211 for (i
= 1; i
< 16; i
++) {
212 if (adb_handler
[i
].original_address
== 0)
214 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
216 adb_handler
[i
].handler_id
= req
.reply
[2];
217 printk(" [%d]: %d %x", i
, adb_handler
[i
].original_address
,
218 adb_handler
[i
].handler_id
);
226 * This kernel task handles ADB probing. It dies once probing is
230 adb_probe_task(void *x
)
232 printk(KERN_INFO
"adb: starting probe task...\n");
234 printk(KERN_INFO
"adb: finished probe task...\n");
236 up(&adb_probe_mutex
);
242 __adb_probe_task(struct work_struct
*bullshit
)
244 kthread_run(adb_probe_task
, NULL
, "kadbprobe");
247 static DECLARE_WORK(adb_reset_work
, __adb_probe_task
);
252 if (__adb_probe_sync
) {
257 down(&adb_probe_mutex
);
258 schedule_work(&adb_reset_work
);
264 * notify clients before sleep
266 static int adb_suspend(struct platform_device
*dev
, pm_message_t state
)
269 /* We need to get a lock on the probe thread */
270 down(&adb_probe_mutex
);
272 if (adb_controller
->autopoll
)
273 adb_controller
->autopoll(0);
274 blocking_notifier_call_chain(&adb_client_list
, ADB_MSG_POWERDOWN
, NULL
);
280 * reset bus after sleep
282 static int adb_resume(struct platform_device
*dev
)
285 up(&adb_probe_mutex
);
290 #endif /* CONFIG_PM */
292 static int __init
adb_init(void)
294 struct adb_driver
*driver
;
298 if (!machine_is(chrp
) && !machine_is(powermac
))
306 /* xmon may do early-init */
311 adb_controller
= NULL
;
314 while ((driver
= adb_driver_list
[i
++]) != NULL
) {
315 if (!driver
->probe()) {
316 adb_controller
= driver
;
320 if (adb_controller
!= NULL
&& adb_controller
->init
&&
321 adb_controller
->init())
322 adb_controller
= NULL
;
323 if (adb_controller
== NULL
) {
324 printk(KERN_WARNING
"Warning: no ADB interface detected\n");
327 if (of_machine_is_compatible("AAPL,PowerBook1998") ||
328 of_machine_is_compatible("PowerBook1,1"))
330 #endif /* CONFIG_PPC */
338 device_initcall(adb_init
);
341 do_adb_reset_bus(void)
345 if (adb_controller
== NULL
)
348 if (adb_controller
->autopoll
)
349 adb_controller
->autopoll(0);
351 blocking_notifier_call_chain(&adb_client_list
,
352 ADB_MSG_PRE_RESET
, NULL
);
354 if (sleepy_trackpad
) {
355 /* Let the trackpad settle down */
359 mutex_lock(&adb_handler_mutex
);
360 write_lock_irq(&adb_handler_lock
);
361 memset(adb_handler
, 0, sizeof(adb_handler
));
362 write_unlock_irq(&adb_handler_lock
);
364 /* That one is still a bit synchronous, oh well... */
365 if (adb_controller
->reset_bus
)
366 ret
= adb_controller
->reset_bus();
370 if (sleepy_trackpad
) {
371 /* Let the trackpad settle down */
376 autopoll_devs
= adb_scan_bus();
377 if (adb_controller
->autopoll
)
378 adb_controller
->autopoll(autopoll_devs
);
380 mutex_unlock(&adb_handler_mutex
);
382 blocking_notifier_call_chain(&adb_client_list
,
383 ADB_MSG_POST_RESET
, NULL
);
391 if ((adb_controller
== NULL
)||(adb_controller
->poll
== NULL
))
393 adb_controller
->poll();
396 static void adb_sync_req_done(struct adb_request
*req
)
398 struct completion
*comp
= req
->arg
;
404 adb_request(struct adb_request
*req
, void (*done
)(struct adb_request
*),
405 int flags
, int nbytes
, ...)
410 struct completion comp
;
412 if ((adb_controller
== NULL
) || (adb_controller
->send_request
== NULL
))
417 req
->nbytes
= nbytes
+1;
419 req
->reply_expected
= flags
& ADBREQ_REPLY
;
420 req
->data
[0] = ADB_PACKET
;
421 va_start(list
, nbytes
);
422 for (i
= 0; i
< nbytes
; ++i
)
423 req
->data
[i
+1] = va_arg(list
, int);
426 if (flags
& ADBREQ_NOSEND
)
429 /* Synchronous requests block using an on-stack completion */
430 if (flags
& ADBREQ_SYNC
) {
432 req
->done
= adb_sync_req_done
;
434 init_completion(&comp
);
437 rc
= adb_controller
->send_request(req
, 0);
439 if ((flags
& ADBREQ_SYNC
) && !rc
&& !req
->complete
)
440 wait_for_completion(&comp
);
445 /* Ultimately this should return the number of devices with
446 the given default id.
447 And it does it now ! Note: changed behaviour: This function
448 will now register if default_id _and_ handler_id both match
449 but handler_id can be left to 0 to match with default_id only.
450 When handler_id is set, this function will try to adjust
451 the handler_id id it doesn't match. */
453 adb_register(int default_id
, int handler_id
, struct adb_ids
*ids
,
454 void (*handler
)(unsigned char *, int, int))
458 mutex_lock(&adb_handler_mutex
);
460 for (i
= 1; i
< 16; i
++) {
461 if ((adb_handler
[i
].original_address
== default_id
) &&
462 (!handler_id
|| (handler_id
== adb_handler
[i
].handler_id
) ||
463 try_handler_change(i
, handler_id
))) {
464 if (adb_handler
[i
].handler
!= 0) {
466 "Two handlers for ADB device %d\n",
470 write_lock_irq(&adb_handler_lock
);
471 adb_handler
[i
].handler
= handler
;
472 write_unlock_irq(&adb_handler_lock
);
473 ids
->id
[ids
->nids
++] = i
;
476 mutex_unlock(&adb_handler_mutex
);
481 adb_unregister(int index
)
485 mutex_lock(&adb_handler_mutex
);
486 write_lock_irq(&adb_handler_lock
);
487 if (adb_handler
[index
].handler
) {
488 while(adb_handler
[index
].busy
) {
489 write_unlock_irq(&adb_handler_lock
);
491 write_lock_irq(&adb_handler_lock
);
494 adb_handler
[index
].handler
= NULL
;
496 write_unlock_irq(&adb_handler_lock
);
497 mutex_unlock(&adb_handler_mutex
);
502 adb_input(unsigned char *buf
, int nb
, int autopoll
)
505 static int dump_adb_input
= 0;
508 void (*handler
)(unsigned char *, int, int);
510 /* We skip keystrokes and mouse moves when the sleep process
511 * has been started. We stop autopoll, but this is another security
517 if (dump_adb_input
) {
518 printk(KERN_INFO
"adb packet: ");
519 for (i
= 0; i
< nb
; ++i
)
520 printk(" %x", buf
[i
]);
521 printk(", id = %d\n", id
);
523 write_lock_irqsave(&adb_handler_lock
, flags
);
524 handler
= adb_handler
[id
].handler
;
526 adb_handler
[id
].busy
= 1;
527 write_unlock_irqrestore(&adb_handler_lock
, flags
);
528 if (handler
!= NULL
) {
529 (*handler
)(buf
, nb
, autopoll
);
531 adb_handler
[id
].busy
= 0;
536 /* Try to change handler to new_id. Will return 1 if successful. */
537 static int try_handler_change(int address
, int new_id
)
539 struct adb_request req
;
541 if (adb_handler
[address
].handler_id
== new_id
)
543 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
544 ADB_WRITEREG(address
, 3), address
| 0x20, new_id
);
545 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
546 ADB_READREG(address
, 3));
547 if (req
.reply_len
< 2)
549 if (req
.reply
[2] != new_id
)
551 adb_handler
[address
].handler_id
= req
.reply
[2];
557 adb_try_handler_change(int address
, int new_id
)
561 mutex_lock(&adb_handler_mutex
);
562 ret
= try_handler_change(address
, new_id
);
563 mutex_unlock(&adb_handler_mutex
);
568 adb_get_infos(int address
, int *original_address
, int *handler_id
)
570 mutex_lock(&adb_handler_mutex
);
571 *original_address
= adb_handler
[address
].original_address
;
572 *handler_id
= adb_handler
[address
].handler_id
;
573 mutex_unlock(&adb_handler_mutex
);
575 return (*original_address
!= 0);
580 * /dev/adb device driver.
583 #define ADB_MAJOR 56 /* major number for /dev/adb */
585 struct adbdev_state
{
588 struct adb_request
*completed
;
589 wait_queue_head_t wait_queue
;
593 static void adb_write_done(struct adb_request
*req
)
595 struct adbdev_state
*state
= (struct adbdev_state
*) req
->arg
;
598 if (!req
->complete
) {
602 spin_lock_irqsave(&state
->lock
, flags
);
603 atomic_dec(&state
->n_pending
);
606 if (atomic_read(&state
->n_pending
) == 0) {
607 spin_unlock_irqrestore(&state
->lock
, flags
);
612 struct adb_request
**ap
= &state
->completed
;
617 wake_up_interruptible(&state
->wait_queue
);
619 spin_unlock_irqrestore(&state
->lock
, flags
);
623 do_adb_query(struct adb_request
*req
)
629 case ADB_QUERY_GETDEVINFO
:
632 mutex_lock(&adb_handler_mutex
);
633 req
->reply
[0] = adb_handler
[req
->data
[2]].original_address
;
634 req
->reply
[1] = adb_handler
[req
->data
[2]].handler_id
;
635 mutex_unlock(&adb_handler_mutex
);
645 static int adb_open(struct inode
*inode
, struct file
*file
)
647 struct adbdev_state
*state
;
650 mutex_lock(&adb_mutex
);
651 if (iminor(inode
) > 0 || adb_controller
== NULL
) {
655 state
= kmalloc(sizeof(struct adbdev_state
), GFP_KERNEL
);
660 file
->private_data
= state
;
661 spin_lock_init(&state
->lock
);
662 atomic_set(&state
->n_pending
, 0);
663 state
->completed
= NULL
;
664 init_waitqueue_head(&state
->wait_queue
);
668 mutex_unlock(&adb_mutex
);
672 static int adb_release(struct inode
*inode
, struct file
*file
)
674 struct adbdev_state
*state
= file
->private_data
;
677 mutex_lock(&adb_mutex
);
679 file
->private_data
= NULL
;
680 spin_lock_irqsave(&state
->lock
, flags
);
681 if (atomic_read(&state
->n_pending
) == 0
682 && state
->completed
== NULL
) {
683 spin_unlock_irqrestore(&state
->lock
, flags
);
687 spin_unlock_irqrestore(&state
->lock
, flags
);
690 mutex_unlock(&adb_mutex
);
694 static ssize_t
adb_read(struct file
*file
, char __user
*buf
,
695 size_t count
, loff_t
*ppos
)
698 struct adbdev_state
*state
= file
->private_data
;
699 struct adb_request
*req
;
700 wait_queue_t wait
= __WAITQUEUE_INITIALIZER(wait
,current
);
705 if (count
> sizeof(req
->reply
))
706 count
= sizeof(req
->reply
);
707 if (!access_ok(VERIFY_WRITE
, buf
, count
))
711 spin_lock_irqsave(&state
->lock
, flags
);
712 add_wait_queue(&state
->wait_queue
, &wait
);
713 set_current_state(TASK_INTERRUPTIBLE
);
716 req
= state
->completed
;
718 state
->completed
= req
->next
;
719 else if (atomic_read(&state
->n_pending
) == 0)
721 if (req
!= NULL
|| ret
!= 0)
724 if (file
->f_flags
& O_NONBLOCK
) {
728 if (signal_pending(current
)) {
732 spin_unlock_irqrestore(&state
->lock
, flags
);
734 spin_lock_irqsave(&state
->lock
, flags
);
737 set_current_state(TASK_RUNNING
);
738 remove_wait_queue(&state
->wait_queue
, &wait
);
739 spin_unlock_irqrestore(&state
->lock
, flags
);
744 ret
= req
->reply_len
;
747 if (ret
> 0 && copy_to_user(buf
, req
->reply
, ret
))
754 static ssize_t
adb_write(struct file
*file
, const char __user
*buf
,
755 size_t count
, loff_t
*ppos
)
758 struct adbdev_state
*state
= file
->private_data
;
759 struct adb_request
*req
;
761 if (count
< 2 || count
> sizeof(req
->data
))
763 if (adb_controller
== NULL
)
765 if (!access_ok(VERIFY_READ
, buf
, count
))
768 req
= kmalloc(sizeof(struct adb_request
),
774 req
->done
= adb_write_done
;
775 req
->arg
= (void *) state
;
779 if (copy_from_user(req
->data
, buf
, count
))
782 atomic_inc(&state
->n_pending
);
784 /* If a probe is in progress or we are sleeping, wait for it to complete */
785 down(&adb_probe_mutex
);
787 /* Queries are special requests sent to the ADB driver itself */
788 if (req
->data
[0] == ADB_QUERY
) {
790 ret
= do_adb_query(req
);
793 up(&adb_probe_mutex
);
795 /* Special case for ADB_BUSRESET request, all others are sent to
797 else if ((req
->data
[0] == ADB_PACKET
)&&(count
> 1)
798 &&(req
->data
[1] == ADB_BUSRESET
)) {
799 ret
= do_adb_reset_bus();
800 up(&adb_probe_mutex
);
801 atomic_dec(&state
->n_pending
);
806 req
->reply_expected
= ((req
->data
[1] & 0xc) == 0xc);
807 if (adb_controller
&& adb_controller
->send_request
)
808 ret
= adb_controller
->send_request(req
, 0);
811 up(&adb_probe_mutex
);
815 atomic_dec(&state
->n_pending
);
825 static const struct file_operations adb_fops
= {
826 .owner
= THIS_MODULE
,
831 .release
= adb_release
,
834 static struct platform_driver adb_pfdrv
= {
839 .suspend
= adb_suspend
,
840 .resume
= adb_resume
,
844 static struct platform_device adb_pfdev
= {
849 adb_dummy_probe(struct platform_device
*dev
)
851 if (dev
== &adb_pfdev
)
859 if (register_chrdev(ADB_MAJOR
, "adb", &adb_fops
)) {
860 printk(KERN_ERR
"adb: unable to get major %d\n", ADB_MAJOR
);
864 adb_dev_class
= class_create(THIS_MODULE
, "adb");
865 if (IS_ERR(adb_dev_class
))
867 device_create(adb_dev_class
, NULL
, MKDEV(ADB_MAJOR
, 0), NULL
, "adb");
869 platform_device_register(&adb_pfdev
);
870 platform_driver_probe(&adb_pfdrv
, adb_dummy_probe
);