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;
92 #ifdef CONFIG_PM_SLEEP
93 static void 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)
251 strcpy(current->comm, "kadbprobe");
253 printk(KERN_INFO "adb: starting probe task...\n");
255 printk(KERN_INFO "adb: finished probe task...\n");
257 adb_probe_task_pid = 0;
258 up(&adb_probe_mutex);
264 __adb_probe_task(struct work_struct *bullshit)
266 adb_probe_task_pid = kernel_thread(adb_probe_task, NULL, SIGCHLD | CLONE_KERNEL);
269 static DECLARE_WORK(adb_reset_work, __adb_probe_task);
274 if (__adb_probe_sync) {
279 down(&adb_probe_mutex);
280 schedule_work(&adb_reset_work);
284 int __init adb_init(void)
286 struct adb_driver *driver;
290 if (!machine_is(chrp) && !machine_is(powermac))
298 /* xmon may do early-init */
303 adb_controller = NULL;
306 while ((driver = adb_driver_list[i++]) != NULL) {
307 if (!driver->probe()) {
308 adb_controller = driver;
312 if ((adb_controller == NULL) || adb_controller->init()) {
313 printk(KERN_WARNING "Warning: no ADB interface detected\n");
314 adb_controller = NULL;
316 #ifdef CONFIG_PM_SLEEP
317 pmu_register_sleep_notifier(&adb_sleep_notifier);
318 #endif /* CONFIG_PM */
320 if (machine_is_compatible("AAPL,PowerBook1998") ||
321 machine_is_compatible("PowerBook1,1"))
323 #endif /* CONFIG_PPC */
324 init_completion(&adb_probe_task_comp);
331 __initcall(adb_init);
335 * notify clients before sleep and reset bus afterwards
338 adb_notify_sleep(struct pmu_sleep_notifier *self, int when)
341 case PBOOK_SLEEP_REQUEST:
343 /* We need to get a lock on the probe thread */
344 down(&adb_probe_mutex);
346 if (adb_controller->autopoll)
347 adb_controller->autopoll(0);
348 blocking_notifier_call_chain(&adb_client_list,
349 ADB_MSG_POWERDOWN, NULL);
353 up(&adb_probe_mutex);
358 #endif /* CONFIG_PM */
361 do_adb_reset_bus(void)
365 if (adb_controller == NULL)
368 if (adb_controller->autopoll)
369 adb_controller->autopoll(0);
371 blocking_notifier_call_chain(&adb_client_list,
372 ADB_MSG_PRE_RESET, NULL);
374 if (sleepy_trackpad) {
375 /* Let the trackpad settle down */
379 down(&adb_handler_sem);
380 write_lock_irq(&adb_handler_lock);
381 memset(adb_handler, 0, sizeof(adb_handler));
382 write_unlock_irq(&adb_handler_lock);
384 /* That one is still a bit synchronous, oh well... */
385 if (adb_controller->reset_bus)
386 ret = adb_controller->reset_bus();
390 if (sleepy_trackpad) {
391 /* Let the trackpad settle down */
396 autopoll_devs = adb_scan_bus();
397 if (adb_controller->autopoll)
398 adb_controller->autopoll(autopoll_devs);
400 up(&adb_handler_sem);
402 blocking_notifier_call_chain(&adb_client_list,
403 ADB_MSG_POST_RESET, NULL);
411 if ((adb_controller == NULL)||(adb_controller->poll == NULL))
413 adb_controller->poll();
417 adb_probe_wakeup(struct adb_request *req)
419 complete(&adb_probe_task_comp);
422 /* Static request used during probe */
423 static struct adb_request adb_sreq;
424 static unsigned long adb_sreq_lock; // Use semaphore ! */
427 adb_request(struct adb_request *req, void (*done)(struct adb_request *),
428 int flags, int nbytes, ...)
434 if ((adb_controller == NULL) || (adb_controller->send_request == NULL))
438 if (req == NULL && (flags & ADBREQ_NOSEND))
442 if (test_and_set_bit(0,&adb_sreq_lock)) {
443 printk("adb.c: Warning: contention on static request !\n");
447 flags |= ADBREQ_SYNC;
451 req->nbytes = nbytes+1;
453 req->reply_expected = flags & ADBREQ_REPLY;
454 req->data[0] = ADB_PACKET;
455 va_start(list, nbytes);
456 for (i = 0; i < nbytes; ++i)
457 req->data[i+1] = va_arg(list, int);
460 if (flags & ADBREQ_NOSEND)
463 /* Synchronous requests send from the probe thread cause it to
464 * block. Beware that the "done" callback will be overriden !
466 if ((flags & ADBREQ_SYNC) &&
467 (current->pid && adb_probe_task_pid &&
468 adb_probe_task_pid == current->pid)) {
469 req->done = adb_probe_wakeup;
470 rc = adb_controller->send_request(req, 0);
471 if (rc || req->complete)
473 wait_for_completion(&adb_probe_task_comp);
478 rc = adb_controller->send_request(req, flags & ADBREQ_SYNC);
481 clear_bit(0, &adb_sreq_lock);
486 /* Ultimately this should return the number of devices with
487 the given default id.
488 And it does it now ! Note: changed behaviour: This function
489 will now register if default_id _and_ handler_id both match
490 but handler_id can be left to 0 to match with default_id only.
491 When handler_id is set, this function will try to adjust
492 the handler_id id it doesn't match. */
494 adb_register(int default_id, int handler_id, struct adb_ids *ids,
495 void (*handler)(unsigned char *, int, int))
499 down(&adb_handler_sem);
501 for (i = 1; i < 16; i++) {
502 if ((adb_handler[i].original_address == default_id) &&
503 (!handler_id || (handler_id == adb_handler[i].handler_id) ||
504 try_handler_change(i, handler_id))) {
505 if (adb_handler[i].handler != 0) {
507 "Two handlers for ADB device %d\n",
511 write_lock_irq(&adb_handler_lock);
512 adb_handler[i].handler = handler;
513 write_unlock_irq(&adb_handler_lock);
514 ids->id[ids->nids++] = i;
517 up(&adb_handler_sem);
522 adb_unregister(int index)
526 down(&adb_handler_sem);
527 write_lock_irq(&adb_handler_lock);
528 if (adb_handler[index].handler) {
529 while(adb_handler[index].busy) {
530 write_unlock_irq(&adb_handler_lock);
532 write_lock_irq(&adb_handler_lock);
535 adb_handler[index].handler = NULL;
537 write_unlock_irq(&adb_handler_lock);
538 up(&adb_handler_sem);
543 adb_input(unsigned char *buf, int nb, int autopoll)
546 static int dump_adb_input = 0;
549 void (*handler)(unsigned char *, int, int);
551 /* We skip keystrokes and mouse moves when the sleep process
552 * has been started. We stop autopoll, but this is another security
558 if (dump_adb_input) {
559 printk(KERN_INFO "adb packet: ");
560 for (i = 0; i < nb; ++i)
561 printk(" %x", buf[i]);
562 printk(", id = %d\n", id);
564 write_lock_irqsave(&adb_handler_lock, flags);
565 handler = adb_handler[id].handler;
567 adb_handler[id].busy = 1;
568 write_unlock_irqrestore(&adb_handler_lock, flags);
569 if (handler != NULL) {
570 (*handler)(buf, nb, autopoll);
572 adb_handler[id].busy = 0;
577 /* Try to change handler to new_id. Will return 1 if successful. */
578 static int try_handler_change(int address, int new_id)
580 struct adb_request req;
582 if (adb_handler[address].handler_id == new_id)
584 adb_request(&req, NULL, ADBREQ_SYNC, 3,
585 ADB_WRITEREG(address, 3), address | 0x20, new_id);
586 adb_request(&req, NULL, ADBREQ_SYNC | ADBREQ_REPLY, 1,
587 ADB_READREG(address, 3));
588 if (req.reply_len < 2)
590 if (req.reply[2] != new_id)
592 adb_handler[address].handler_id = req.reply[2];
598 adb_try_handler_change(int address, int new_id)
602 down(&adb_handler_sem);
603 ret = try_handler_change(address, new_id);
604 up(&adb_handler_sem);
609 adb_get_infos(int address, int *original_address, int *handler_id)
611 down(&adb_handler_sem);
612 *original_address = adb_handler[address].original_address;
613 *handler_id = adb_handler[address].handler_id;
614 up(&adb_handler_sem);
616 return (*original_address != 0);
621 * /dev/adb device driver.
624 #define ADB_MAJOR 56 /* major number for /dev/adb */
626 struct adbdev_state {
629 struct adb_request *completed;
630 wait_queue_head_t wait_queue;
634 static void adb_write_done(struct adb_request *req)
636 struct adbdev_state *state = (struct adbdev_state *) req->arg;
639 if (!req->complete) {
643 spin_lock_irqsave(&state->lock, flags);
644 atomic_dec(&state->n_pending);
647 if (atomic_read(&state->n_pending) == 0) {
648 spin_unlock_irqrestore(&state->lock, flags);
653 struct adb_request **ap = &state->completed;
658 wake_up_interruptible(&state->wait_queue);
660 spin_unlock_irqrestore(&state->lock, flags);
664 do_adb_query(struct adb_request *req)
670 case ADB_QUERY_GETDEVINFO:
673 down(&adb_handler_sem);
674 req->reply[0] = adb_handler[req->data[2]].original_address;
675 req->reply[1] = adb_handler[req->data[2]].handler_id;
676 up(&adb_handler_sem);
686 static int adb_open(struct inode *inode, struct file *file)
688 struct adbdev_state *state;
690 if (iminor(inode) > 0 || adb_controller == NULL)
692 state = kmalloc(sizeof(struct adbdev_state), GFP_KERNEL);
695 file->private_data = state;
696 spin_lock_init(&state->lock);
697 atomic_set(&state->n_pending, 0);
698 state->completed = NULL;
699 init_waitqueue_head(&state->wait_queue);
705 static int adb_release(struct inode *inode, struct file *file)
707 struct adbdev_state *state = file->private_data;
712 file->private_data = NULL;
713 spin_lock_irqsave(&state->lock, flags);
714 if (atomic_read(&state->n_pending) == 0
715 && state->completed == NULL) {
716 spin_unlock_irqrestore(&state->lock, flags);
720 spin_unlock_irqrestore(&state->lock, flags);
727 static ssize_t adb_read(struct file *file, char __user *buf,
728 size_t count, loff_t *ppos)
731 struct adbdev_state *state = file->private_data;
732 struct adb_request *req;
733 wait_queue_t wait = __WAITQUEUE_INITIALIZER(wait,current);
738 if (count > sizeof(req->reply))
739 count = sizeof(req->reply);
740 if (!access_ok(VERIFY_WRITE, buf, count))
744 spin_lock_irqsave(&state->lock, flags);
745 add_wait_queue(&state->wait_queue, &wait);
746 current->state = TASK_INTERRUPTIBLE;
749 req = state->completed;
751 state->completed = req->next;
752 else if (atomic_read(&state->n_pending) == 0)
754 if (req != NULL || ret != 0)
757 if (file->f_flags & O_NONBLOCK) {
761 if (signal_pending(current)) {
765 spin_unlock_irqrestore(&state->lock, flags);
767 spin_lock_irqsave(&state->lock, flags);
770 current->state = TASK_RUNNING;
771 remove_wait_queue(&state->wait_queue, &wait);
772 spin_unlock_irqrestore(&state->lock, flags);
777 ret = req->reply_len;
780 if (ret > 0 && copy_to_user(buf, req->reply, ret))
787 static ssize_t adb_write(struct file *file, const char __user *buf,
788 size_t count, loff_t *ppos)
791 struct adbdev_state *state = file->private_data;
792 struct adb_request *req;
794 if (count < 2 || count > sizeof(req->data))
796 if (adb_controller == NULL)
798 if (!access_ok(VERIFY_READ, buf, count))
801 req = kmalloc(sizeof(struct adb_request),
807 req->done = adb_write_done;
808 req->arg = (void *) state;
812 if (copy_from_user(req->data, buf, count))
815 atomic_inc(&state->n_pending);
817 /* If a probe is in progress or we are sleeping, wait for it to complete */
818 down(&adb_probe_mutex);
820 /* Queries are special requests sent to the ADB driver itself */
821 if (req->data[0] == ADB_QUERY) {
823 ret = do_adb_query(req);
826 up(&adb_probe_mutex);
828 /* Special case for ADB_BUSRESET request, all others are sent to
830 else if ((req->data[0] == ADB_PACKET)&&(count > 1)
831 &&(req->data[1] == ADB_BUSRESET)) {
832 ret = do_adb_reset_bus();
833 up(&adb_probe_mutex);
834 atomic_dec(&state->n_pending);
839 req->reply_expected = ((req->data[1] & 0xc) == 0xc);
840 if (adb_controller && adb_controller->send_request)
841 ret = adb_controller->send_request(req, 0);
844 up(&adb_probe_mutex);
848 atomic_dec(&state->n_pending);
858 static const struct file_operations adb_fops = {
859 .owner = THIS_MODULE,
864 .release = adb_release,
870 if (register_chrdev(ADB_MAJOR, "adb", &adb_fops)) {
871 printk(KERN_ERR "adb: unable to get major %d\n", ADB_MAJOR);
875 adb_dev_class = class_create(THIS_MODULE, "adb");
876 if (IS_ERR(adb_dev_class))
878 class_device_create(adb_dev_class, NULL, MKDEV(ADB_MAJOR, 0), NULL, "adb");