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>
38 #include <linux/kthread.h>
39 #include <linux/platform_device.h>
41 #include <asm/uaccess.h>
42 #include <asm/semaphore.h>
45 #include <asm/machdep.h>
49 EXPORT_SYMBOL(adb_controller
);
50 EXPORT_SYMBOL(adb_client_list
);
52 extern struct adb_driver via_macii_driver
;
53 extern struct adb_driver via_maciisi_driver
;
54 extern struct adb_driver via_cuda_driver
;
55 extern struct adb_driver adb_iop_driver
;
56 extern struct adb_driver via_pmu_driver
;
57 extern struct adb_driver macio_adb_driver
;
59 static struct adb_driver
*adb_driver_list
[] = {
60 #ifdef CONFIG_ADB_MACII
63 #ifdef CONFIG_ADB_MACIISI
66 #ifdef CONFIG_ADB_CUDA
72 #if defined(CONFIG_ADB_PMU) || defined(CONFIG_ADB_PMU68K)
75 #ifdef CONFIG_ADB_MACIO
81 static struct class *adb_dev_class
;
83 struct adb_driver
*adb_controller
;
84 BLOCKING_NOTIFIER_HEAD(adb_client_list
);
85 static int adb_got_sleep
;
86 static int adb_inited
;
87 static DECLARE_MUTEX(adb_probe_mutex
);
88 static int sleepy_trackpad
;
89 static int autopoll_devs
;
92 static int adb_scan_bus(void);
93 static int do_adb_reset_bus(void);
94 static void adbdev_init(void);
95 static int try_handler_change(int, int);
97 static struct adb_handler
{
98 void (*handler
)(unsigned char *, int, int);
105 * The adb_handler_sem mutex protects all accesses to the original_address
106 * and handler_id fields of adb_handler[i] for all i, and changes to the
108 * Accesses to the handler field are protected by the adb_handler_lock
109 * rwlock. It is held across all calls to any handler, so that by the
110 * time adb_unregister returns, we know that the old handler isn't being
113 static DECLARE_MUTEX(adb_handler_sem
);
114 static DEFINE_RWLOCK(adb_handler_lock
);
117 static void printADBreply(struct adb_request
*req
)
121 printk("adb reply (%d)", req
->reply_len
);
122 for(i
= 0; i
< req
->reply_len
; i
++)
123 printk(" %x", req
->reply
[i
]);
129 static int adb_scan_bus(void)
131 int i
, highFree
=0, noMovement
;
133 struct adb_request req
;
135 /* assumes adb_handler[] is all zeroes at this point */
136 for (i
= 1; i
< 16; i
++) {
137 /* see if there is anything at address i */
138 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
140 if (req
.reply_len
> 1)
141 /* one or more devices at this address */
142 adb_handler
[i
].original_address
= i
;
143 else if (i
> highFree
)
147 /* Note we reset noMovement to 0 each time we move a device */
148 for (noMovement
= 1; noMovement
< 2 && highFree
> 0; noMovement
++) {
149 for (i
= 1; i
< 16; i
++) {
150 if (adb_handler
[i
].original_address
== 0)
153 * Send a "talk register 3" command to address i
154 * to provoke a collision if there is more than
155 * one device at this address.
157 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
160 * Move the device(s) which didn't detect a
161 * collision to address `highFree'. Hopefully
162 * this only moves one device.
164 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
165 (i
<< 4) | 0xb, (highFree
| 0x60), 0xfe);
167 * See if anybody actually moved. This is suggested
170 * http://developer.apple.com/technotes/hw/hw_01.html
172 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
173 (highFree
<< 4) | 0xf);
174 if (req
.reply_len
<= 1) continue;
176 * Test whether there are any device(s) left
179 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
181 if (req
.reply_len
> 1) {
183 * There are still one or more devices
184 * left at address i. Register the one(s)
185 * we moved to `highFree', and find a new
186 * value for highFree.
188 adb_handler
[highFree
].original_address
=
189 adb_handler
[i
].original_address
;
190 while (highFree
> 0 &&
191 adb_handler
[highFree
].original_address
)
200 * No devices left at address i; move the
201 * one(s) we moved to `highFree' back to i.
203 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
204 (highFree
<< 4) | 0xb,
210 /* Now fill in the handler_id field of the adb_handler entries. */
211 printk(KERN_DEBUG
"adb devices:");
212 for (i
= 1; i
< 16; i
++) {
213 if (adb_handler
[i
].original_address
== 0)
215 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
217 adb_handler
[i
].handler_id
= req
.reply
[2];
218 printk(" [%d]: %d %x", i
, adb_handler
[i
].original_address
,
219 adb_handler
[i
].handler_id
);
227 * This kernel task handles ADB probing. It dies once probing is
231 adb_probe_task(void *x
)
233 printk(KERN_INFO
"adb: starting probe task...\n");
235 printk(KERN_INFO
"adb: finished probe task...\n");
237 up(&adb_probe_mutex
);
243 __adb_probe_task(struct work_struct
*bullshit
)
245 kthread_run(adb_probe_task
, NULL
, "kadbprobe");
248 static DECLARE_WORK(adb_reset_work
, __adb_probe_task
);
253 if (__adb_probe_sync
) {
258 down(&adb_probe_mutex
);
259 schedule_work(&adb_reset_work
);
265 * notify clients before sleep
267 static int adb_suspend(struct platform_device
*dev
, pm_message_t state
)
270 /* We need to get a lock on the probe thread */
271 down(&adb_probe_mutex
);
273 if (adb_controller
->autopoll
)
274 adb_controller
->autopoll(0);
275 blocking_notifier_call_chain(&adb_client_list
, ADB_MSG_POWERDOWN
, NULL
);
281 * reset bus after sleep
283 static int adb_resume(struct platform_device
*dev
)
286 up(&adb_probe_mutex
);
291 #endif /* CONFIG_PM */
293 int __init
adb_init(void)
295 struct adb_driver
*driver
;
299 if (!machine_is(chrp
) && !machine_is(powermac
))
307 /* xmon may do early-init */
312 adb_controller
= NULL
;
315 while ((driver
= adb_driver_list
[i
++]) != NULL
) {
316 if (!driver
->probe()) {
317 adb_controller
= driver
;
321 if ((adb_controller
== NULL
) || adb_controller
->init()) {
322 printk(KERN_WARNING
"Warning: no ADB interface detected\n");
323 adb_controller
= NULL
;
326 if (machine_is_compatible("AAPL,PowerBook1998") ||
327 machine_is_compatible("PowerBook1,1"))
329 #endif /* CONFIG_PPC */
337 __initcall(adb_init
);
340 do_adb_reset_bus(void)
344 if (adb_controller
== NULL
)
347 if (adb_controller
->autopoll
)
348 adb_controller
->autopoll(0);
350 blocking_notifier_call_chain(&adb_client_list
,
351 ADB_MSG_PRE_RESET
, NULL
);
353 if (sleepy_trackpad
) {
354 /* Let the trackpad settle down */
358 down(&adb_handler_sem
);
359 write_lock_irq(&adb_handler_lock
);
360 memset(adb_handler
, 0, sizeof(adb_handler
));
361 write_unlock_irq(&adb_handler_lock
);
363 /* That one is still a bit synchronous, oh well... */
364 if (adb_controller
->reset_bus
)
365 ret
= adb_controller
->reset_bus();
369 if (sleepy_trackpad
) {
370 /* Let the trackpad settle down */
375 autopoll_devs
= adb_scan_bus();
376 if (adb_controller
->autopoll
)
377 adb_controller
->autopoll(autopoll_devs
);
379 up(&adb_handler_sem
);
381 blocking_notifier_call_chain(&adb_client_list
,
382 ADB_MSG_POST_RESET
, NULL
);
390 if ((adb_controller
== NULL
)||(adb_controller
->poll
== NULL
))
392 adb_controller
->poll();
395 static void adb_sync_req_done(struct adb_request
*req
)
397 struct completion
*comp
= req
->arg
;
403 adb_request(struct adb_request
*req
, void (*done
)(struct adb_request
*),
404 int flags
, int nbytes
, ...)
409 struct completion comp
;
411 if ((adb_controller
== NULL
) || (adb_controller
->send_request
== NULL
))
416 req
->nbytes
= nbytes
+1;
418 req
->reply_expected
= flags
& ADBREQ_REPLY
;
419 req
->data
[0] = ADB_PACKET
;
420 va_start(list
, nbytes
);
421 for (i
= 0; i
< nbytes
; ++i
)
422 req
->data
[i
+1] = va_arg(list
, int);
425 if (flags
& ADBREQ_NOSEND
)
428 /* Synchronous requests block using an on-stack completion */
429 if (flags
& ADBREQ_SYNC
) {
431 req
->done
= adb_sync_req_done
;
433 init_completion(&comp
);
436 rc
= adb_controller
->send_request(req
, 0);
438 if ((flags
& ADBREQ_SYNC
) && !rc
&& !req
->complete
)
439 wait_for_completion(&comp
);
444 /* Ultimately this should return the number of devices with
445 the given default id.
446 And it does it now ! Note: changed behaviour: This function
447 will now register if default_id _and_ handler_id both match
448 but handler_id can be left to 0 to match with default_id only.
449 When handler_id is set, this function will try to adjust
450 the handler_id id it doesn't match. */
452 adb_register(int default_id
, int handler_id
, struct adb_ids
*ids
,
453 void (*handler
)(unsigned char *, int, int))
457 down(&adb_handler_sem
);
459 for (i
= 1; i
< 16; i
++) {
460 if ((adb_handler
[i
].original_address
== default_id
) &&
461 (!handler_id
|| (handler_id
== adb_handler
[i
].handler_id
) ||
462 try_handler_change(i
, handler_id
))) {
463 if (adb_handler
[i
].handler
!= 0) {
465 "Two handlers for ADB device %d\n",
469 write_lock_irq(&adb_handler_lock
);
470 adb_handler
[i
].handler
= handler
;
471 write_unlock_irq(&adb_handler_lock
);
472 ids
->id
[ids
->nids
++] = i
;
475 up(&adb_handler_sem
);
480 adb_unregister(int index
)
484 down(&adb_handler_sem
);
485 write_lock_irq(&adb_handler_lock
);
486 if (adb_handler
[index
].handler
) {
487 while(adb_handler
[index
].busy
) {
488 write_unlock_irq(&adb_handler_lock
);
490 write_lock_irq(&adb_handler_lock
);
493 adb_handler
[index
].handler
= NULL
;
495 write_unlock_irq(&adb_handler_lock
);
496 up(&adb_handler_sem
);
501 adb_input(unsigned char *buf
, int nb
, int autopoll
)
504 static int dump_adb_input
= 0;
507 void (*handler
)(unsigned char *, int, int);
509 /* We skip keystrokes and mouse moves when the sleep process
510 * has been started. We stop autopoll, but this is another security
516 if (dump_adb_input
) {
517 printk(KERN_INFO
"adb packet: ");
518 for (i
= 0; i
< nb
; ++i
)
519 printk(" %x", buf
[i
]);
520 printk(", id = %d\n", id
);
522 write_lock_irqsave(&adb_handler_lock
, flags
);
523 handler
= adb_handler
[id
].handler
;
525 adb_handler
[id
].busy
= 1;
526 write_unlock_irqrestore(&adb_handler_lock
, flags
);
527 if (handler
!= NULL
) {
528 (*handler
)(buf
, nb
, autopoll
);
530 adb_handler
[id
].busy
= 0;
535 /* Try to change handler to new_id. Will return 1 if successful. */
536 static int try_handler_change(int address
, int new_id
)
538 struct adb_request req
;
540 if (adb_handler
[address
].handler_id
== new_id
)
542 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
543 ADB_WRITEREG(address
, 3), address
| 0x20, new_id
);
544 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
545 ADB_READREG(address
, 3));
546 if (req
.reply_len
< 2)
548 if (req
.reply
[2] != new_id
)
550 adb_handler
[address
].handler_id
= req
.reply
[2];
556 adb_try_handler_change(int address
, int new_id
)
560 down(&adb_handler_sem
);
561 ret
= try_handler_change(address
, new_id
);
562 up(&adb_handler_sem
);
567 adb_get_infos(int address
, int *original_address
, int *handler_id
)
569 down(&adb_handler_sem
);
570 *original_address
= adb_handler
[address
].original_address
;
571 *handler_id
= adb_handler
[address
].handler_id
;
572 up(&adb_handler_sem
);
574 return (*original_address
!= 0);
579 * /dev/adb device driver.
582 #define ADB_MAJOR 56 /* major number for /dev/adb */
584 struct adbdev_state
{
587 struct adb_request
*completed
;
588 wait_queue_head_t wait_queue
;
592 static void adb_write_done(struct adb_request
*req
)
594 struct adbdev_state
*state
= (struct adbdev_state
*) req
->arg
;
597 if (!req
->complete
) {
601 spin_lock_irqsave(&state
->lock
, flags
);
602 atomic_dec(&state
->n_pending
);
605 if (atomic_read(&state
->n_pending
) == 0) {
606 spin_unlock_irqrestore(&state
->lock
, flags
);
611 struct adb_request
**ap
= &state
->completed
;
616 wake_up_interruptible(&state
->wait_queue
);
618 spin_unlock_irqrestore(&state
->lock
, flags
);
622 do_adb_query(struct adb_request
*req
)
628 case ADB_QUERY_GETDEVINFO
:
631 down(&adb_handler_sem
);
632 req
->reply
[0] = adb_handler
[req
->data
[2]].original_address
;
633 req
->reply
[1] = adb_handler
[req
->data
[2]].handler_id
;
634 up(&adb_handler_sem
);
644 static int adb_open(struct inode
*inode
, struct file
*file
)
646 struct adbdev_state
*state
;
648 if (iminor(inode
) > 0 || adb_controller
== NULL
)
650 state
= kmalloc(sizeof(struct adbdev_state
), GFP_KERNEL
);
653 file
->private_data
= state
;
654 spin_lock_init(&state
->lock
);
655 atomic_set(&state
->n_pending
, 0);
656 state
->completed
= NULL
;
657 init_waitqueue_head(&state
->wait_queue
);
663 static int adb_release(struct inode
*inode
, struct file
*file
)
665 struct adbdev_state
*state
= file
->private_data
;
670 file
->private_data
= NULL
;
671 spin_lock_irqsave(&state
->lock
, flags
);
672 if (atomic_read(&state
->n_pending
) == 0
673 && state
->completed
== NULL
) {
674 spin_unlock_irqrestore(&state
->lock
, flags
);
678 spin_unlock_irqrestore(&state
->lock
, flags
);
685 static ssize_t
adb_read(struct file
*file
, char __user
*buf
,
686 size_t count
, loff_t
*ppos
)
689 struct adbdev_state
*state
= file
->private_data
;
690 struct adb_request
*req
;
691 wait_queue_t wait
= __WAITQUEUE_INITIALIZER(wait
,current
);
696 if (count
> sizeof(req
->reply
))
697 count
= sizeof(req
->reply
);
698 if (!access_ok(VERIFY_WRITE
, buf
, count
))
702 spin_lock_irqsave(&state
->lock
, flags
);
703 add_wait_queue(&state
->wait_queue
, &wait
);
704 current
->state
= TASK_INTERRUPTIBLE
;
707 req
= state
->completed
;
709 state
->completed
= req
->next
;
710 else if (atomic_read(&state
->n_pending
) == 0)
712 if (req
!= NULL
|| ret
!= 0)
715 if (file
->f_flags
& O_NONBLOCK
) {
719 if (signal_pending(current
)) {
723 spin_unlock_irqrestore(&state
->lock
, flags
);
725 spin_lock_irqsave(&state
->lock
, flags
);
728 current
->state
= TASK_RUNNING
;
729 remove_wait_queue(&state
->wait_queue
, &wait
);
730 spin_unlock_irqrestore(&state
->lock
, flags
);
735 ret
= req
->reply_len
;
738 if (ret
> 0 && copy_to_user(buf
, req
->reply
, ret
))
745 static ssize_t
adb_write(struct file
*file
, const char __user
*buf
,
746 size_t count
, loff_t
*ppos
)
749 struct adbdev_state
*state
= file
->private_data
;
750 struct adb_request
*req
;
752 if (count
< 2 || count
> sizeof(req
->data
))
754 if (adb_controller
== NULL
)
756 if (!access_ok(VERIFY_READ
, buf
, count
))
759 req
= kmalloc(sizeof(struct adb_request
),
765 req
->done
= adb_write_done
;
766 req
->arg
= (void *) state
;
770 if (copy_from_user(req
->data
, buf
, count
))
773 atomic_inc(&state
->n_pending
);
775 /* If a probe is in progress or we are sleeping, wait for it to complete */
776 down(&adb_probe_mutex
);
778 /* Queries are special requests sent to the ADB driver itself */
779 if (req
->data
[0] == ADB_QUERY
) {
781 ret
= do_adb_query(req
);
784 up(&adb_probe_mutex
);
786 /* Special case for ADB_BUSRESET request, all others are sent to
788 else if ((req
->data
[0] == ADB_PACKET
)&&(count
> 1)
789 &&(req
->data
[1] == ADB_BUSRESET
)) {
790 ret
= do_adb_reset_bus();
791 up(&adb_probe_mutex
);
792 atomic_dec(&state
->n_pending
);
797 req
->reply_expected
= ((req
->data
[1] & 0xc) == 0xc);
798 if (adb_controller
&& adb_controller
->send_request
)
799 ret
= adb_controller
->send_request(req
, 0);
802 up(&adb_probe_mutex
);
806 atomic_dec(&state
->n_pending
);
816 static const struct file_operations adb_fops
= {
817 .owner
= THIS_MODULE
,
822 .release
= adb_release
,
825 static struct platform_driver adb_pfdrv
= {
830 .suspend
= adb_suspend
,
831 .resume
= adb_resume
,
835 static struct platform_device adb_pfdev
= {
840 adb_dummy_probe(struct platform_device
*dev
)
842 if (dev
== &adb_pfdev
)
850 if (register_chrdev(ADB_MAJOR
, "adb", &adb_fops
)) {
851 printk(KERN_ERR
"adb: unable to get major %d\n", ADB_MAJOR
);
855 adb_dev_class
= class_create(THIS_MODULE
, "adb");
856 if (IS_ERR(adb_dev_class
))
858 device_create(adb_dev_class
, NULL
, MKDEV(ADB_MAJOR
, 0), "adb");
860 platform_device_register(&adb_pfdev
);
861 platform_driver_probe(&adb_pfdrv
, adb_dummy_probe
);