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/config.h>
20 #include <linux/types.h>
21 #include <linux/errno.h>
22 #include <linux/kernel.h>
23 #include <linux/slab.h>
24 #include <linux/module.h>
27 #include <linux/sched.h>
28 #include <linux/smp_lock.h>
29 #include <linux/adb.h>
30 #include <linux/cuda.h>
31 #include <linux/pmu.h>
32 #include <linux/notifier.h>
33 #include <linux/wait.h>
34 #include <linux/init.h>
35 #include <linux/delay.h>
36 #include <linux/spinlock.h>
37 #include <linux/completion.h>
38 #include <linux/device.h>
39 #include <linux/devfs_fs_kernel.h>
41 #include <asm/uaccess.h>
42 #include <asm/semaphore.h>
48 EXPORT_SYMBOL(adb_controller);
49 EXPORT_SYMBOL(adb_client_list);
51 extern struct adb_driver via_macii_driver;
52 extern struct adb_driver via_maciisi_driver;
53 extern struct adb_driver via_cuda_driver;
54 extern struct adb_driver adb_iop_driver;
55 extern struct adb_driver via_pmu_driver;
56 extern struct adb_driver macio_adb_driver;
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_simple *adb_dev_class;
82 struct adb_driver *adb_controller;
83 struct notifier_block *adb_client_list = NULL;
84 static int adb_got_sleep;
85 static int adb_inited;
86 static pid_t adb_probe_task_pid;
87 static DECLARE_MUTEX(adb_probe_mutex);
88 static struct completion adb_probe_task_comp;
89 static int sleepy_trackpad;
90 static int autopoll_devs;
93 #ifdef CONFIG_PMAC_PBOOK
94 static int adb_notify_sleep(struct pmu_sleep_notifier *self, int when);
95 static struct pmu_sleep_notifier adb_sleep_notifier = {
101 static int adb_scan_bus(void);
102 static int do_adb_reset_bus(void);
103 static void adbdev_init(void);
104 static int try_handler_change(int, int);
106 static struct adb_handler {
107 void (*handler)(unsigned char *, int, struct pt_regs *, int);
108 int original_address;
114 * The adb_handler_sem mutex protects all accesses to the original_address
115 * and handler_id fields of adb_handler[i] for all i, and changes to the
117 * Accesses to the handler field are protected by the adb_handler_lock
118 * rwlock. It is held across all calls to any handler, so that by the
119 * time adb_unregister returns, we know that the old handler isn't being
122 static DECLARE_MUTEX(adb_handler_sem);
123 static rwlock_t adb_handler_lock = RW_LOCK_UNLOCKED;
126 static void printADBreply(struct adb_request *req)
130 printk("adb reply (%d)", req->reply_len);
131 for(i = 0; i < req->reply_len; i++)
132 printk(" %x", req->reply[i]);
139 static __inline__ void adb_wait_ms(unsigned int ms)
141 if (current->pid && adb_probe_task_pid &&
142 adb_probe_task_pid == current->pid) {
143 set_task_state(current, TASK_UNINTERRUPTIBLE);
144 schedule_timeout(1 + ms * HZ / 1000);
149 static int adb_scan_bus(void)
151 int i, highFree=0, noMovement;
153 struct adb_request req;
155 /* assumes adb_handler[] is all zeroes at this point */
156 for (i = 1; i < 16; i++) {
157 /* see if there is anything at address i */
158 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
160 if (req.reply_len > 1)
161 /* one or more devices at this address */
162 adb_handler[i].original_address = i;
163 else if (i > highFree)
167 /* Note we reset noMovement to 0 each time we move a device */
168 for (noMovement = 1; noMovement < 2 && highFree > 0; noMovement++) {
169 for (i = 1; i < 16; i++) {
170 if (adb_handler[i].original_address == 0)
173 * Send a "talk register 3" command to address i
174 * to provoke a collision if there is more than
175 * one device at this address.
177 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
180 * Move the device(s) which didn't detect a
181 * collision to address `highFree'. Hopefully
182 * this only moves one device.
184 adb_request(&req, NULL, ADBREQ_SYNC, 3,
185 (i<< 4) | 0xb, (highFree | 0x60), 0xfe);
187 * See if anybody actually moved. This is suggested
190 * http://developer.apple.com/technotes/hw/hw_01.html
192 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
193 (highFree << 4) | 0xf);
194 if (req.reply_len <= 1) continue;
196 * Test whether there are any device(s) left
199 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
201 if (req.reply_len > 1) {
203 * There are still one or more devices
204 * left at address i. Register the one(s)
205 * we moved to `highFree', and find a new
206 * value for highFree.
208 adb_handler[highFree].original_address =
209 adb_handler[i].original_address;
210 while (highFree > 0 &&
211 adb_handler[highFree].original_address)
220 * No devices left at address i; move the
221 * one(s) we moved to `highFree' back to i.
223 adb_request(&req, NULL, ADBREQ_SYNC, 3,
224 (highFree << 4) | 0xb,
230 /* Now fill in the handler_id field of the adb_handler entries. */
231 printk(KERN_DEBUG "adb devices:");
232 for (i = 1; i < 16; i++) {
233 if (adb_handler[i].original_address == 0)
235 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
237 adb_handler[i].handler_id = req.reply[2];
238 printk(" [%d]: %d %x", i, adb_handler[i].original_address,
239 adb_handler[i].handler_id);
247 * This kernel task handles ADB probing. It dies once probing is
251 adb_probe_task(void *x)
255 strcpy(current->comm, "kadbprobe");
257 sigfillset(&blocked);
258 sigprocmask(SIG_BLOCK, &blocked, NULL);
259 flush_signals(current);
261 printk(KERN_INFO "adb: starting probe task...\n");
263 printk(KERN_INFO "adb: finished probe task...\n");
265 adb_probe_task_pid = 0;
266 up(&adb_probe_mutex);
272 __adb_probe_task(void *data)
274 adb_probe_task_pid = kernel_thread(adb_probe_task, NULL, SIGCHLD | CLONE_KERNEL);
277 static DECLARE_WORK(adb_reset_work, __adb_probe_task, NULL);
282 if (__adb_probe_sync) {
287 down(&adb_probe_mutex);
288 schedule_work(&adb_reset_work);
292 int __init adb_init(void)
294 struct adb_driver *driver;
298 if ( (_machine != _MACH_chrp) && (_machine != _MACH_Pmac) )
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 printk(KERN_WARNING "Warning: no ADB interface detected\n");
322 adb_controller = NULL;
324 #ifdef CONFIG_PMAC_PBOOK
325 pmu_register_sleep_notifier(&adb_sleep_notifier);
326 #endif /* CONFIG_PMAC_PBOOK */
328 if (machine_is_compatible("AAPL,PowerBook1998") ||
329 machine_is_compatible("PowerBook1,1"))
331 #endif /* CONFIG_PPC */
332 init_completion(&adb_probe_task_comp);
339 __initcall(adb_init);
341 #ifdef CONFIG_PMAC_PBOOK
343 * notify clients before sleep and reset bus afterwards
346 adb_notify_sleep(struct pmu_sleep_notifier *self, int when)
351 case PBOOK_SLEEP_REQUEST:
353 /* We need to get a lock on the probe thread */
354 down(&adb_probe_mutex);
356 if (adb_controller->autopoll)
357 adb_controller->autopoll(0);
358 ret = notifier_call_chain(&adb_client_list, ADB_MSG_POWERDOWN, NULL);
359 if (ret & NOTIFY_STOP_MASK) {
360 up(&adb_probe_mutex);
361 return PBOOK_SLEEP_REFUSE;
364 case PBOOK_SLEEP_REJECT:
367 up(&adb_probe_mutex);
372 case PBOOK_SLEEP_NOW:
376 up(&adb_probe_mutex);
380 return PBOOK_SLEEP_OK;
382 #endif /* CONFIG_PMAC_PBOOK */
385 do_adb_reset_bus(void)
389 if (adb_controller == NULL)
392 if (adb_controller->autopoll)
393 adb_controller->autopoll(0);
395 nret = notifier_call_chain(&adb_client_list, 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 = notifier_call_chain(&adb_client_list, ADB_MSG_POST_RESET, NULL);
431 if (nret & NOTIFY_STOP_MASK)
440 if ((adb_controller == NULL)||(adb_controller->poll == NULL))
442 adb_controller->poll();
446 adb_probe_wakeup(struct adb_request *req)
448 complete(&adb_probe_task_comp);
451 /* Static request used during probe */
452 static struct adb_request adb_sreq;
453 static unsigned long adb_sreq_lock; // Use semaphore ! */
456 adb_request(struct adb_request *req, void (*done)(struct adb_request *),
457 int flags, int nbytes, ...)
463 if ((adb_controller == NULL) || (adb_controller->send_request == NULL))
467 if (req == NULL && (flags & ADBREQ_NOSEND))
471 if (test_and_set_bit(0,&adb_sreq_lock)) {
472 printk("adb.c: Warning: contention on static request !\n");
476 flags |= ADBREQ_SYNC;
480 req->nbytes = nbytes+1;
482 req->reply_expected = flags & ADBREQ_REPLY;
483 req->data[0] = ADB_PACKET;
484 va_start(list, nbytes);
485 for (i = 0; i < nbytes; ++i)
486 req->data[i+1] = va_arg(list, int);
489 if (flags & ADBREQ_NOSEND)
492 /* Synchronous requests send from the probe thread cause it to
493 * block. Beware that the "done" callback will be overriden !
495 if ((flags & ADBREQ_SYNC) &&
496 (current->pid && adb_probe_task_pid &&
497 adb_probe_task_pid == current->pid)) {
498 req->done = adb_probe_wakeup;
499 rc = adb_controller->send_request(req, 0);
500 if (rc || req->complete)
502 wait_for_completion(&adb_probe_task_comp);
507 rc = adb_controller->send_request(req, flags & ADBREQ_SYNC);
510 clear_bit(0, &adb_sreq_lock);
515 /* Ultimately this should return the number of devices with
516 the given default id.
517 And it does it now ! Note: changed behaviour: This function
518 will now register if default_id _and_ handler_id both match
519 but handler_id can be left to 0 to match with default_id only.
520 When handler_id is set, this function will try to adjust
521 the handler_id id it doesn't match. */
523 adb_register(int default_id, int handler_id, struct adb_ids *ids,
524 void (*handler)(unsigned char *, int, struct pt_regs *, int))
528 down(&adb_handler_sem);
530 for (i = 1; i < 16; i++) {
531 if ((adb_handler[i].original_address == default_id) &&
532 (!handler_id || (handler_id == adb_handler[i].handler_id) ||
533 try_handler_change(i, handler_id))) {
534 if (adb_handler[i].handler != 0) {
536 "Two handlers for ADB device %d\n",
540 write_lock_irq(&adb_handler_lock);
541 adb_handler[i].handler = handler;
542 write_unlock_irq(&adb_handler_lock);
543 ids->id[ids->nids++] = i;
546 up(&adb_handler_sem);
551 adb_unregister(int index)
555 down(&adb_handler_sem);
556 write_lock_irq(&adb_handler_lock);
557 if (adb_handler[index].handler) {
558 while(adb_handler[index].busy) {
559 write_unlock_irq(&adb_handler_lock);
561 write_lock_irq(&adb_handler_lock);
564 adb_handler[index].handler = 0;
566 write_unlock_irq(&adb_handler_lock);
567 up(&adb_handler_sem);
572 adb_input(unsigned char *buf, int nb, struct pt_regs *regs, int autopoll)
575 static int dump_adb_input = 0;
578 void (*handler)(unsigned char *, int, struct pt_regs *, int);
580 /* We skip keystrokes and mouse moves when the sleep process
581 * has been started. We stop autopoll, but this is another security
587 if (dump_adb_input) {
588 printk(KERN_INFO "adb packet: ");
589 for (i = 0; i < nb; ++i)
590 printk(" %x", buf[i]);
591 printk(", id = %d\n", id);
593 write_lock_irqsave(&adb_handler_lock, flags);
594 handler = adb_handler[id].handler;
596 adb_handler[id].busy = 1;
597 write_unlock_irqrestore(&adb_handler_lock, flags);
598 if (handler != NULL) {
599 (*handler)(buf, nb, regs, autopoll);
601 adb_handler[id].busy = 0;
606 /* Try to change handler to new_id. Will return 1 if successful. */
607 static int try_handler_change(int address, int new_id)
609 struct adb_request req;
611 if (adb_handler[address].handler_id == new_id)
613 adb_request(&req, NULL, ADBREQ_SYNC, 3,
614 ADB_WRITEREG(address, 3), address | 0x20, new_id);
615 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
616 ADB_READREG(address, 3));
617 if (req.reply_len < 2)
619 if (req.reply[2] != new_id)
621 adb_handler[address].handler_id = req.reply[2];
627 adb_try_handler_change(int address, int new_id)
631 down(&adb_handler_sem);
632 ret = try_handler_change(address, new_id);
633 up(&adb_handler_sem);
638 adb_get_infos(int address, int *original_address, int *handler_id)
640 down(&adb_handler_sem);
641 *original_address = adb_handler[address].original_address;
642 *handler_id = adb_handler[address].handler_id;
643 up(&adb_handler_sem);
645 return (*original_address != 0);
650 * /dev/adb device driver.
653 #define ADB_MAJOR 56 /* major number for /dev/adb */
655 struct adbdev_state {
658 struct adb_request *completed;
659 wait_queue_head_t wait_queue;
663 static void adb_write_done(struct adb_request *req)
665 struct adbdev_state *state = (struct adbdev_state *) req->arg;
668 if (!req->complete) {
672 spin_lock_irqsave(&state->lock, flags);
673 atomic_dec(&state->n_pending);
676 if (atomic_read(&state->n_pending) == 0) {
677 spin_unlock_irqrestore(&state->lock, flags);
682 struct adb_request **ap = &state->completed;
687 wake_up_interruptible(&state->wait_queue);
689 spin_unlock_irqrestore(&state->lock, flags);
693 do_adb_query(struct adb_request *req)
699 case ADB_QUERY_GETDEVINFO:
702 down(&adb_handler_sem);
703 req->reply[0] = adb_handler[req->data[2]].original_address;
704 req->reply[1] = adb_handler[req->data[2]].handler_id;
705 up(&adb_handler_sem);
715 static int adb_open(struct inode *inode, struct file *file)
717 struct adbdev_state *state;
719 if (iminor(inode) > 0 || adb_controller == NULL)
721 state = kmalloc(sizeof(struct adbdev_state), GFP_KERNEL);
724 file->private_data = state;
725 spin_lock_init(&state->lock);
726 atomic_set(&state->n_pending, 0);
727 state->completed = NULL;
728 init_waitqueue_head(&state->wait_queue);
734 static int adb_release(struct inode *inode, struct file *file)
736 struct adbdev_state *state = file->private_data;
741 file->private_data = NULL;
742 spin_lock_irqsave(&state->lock, flags);
743 if (atomic_read(&state->n_pending) == 0
744 && state->completed == NULL) {
745 spin_unlock_irqrestore(&state->lock, flags);
749 spin_unlock_irqrestore(&state->lock, flags);
756 static ssize_t adb_read(struct file *file, char __user *buf,
757 size_t count, loff_t *ppos)
760 struct adbdev_state *state = file->private_data;
761 struct adb_request *req;
762 wait_queue_t wait = __WAITQUEUE_INITIALIZER(wait,current);
767 if (count > sizeof(req->reply))
768 count = sizeof(req->reply);
769 ret = verify_area(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 ret = verify_area(VERIFY_READ, buf, count);
832 req = (struct adb_request *) kmalloc(sizeof(struct adb_request),
838 req->done = adb_write_done;
839 req->arg = (void *) state;
843 if (copy_from_user(req->data, buf, count))
846 atomic_inc(&state->n_pending);
848 /* If a probe is in progress or we are sleeping, wait for it to complete */
849 down(&adb_probe_mutex);
851 /* Queries are special requests sent to the ADB driver itself */
852 if (req->data[0] == ADB_QUERY) {
854 ret = do_adb_query(req);
857 up(&adb_probe_mutex);
859 /* Special case for ADB_BUSRESET request, all others are sent to
861 else if ((req->data[0] == ADB_PACKET)&&(count > 1)
862 &&(req->data[1] == ADB_BUSRESET)) {
863 ret = do_adb_reset_bus();
864 up(&adb_probe_mutex);
865 atomic_dec(&state->n_pending);
870 req->reply_expected = ((req->data[1] & 0xc) == 0xc);
871 if (adb_controller && adb_controller->send_request)
872 ret = adb_controller->send_request(req, 0);
875 up(&adb_probe_mutex);
879 atomic_dec(&state->n_pending);
889 static struct file_operations adb_fops = {
890 .owner = THIS_MODULE,
895 .release = adb_release,
901 if (register_chrdev(ADB_MAJOR, "adb", &adb_fops)) {
902 printk(KERN_ERR "adb: unable to get major %d\n", ADB_MAJOR);
906 devfs_mk_cdev(MKDEV(ADB_MAJOR, 0), S_IFCHR | S_IRUSR | S_IWUSR, "adb");
908 adb_dev_class = class_simple_create(THIS_MODULE, "adb");
909 if (IS_ERR(adb_dev_class)) {
912 class_simple_device_add(adb_dev_class, MKDEV(ADB_MAJOR, 0), NULL, "adb");