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/smp_lock.h>
28 #include <linux/adb.h>
29 #include <linux/cuda.h>
30 #include <linux/pmu.h>
31 #include <linux/notifier.h>
32 #include <linux/wait.h>
33 #include <linux/init.h>
34 #include <linux/delay.h>
35 #include <linux/spinlock.h>
36 #include <linux/completion.h>
37 #include <linux/device.h>
39 #include <asm/uaccess.h>
40 #include <asm/semaphore.h>
43 #include <asm/machdep.h>
47 EXPORT_SYMBOL(adb_controller
);
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 struct adb_driver
*adb_driver_list
[] = {
58 #ifdef CONFIG_ADB_MACII
61 #ifdef CONFIG_ADB_MACIISI
64 #ifdef CONFIG_ADB_CUDA
70 #if defined(CONFIG_ADB_PMU) || defined(CONFIG_ADB_PMU68K)
73 #ifdef CONFIG_ADB_MACIO
79 static struct class *adb_dev_class
;
81 struct adb_driver
*adb_controller
;
82 BLOCKING_NOTIFIER_HEAD(adb_client_list
);
83 static int adb_got_sleep
;
84 static int adb_inited
;
85 static pid_t adb_probe_task_pid
;
86 static DECLARE_MUTEX(adb_probe_mutex
);
87 static struct completion adb_probe_task_comp
;
88 static int sleepy_trackpad
;
89 static int autopoll_devs
;
93 static int adb_notify_sleep(struct pmu_sleep_notifier
*self
, int when
);
94 static struct pmu_sleep_notifier adb_sleep_notifier
= {
100 static int adb_scan_bus(void);
101 static int do_adb_reset_bus(void);
102 static void adbdev_init(void);
103 static int try_handler_change(int, int);
105 static struct adb_handler
{
106 void (*handler
)(unsigned char *, int, int);
107 int original_address
;
113 * The adb_handler_sem mutex protects all accesses to the original_address
114 * and handler_id fields of adb_handler[i] for all i, and changes to the
116 * Accesses to the handler field are protected by the adb_handler_lock
117 * rwlock. It is held across all calls to any handler, so that by the
118 * time adb_unregister returns, we know that the old handler isn't being
121 static DECLARE_MUTEX(adb_handler_sem
);
122 static DEFINE_RWLOCK(adb_handler_lock
);
125 static void printADBreply(struct adb_request
*req
)
129 printk("adb reply (%d)", req
->reply_len
);
130 for(i
= 0; i
< req
->reply_len
; i
++)
131 printk(" %x", req
->reply
[i
]);
138 static __inline__
void adb_wait_ms(unsigned int ms
)
140 if (current
->pid
&& adb_probe_task_pid
&&
141 adb_probe_task_pid
== current
->pid
)
147 static int adb_scan_bus(void)
149 int i
, highFree
=0, noMovement
;
151 struct adb_request req
;
153 /* assumes adb_handler[] is all zeroes at this point */
154 for (i
= 1; i
< 16; i
++) {
155 /* see if there is anything at address i */
156 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
158 if (req
.reply_len
> 1)
159 /* one or more devices at this address */
160 adb_handler
[i
].original_address
= i
;
161 else if (i
> highFree
)
165 /* Note we reset noMovement to 0 each time we move a device */
166 for (noMovement
= 1; noMovement
< 2 && highFree
> 0; noMovement
++) {
167 for (i
= 1; i
< 16; i
++) {
168 if (adb_handler
[i
].original_address
== 0)
171 * Send a "talk register 3" command to address i
172 * to provoke a collision if there is more than
173 * one device at this address.
175 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
178 * Move the device(s) which didn't detect a
179 * collision to address `highFree'. Hopefully
180 * this only moves one device.
182 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
183 (i
<< 4) | 0xb, (highFree
| 0x60), 0xfe);
185 * See if anybody actually moved. This is suggested
188 * http://developer.apple.com/technotes/hw/hw_01.html
190 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
191 (highFree
<< 4) | 0xf);
192 if (req
.reply_len
<= 1) continue;
194 * Test whether there are any device(s) left
197 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
199 if (req
.reply_len
> 1) {
201 * There are still one or more devices
202 * left at address i. Register the one(s)
203 * we moved to `highFree', and find a new
204 * value for highFree.
206 adb_handler
[highFree
].original_address
=
207 adb_handler
[i
].original_address
;
208 while (highFree
> 0 &&
209 adb_handler
[highFree
].original_address
)
218 * No devices left at address i; move the
219 * one(s) we moved to `highFree' back to i.
221 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
222 (highFree
<< 4) | 0xb,
228 /* Now fill in the handler_id field of the adb_handler entries. */
229 printk(KERN_DEBUG
"adb devices:");
230 for (i
= 1; i
< 16; i
++) {
231 if (adb_handler
[i
].original_address
== 0)
233 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
235 adb_handler
[i
].handler_id
= req
.reply
[2];
236 printk(" [%d]: %d %x", i
, adb_handler
[i
].original_address
,
237 adb_handler
[i
].handler_id
);
245 * This kernel task handles ADB probing. It dies once probing is
249 adb_probe_task(void *x
)
253 strcpy(current
->comm
, "kadbprobe");
255 sigfillset(&blocked
);
256 sigprocmask(SIG_BLOCK
, &blocked
, NULL
);
257 flush_signals(current
);
259 printk(KERN_INFO
"adb: starting probe task...\n");
261 printk(KERN_INFO
"adb: finished probe task...\n");
263 adb_probe_task_pid
= 0;
264 up(&adb_probe_mutex
);
270 __adb_probe_task(struct work_struct
*bullshit
)
272 adb_probe_task_pid
= kernel_thread(adb_probe_task
, NULL
, SIGCHLD
| CLONE_KERNEL
);
275 static DECLARE_WORK(adb_reset_work
, __adb_probe_task
);
280 if (__adb_probe_sync
) {
285 down(&adb_probe_mutex
);
286 schedule_work(&adb_reset_work
);
290 int __init
adb_init(void)
292 struct adb_driver
*driver
;
296 if (!machine_is(chrp
) && !machine_is(powermac
))
304 /* xmon may do early-init */
309 adb_controller
= NULL
;
312 while ((driver
= adb_driver_list
[i
++]) != NULL
) {
313 if (!driver
->probe()) {
314 adb_controller
= driver
;
318 if ((adb_controller
== NULL
) || adb_controller
->init()) {
319 printk(KERN_WARNING
"Warning: no ADB interface detected\n");
320 adb_controller
= NULL
;
323 pmu_register_sleep_notifier(&adb_sleep_notifier
);
324 #endif /* CONFIG_PM */
326 if (machine_is_compatible("AAPL,PowerBook1998") ||
327 machine_is_compatible("PowerBook1,1"))
329 #endif /* CONFIG_PPC */
330 init_completion(&adb_probe_task_comp
);
337 __initcall(adb_init
);
341 * notify clients before sleep and reset bus afterwards
344 adb_notify_sleep(struct pmu_sleep_notifier
*self
, int when
)
349 case PBOOK_SLEEP_REQUEST
:
351 /* We need to get a lock on the probe thread */
352 down(&adb_probe_mutex
);
354 if (adb_controller
->autopoll
)
355 adb_controller
->autopoll(0);
356 ret
= blocking_notifier_call_chain(&adb_client_list
,
357 ADB_MSG_POWERDOWN
, NULL
);
358 if (ret
& NOTIFY_STOP_MASK
) {
359 up(&adb_probe_mutex
);
360 return PBOOK_SLEEP_REFUSE
;
363 case PBOOK_SLEEP_REJECT
:
366 up(&adb_probe_mutex
);
371 case PBOOK_SLEEP_NOW
:
375 up(&adb_probe_mutex
);
379 return PBOOK_SLEEP_OK
;
381 #endif /* CONFIG_PM */
384 do_adb_reset_bus(void)
388 if (adb_controller
== NULL
)
391 if (adb_controller
->autopoll
)
392 adb_controller
->autopoll(0);
394 nret
= blocking_notifier_call_chain(&adb_client_list
,
395 ADB_MSG_PRE_RESET
, NULL
);
396 if (nret
& NOTIFY_STOP_MASK
) {
397 if (adb_controller
->autopoll
)
398 adb_controller
->autopoll(autopoll_devs
);
402 if (sleepy_trackpad
) {
403 /* Let the trackpad settle down */
407 down(&adb_handler_sem
);
408 write_lock_irq(&adb_handler_lock
);
409 memset(adb_handler
, 0, sizeof(adb_handler
));
410 write_unlock_irq(&adb_handler_lock
);
412 /* That one is still a bit synchronous, oh well... */
413 if (adb_controller
->reset_bus
)
414 ret
= adb_controller
->reset_bus();
418 if (sleepy_trackpad
) {
419 /* Let the trackpad settle down */
424 autopoll_devs
= adb_scan_bus();
425 if (adb_controller
->autopoll
)
426 adb_controller
->autopoll(autopoll_devs
);
428 up(&adb_handler_sem
);
430 nret
= blocking_notifier_call_chain(&adb_client_list
,
431 ADB_MSG_POST_RESET
, NULL
);
432 if (nret
& NOTIFY_STOP_MASK
)
441 if ((adb_controller
== NULL
)||(adb_controller
->poll
== NULL
))
443 adb_controller
->poll();
447 adb_probe_wakeup(struct adb_request
*req
)
449 complete(&adb_probe_task_comp
);
452 /* Static request used during probe */
453 static struct adb_request adb_sreq
;
454 static unsigned long adb_sreq_lock
; // Use semaphore ! */
457 adb_request(struct adb_request
*req
, void (*done
)(struct adb_request
*),
458 int flags
, int nbytes
, ...)
464 if ((adb_controller
== NULL
) || (adb_controller
->send_request
== NULL
))
468 if (req
== NULL
&& (flags
& ADBREQ_NOSEND
))
472 if (test_and_set_bit(0,&adb_sreq_lock
)) {
473 printk("adb.c: Warning: contention on static request !\n");
477 flags
|= ADBREQ_SYNC
;
481 req
->nbytes
= nbytes
+1;
483 req
->reply_expected
= flags
& ADBREQ_REPLY
;
484 req
->data
[0] = ADB_PACKET
;
485 va_start(list
, nbytes
);
486 for (i
= 0; i
< nbytes
; ++i
)
487 req
->data
[i
+1] = va_arg(list
, int);
490 if (flags
& ADBREQ_NOSEND
)
493 /* Synchronous requests send from the probe thread cause it to
494 * block. Beware that the "done" callback will be overriden !
496 if ((flags
& ADBREQ_SYNC
) &&
497 (current
->pid
&& adb_probe_task_pid
&&
498 adb_probe_task_pid
== current
->pid
)) {
499 req
->done
= adb_probe_wakeup
;
500 rc
= adb_controller
->send_request(req
, 0);
501 if (rc
|| req
->complete
)
503 wait_for_completion(&adb_probe_task_comp
);
508 rc
= adb_controller
->send_request(req
, flags
& ADBREQ_SYNC
);
511 clear_bit(0, &adb_sreq_lock
);
516 /* Ultimately this should return the number of devices with
517 the given default id.
518 And it does it now ! Note: changed behaviour: This function
519 will now register if default_id _and_ handler_id both match
520 but handler_id can be left to 0 to match with default_id only.
521 When handler_id is set, this function will try to adjust
522 the handler_id id it doesn't match. */
524 adb_register(int default_id
, int handler_id
, struct adb_ids
*ids
,
525 void (*handler
)(unsigned char *, int, int))
529 down(&adb_handler_sem
);
531 for (i
= 1; i
< 16; i
++) {
532 if ((adb_handler
[i
].original_address
== default_id
) &&
533 (!handler_id
|| (handler_id
== adb_handler
[i
].handler_id
) ||
534 try_handler_change(i
, handler_id
))) {
535 if (adb_handler
[i
].handler
!= 0) {
537 "Two handlers for ADB device %d\n",
541 write_lock_irq(&adb_handler_lock
);
542 adb_handler
[i
].handler
= handler
;
543 write_unlock_irq(&adb_handler_lock
);
544 ids
->id
[ids
->nids
++] = i
;
547 up(&adb_handler_sem
);
552 adb_unregister(int index
)
556 down(&adb_handler_sem
);
557 write_lock_irq(&adb_handler_lock
);
558 if (adb_handler
[index
].handler
) {
559 while(adb_handler
[index
].busy
) {
560 write_unlock_irq(&adb_handler_lock
);
562 write_lock_irq(&adb_handler_lock
);
565 adb_handler
[index
].handler
= NULL
;
567 write_unlock_irq(&adb_handler_lock
);
568 up(&adb_handler_sem
);
573 adb_input(unsigned char *buf
, int nb
, int autopoll
)
576 static int dump_adb_input
= 0;
579 void (*handler
)(unsigned char *, int, int);
581 /* We skip keystrokes and mouse moves when the sleep process
582 * has been started. We stop autopoll, but this is another security
588 if (dump_adb_input
) {
589 printk(KERN_INFO
"adb packet: ");
590 for (i
= 0; i
< nb
; ++i
)
591 printk(" %x", buf
[i
]);
592 printk(", id = %d\n", id
);
594 write_lock_irqsave(&adb_handler_lock
, flags
);
595 handler
= adb_handler
[id
].handler
;
597 adb_handler
[id
].busy
= 1;
598 write_unlock_irqrestore(&adb_handler_lock
, flags
);
599 if (handler
!= NULL
) {
600 (*handler
)(buf
, nb
, autopoll
);
602 adb_handler
[id
].busy
= 0;
607 /* Try to change handler to new_id. Will return 1 if successful. */
608 static int try_handler_change(int address
, int new_id
)
610 struct adb_request req
;
612 if (adb_handler
[address
].handler_id
== new_id
)
614 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
615 ADB_WRITEREG(address
, 3), address
| 0x20, new_id
);
616 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
617 ADB_READREG(address
, 3));
618 if (req
.reply_len
< 2)
620 if (req
.reply
[2] != new_id
)
622 adb_handler
[address
].handler_id
= req
.reply
[2];
628 adb_try_handler_change(int address
, int new_id
)
632 down(&adb_handler_sem
);
633 ret
= try_handler_change(address
, new_id
);
634 up(&adb_handler_sem
);
639 adb_get_infos(int address
, int *original_address
, int *handler_id
)
641 down(&adb_handler_sem
);
642 *original_address
= adb_handler
[address
].original_address
;
643 *handler_id
= adb_handler
[address
].handler_id
;
644 up(&adb_handler_sem
);
646 return (*original_address
!= 0);
651 * /dev/adb device driver.
654 #define ADB_MAJOR 56 /* major number for /dev/adb */
656 struct adbdev_state
{
659 struct adb_request
*completed
;
660 wait_queue_head_t wait_queue
;
664 static void adb_write_done(struct adb_request
*req
)
666 struct adbdev_state
*state
= (struct adbdev_state
*) req
->arg
;
669 if (!req
->complete
) {
673 spin_lock_irqsave(&state
->lock
, flags
);
674 atomic_dec(&state
->n_pending
);
677 if (atomic_read(&state
->n_pending
) == 0) {
678 spin_unlock_irqrestore(&state
->lock
, flags
);
683 struct adb_request
**ap
= &state
->completed
;
688 wake_up_interruptible(&state
->wait_queue
);
690 spin_unlock_irqrestore(&state
->lock
, flags
);
694 do_adb_query(struct adb_request
*req
)
700 case ADB_QUERY_GETDEVINFO
:
703 down(&adb_handler_sem
);
704 req
->reply
[0] = adb_handler
[req
->data
[2]].original_address
;
705 req
->reply
[1] = adb_handler
[req
->data
[2]].handler_id
;
706 up(&adb_handler_sem
);
716 static int adb_open(struct inode
*inode
, struct file
*file
)
718 struct adbdev_state
*state
;
720 if (iminor(inode
) > 0 || adb_controller
== NULL
)
722 state
= kmalloc(sizeof(struct adbdev_state
), GFP_KERNEL
);
725 file
->private_data
= state
;
726 spin_lock_init(&state
->lock
);
727 atomic_set(&state
->n_pending
, 0);
728 state
->completed
= NULL
;
729 init_waitqueue_head(&state
->wait_queue
);
735 static int adb_release(struct inode
*inode
, struct file
*file
)
737 struct adbdev_state
*state
= file
->private_data
;
742 file
->private_data
= NULL
;
743 spin_lock_irqsave(&state
->lock
, flags
);
744 if (atomic_read(&state
->n_pending
) == 0
745 && state
->completed
== NULL
) {
746 spin_unlock_irqrestore(&state
->lock
, flags
);
750 spin_unlock_irqrestore(&state
->lock
, flags
);
757 static ssize_t
adb_read(struct file
*file
, char __user
*buf
,
758 size_t count
, loff_t
*ppos
)
761 struct adbdev_state
*state
= file
->private_data
;
762 struct adb_request
*req
;
763 wait_queue_t wait
= __WAITQUEUE_INITIALIZER(wait
,current
);
768 if (count
> sizeof(req
->reply
))
769 count
= sizeof(req
->reply
);
770 if (!access_ok(VERIFY_WRITE
, buf
, count
))
774 spin_lock_irqsave(&state
->lock
, flags
);
775 add_wait_queue(&state
->wait_queue
, &wait
);
776 current
->state
= TASK_INTERRUPTIBLE
;
779 req
= state
->completed
;
781 state
->completed
= req
->next
;
782 else if (atomic_read(&state
->n_pending
) == 0)
784 if (req
!= NULL
|| ret
!= 0)
787 if (file
->f_flags
& O_NONBLOCK
) {
791 if (signal_pending(current
)) {
795 spin_unlock_irqrestore(&state
->lock
, flags
);
797 spin_lock_irqsave(&state
->lock
, flags
);
800 current
->state
= TASK_RUNNING
;
801 remove_wait_queue(&state
->wait_queue
, &wait
);
802 spin_unlock_irqrestore(&state
->lock
, flags
);
807 ret
= req
->reply_len
;
810 if (ret
> 0 && copy_to_user(buf
, req
->reply
, ret
))
817 static ssize_t
adb_write(struct file
*file
, const char __user
*buf
,
818 size_t count
, loff_t
*ppos
)
821 struct adbdev_state
*state
= file
->private_data
;
822 struct adb_request
*req
;
824 if (count
< 2 || count
> sizeof(req
->data
))
826 if (adb_controller
== NULL
)
828 if (!access_ok(VERIFY_READ
, buf
, count
))
831 req
= kmalloc(sizeof(struct adb_request
),
837 req
->done
= adb_write_done
;
838 req
->arg
= (void *) state
;
842 if (copy_from_user(req
->data
, buf
, count
))
845 atomic_inc(&state
->n_pending
);
847 /* If a probe is in progress or we are sleeping, wait for it to complete */
848 down(&adb_probe_mutex
);
850 /* Queries are special requests sent to the ADB driver itself */
851 if (req
->data
[0] == ADB_QUERY
) {
853 ret
= do_adb_query(req
);
856 up(&adb_probe_mutex
);
858 /* Special case for ADB_BUSRESET request, all others are sent to
860 else if ((req
->data
[0] == ADB_PACKET
)&&(count
> 1)
861 &&(req
->data
[1] == ADB_BUSRESET
)) {
862 ret
= do_adb_reset_bus();
863 up(&adb_probe_mutex
);
864 atomic_dec(&state
->n_pending
);
869 req
->reply_expected
= ((req
->data
[1] & 0xc) == 0xc);
870 if (adb_controller
&& adb_controller
->send_request
)
871 ret
= adb_controller
->send_request(req
, 0);
874 up(&adb_probe_mutex
);
878 atomic_dec(&state
->n_pending
);
888 static struct file_operations adb_fops
= {
889 .owner
= THIS_MODULE
,
894 .release
= adb_release
,
900 if (register_chrdev(ADB_MAJOR
, "adb", &adb_fops
)) {
901 printk(KERN_ERR
"adb: unable to get major %d\n", ADB_MAJOR
);
905 adb_dev_class
= class_create(THIS_MODULE
, "adb");
906 if (IS_ERR(adb_dev_class
))
908 class_device_create(adb_dev_class
, NULL
, MKDEV(ADB_MAJOR
, 0), NULL
, "adb");