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 <linux/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
)
198 * No devices left at address i; move the
199 * one(s) we moved to `highFree' back to i.
201 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
202 (highFree
<< 4) | 0xb,
208 /* Now fill in the handler_id field of the adb_handler entries. */
209 printk(KERN_DEBUG
"adb devices:");
210 for (i
= 1; i
< 16; i
++) {
211 if (adb_handler
[i
].original_address
== 0)
213 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
215 adb_handler
[i
].handler_id
= req
.reply
[2];
216 printk(" [%d]: %d %x", i
, adb_handler
[i
].original_address
,
217 adb_handler
[i
].handler_id
);
225 * This kernel task handles ADB probing. It dies once probing is
229 adb_probe_task(void *x
)
231 printk(KERN_INFO
"adb: starting probe task...\n");
233 printk(KERN_INFO
"adb: finished probe task...\n");
235 up(&adb_probe_mutex
);
241 __adb_probe_task(struct work_struct
*bullshit
)
243 kthread_run(adb_probe_task
, NULL
, "kadbprobe");
246 static DECLARE_WORK(adb_reset_work
, __adb_probe_task
);
251 if (__adb_probe_sync
) {
256 down(&adb_probe_mutex
);
257 schedule_work(&adb_reset_work
);
263 * notify clients before sleep
265 static int __adb_suspend(struct platform_device
*dev
, pm_message_t state
)
268 /* We need to get a lock on the probe thread */
269 down(&adb_probe_mutex
);
271 if (adb_controller
->autopoll
)
272 adb_controller
->autopoll(0);
273 blocking_notifier_call_chain(&adb_client_list
, ADB_MSG_POWERDOWN
, NULL
);
278 static int adb_suspend(struct device
*dev
)
280 return __adb_suspend(to_platform_device(dev
), PMSG_SUSPEND
);
283 static int adb_freeze(struct device
*dev
)
285 return __adb_suspend(to_platform_device(dev
), PMSG_FREEZE
);
288 static int adb_poweroff(struct device
*dev
)
290 return __adb_suspend(to_platform_device(dev
), PMSG_HIBERNATE
);
294 * reset bus after sleep
296 static int __adb_resume(struct platform_device
*dev
)
299 up(&adb_probe_mutex
);
305 static int adb_resume(struct device
*dev
)
307 return __adb_resume(to_platform_device(dev
));
309 #endif /* CONFIG_PM */
311 static int __init
adb_init(void)
313 struct adb_driver
*driver
;
317 if (!machine_is(chrp
) && !machine_is(powermac
))
325 /* xmon may do early-init */
330 adb_controller
= NULL
;
333 while ((driver
= adb_driver_list
[i
++]) != NULL
) {
334 if (!driver
->probe()) {
335 adb_controller
= driver
;
339 if (adb_controller
!= NULL
&& adb_controller
->init
&&
340 adb_controller
->init())
341 adb_controller
= NULL
;
342 if (adb_controller
== NULL
) {
343 printk(KERN_WARNING
"Warning: no ADB interface detected\n");
346 if (of_machine_is_compatible("AAPL,PowerBook1998") ||
347 of_machine_is_compatible("PowerBook1,1"))
349 #endif /* CONFIG_PPC */
357 device_initcall(adb_init
);
360 do_adb_reset_bus(void)
364 if (adb_controller
== NULL
)
367 if (adb_controller
->autopoll
)
368 adb_controller
->autopoll(0);
370 blocking_notifier_call_chain(&adb_client_list
,
371 ADB_MSG_PRE_RESET
, NULL
);
373 if (sleepy_trackpad
) {
374 /* Let the trackpad settle down */
378 mutex_lock(&adb_handler_mutex
);
379 write_lock_irq(&adb_handler_lock
);
380 memset(adb_handler
, 0, sizeof(adb_handler
));
381 write_unlock_irq(&adb_handler_lock
);
383 /* That one is still a bit synchronous, oh well... */
384 if (adb_controller
->reset_bus
)
385 ret
= adb_controller
->reset_bus();
389 if (sleepy_trackpad
) {
390 /* Let the trackpad settle down */
395 autopoll_devs
= adb_scan_bus();
396 if (adb_controller
->autopoll
)
397 adb_controller
->autopoll(autopoll_devs
);
399 mutex_unlock(&adb_handler_mutex
);
401 blocking_notifier_call_chain(&adb_client_list
,
402 ADB_MSG_POST_RESET
, NULL
);
410 if ((adb_controller
== NULL
)||(adb_controller
->poll
== NULL
))
412 adb_controller
->poll();
415 static void adb_sync_req_done(struct adb_request
*req
)
417 struct completion
*comp
= req
->arg
;
423 adb_request(struct adb_request
*req
, void (*done
)(struct adb_request
*),
424 int flags
, int nbytes
, ...)
429 struct completion comp
;
431 if ((adb_controller
== NULL
) || (adb_controller
->send_request
== NULL
))
436 req
->nbytes
= nbytes
+1;
438 req
->reply_expected
= flags
& ADBREQ_REPLY
;
439 req
->data
[0] = ADB_PACKET
;
440 va_start(list
, nbytes
);
441 for (i
= 0; i
< nbytes
; ++i
)
442 req
->data
[i
+1] = va_arg(list
, int);
445 if (flags
& ADBREQ_NOSEND
)
448 /* Synchronous requests block using an on-stack completion */
449 if (flags
& ADBREQ_SYNC
) {
451 req
->done
= adb_sync_req_done
;
453 init_completion(&comp
);
456 rc
= adb_controller
->send_request(req
, 0);
458 if ((flags
& ADBREQ_SYNC
) && !rc
&& !req
->complete
)
459 wait_for_completion(&comp
);
464 /* Ultimately this should return the number of devices with
465 the given default id.
466 And it does it now ! Note: changed behaviour: This function
467 will now register if default_id _and_ handler_id both match
468 but handler_id can be left to 0 to match with default_id only.
469 When handler_id is set, this function will try to adjust
470 the handler_id id it doesn't match. */
472 adb_register(int default_id
, int handler_id
, struct adb_ids
*ids
,
473 void (*handler
)(unsigned char *, int, int))
477 mutex_lock(&adb_handler_mutex
);
479 for (i
= 1; i
< 16; i
++) {
480 if ((adb_handler
[i
].original_address
== default_id
) &&
481 (!handler_id
|| (handler_id
== adb_handler
[i
].handler_id
) ||
482 try_handler_change(i
, handler_id
))) {
483 if (adb_handler
[i
].handler
!= 0) {
485 "Two handlers for ADB device %d\n",
489 write_lock_irq(&adb_handler_lock
);
490 adb_handler
[i
].handler
= handler
;
491 write_unlock_irq(&adb_handler_lock
);
492 ids
->id
[ids
->nids
++] = i
;
495 mutex_unlock(&adb_handler_mutex
);
500 adb_unregister(int index
)
504 mutex_lock(&adb_handler_mutex
);
505 write_lock_irq(&adb_handler_lock
);
506 if (adb_handler
[index
].handler
) {
507 while(adb_handler
[index
].busy
) {
508 write_unlock_irq(&adb_handler_lock
);
510 write_lock_irq(&adb_handler_lock
);
513 adb_handler
[index
].handler
= NULL
;
515 write_unlock_irq(&adb_handler_lock
);
516 mutex_unlock(&adb_handler_mutex
);
521 adb_input(unsigned char *buf
, int nb
, int autopoll
)
524 static int dump_adb_input
;
527 void (*handler
)(unsigned char *, int, int);
529 /* We skip keystrokes and mouse moves when the sleep process
530 * has been started. We stop autopoll, but this is another security
536 if (dump_adb_input
) {
537 printk(KERN_INFO
"adb packet: ");
538 for (i
= 0; i
< nb
; ++i
)
539 printk(" %x", buf
[i
]);
540 printk(", id = %d\n", id
);
542 write_lock_irqsave(&adb_handler_lock
, flags
);
543 handler
= adb_handler
[id
].handler
;
545 adb_handler
[id
].busy
= 1;
546 write_unlock_irqrestore(&adb_handler_lock
, flags
);
547 if (handler
!= NULL
) {
548 (*handler
)(buf
, nb
, autopoll
);
550 adb_handler
[id
].busy
= 0;
555 /* Try to change handler to new_id. Will return 1 if successful. */
556 static int try_handler_change(int address
, int new_id
)
558 struct adb_request req
;
560 if (adb_handler
[address
].handler_id
== new_id
)
562 adb_request(&req
, NULL
, ADBREQ_SYNC
, 3,
563 ADB_WRITEREG(address
, 3), address
| 0x20, new_id
);
564 adb_request(&req
, NULL
, ADBREQ_SYNC
| ADBREQ_REPLY
, 1,
565 ADB_READREG(address
, 3));
566 if (req
.reply_len
< 2)
568 if (req
.reply
[2] != new_id
)
570 adb_handler
[address
].handler_id
= req
.reply
[2];
576 adb_try_handler_change(int address
, int new_id
)
580 mutex_lock(&adb_handler_mutex
);
581 ret
= try_handler_change(address
, new_id
);
582 mutex_unlock(&adb_handler_mutex
);
587 adb_get_infos(int address
, int *original_address
, int *handler_id
)
589 mutex_lock(&adb_handler_mutex
);
590 *original_address
= adb_handler
[address
].original_address
;
591 *handler_id
= adb_handler
[address
].handler_id
;
592 mutex_unlock(&adb_handler_mutex
);
594 return (*original_address
!= 0);
599 * /dev/adb device driver.
602 #define ADB_MAJOR 56 /* major number for /dev/adb */
604 struct adbdev_state
{
607 struct adb_request
*completed
;
608 wait_queue_head_t wait_queue
;
612 static void adb_write_done(struct adb_request
*req
)
614 struct adbdev_state
*state
= (struct adbdev_state
*) req
->arg
;
617 if (!req
->complete
) {
621 spin_lock_irqsave(&state
->lock
, flags
);
622 atomic_dec(&state
->n_pending
);
625 if (atomic_read(&state
->n_pending
) == 0) {
626 spin_unlock_irqrestore(&state
->lock
, flags
);
631 struct adb_request
**ap
= &state
->completed
;
636 wake_up_interruptible(&state
->wait_queue
);
638 spin_unlock_irqrestore(&state
->lock
, flags
);
642 do_adb_query(struct adb_request
*req
)
646 switch(req
->data
[1]) {
647 case ADB_QUERY_GETDEVINFO
:
650 mutex_lock(&adb_handler_mutex
);
651 req
->reply
[0] = adb_handler
[req
->data
[2]].original_address
;
652 req
->reply
[1] = adb_handler
[req
->data
[2]].handler_id
;
653 mutex_unlock(&adb_handler_mutex
);
663 static int adb_open(struct inode
*inode
, struct file
*file
)
665 struct adbdev_state
*state
;
668 mutex_lock(&adb_mutex
);
669 if (iminor(inode
) > 0 || adb_controller
== NULL
) {
673 state
= kmalloc(sizeof(struct adbdev_state
), GFP_KERNEL
);
678 file
->private_data
= state
;
679 spin_lock_init(&state
->lock
);
680 atomic_set(&state
->n_pending
, 0);
681 state
->completed
= NULL
;
682 init_waitqueue_head(&state
->wait_queue
);
686 mutex_unlock(&adb_mutex
);
690 static int adb_release(struct inode
*inode
, struct file
*file
)
692 struct adbdev_state
*state
= file
->private_data
;
695 mutex_lock(&adb_mutex
);
697 file
->private_data
= NULL
;
698 spin_lock_irqsave(&state
->lock
, flags
);
699 if (atomic_read(&state
->n_pending
) == 0
700 && state
->completed
== NULL
) {
701 spin_unlock_irqrestore(&state
->lock
, flags
);
705 spin_unlock_irqrestore(&state
->lock
, flags
);
708 mutex_unlock(&adb_mutex
);
712 static ssize_t
adb_read(struct file
*file
, char __user
*buf
,
713 size_t count
, loff_t
*ppos
)
716 struct adbdev_state
*state
= file
->private_data
;
717 struct adb_request
*req
;
718 DECLARE_WAITQUEUE(wait
, current
);
723 if (count
> sizeof(req
->reply
))
724 count
= sizeof(req
->reply
);
725 if (!access_ok(VERIFY_WRITE
, buf
, count
))
729 spin_lock_irqsave(&state
->lock
, flags
);
730 add_wait_queue(&state
->wait_queue
, &wait
);
731 set_current_state(TASK_INTERRUPTIBLE
);
734 req
= state
->completed
;
736 state
->completed
= req
->next
;
737 else if (atomic_read(&state
->n_pending
) == 0)
739 if (req
!= NULL
|| ret
!= 0)
742 if (file
->f_flags
& O_NONBLOCK
) {
746 if (signal_pending(current
)) {
750 spin_unlock_irqrestore(&state
->lock
, flags
);
752 spin_lock_irqsave(&state
->lock
, flags
);
755 set_current_state(TASK_RUNNING
);
756 remove_wait_queue(&state
->wait_queue
, &wait
);
757 spin_unlock_irqrestore(&state
->lock
, flags
);
762 ret
= req
->reply_len
;
765 if (ret
> 0 && copy_to_user(buf
, req
->reply
, ret
))
772 static ssize_t
adb_write(struct file
*file
, const char __user
*buf
,
773 size_t count
, loff_t
*ppos
)
776 struct adbdev_state
*state
= file
->private_data
;
777 struct adb_request
*req
;
779 if (count
< 2 || count
> sizeof(req
->data
))
781 if (adb_controller
== NULL
)
783 if (!access_ok(VERIFY_READ
, buf
, count
))
786 req
= kmalloc(sizeof(struct adb_request
),
792 req
->done
= adb_write_done
;
793 req
->arg
= (void *) state
;
797 if (copy_from_user(req
->data
, buf
, count
))
800 atomic_inc(&state
->n_pending
);
802 /* If a probe is in progress or we are sleeping, wait for it to complete */
803 down(&adb_probe_mutex
);
805 /* Queries are special requests sent to the ADB driver itself */
806 if (req
->data
[0] == ADB_QUERY
) {
808 ret
= do_adb_query(req
);
811 up(&adb_probe_mutex
);
813 /* Special case for ADB_BUSRESET request, all others are sent to
815 else if ((req
->data
[0] == ADB_PACKET
) && (count
> 1)
816 && (req
->data
[1] == ADB_BUSRESET
)) {
817 ret
= do_adb_reset_bus();
818 up(&adb_probe_mutex
);
819 atomic_dec(&state
->n_pending
);
824 req
->reply_expected
= ((req
->data
[1] & 0xc) == 0xc);
825 if (adb_controller
&& adb_controller
->send_request
)
826 ret
= adb_controller
->send_request(req
, 0);
829 up(&adb_probe_mutex
);
833 atomic_dec(&state
->n_pending
);
843 static const struct file_operations adb_fops
= {
844 .owner
= THIS_MODULE
,
849 .release
= adb_release
,
853 static const struct dev_pm_ops adb_dev_pm_ops
= {
854 .suspend
= adb_suspend
,
855 .resume
= adb_resume
,
856 /* Hibernate hooks */
857 .freeze
= adb_freeze
,
859 .poweroff
= adb_poweroff
,
860 .restore
= adb_resume
,
864 static struct platform_driver adb_pfdrv
= {
868 .pm
= &adb_dev_pm_ops
,
873 static struct platform_device adb_pfdev
= {
878 adb_dummy_probe(struct platform_device
*dev
)
880 if (dev
== &adb_pfdev
)
888 if (register_chrdev(ADB_MAJOR
, "adb", &adb_fops
)) {
889 printk(KERN_ERR
"adb: unable to get major %d\n", ADB_MAJOR
);
893 adb_dev_class
= class_create(THIS_MODULE
, "adb");
894 if (IS_ERR(adb_dev_class
))
896 device_create(adb_dev_class
, NULL
, MKDEV(ADB_MAJOR
, 0), NULL
, "adb");
898 platform_device_register(&adb_pfdev
);
899 platform_driver_probe(&adb_pfdrv
, adb_dummy_probe
);